Operazione del servizio GetAudiencesByIds - Gestione campagna
Recupera i gruppi di destinatari specificati dall'account specificato.
Elementi della richiesta
L'oggetto GetAudiencesByIdsRequest definisce il corpo e gli elementi di 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 |
|---|---|---|
| AudienceIds | Un massimo di 100 identificatori dei gruppi di destinatari richiesti. Questo elemento della richiesta è facoltativo. Se questo elemento è null o vuoto, si richiede in modo efficace tutti i gruppi di destinatari con ambito cliente e account per l'account specificato. Se gli identificatori del gruppo di destinatari non corrispondono ai tipi di destinatari richiesti, l'operazione restituirà un errore batch per ogni ID gruppo di destinatari richiesto. |
matrice long |
| ReturnAdditionalFields | I valori di campo aggiuntivi consentono di ottenere le funzionalità più recenti usando la versione corrente dell'API Campaign Management e nella versione successiva gli elementi corrispondenti verranno inclusi per impostazione predefinita. Questo elemento della richiesta è facoltativo. |
AudienceAdditionalField |
| Digitare | Tipo di gruppi di destinatari da restituire. È possibile includere più valori come flag. Il modo in cui si specificano più flag dipende dal linguaggio di programmazione usato. Ad esempio, C# considera questi valori come valori flag e Java li considera come una matrice di stringhe. Soap deve includere una stringa che contiene un elenco di valori delimitato da spazi, <Type>RemarketingList SimilarRemarketingList</Type>ad esempio . |
AudienceType |
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. |
Stringa |
| 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. |
Stringa |
| 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. |
Stringa |
| DeveloperToken | Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori. |
Stringa |
| 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. | Stringa |
| 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. | Stringa |
Elementi di risposta
L'oggetto GetAudiencesByIdsResponse definisce il corpo e gli elementi di 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 |
|---|---|---|
| Pubblico | Elenco di gruppi di destinatari che corrisponde direttamente agli identificatori del gruppo di destinatari specificati nella richiesta. Gli elementi dell'elenco possono essere restituiti come Null. Per ogni indice di elenco in cui un gruppo di destinatari non è stato recuperato, l'elemento corrispondente sarà Null. | Matrice di destinatari |
| 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. | Stringa |
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">GetAudiencesByIds</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>
<GetAudiencesByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AudienceIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AudienceIds>
<Type>ValueHere</Type>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAudiencesByIdsRequest>
</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>
<GetAudiencesByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Audiences d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Audience d4p1:type="-- derived type specified here with the appropriate prefix --">
<AudienceNetworkSize d4p1:nil="false">ValueHere</AudienceNetworkSize>
<CustomerShare d4p1:nil="false">
<CustomerAccountShares d4p1:nil="false">
<CustomerAccountShare>
<AccountId d4p1:nil="false">ValueHere</AccountId>
<Associations d4p1:nil="false">
<CustomerAccountShareAssociation>
<AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
<UsageType d4p1:nil="false">ValueHere</UsageType>
</CustomerAccountShareAssociation>
</Associations>
<CustomerId d4p1:nil="false">ValueHere</CustomerId>
</CustomerAccountShare>
</CustomerAccountShares>
<OwnerCustomerId d4p1:nil="false">ValueHere</OwnerCustomerId>
</CustomerShare>
<Description d4p1:nil="false">ValueHere</Description>
<ForwardCompatibilityMap xmlns:e126="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e126:KeyValuePairOfstringstring>
<e126:key d4p1:nil="false">ValueHere</e126:key>
<e126:value d4p1:nil="false">ValueHere</e126:value>
</e126:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<MembershipDuration d4p1:nil="false">ValueHere</MembershipDuration>
<Name d4p1:nil="false">ValueHere</Name>
<ParentId d4p1:nil="false">ValueHere</ParentId>
<Scope d4p1:nil="false">ValueHere</Scope>
<SearchSize d4p1:nil="false">ValueHere</SearchSize>
<SupportedCampaignTypes d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</SupportedCampaignTypes>
<Type>ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to RemarketingList-->
<Rule d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to PageVisitorsRule-->
<NormalForm d4p1:nil="false">ValueHere</NormalForm>
<RuleItemGroups d4p1:nil="false">
<RuleItemGroup>
<Items d4p1:nil="false">
<RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
<!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
</RuleItem>
</Items>
</RuleItemGroup>
</RuleItemGroups>
<!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoVisitedAnotherPageRule-->
<AnotherRuleItemGroups d4p1:nil="false">
<RuleItemGroup>
<Items d4p1:nil="false">
<RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
<!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
</RuleItem>
</Items>
</RuleItemGroup>
</AnotherRuleItemGroups>
<RuleItemGroups d4p1:nil="false">
<RuleItemGroup>
<Items d4p1:nil="false">
<RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
<!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
</RuleItem>
</Items>
</RuleItemGroup>
</RuleItemGroups>
<!--These fields are applicable if the derived type attribute is set to PageVisitorsWhoDidNotVisitAnotherPageRule-->
<ExcludeRuleItemGroups d4p1:nil="false">
<RuleItemGroup>
<Items d4p1:nil="false">
<RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
<!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
</RuleItem>
</Items>
</RuleItemGroup>
</ExcludeRuleItemGroups>
<IncludeRuleItemGroups d4p1:nil="false">
<RuleItemGroup>
<Items d4p1:nil="false">
<RuleItem d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to StringRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
<!--These fields are applicable if the derived type attribute is set to NumberRuleItem-->
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator>ValueHere</Operator>
<Value d4p1:nil="false">ValueHere</Value>
</RuleItem>
</Items>
</RuleItemGroup>
</IncludeRuleItemGroups>
<!--These fields are applicable if the derived type attribute is set to CustomEventsRule-->
<Action d4p1:nil="false">ValueHere</Action>
<ActionOperator>ValueHere</ActionOperator>
<Category d4p1:nil="false">ValueHere</Category>
<CategoryOperator>ValueHere</CategoryOperator>
<Label d4p1:nil="false">ValueHere</Label>
<LabelOperator>ValueHere</LabelOperator>
<Value d4p1:nil="false">ValueHere</Value>
<ValueOperator>ValueHere</ValueOperator>
</Rule>
<TagId d4p1:nil="false">ValueHere</TagId>
<!--No additional fields are applicable if the derived type attribute is set to CustomAudience-->
<!--No additional fields are applicable if the derived type attribute is set to InMarketAudience-->
<!--These fields are applicable if the derived type attribute is set to ProductAudience-->
<ProductAudienceType d4p1:nil="false">ValueHere</ProductAudienceType>
<TagId d4p1:nil="false">ValueHere</TagId>
<!--This field is applicable if the derived type attribute is set to SimilarRemarketingList-->
<SourceId>ValueHere</SourceId>
<!--This field is applicable if the derived type attribute is set to CombinedList-->
<CombinationRules d4p1:nil="false">
<CombinationRule>
<AudienceIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AudienceIds>
<Operator>ValueHere</Operator>
</CombinationRule>
</CombinationRules>
<!--No additional fields are applicable if the derived type attribute is set to CustomerList-->
<!--These fields are applicable if the derived type attribute is set to ImpressionBasedRemarketingList-->
<AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
<CampaignId d4p1:nil="false">ValueHere</CampaignId>
<EntityType>ValueHere</EntityType>
</Audience>
</Audiences>
<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:e127="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e127:KeyValuePairOfstringstring>
<e127:key d4p1:nil="false">ValueHere</e127:key>
<e127:value d4p1:nil="false">ValueHere</e127:value>
</e127: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>
</GetAudiencesByIdsResponse>
</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<GetAudiencesByIdsResponse> GetAudiencesByIdsAsync(
IList<long> audienceIds,
AudienceType type,
AudienceAdditionalField? returnAdditionalFields)
{
var request = new GetAudiencesByIdsRequest
{
AudienceIds = audienceIds,
Type = type,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAudiencesByIdsAsync(r), request));
}
static GetAudiencesByIdsResponse getAudiencesByIds(
ArrayOflong audienceIds,
ArrayList<AudienceType> type,
ArrayList<AudienceAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAudiencesByIdsRequest request = new GetAudiencesByIdsRequest();
request.setAudienceIds(audienceIds);
request.setType(type);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAudiencesByIds(request);
}
static function GetAudiencesByIds(
$audienceIds,
$type,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAudiencesByIdsRequest();
$request->AudienceIds = $audienceIds;
$request->Type = $type;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAudiencesByIds($request);
}
response=campaignmanagement_service.GetAudiencesByIds(
AudienceIds=AudienceIds,
Type=Type,
ReturnAdditionalFields=ReturnAdditionalFields)
Requisiti
Servizio: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13