Compartir a través de

Operación del servicio SetLabelAssociations: administración de campañas

  • Artículo

Establece las asociaciones de etiquetas.

Elementos Request

El objeto SetLabelAssociationsRequest 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
EntityType Indica el tipo de entidad asociado a la etiqueta.

Los valores de tipo de entidad admitidos son Campaign, AdGroup, Ad y Keyword.		 EntityType
EtiquetaSociaciones Lista de asociaciones de etiquetas que se van a establecer.

Cada asociación de etiquetas incluye identificadores de etiqueta y entidad.

El tamaño máximo de la lista es de 100 elementos por solicitud de servicio.

Cada entidad se puede asociar con un máximo de 50 etiquetas. Por ejemplo , la campaña A se puede asociar con hasta 50 etiquetas.		 Matriz LabelAssociation

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 SetLabelAssociationsResponse 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
PartialErrors Matriz de objetos BatchError que contienen detalles de las asociaciones que no se recuperaron correctamente.

La lista de errores corresponde directamente a la lista de asociaciones de la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que se recuperó correctamente una asociación, el elemento de error correspondiente será null. Idealmente, todas las asociaciones se recuperan correctamente y todos los elementos de esta lista son null.		 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">SetLabelAssociations</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>
    <SetLabelAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityType>ValueHere</EntityType>
      <LabelAssociations i:nil="false">
        <LabelAssociation>
          <EntityId>ValueHere</EntityId>
          <LabelId>ValueHere</LabelId>
        </LabelAssociation>
      </LabelAssociations>
    </SetLabelAssociationsRequest>
  </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>
    <SetLabelAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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:e371="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e371:KeyValuePairOfstringstring>
              <e371:key d4p1:nil="false">ValueHere</e371:key>
              <e371:value d4p1:nil="false">ValueHere</e371:value>
            </e371: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>
    </SetLabelAssociationsResponse>
  </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<SetLabelAssociationsResponse> SetLabelAssociationsAsync(
	EntityType entityType,
	IList<LabelAssociation> labelAssociations)
{
	var request = new SetLabelAssociationsRequest
	{
		EntityType = entityType,
		LabelAssociations = labelAssociations
	};

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

static SetLabelAssociationsResponse setLabelAssociations(
	EntityType entityType,
	ArrayOfLabelAssociation labelAssociations) throws RemoteException, Exception
{
	SetLabelAssociationsRequest request = new SetLabelAssociationsRequest();

	request.setEntityType(entityType);
	request.setLabelAssociations(labelAssociations);

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

static function SetLabelAssociations(
	$entityType,
	$labelAssociations)
{

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

	$request = new SetLabelAssociationsRequest();

	$request->EntityType = $entityType;
	$request->LabelAssociations = $labelAssociations;

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

response=campaignmanagement_service.SetLabelAssociations(
	EntityType=EntityType,
	LabelAssociations=LabelAssociations)

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/LabelAssociations/Set

Elementos Request

El objeto SetLabelAssociationsRequest 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
EntityType Indica el tipo de entidad asociado a la etiqueta.

Los valores de tipo de entidad admitidos son Campaign, AdGroup, Ad y Keyword.		 EntityType
EtiquetaSociaciones Lista de asociaciones de etiquetas que se van a establecer.

Cada asociación de etiquetas incluye identificadores de etiqueta y entidad.

El tamaño máximo de la lista es de 100 elementos por solicitud de servicio.

Cada entidad se puede asociar con un máximo de 50 etiquetas. Por ejemplo , la campaña A se puede asociar con hasta 50 etiquetas.		 Matriz LabelAssociation

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 SetLabelAssociationsResponse 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
PartialErrors Matriz de objetos BatchError que contienen detalles de las asociaciones que no se recuperaron correctamente.

La lista de errores corresponde directamente a la lista de asociaciones de la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que se recuperó correctamente una asociación, el elemento de error correspondiente será null. Idealmente, todas las asociaciones se recuperan correctamente y todos los elementos de esta lista son null.		 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.

{
  "EntityType": "ValueHere",
  "LabelAssociations": [
    {
      "EntityId": "LongValueHere",
      "LabelId": "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.

{
  "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<SetLabelAssociationsResponse> SetLabelAssociationsAsync(
	EntityType entityType,
	IList<LabelAssociation> labelAssociations)
{
	var request = new SetLabelAssociationsRequest
	{
		EntityType = entityType,
		LabelAssociations = labelAssociations
	};

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

static SetLabelAssociationsResponse setLabelAssociations(
	EntityType entityType,
	ArrayOfLabelAssociation labelAssociations) throws RemoteException, Exception
{
	SetLabelAssociationsRequest request = new SetLabelAssociationsRequest();

	request.setEntityType(entityType);
	request.setLabelAssociations(labelAssociations);

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

static function SetLabelAssociations(
	$entityType,
	$labelAssociations)
{

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

	$request = new SetLabelAssociationsRequest();

	$request->EntityType = $entityType;
	$request->LabelAssociations = $labelAssociations;

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

response=campaignmanagement_service.SetLabelAssociations(
	EntityType=EntityType,
	LabelAssociations=LabelAssociations)