Operación de servicio GetAdGroupsByIds: Administración de campañas
Obtiene los grupos de anuncios especificados dentro de la campaña especificada.
Elementos Request
El objeto GetAdGroupsByIdsRequest 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 |
|---|---|---|
| AdGroupIds | Un máximo de 1000 identificadores de los grupos de anuncios que se van a obtener. | matriz larga |
| CampaignId | Identificador de la campaña que contiene los grupos de anuncios que se van a obtener. | largo |
| ReturnAdditionalFields | Lista de propiedades adicionales que quieres incluir en cada grupo de anuncios 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. |
AdGroupAdditionalField |
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 GetAdGroupsByIdsResponse 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 |
|---|---|---|
| AdGroups | Lista de grupos de anuncios que se corresponden directamente con los identificadores de grupo de anuncios especificados en la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó un grupo de anuncios, el elemento correspondiente será null. | Matriz de AdGroup |
| PartialErrors | Lista de errores por lotes que contienen detalles de los elementos de solicitud que no se han realizado correctamente. La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud. |
Matriz BatchError |
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">GetAdGroupsByIds</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>
<GetAdGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignId>ValueHere</CampaignId>
<AdGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupIds>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdGroupsByIdsRequest>
</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>
<GetAdGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdGroup>
<AdRotation d4p1:nil="false">
<EndDate d4p1:nil="false">ValueHere</EndDate>
<StartDate d4p1:nil="false">ValueHere</StartDate>
<Type d4p1:nil="false">ValueHere</Type>
</AdRotation>
<AudienceAdsBidAdjustment d4p1:nil="false">ValueHere</AudienceAdsBidAdjustment>
<BiddingScheme 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 MaxClicksBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
<!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
<!--No additional fields are applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to EnhancedCpcBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
<!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
<InheritedBidStrategyType d4p1:nil="false">ValueHere</InheritedBidStrategyType>
<!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
<!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
<TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
<!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetAdPosition d4p1:nil="false">ValueHere</TargetAdPosition>
<TargetImpressionShare d4p1:nil="false">ValueHere</TargetImpressionShare>
<!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
<MaxPercentCpc d4p1:nil="false">ValueHere</MaxPercentCpc>
<!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
<CommissionRate d4p1:nil="false">ValueHere</CommissionRate>
<!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
<ManualCpi d4p1:nil="false">ValueHere</ManualCpi>
<!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
<TargetCostPerSale d4p1:nil="false">ValueHere</TargetCostPerSale>
</BiddingScheme>
<CommissionRate d4p1:nil="false">
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
</CommissionRate>
<CpcBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</CpcBid>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<ForwardCompatibilityMap xmlns:e227="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e227:KeyValuePairOfstringstring>
<e227:key d4p1:nil="false">ValueHere</e227:key>
<e227:value d4p1:nil="false">ValueHere</e227:value>
</e227:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<FrequencyCapSettings d4p1:nil="false">
<FrequencyCapSettings>
<CapValue>ValueHere</CapValue>
<TimeGranularity>ValueHere</TimeGranularity>
</FrequencyCapSettings>
</FrequencyCapSettings>
<Id d4p1:nil="false">ValueHere</Id>
<Language d4p1:nil="false">ValueHere</Language>
<MultimediaAdsBidAdjustment d4p1:nil="false">ValueHere</MultimediaAdsBidAdjustment>
<Name d4p1:nil="false">ValueHere</Name>
<Network d4p1:nil="false">ValueHere</Network>
<PercentCpcBid d4p1:nil="false">
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
</PercentCpcBid>
<PrivacyStatus d4p1:nil="false">ValueHere</PrivacyStatus>
<Settings d4p1:nil="false">
<Setting 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 VerifiedTrackingSetting-->
<Details xmlns:e228="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e228:ArrayOfKeyValuePairOfstringstring>
<e228:KeyValuePairOfstringstring>
<e228:key d4p1:nil="false">ValueHere</e228:key>
<e228:value d4p1:nil="false">ValueHere</e228:value>
</e228:KeyValuePairOfstringstring>
</e228:ArrayOfKeyValuePairOfstringstring>
</Details>
<!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
<FeedLabel d4p1:nil="false">ValueHere</FeedLabel>
<LocalInventoryAdsEnabled d4p1:nil="false">ValueHere</LocalInventoryAdsEnabled>
<Priority d4p1:nil="false">ValueHere</Priority>
<SalesCountryCode d4p1:nil="false">ValueHere</SalesCountryCode>
<ShoppableAdsEnabled d4p1:nil="false">ValueHere</ShoppableAdsEnabled>
<StoreId d4p1:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
<FeedId d4p1:nil="false">ValueHere</FeedId>
<!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
<DomainName d4p1:nil="false">ValueHere</DomainName>
<DynamicDescriptionEnabled d4p1:nil="false">ValueHere</DynamicDescriptionEnabled>
<Language d4p1:nil="false">ValueHere</Language>
<PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<Source d4p1:nil="false">ValueHere</Source>
<!--This field is applicable if the derived type attribute is set to TargetSetting-->
<Details d4p1:nil="false">
<TargetSettingDetail>
<CriterionTypeGroup>ValueHere</CriterionTypeGroup>
<TargetAndBid>ValueHere</TargetAndBid>
</TargetSettingDetail>
</Details>
<!--These fields are applicable if the derived type attribute is set to CoOpSetting-->
<BidBoostValue d4p1:nil="false">ValueHere</BidBoostValue>
<BidMaxValue d4p1:nil="false">ValueHere</BidMaxValue>
<BidOption d4p1:nil="false">ValueHere</BidOption>
<!--This field is applicable if the derived type attribute is set to DisclaimerSetting-->
<DisclaimerAdsEnabled>ValueHere</DisclaimerAdsEnabled>
<!--This field is applicable if the derived type attribute is set to HotelSetting-->
<HotelAdGroupType>ValueHere</HotelAdGroupType>
<!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsSetting-->
<AutoGeneratedAssetsEnabled d4p1:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
<!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
<AutoGeneratedImageOptOut d4p1:nil="false">ValueHere</AutoGeneratedImageOptOut>
<AutoGeneratedTextOptOut d4p1:nil="false">ValueHere</AutoGeneratedTextOptOut>
<CostPerSaleOptOut d4p1:nil="false">ValueHere</CostPerSaleOptOut>
<FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
<PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<!--These fields are applicable if the derived type attribute is set to CallToActionSetting-->
<AutomatedCallToActionOptOut d4p1:nil="false">ValueHere</AutomatedCallToActionOptOut>
<CallToActionOptOut d4p1:nil="false">ValueHere</CallToActionOptOut>
<!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
<DisplayUrlMode d4p1:nil="false">ValueHere</DisplayUrlMode>
<WebsiteDescription d4p1:nil="false">ValueHere</WebsiteDescription>
<!--These fields are applicable if the derived type attribute is set to AppSetting-->
<AppId d4p1:nil="false">ValueHere</AppId>
<AppStore>ValueHere</AppStore>
<!--This field is applicable if the derived type attribute is set to ThirdPartyMeasurementSetting-->
<Details xmlns:e229="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e229:ArrayOfKeyValuePairOfstringstring>
<e229:KeyValuePairOfstringstring>
<e229:key d4p1:nil="false">ValueHere</e229:key>
<e229:value d4p1:nil="false">ValueHere</e229:value>
</e229:KeyValuePairOfstringstring>
</e229:ArrayOfKeyValuePairOfstringstring>
</Details>
</Setting>
</Settings>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<Status d4p1:nil="false">ValueHere</Status>
<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>
<UseOptimizedTargeting d4p1:nil="false">ValueHere</UseOptimizedTargeting>
<UsePredictiveTargeting d4p1:nil="false">ValueHere</UsePredictiveTargeting>
<AdScheduleUseSearcherTimeZone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
<AdGroupType d4p1:nil="false">ValueHere</AdGroupType>
<CpvBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</CpvBid>
<CpmBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</CpmBid>
<McpaBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</McpaBid>
</AdGroup>
</AdGroups>
<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:e230="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e230:KeyValuePairOfstringstring>
<e230:key d4p1:nil="false">ValueHere</e230:key>
<e230:value d4p1:nil="false">ValueHere</e230:value>
</e230: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>
</GetAdGroupsByIdsResponse>
</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<GetAdGroupsByIdsResponse> GetAdGroupsByIdsAsync(
long campaignId,
IList<long> adGroupIds,
AdGroupAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupsByIdsRequest
{
CampaignId = campaignId,
AdGroupIds = adGroupIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupsByIdsAsync(r), request));
}
static GetAdGroupsByIdsResponse getAdGroupsByIds(
java.lang.Long campaignId,
ArrayOflong adGroupIds,
ArrayList<AdGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupsByIdsRequest request = new GetAdGroupsByIdsRequest();
request.setCampaignId(campaignId);
request.setAdGroupIds(adGroupIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupsByIds(request);
}
static function GetAdGroupsByIds(
$campaignId,
$adGroupIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupsByIdsRequest();
$request->CampaignId = $campaignId;
$request->AdGroupIds = $adGroupIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupsByIds($request);
}
response=campaignmanagement_service.GetAdGroupsByIds(
CampaignId=CampaignId,
AdGroupIds=AdGroupIds,
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/AdGroups/QueryByIds
Elementos Request
El objeto GetAdGroupsByIdsRequest 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 |
|---|---|---|
| AdGroupIds | Un máximo de 1000 identificadores de los grupos de anuncios que se van a obtener. | matriz larga |
| CampaignId | Identificador de la campaña que contiene los grupos de anuncios que se van a obtener. | largo |
| ReturnAdditionalFields | Lista de propiedades adicionales que quieres incluir en cada grupo de anuncios 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. |
AdGroupAdditionalField |
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 GetAdGroupsByIdsResponse 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 |
|---|---|---|
| AdGroups | Lista de grupos de anuncios que se corresponden directamente con los identificadores de grupo de anuncios especificados en la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó un grupo de anuncios, el elemento correspondiente será null. | Matriz de AdGroup |
| PartialErrors | Lista de errores por lotes que contienen detalles de los elementos de solicitud que no se han realizado correctamente. La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud. |
Matriz BatchError |
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.
{
"CampaignId": "LongValueHere",
"AdGroupIds": [
"LongValueHere"
],
"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 BiddingScheme es CommissionBiddingScheme, Setting is AppSetting, BatchError is EditorialError.
{
"AdGroups": [
{
"AdGroupType": "ValueHere",
"AdRotation": {
"EndDate": "ValueHere",
"StartDate": "ValueHere",
"Type": "ValueHere"
},
"AdScheduleUseSearcherTimeZone": "ValueHere",
"AudienceAdsBidAdjustment": IntValueHere,
"BiddingScheme": {
"Type": "CommissionBiddingScheme",
"CommissionRate": DoubleValueHere
},
"CommissionRate": {
"RateAmount": {
"Amount": DoubleValueHere
}
},
"CpcBid": {
"Amount": DoubleValueHere
},
"CpmBid": {
"Amount": DoubleValueHere
},
"CpvBid": {
"Amount": DoubleValueHere
},
"EndDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"FinalUrlSuffix": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"FrequencyCapSettings": [
{
"CapValue": IntValueHere,
"TimeGranularity": "ValueHere"
}
],
"Id": "LongValueHere",
"Language": "ValueHere",
"McpaBid": {
"Amount": DoubleValueHere
},
"MultimediaAdsBidAdjustment": IntValueHere,
"Name": "ValueHere",
"Network": "ValueHere",
"PercentCpcBid": {
"RateAmount": {
"Amount": DoubleValueHere
}
},
"PrivacyStatus": "ValueHere",
"Settings": [
{
"Type": "AppSetting",
"AppId": "ValueHere",
"AppStore": "ValueHere"
}
],
"StartDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"Status": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "ValueHere"
}
]
},
"UseOptimizedTargeting": "ValueHere",
"UsePredictiveTargeting": "ValueHere"
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
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<GetAdGroupsByIdsResponse> GetAdGroupsByIdsAsync(
long campaignId,
IList<long> adGroupIds,
AdGroupAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupsByIdsRequest
{
CampaignId = campaignId,
AdGroupIds = adGroupIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupsByIdsAsync(r), request));
}
static GetAdGroupsByIdsResponse getAdGroupsByIds(
java.lang.Long campaignId,
ArrayOflong adGroupIds,
ArrayList<AdGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupsByIdsRequest request = new GetAdGroupsByIdsRequest();
request.setCampaignId(campaignId);
request.setAdGroupIds(adGroupIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupsByIds(request);
}
static function GetAdGroupsByIds(
$campaignId,
$adGroupIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupsByIdsRequest();
$request->CampaignId = $campaignId;
$request->AdGroupIds = $adGroupIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupsByIds($request);
}
response=campaignmanagement_service.GetAdGroupsByIds(
CampaignId=CampaignId,
AdGroupIds=AdGroupIds,
ReturnAdditionalFields=ReturnAdditionalFields)