Opération de service GetAdsByAdGroupId - Gestion des campagnes
Récupère les annonces au sein d’un groupe d’annonces.
Éléments de demande
L’objet GetAdsByAdGroupIdRequest 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 |
---|---|---|
AdGroupId | Identificateur du groupe d’annonces à partir duquel récupérer les annonces. | long |
AdTypes | Un ou plusieurs types d’annonces à récupérer. | Tableau AdType |
ReturnAdditionalFields | Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque annonce retournée. 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. |
AdAdditionalField |
É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 |
Mot de passe | 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 GetAdsByAdGroupIdResponse 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 |
---|---|---|
Annonces | Liste des annonces qui ont été récupérées. Si le groupe d’annonces ne contient pas de publicités, ce tableau est vide. | Tableau d’annonces |
É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">GetAdsByAdGroupId</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>
<GetAdsByAdGroupIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupId>ValueHere</AdGroupId>
<AdTypes i:nil="false">
<AdType>ValueHere</AdType>
</AdTypes>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdsByAdGroupIdRequest>
</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>
<GetAdsByAdGroupIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Ads d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Ad d4p1:type="-- derived type specified here with the appropriate prefix --">
<AdFormatPreference d4p1:nil="false">ValueHere</AdFormatPreference>
<DevicePreference d4p1:nil="false">ValueHere</DevicePreference>
<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>
<ForwardCompatibilityMap xmlns:e235="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e235:KeyValuePairOfstringstring>
<e235:key d4p1:nil="false">ValueHere</e235:key>
<e235:value d4p1:nil="false">ValueHere</e235:value>
</e235:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Status d4p1:nil="false">ValueHere</Status>
<TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
<Type d4p1:nil="false">ValueHere</Type>
<UrlCustomParameters d4p1:nil="false">
<Parameters d4p1:nil="false">
<CustomParameter>
<Key d4p1:nil="false">ValueHere</Key>
<Value d4p1:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to TextAd-->
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<DisplayUrl d4p1:nil="false">ValueHere</DisplayUrl>
<Text d4p1:nil="false">ValueHere</Text>
<Title d4p1:nil="false">ValueHere</Title>
<!--This field is applicable if the derived type attribute is set to ProductAd-->
<PromotionalText d4p1:nil="false">ValueHere</PromotionalText>
<!--No additional fields are applicable if the derived type attribute is set to HotelAd-->
<!--These fields are applicable if the derived type attribute is set to AppInstallAd-->
<AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
<AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
<Text d4p1:nil="false">ValueHere</Text>
<Title d4p1:nil="false">ValueHere</Title>
<!--These fields are applicable if the derived type attribute is set to ExpandedTextAd-->
<Domain d4p1:nil="false">ValueHere</Domain>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
<Text d4p1:nil="false">ValueHere</Text>
<TextPart2 d4p1:nil="false">ValueHere</TextPart2>
<TitlePart1 d4p1:nil="false">ValueHere</TitlePart1>
<TitlePart2 d4p1:nil="false">ValueHere</TitlePart2>
<TitlePart3 d4p1:nil="false">ValueHere</TitlePart3>
<!--These fields are applicable if the derived type attribute is set to DynamicSearchAd-->
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
<Text d4p1:nil="false">ValueHere</Text>
<TextPart2 d4p1:nil="false">ValueHere</TextPart2>
<!--These fields are applicable if the derived type attribute is set to ResponsiveAd-->
<AdSubType d4p1:nil="false">ValueHere</AdSubType>
<BusinessName d4p1:nil="false">ValueHere</BusinessName>
<CallToAction d4p1:nil="false">ValueHere</CallToAction>
<CallToActionLanguage d4p1:nil="false">ValueHere</CallToActionLanguage>
<Descriptions d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Descriptions>
<Headline d4p1:nil="false">ValueHere</Headline>
<Headlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Headlines>
<Images d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Images>
<ImpressionTrackingUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</ImpressionTrackingUrls>
<LongHeadline d4p1:nil="false">
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</LongHeadline>
<LongHeadlineString d4p1:nil="false">ValueHere</LongHeadlineString>
<LongHeadlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</LongHeadlines>
<Text d4p1:nil="false">ValueHere</Text>
<VerifiedTrackingSettings d4p1:nil="false">
<Details xmlns:e236="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e236:ArrayOfKeyValuePairOfstringstring>
<e236:KeyValuePairOfstringstring>
<e236:key d4p1:nil="false">ValueHere</e236:key>
<e236:value d4p1:nil="false">ValueHere</e236:value>
</e236:KeyValuePairOfstringstring>
</e236:ArrayOfKeyValuePairOfstringstring>
</Details>
</VerifiedTrackingSettings>
<Videos d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Videos>
<!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAd-->
<Descriptions d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Descriptions>
<Domain d4p1:nil="false">ValueHere</Domain>
<Headlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Headlines>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
</Ad>
</Ads>
</GetAdsByAdGroupIdResponse>
</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<GetAdsByAdGroupIdResponse> GetAdsByAdGroupIdAsync(
long adGroupId,
IList<AdType> adTypes,
AdAdditionalField? returnAdditionalFields)
{
var request = new GetAdsByAdGroupIdRequest
{
AdGroupId = adGroupId,
AdTypes = adTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdsByAdGroupIdAsync(r), request));
}
static GetAdsByAdGroupIdResponse getAdsByAdGroupId(
java.lang.Long adGroupId,
ArrayOfAdType adTypes,
ArrayList<AdAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdsByAdGroupIdRequest request = new GetAdsByAdGroupIdRequest();
request.setAdGroupId(adGroupId);
request.setAdTypes(adTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdsByAdGroupId(request);
}
static function GetAdsByAdGroupId(
$adGroupId,
$adTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdsByAdGroupIdRequest();
$request->AdGroupId = $adGroupId;
$request->AdTypes = $adTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByAdGroupId($request);
}
response=campaignmanagement_service.GetAdsByAdGroupId(
AdGroupId=AdGroupId,
AdTypes=AdTypes,
ReturnAdditionalFields=ReturnAdditionalFields)
Configuration requise
Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
URL de la demande
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Ads/QueryByAdGroupId
Éléments de demande
L’objet GetAdsByAdGroupIdRequest définit les éléments body et header de la demande d’opération de service.
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 |
---|---|---|
AdGroupId | Identificateur du groupe d’annonces à partir duquel récupérer les annonces. | long |
AdTypes | Un ou plusieurs types d’annonces à récupérer. | Tableau AdType |
ReturnAdditionalFields | Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque annonce retournée. 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. |
AdAdditionalField |
Éléments d’en-tête de requête
Élément | Description | Type de données |
---|---|---|
Autorisation | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. 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 |
Mot de passe | 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 GetAdsByAdGroupIdResponse 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 le json de réponse.
Response Body, éléments
Élément | Description | Type de données |
---|---|---|
Annonces | Liste des annonces qui ont été récupérées. Si le groupe d’annonces ne contient pas de publicités, ce tableau est vide. | Tableau d’annonces |
É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 JSON
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. 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.
{
"AdGroupId": "LongValueHere",
"AdTypes": [
"ValueHere"
],
"ReturnAdditionalFields": "ValueHere"
}
JSON de réponse
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.
Vous trouverez ci-dessous un exemple qui s’applique si le type d’annonce est AppInstallAd.
{
"Ads": [
{
"AdFormatPreference": "ValueHere",
"DevicePreference": "LongValueHere",
"EditorialStatus": "ValueHere",
"FinalAppUrls": [
{
"OsType": "ValueHere",
"Url": "ValueHere"
}
],
"FinalMobileUrls": [
"ValueHere"
],
"FinalUrls": [
"ValueHere"
],
"FinalUrlSuffix": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Status": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"Type": "AppInstall",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "ValueHere"
}
]
},
"AppPlatform": "ValueHere",
"AppStoreId": "ValueHere",
"Text": "ValueHere",
"Title": "ValueHere"
}
]
}
Syntaxe du code
Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. 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<GetAdsByAdGroupIdResponse> GetAdsByAdGroupIdAsync(
long adGroupId,
IList<AdType> adTypes,
AdAdditionalField? returnAdditionalFields)
{
var request = new GetAdsByAdGroupIdRequest
{
AdGroupId = adGroupId,
AdTypes = adTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdsByAdGroupIdAsync(r), request));
}
static GetAdsByAdGroupIdResponse getAdsByAdGroupId(
java.lang.Long adGroupId,
ArrayOfAdType adTypes,
ArrayList<AdAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdsByAdGroupIdRequest request = new GetAdsByAdGroupIdRequest();
request.setAdGroupId(adGroupId);
request.setAdTypes(adTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdsByAdGroupId(request);
}
static function GetAdsByAdGroupId(
$adGroupId,
$adTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdsByAdGroupIdRequest();
$request->AdGroupId = $adGroupId;
$request->AdTypes = $adTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByAdGroupId($request);
}
response=campaignmanagement_service.GetAdsByAdGroupId(
AdGroupId=AdGroupId,
AdTypes=AdTypes,
ReturnAdditionalFields=ReturnAdditionalFields)