Compartir a través de

Operación de servicio ApplyAssetGroupListingGroupActions: Administración de campañas

  • Artículo

Aplica una acción a un grupo de listas de grupos de recursos.

Tenga en cuenta las siguientes reglas de validación:

  • Como mínimo, debe especificar al menos el nodo raíz para la estructura de árbol de grupo de lista. El AssetGroupListingGroup raíz del grupo de listado debe tener su operando de condición establecido en "All" y Attribute en null. Si va a publicar anuncios para todos los productos del catálogo, establezca PartitionType en "Unit". Si va a publicar anuncios en condiciones de producto más específicas, establezca YPartitionTypeY en "Subdivision", ParentCriterionId en nully id en un valor negativo. Usará el valor negativo como ParentCriterionId para los nodos secundarios.

  • El nodo raíz se considera nivel 0 y un árbol puede tener ramas de hasta 7 niveles de profundidad.

  • Puede especificar hasta 5000 objetos AssetGroupListingGroupAction por llamada. Todo el árbol creado a través de varias llamadas puede tener hasta 20 000 nodos.

  • Cada uno de los objetos AssetGroupListingGroup debe tener el mismo AssetGroupId; de lo contrario, se producirá un error en la llamada.

  • Para actualizar las propiedades Condition o Attribute , debe eliminar el nodo de árbol de partición de producto existente y agregar un nuevo nodo de árbol de partición de producto que obtendrá un nuevo identificador. Para actualizar desde un elemento no excluido a un AssetGroupListingGroup excluido o al revés, debe eliminar el nodo de árbol de particiones de producto existente y agregar un nuevo nodo de árbol de particiones de producto que obtendrá un nuevo identificador.

  • Si se produce un error en alguna acción, también se producirá un error en todas las acciones restantes que podrían haberse realizado correctamente.

  • Todas las acciones de una llamada deben dar lugar a una estructura de árbol completa. Si necesita aplicar más de 5000 acciones por grupo de recursos, debe realizar varias llamadas. Obtenga los identificadores del grupo de recursos primarios de la primera llamada y agregue más elementos secundarios según sea necesario en las llamadas posteriores.

  • Cada ruta de acceso desde el nodo raíz hasta el final de una rama debe terminar con un nodo hoja (ProductPartitionType=Unit).

  • Cada subdivisión debe tener al menos un nodo hoja para el resto de las condiciones de la subdivisión. Por ejemplo, use el mismo operando que sus unidades del mismo nivel y establezca su atributo en null.

  • Solo puede especificar un nodo secundario después de su elemento primario.

  • Si va a agregar particiones con varios niveles en los que aún no existe ninguno de los elementos primarios o secundarios, use un valor int negativo como referencia para identificar al elemento primario. Por ejemplo, establezca el id. del elemento primario y el elemento ParentListingGroupId del elemento secundario en el mismo valor negativo. Los identificadores negativos solo son válidos durante la llamada. En el mensaje de respuesta se devuelven identificadores de sistema únicos para cada grupo de lista de grupos de recursos agregado correctamente.

  • Para pausar cualquier partición de producto, debe pausar todo el grupo de recursos llamando a UpdateAssetGroups. Puede llamar a UpdateCampaigns para pausar toda la campaña.

  • En el caso de una acción Eliminar , solo es necesario especificar el Id . y AssetGroupId en AssetGroupListingGroup.

  • Si elimina una partición de producto primaria, también se eliminarán todos sus elementos secundarios y descendientes.

  • No puede especificar condiciones de producto duplicadas en una rama.

Elementos Request

El objeto ApplyAssetGroupListingGroupActionsRequest 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
ListingGroupActions Lista de objetos AssetGroupListingGroupAction que contienen un elemento Action y un elemento ListingGroup . Todas las acciones del grupo de listas de grupos de recursos deben ser para el mismo grupo de recursos.

Puede pasar 5000 AssetGroupListingGroupAction por llamada y aplicar un máximo de 20 000 grupos de listados a cada grupo de recursos.		 Matriz AssetGroupListingGroupAction

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 ApplyAssetGroupListingGroupActionsResponse 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
AssetGroupListingGroupIds Una lista de identificadores que para los grupos de enumeración que tenían aplicada la acción. La lista de identificadores corresponde directamente a la lista de grupos de listados de la solicitud.

Si se produce un error en alguna acción de grupo de lista, se producirá un error en todas las acciones restantes del grupo de listados y todos los elementos de esta lista serán null.		 matriz larga
PartialErrors Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente. 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">ApplyAssetGroupListingGroupActions</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>
    <ApplyAssetGroupListingGroupActionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListingGroupActions i:nil="false">
        <AssetGroupListingGroupAction>
          <Action>ValueHere</Action>
          <ListingGroup i:nil="false">
            <AssetGroupId>ValueHere</AssetGroupId>
            <AssetGroupListingType>ValueHere</AssetGroupListingType>
            <Dimension i:nil="false">
              <Attribute i:nil="false">ValueHere</Attribute>
              <Operand i:nil="false">ValueHere</Operand>
              <Operator i:nil="false">ValueHere</Operator>
            </Dimension>
            <Id i:nil="false">ValueHere</Id>
            <IsExcluded>ValueHere</IsExcluded>
            <ParentListingGroupId i:nil="false">ValueHere</ParentListingGroupId>
          </ListingGroup>
        </AssetGroupListingGroupAction>
      </ListingGroupActions>
    </ApplyAssetGroupListingGroupActionsRequest>
  </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>
    <ApplyAssetGroupListingGroupActionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AssetGroupListingGroupIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </AssetGroupListingGroupIds>
      <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:e131="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e131:KeyValuePairOfstringstring>
              <e131:key d4p1:nil="false">ValueHere</e131:key>
              <e131:value d4p1:nil="false">ValueHere</e131:value>
            </e131: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>
    </ApplyAssetGroupListingGroupActionsResponse>
  </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<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)

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/AssetGroupListingGroupActions/Apply

Elementos Request

El objeto ApplyAssetGroupListingGroupActionsRequest 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
ListingGroupActions Lista de objetos AssetGroupListingGroupAction que contienen un elemento Action y un elemento ListingGroup . Todas las acciones del grupo de listas de grupos de recursos deben ser para el mismo grupo de recursos.

Puede pasar 5000 AssetGroupListingGroupAction por llamada y aplicar un máximo de 20 000 grupos de listados a cada grupo de recursos.		 Matriz AssetGroupListingGroupAction

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 ApplyAssetGroupListingGroupActionsResponse 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
AssetGroupListingGroupIds Una lista de identificadores que para los grupos de enumeración que tenían aplicada la acción. La lista de identificadores corresponde directamente a la lista de grupos de listados de la solicitud.

Si se produce un error en alguna acción de grupo de lista, se producirá un error en todas las acciones restantes del grupo de listados y todos los elementos de esta lista serán null.		 matriz larga
PartialErrors Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente. 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.

{
  "ListingGroupActions": [
    {
      "Action": "ValueHere",
      "ListingGroup": {
        "AssetGroupId": "LongValueHere",
        "AssetGroupListingType": "ValueHere",
        "Dimension": {
          "Attribute": "ValueHere",
          "Operand": "ValueHere",
          "Operator": "ValueHere"
        },
        "Id": "LongValueHere",
        "IsExcluded": "ValueHere",
        "ParentListingGroupId": "LongValueHere"
      }
    }
  ]
}

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.

{
  "AssetGroupListingGroupIds": [
    "LongValueHere"
  ],
  "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<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)