Compartir a través de

Operación del servicio UpdateAdGroups: Administración de campañas

  • Artículo

Novedades los grupos de anuncios especificados en una campaña.

Elementos Request

El objeto UpdateAdGroupsRequest 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
AdGroups Matriz que puede contener un máximo de 1000 objetos AdGroup para actualizar. Matriz de AdGroup
CampaignId Identificador de la campaña que posee los grupos de anuncios que se van a actualizar. largo
ReturnInheritedBidStrategyTypes Reservado para uso futuro. boolean
UpdateAudienceAdsBidAdjustment Determina si el servicio debe usar o no el elemento AudienceAdsBidAdjustment de cada AdGroup especificado durante la actualización. Si se establece en True, se usará AudienceAdsBidAdjustment y, de lo contrario, se omitirá y se conservará la configuración de ajuste de puja nativa existente durante la actualización.

El valor predeterminado es False si este elemento no está establecido.		 boolean

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 UpdateAdGroupsResponse 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
InheritedBidStrategyTypes Reservado para uso futuro. matriz de cadenas
PartialErrors Matriz de objetos BatchError 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">UpdateAdGroups</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>
    <UpdateAdGroupsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <CampaignId>ValueHere</CampaignId>
      <AdGroups i:nil="false">
        <AdGroup>
          <AdRotation i:nil="false">
            <EndDate i:nil="false">ValueHere</EndDate>
            <StartDate i:nil="false">ValueHere</StartDate>
            <Type i:nil="false">ValueHere</Type>
          </AdRotation>
          <AudienceAdsBidAdjustment i:nil="false">ValueHere</AudienceAdsBidAdjustment>
          <BiddingScheme i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
            <Type i:nil="false">ValueHere</Type>
            <!--This field is applicable if the derived type attribute is set to MaxClicksBiddingScheme-->
            <MaxCpc i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
            <MaxCpc i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa i:nil="false">ValueHere</TargetCpa>
            <!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
            <MaxCpc i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa i: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 i:nil="false">ValueHere</InheritedBidStrategyType>
            <!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
            <MaxCpc i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetRoas i:nil="false">ValueHere</TargetRoas>
            <!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
            <MaxCpc i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
            <TargetRoas i:nil="false">ValueHere</TargetRoas>
            <!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
            <MaxCpc i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetAdPosition i:nil="false">ValueHere</TargetAdPosition>
            <TargetImpressionShare i:nil="false">ValueHere</TargetImpressionShare>
            <!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
            <MaxPercentCpc i:nil="false">ValueHere</MaxPercentCpc>
            <!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
            <CommissionRate i:nil="false">ValueHere</CommissionRate>
            <!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
            <ManualCpi i:nil="false">ValueHere</ManualCpi>
            <!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
            <TargetCostPerSale i:nil="false">ValueHere</TargetCostPerSale>
          </BiddingScheme>
          <CommissionRate i:nil="false">
            <RateAmount i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </RateAmount>
          </CommissionRate>
          <CpcBid i:nil="false">
            <Amount i:nil="false">ValueHere</Amount>
          </CpcBid>
          <EndDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
          <ForwardCompatibilityMap xmlns:e389="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e389:KeyValuePairOfstringstring>
              <e389:key i:nil="false">ValueHere</e389:key>
              <e389:value i:nil="false">ValueHere</e389:value>
            </e389:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <FrequencyCapSettings i:nil="false">
            <FrequencyCapSettings>
              <CapValue>ValueHere</CapValue>
              <TimeGranularity>ValueHere</TimeGranularity>
            </FrequencyCapSettings>
          </FrequencyCapSettings>
          <Id i:nil="false">ValueHere</Id>
          <Language i:nil="false">ValueHere</Language>
          <MultimediaAdsBidAdjustment i:nil="false">ValueHere</MultimediaAdsBidAdjustment>
          <Name i:nil="false">ValueHere</Name>
          <Network i:nil="false">ValueHere</Network>
          <PercentCpcBid i:nil="false">
            <RateAmount i:nil="false">
              <Amount i:nil="false">ValueHere</Amount>
            </RateAmount>
          </PercentCpcBid>
          <PrivacyStatus i:nil="false">ValueHere</PrivacyStatus>
          <Settings i:nil="false">
            <Setting i:type="-- derived type specified here with the appropriate prefix --">
              <Type i:nil="false">ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to VerifiedTrackingSetting-->
              <Details xmlns:e390="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
                <e390:ArrayOfKeyValuePairOfstringstring>
                  <e390:KeyValuePairOfstringstring>
                    <e390:key i:nil="false">ValueHere</e390:key>
                    <e390:value i:nil="false">ValueHere</e390:value>
                  </e390:KeyValuePairOfstringstring>
                </e390:ArrayOfKeyValuePairOfstringstring>
              </Details>
              <!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
              <FeedLabel i:nil="false">ValueHere</FeedLabel>
              <LocalInventoryAdsEnabled i:nil="false">ValueHere</LocalInventoryAdsEnabled>
              <Priority i:nil="false">ValueHere</Priority>
              <SalesCountryCode i:nil="false">ValueHere</SalesCountryCode>
              <ShoppableAdsEnabled i:nil="false">ValueHere</ShoppableAdsEnabled>
              <StoreId i:nil="false">ValueHere</StoreId>
              <!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
              <FeedId i:nil="false">ValueHere</FeedId>
              <!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
              <DomainName i:nil="false">ValueHere</DomainName>
              <DynamicDescriptionEnabled i:nil="false">ValueHere</DynamicDescriptionEnabled>
              <Language i:nil="false">ValueHere</Language>
              <PageFeedIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:long>ValueHere</a1:long>
              </PageFeedIds>
              <Source i:nil="false">ValueHere</Source>
              <!--This field is applicable if the derived type attribute is set to TargetSetting-->
              <Details i: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 i:nil="false">ValueHere</BidBoostValue>
              <BidMaxValue i:nil="false">ValueHere</BidMaxValue>
              <BidOption i: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 i:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
              <!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
              <AutoGeneratedImageOptOut i:nil="false">ValueHere</AutoGeneratedImageOptOut>
              <AutoGeneratedTextOptOut i:nil="false">ValueHere</AutoGeneratedTextOptOut>
              <CostPerSaleOptOut i:nil="false">ValueHere</CostPerSaleOptOut>
              <FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
              <PageFeedIds i: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 i:nil="false">ValueHere</AutomatedCallToActionOptOut>
              <CallToActionOptOut i:nil="false">ValueHere</CallToActionOptOut>
              <!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
              <DisplayUrlMode i:nil="false">ValueHere</DisplayUrlMode>
              <WebsiteDescription i:nil="false">ValueHere</WebsiteDescription>
              <!--These fields are applicable if the derived type attribute is set to AppSetting-->
              <AppId i:nil="false">ValueHere</AppId>
              <AppStore>ValueHere</AppStore>
              <!--This field is applicable if the derived type attribute is set to ThirdPartyMeasurementSetting-->
              <Details xmlns:e391="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
                <e391:ArrayOfKeyValuePairOfstringstring>
                  <e391:KeyValuePairOfstringstring>
                    <e391:key i:nil="false">ValueHere</e391:key>
                    <e391:value i:nil="false">ValueHere</e391:value>
                  </e391:KeyValuePairOfstringstring>
                </e391:ArrayOfKeyValuePairOfstringstring>
              </Details>
            </Setting>
          </Settings>
          <StartDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <Status i:nil="false">ValueHere</Status>
          <TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
          <UrlCustomParameters i:nil="false">
            <Parameters i:nil="false">
              <CustomParameter>
                <Key i:nil="false">ValueHere</Key>
                <Value i:nil="false">ValueHere</Value>
              </CustomParameter>
            </Parameters>
          </UrlCustomParameters>
          <UseOptimizedTargeting i:nil="false">ValueHere</UseOptimizedTargeting>
          <UsePredictiveTargeting i:nil="false">ValueHere</UsePredictiveTargeting>
          <AdScheduleUseSearcherTimeZone i:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
          <AdGroupType i:nil="false">ValueHere</AdGroupType>
          <CpvBid i:nil="false">
            <Amount i:nil="false">ValueHere</Amount>
          </CpvBid>
          <CpmBid i:nil="false">
            <Amount i:nil="false">ValueHere</Amount>
          </CpmBid>
          <McpaBid i:nil="false">
            <Amount i:nil="false">ValueHere</Amount>
          </McpaBid>
        </AdGroup>
      </AdGroups>
      <UpdateAudienceAdsBidAdjustment>ValueHere</UpdateAudienceAdsBidAdjustment>
      <ReturnInheritedBidStrategyTypes i:nil="false">ValueHere</ReturnInheritedBidStrategyTypes>
    </UpdateAdGroupsRequest>
  </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>
    <UpdateAdGroupsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <InheritedBidStrategyTypes d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:string>ValueHere</a1:string>
      </InheritedBidStrategyTypes>
      <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:e392="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e392:KeyValuePairOfstringstring>
              <e392:key d4p1:nil="false">ValueHere</e392:key>
              <e392:value d4p1:nil="false">ValueHere</e392:value>
            </e392: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>
    </UpdateAdGroupsResponse>
  </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<UpdateAdGroupsResponse> UpdateAdGroupsAsync(
	long campaignId,
	IList<AdGroup> adGroups,
	bool updateAudienceAdsBidAdjustment,
	bool? returnInheritedBidStrategyTypes)
{
	var request = new UpdateAdGroupsRequest
	{
		CampaignId = campaignId,
		AdGroups = adGroups,
		UpdateAudienceAdsBidAdjustment = updateAudienceAdsBidAdjustment,
		ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.UpdateAdGroupsAsync(r), request));
}

static UpdateAdGroupsResponse updateAdGroups(
	java.lang.Long campaignId,
	ArrayOfAdGroup adGroups,
	boolean updateAudienceAdsBidAdjustment,
	boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
	UpdateAdGroupsRequest request = new UpdateAdGroupsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroups(adGroups);
	request.setUpdateAudienceAdsBidAdjustment(updateAudienceAdsBidAdjustment);
	request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);

	return CampaignManagementService.getService().updateAdGroups(request);
}

static function UpdateAdGroups(
	$campaignId,
	$adGroups,
	$updateAudienceAdsBidAdjustment,
	$returnInheritedBidStrategyTypes)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new UpdateAdGroupsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroups = $adGroups;
	$request->UpdateAudienceAdsBidAdjustment = $updateAudienceAdsBidAdjustment;
	$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;

	return $GLOBALS['CampaignManagementProxy']->GetService()->UpdateAdGroups($request);
}

response=campaignmanagement_service.UpdateAdGroups(
	CampaignId=CampaignId,
	AdGroups=AdGroups,
	UpdateAudienceAdsBidAdjustment=UpdateAudienceAdsBidAdjustment,
	ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)

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

Elementos Request

El objeto UpdateAdGroupsRequest 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
AdGroups Matriz que puede contener un máximo de 1000 objetos AdGroup para actualizar. Matriz de AdGroup
CampaignId Identificador de la campaña que posee los grupos de anuncios que se van a actualizar. largo
ReturnInheritedBidStrategyTypes Reservado para uso futuro. boolean
UpdateAudienceAdsBidAdjustment Determina si el servicio debe usar o no el elemento AudienceAdsBidAdjustment de cada AdGroup especificado durante la actualización. Si se establece en True, se usará AudienceAdsBidAdjustment y, de lo contrario, se omitirá y se conservará la configuración de ajuste de puja nativa existente durante la actualización.

El valor predeterminado es False si este elemento no está establecido.		 boolean

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 UpdateAdGroupsResponse 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
InheritedBidStrategyTypes Reservado para uso futuro. matriz de cadenas
PartialErrors Matriz de objetos BatchError 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.

A continuación se muestra un ejemplo que es aplicable si el tipo de BiddingScheme es CommissionBiddingScheme, Setting is AppSetting.

{
  "CampaignId": "LongValueHere",
  "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"
    }
  ],
  "UpdateAudienceAdsBidAdjustment": "ValueHere",
  "ReturnInheritedBidStrategyTypes": "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 BatchError es EditorialError.

{
  "InheritedBidStrategyTypes": [
    "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<UpdateAdGroupsResponse> UpdateAdGroupsAsync(
	long campaignId,
	IList<AdGroup> adGroups,
	bool updateAudienceAdsBidAdjustment,
	bool? returnInheritedBidStrategyTypes)
{
	var request = new UpdateAdGroupsRequest
	{
		CampaignId = campaignId,
		AdGroups = adGroups,
		UpdateAudienceAdsBidAdjustment = updateAudienceAdsBidAdjustment,
		ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.UpdateAdGroupsAsync(r), request));
}

static UpdateAdGroupsResponse updateAdGroups(
	java.lang.Long campaignId,
	ArrayOfAdGroup adGroups,
	boolean updateAudienceAdsBidAdjustment,
	boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
	UpdateAdGroupsRequest request = new UpdateAdGroupsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroups(adGroups);
	request.setUpdateAudienceAdsBidAdjustment(updateAudienceAdsBidAdjustment);
	request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);

	return CampaignManagementService.getService().updateAdGroups(request);
}

static function UpdateAdGroups(
	$campaignId,
	$adGroups,
	$updateAudienceAdsBidAdjustment,
	$returnInheritedBidStrategyTypes)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new UpdateAdGroupsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroups = $adGroups;
	$request->UpdateAudienceAdsBidAdjustment = $updateAudienceAdsBidAdjustment;
	$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;

	return $GLOBALS['CampaignManagementProxy']->GetService()->UpdateAdGroups($request);
}

response=campaignmanagement_service.UpdateAdGroups(
	CampaignId=CampaignId,
	AdGroups=AdGroups,
	UpdateAudienceAdsBidAdjustment=UpdateAudienceAdsBidAdjustment,
	ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)