Opération de service GetAdGroupCriterionsByIds - Gestion des campagnes
Obtient les critères de groupe d’annonces par identificateurs et types.
Éléments de demande
L’objet GetAdGroupCriterionsByIdsRequest 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 |
|---|---|---|
| AdGroupCriterionIds | Liste d’identificateurs uniques qui identifient les critères à obtenir. Vous pouvez inclure jusqu’à 1 000 identificateurs de critères de groupe d’annonces par demande. Si cet élément est null, tous les critères de l’AdGroupId spécifié seront récupérés. |
tableau long |
| AdGroupId | Identificateur du groupe d’annonces qui possède les critères à obtenir. | Long |
| CriterionType | Type de critère à obtenir, par exemple Page web. Vous ne pouvez spécifier qu’un seul type. Les valeurs Targets et Audience ne sont pas autorisées pour cette opération. | AdGroupCriterionType |
| ReturnAdditionalFields | Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque critère de groupe d’annonces retourné. 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. |
CriterionAdditionalField |
É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 GetAdGroupCriterionsByIdsResponse 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 |
|---|---|---|
| AdGroupCriterions | Liste des critères qui correspondent directement aux identificateurs spécifiés dans la demande. Si un identificateur de la liste n’est pas valide, l’élément correspondant dans la réponse est défini sur null. | Tableau AdGroupCriterion |
É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">GetAdGroupCriterionsByIds</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>
<GetAdGroupCriterionsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupCriterionIds>
<AdGroupId>ValueHere</AdGroupId>
<CriterionType>ValueHere</CriterionType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdGroupCriterionsByIdsRequest>
</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>
<GetAdGroupCriterionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupCriterions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdGroupCriterion d4p1:type="-- derived type specified here with the appropriate prefix --">
<AdGroupId>ValueHere</AdGroupId>
<Criterion 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 ProductPartition-->
<Condition d4p1:nil="false">
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</Condition>
<ParentCriterionId d4p1:nil="false">ValueHere</ParentCriterionId>
<PartitionType>ValueHere</PartitionType>
<!--These fields are applicable if the derived type attribute is set to HotelGroup-->
<Listing d4p1:nil="false">
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
</Listing>
<ListingType>ValueHere</ListingType>
<ParentCriterionId d4p1:nil="false">ValueHere</ParentCriterionId>
<!--These fields are applicable if the derived type attribute is set to HotelAdvanceBookingWindowCriterion-->
<MaxDays d4p1:nil="false">ValueHere</MaxDays>
<MinDays d4p1:nil="false">ValueHere</MinDays>
<!--These fields are applicable if the derived type attribute is set to HotelCheckInDateCriterion-->
<EndDate d4p1:nil="false">ValueHere</EndDate>
<StartDate d4p1:nil="false">ValueHere</StartDate>
<!--This field is applicable if the derived type attribute is set to HotelCheckInDayCriterion-->
<CheckInDay d4p1:nil="false">ValueHere</CheckInDay>
<!--This field is applicable if the derived type attribute is set to HotelDateSelectionTypeCriterion-->
<HotelDateSelectionType d4p1:nil="false">ValueHere</HotelDateSelectionType>
<!--These fields are applicable if the derived type attribute is set to HotelLengthOfStayCriterion-->
<MaxNights d4p1:nil="false">ValueHere</MaxNights>
<MinNights d4p1:nil="false">ValueHere</MinNights>
<!--This field is applicable if the derived type attribute is set to ProductScope-->
<Conditions d4p1:nil="false">
<ProductCondition>
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</ProductCondition>
</Conditions>
<!--This field is applicable if the derived type attribute is set to Webpage-->
<Parameter d4p1:nil="false">
<Conditions d4p1:nil="false">
<WebpageCondition>
<Argument d4p1:nil="false">ValueHere</Argument>
<Operand>ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</WebpageCondition>
</Conditions>
<CriterionName d4p1:nil="false">ValueHere</CriterionName>
</Parameter>
<!--This field is applicable if the derived type attribute is set to AgeCriterion-->
<AgeRange d4p1:nil="false">ValueHere</AgeRange>
<!--These fields are applicable if the derived type attribute is set to DeviceCriterion-->
<DeviceName d4p1:nil="false">ValueHere</DeviceName>
<OSName d4p1:nil="false">ValueHere</OSName>
<!--These fields are applicable if the derived type attribute is set to DayTimeCriterion-->
<Day d4p1:nil="false">ValueHere</Day>
<FromHour d4p1:nil="false">ValueHere</FromHour>
<FromMinute d4p1:nil="false">ValueHere</FromMinute>
<ToHour d4p1:nil="false">ValueHere</ToHour>
<ToMinute d4p1:nil="false">ValueHere</ToMinute>
<!--This field is applicable if the derived type attribute is set to GenderCriterion-->
<GenderType d4p1:nil="false">ValueHere</GenderType>
<!--These fields are applicable if the derived type attribute is set to RadiusCriterion-->
<LatitudeDegrees d4p1:nil="false">ValueHere</LatitudeDegrees>
<LongitudeDegrees d4p1:nil="false">ValueHere</LongitudeDegrees>
<Name d4p1:nil="false">ValueHere</Name>
<Radius d4p1:nil="false">ValueHere</Radius>
<RadiusUnit d4p1:nil="false">ValueHere</RadiusUnit>
<!--These fields are applicable if the derived type attribute is set to LocationCriterion-->
<DisplayName d4p1:nil="false">ValueHere</DisplayName>
<EnclosedLocationIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EnclosedLocationIds>
<LocationId d4p1:nil="false">ValueHere</LocationId>
<LocationType d4p1:nil="false">ValueHere</LocationType>
<!--This field is applicable if the derived type attribute is set to LocationIntentCriterion-->
<IntentOption d4p1:nil="false">ValueHere</IntentOption>
<!--These fields are applicable if the derived type attribute is set to AudienceCriterion-->
<AudienceId d4p1:nil="false">ValueHere</AudienceId>
<AudienceType d4p1:nil="false">ValueHere</AudienceType>
<!--These fields are applicable if the derived type attribute is set to ProfileCriterion-->
<ProfileId>ValueHere</ProfileId>
<ProfileType>ValueHere</ProfileType>
<!--This field is applicable if the derived type attribute is set to StoreCriterion-->
<StoreId d4p1:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DealCriterion-->
<DealId>ValueHere</DealId>
<!--This field is applicable if the derived type attribute is set to GenreCriterion-->
<GenreId>ValueHere</GenreId>
</Criterion>
<Id d4p1:nil="false">ValueHere</Id>
<Status d4p1:nil="false">ValueHere</Status>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to BiddableAdGroupCriterion-->
<CriterionBid d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to RateBid-->
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
<!--This field is applicable if the derived type attribute is set to FixedBid-->
<Amount>ValueHere</Amount>
<!--This field is applicable if the derived type attribute is set to BidMultiplier-->
<Multiplier>ValueHere</Multiplier>
</CriterionBid>
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<FinalAppUrls d4p1:nil="false">
<AppUrl>
<OsType d4p1:nil="false">ValueHere</OsType>
<Url d4p1:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters d4p1:nil="false">
<Parameters d4p1:nil="false">
<CustomParameter>
<Key d4p1:nil="false">ValueHere</Key>
<Value d4p1:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<CriterionCashback d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to CashbackAdjustment-->
<CashbackPercent d4p1:nil="false">ValueHere</CashbackPercent>
</CriterionCashback>
<!--No additional fields are applicable if the derived type attribute is set to NegativeAdGroupCriterion-->
</AdGroupCriterion>
</AdGroupCriterions>
</GetAdGroupCriterionsByIdsResponse>
</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<GetAdGroupCriterionsByIdsResponse> GetAdGroupCriterionsByIdsAsync(
IList<long> adGroupCriterionIds,
long adGroupId,
AdGroupCriterionType criterionType,
CriterionAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupCriterionsByIdsRequest
{
AdGroupCriterionIds = adGroupCriterionIds,
AdGroupId = adGroupId,
CriterionType = criterionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupCriterionsByIdsAsync(r), request));
}
static GetAdGroupCriterionsByIdsResponse getAdGroupCriterionsByIds(
ArrayOflong adGroupCriterionIds,
java.lang.Long adGroupId,
ArrayList<AdGroupCriterionType> criterionType,
ArrayList<CriterionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupCriterionsByIdsRequest request = new GetAdGroupCriterionsByIdsRequest();
request.setAdGroupCriterionIds(adGroupCriterionIds);
request.setAdGroupId(adGroupId);
request.setCriterionType(criterionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupCriterionsByIds(request);
}
static function GetAdGroupCriterionsByIds(
$adGroupCriterionIds,
$adGroupId,
$criterionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupCriterionsByIdsRequest();
$request->AdGroupCriterionIds = $adGroupCriterionIds;
$request->AdGroupId = $adGroupId;
$request->CriterionType = $criterionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupCriterionsByIds($request);
}
response=campaignmanagement_service.GetAdGroupCriterionsByIds(
AdGroupCriterionIds=AdGroupCriterionIds,
AdGroupId=AdGroupId,
CriterionType=CriterionType,
ReturnAdditionalFields=ReturnAdditionalFields)
Configuration requise
Service : CampaignManagementService.svc v13
Noms: https://bingads.microsoft.com/CampaignManagement/v13