Operazione del servizio GetAccountProperties - Gestione campagna
Ottiene le proprietà a livello di account in base al nome.
Elementi della richiesta
L'oggetto GetAccountPropertiesRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.
Nota
Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.
Elementi del corpo della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| AccountPropertyNames | Nomi delle proprietà dell'account che si desidera ottenere. Ad esempio, determinare se è abilitato o meno il tagging automatico dell'ID di Microsoft Click, includere il valore MSCLKIDAutoTaggingEnabled nella richiesta. |
Matrice AccountPropertyName |
Elementi dell'intestazione della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| AuthenticationToken | Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth. |
corda |
| CustomerAccountId | Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente. |
corda |
| CustomerId | Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente. |
corda |
| DeveloperToken | Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori. |
corda |
| Password | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
| UserName | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
Elementi di risposta
L'oggetto GetAccountPropertiesResponse definisce gli elementi corpo e intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.
Elementi del corpo della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| AccountProprietà | Matrice di proprietà dell'account. Per ogni nome di proprietà dell'account specificato nella richiesta, viene restituito un oggetto AccountProperty . |
Matrice AccountProperty |
| PartialErrors | Matrice di oggetti BatchError che contengono i dettagli per gli elementi della richiesta che non hanno avuto esito positivo. L'elenco di errori non corrisponde direttamente all'elenco di elementi nella richiesta. L'elenco può essere vuoto se non si sono verificati errori o può includere uno o più oggetti errore corrispondenti a ogni voce di elenco non riuscita nella richiesta. |
Matrice BatchError |
Elementi dell'intestazione della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| TrackingId | Identificatore della voce di log che contiene i dettagli della chiamata API. | corda |
Richiedi SOAP
Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Action mustUnderstand="1">GetAccountProperties</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetAccountPropertiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountPropertyNames i:nil="false">
<AccountPropertyName>ValueHere</AccountPropertyName>
</AccountPropertyNames>
</GetAccountPropertiesRequest>
</s:Body>
</s:Envelope>
SOAP della risposta
Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta SOAP.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetAccountPropertiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountProperties d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AccountProperty>
<Name>ValueHere</Name>
<Value d4p1:nil="false">ValueHere</Value>
</AccountProperty>
</AccountProperties>
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e209="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e209:KeyValuePairOfstringstring>
<e209:key d4p1:nil="false">ValueHere</e209:key>
<e209:value d4p1:nil="false">ValueHere</e209:value>
</e209:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</GetAccountPropertiesResponse>
</s:Body>
</s:Envelope>
Sintassi del codice
La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .
public async Task<GetAccountPropertiesResponse> GetAccountPropertiesAsync(
IList<AccountPropertyName> accountPropertyNames)
{
var request = new GetAccountPropertiesRequest
{
AccountPropertyNames = accountPropertyNames
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAccountPropertiesAsync(r), request));
}
static GetAccountPropertiesResponse getAccountProperties(
ArrayOfAccountPropertyName accountPropertyNames) throws RemoteException, Exception
{
GetAccountPropertiesRequest request = new GetAccountPropertiesRequest();
request.setAccountPropertyNames(accountPropertyNames);
return CampaignManagementService.getService().getAccountProperties(request);
}
static function GetAccountProperties(
$accountPropertyNames)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAccountPropertiesRequest();
$request->AccountPropertyNames = $accountPropertyNames;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAccountProperties($request);
}
response=campaignmanagement_service.GetAccountProperties(
AccountPropertyNames=AccountPropertyNames)
Requisiti
Servizio: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
URL richiesta
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AccountProperties/Query
Elementi della richiesta
L'oggetto GetAccountPropertiesRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio.
Nota
Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.
Elementi del corpo della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| AccountPropertyNames | Nomi delle proprietà dell'account che si desidera ottenere. Ad esempio, determinare se è abilitato o meno il tagging automatico dell'ID di Microsoft Click, includere il valore MSCLKIDAutoTaggingEnabled nella richiesta. |
Matrice AccountPropertyName |
Elementi dell'intestazione della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| Autorizzazione | Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Assicurarsi che il token sia preceduto da "Bearer", necessario per l'autenticazione corretta. Per altre informazioni, vedere Autenticazione con OAuth. |
corda |
| CustomerAccountId | Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente. |
corda |
| CustomerId | Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente. |
corda |
| DeveloperToken | Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori. |
corda |
| Password | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
| UserName | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
Elementi di risposta
L'oggetto GetAccountPropertiesResponse definisce gli elementi corpo e intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nel codice JSON della risposta.
Elementi del corpo della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| AccountProprietà | Matrice di proprietà dell'account. Per ogni nome di proprietà dell'account specificato nella richiesta, viene restituito un oggetto AccountProperty . |
Matrice AccountProperty |
| PartialErrors | Matrice di oggetti BatchError che contengono i dettagli per gli elementi della richiesta che non hanno avuto esito positivo. L'elenco di errori non corrisponde direttamente all'elenco di elementi nella richiesta. L'elenco può essere vuoto se non si sono verificati errori o può includere uno o più oggetti errore corrispondenti a ogni voce di elenco non riuscita nella richiesta. |
Matrice BatchError |
Elementi dell'intestazione della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| TrackingId | Identificatore della voce di log che contiene i dettagli della chiamata API. | corda |
Richiedere JSON
Questo modello è stato generato da uno strumento per visualizzare il corpo e gli elementi di intestazione per la richiesta JSON. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.
{
"AccountPropertyNames": [
"ValueHere"
]
}
Risposta JSON
Questo modello è stato generato da uno strumento per mostrare il corpo e gli elementi dell'intestazione per la risposta JSON.
Di seguito è riportato un esempio applicabile se il tipo di BatchError è EditorialError.
{
"AccountProperties": [
{
"Name": "ValueHere",
"Value": "ValueHere"
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
Sintassi del codice
Per chiamare l'API REST tramite SDK, è necessario aggiornare l'SDK a una determinata versione e configurare i parametri di sistema. La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .
public async Task<GetAccountPropertiesResponse> GetAccountPropertiesAsync(
IList<AccountPropertyName> accountPropertyNames)
{
var request = new GetAccountPropertiesRequest
{
AccountPropertyNames = accountPropertyNames
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAccountPropertiesAsync(r), request));
}
static GetAccountPropertiesResponse getAccountProperties(
ArrayOfAccountPropertyName accountPropertyNames) throws RemoteException, Exception
{
GetAccountPropertiesRequest request = new GetAccountPropertiesRequest();
request.setAccountPropertyNames(accountPropertyNames);
return CampaignManagementService.getService().getAccountProperties(request);
}
static function GetAccountProperties(
$accountPropertyNames)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAccountPropertiesRequest();
$request->AccountPropertyNames = $accountPropertyNames;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAccountProperties($request);
}
response=campaignmanagement_service.GetAccountProperties(
AccountPropertyNames=AccountPropertyNames)