Operación de servicio GetAdsByAdGroupId: administración de campañas
Recupera los anuncios de un grupo de anuncios.
Elementos Request
El objeto GetAdsByAdGroupIdRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
AdGroupId | Identificador del grupo de anuncios del que se van a recuperar los anuncios. | largo |
AdTypes | Uno o varios tipos de anuncios que se van a recuperar. | Matriz AdType |
ReturnAdditionalFields | Lista de propiedades adicionales que quieres incluir en cada anuncio devuelto. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Campaign Management API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada. Este elemento request es opcional. |
AdAdditionalField |
Elementos de encabezado de solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
AuthenticationToken | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Para obtener más información, consulte Autenticación con OAuth. |
string |
CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetAdsByAdGroupIdResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.
Elementos del cuerpo de la respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
Anuncios | Lista de anuncios que se han recuperado. Si el grupo de anuncios no contiene anuncios, esta matriz está vacía. | Matriz de anuncios |
Elementos de encabezado de respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de SOAP
Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
<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 respuesta
Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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:e233="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e233:KeyValuePairOfstringstring>
<e233:key d4p1:nil="false">ValueHere</e233:key>
<e233:value d4p1:nil="false">ValueHere</e233:value>
</e233: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:e234="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e234:ArrayOfKeyValuePairOfstringstring>
<e234:KeyValuePairOfstringstring>
<e234:key d4p1:nil="false">ValueHere</e234:key>
<e234:value d4p1:nil="false">ValueHere</e234:value>
</e234:KeyValuePairOfstringstring>
</e234: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>
Sintaxis de código
La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
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)
Requisitos
Servicio: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Dirección URL de solicitud
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Ads/QueryByAdGroupId
Elementos Request
El objeto GetAdsByAdGroupIdRequest define los elementos body y header de la solicitud de operación de servicio.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
AdGroupId | Identificador del grupo de anuncios del que se van a recuperar los anuncios. | largo |
AdTypes | Uno o varios tipos de anuncios que se van a recuperar. | Matriz AdType |
ReturnAdditionalFields | Lista de propiedades adicionales que quieres incluir en cada anuncio devuelto. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Campaign Management API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada. Este elemento request es opcional. |
AdAdditionalField |
Elementos de encabezado de solicitud
Elemento | Descripción | Tipo de datos |
---|---|---|
Autorización | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada. Para obtener más información, consulte Autenticación con OAuth. |
string |
CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetAdsByAdGroupIdResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.
Elementos del cuerpo de la respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
Anuncios | Lista de anuncios que se han recuperado. Si el grupo de anuncios no contiene anuncios, esta matriz está vacía. | Matriz de anuncios |
Elementos de encabezado de respuesta
Elemento | Descripción | Tipo de datos |
---|---|---|
Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de JSON
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
{
"AdGroupId": "LongValueHere",
"AdTypes": [
"ValueHere"
],
"ReturnAdditionalFields": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
A continuación se muestra un ejemplo que es aplicable si el tipo de anuncio es 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"
}
]
}
Sintaxis de código
Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
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)