Opération de service GetAudiencesByIds - Gestion des campagnes
Récupère les audiences spécifiées à partir du compte spécifié.
Éléments de demande
L’objet GetAudiencesByIdsRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| AudienceIds | Un maximum de 100 identificateurs des audiences demandées. Cet élément de requête est facultatif. Si cet élément est null ou vide, vous demandez effectivement toutes les audiences délimitées au client et au compte pour le compte spécifié. Si les identificateurs d’audience ne correspondent pas aux types d’audience demandés, l’opération retourne une erreur de lot pour chaque ID d’audience demandé. |
tableau long |
| ReturnAdditionalFields | Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Gestion des campagnes, et dans la version suivante, les éléments correspondants seront inclus par défaut. Cet élément de requête est facultatif. |
AudienceAdditionalField |
| Type | Type d’audiences à retourner. Vous pouvez inclure plusieurs valeurs en tant qu’indicateurs. La façon dont vous spécifiez plusieurs indicateurs dépend du langage de programmation que vous utilisez. Par exemple, C# traite ces valeurs comme des valeurs d’indicateur et Java les traite comme un tableau de chaînes. Le soap doit inclure une chaîne qui contient une liste de valeurs délimitées par des espaces, par exemple. <Type>RemarketingList SimilarRemarketingList</Type> |
Type d’audience |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| Customerid | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Password | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet GetAudiencesByIdsResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| Audiences | Liste des audiences qui correspond directement aux identificateurs d’audience que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une audience n’a pas été récupérée, l’élément correspondant est null. | Tableau d’audiences |
| PartialErrors | Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi. La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande. |
Tableau BatchError |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<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 de réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’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)
Configuration requise
Service : CampaignManagementService.svc v13
Noms: https://bingads.microsoft.com/CampaignManagement/v13