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

Artículo
12/21/2023

Agrega nuevas etiquetas de Seguimiento universal de eventos (UET) que puede agregar a su sitio web para permitir que Microsoft Advertising recopile acciones que los usuarios realizan en su sitio web.

Después de crear una etiqueta de UET, el siguiente paso es agregar el código de seguimiento de etiquetas de UET al sitio web. Se recomienda que usted o el administrador del sitio web lo agreguen a todo el sitio web en las secciones principal o cuerpo. Si el sitio web tiene una página de diseño de todo el sitio, ese es el mejor lugar para agregarlo porque lo agrega una vez y se incluye en todas las páginas. Para obtener más información, consulte Cómo add the UET tag to my website?.

Puede usar una etiqueta UET con todos sus objetivos de conversión y listas de remarketing. Antes de crear varias etiquetas de UET, consulte Motivos para crear más de una etiqueta de UET.

Sugerencia

Para obtener información general sobre la implementación, consulte la guía técnica de Seguimiento universal de eventos .

Elementos Request

El objeto AddUetTagsRequest 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
UetTags	Matriz de objetos UetTag que se van a agregar a la biblioteca de etiquetas de UET compartida del cliente. El cliente viene determinado por el elemento de encabezado CustomerId necesario. Puede agregar un máximo de 100 etiquetas UET en una sola llamada, aunque tenga en cuenta que puede usar una etiqueta UET con todos sus objetivos de conversión y listas de remarketing. Antes de crear varias etiquetas de UET, consulte Motivos para crear más de una etiqueta de UET. Si la llamada se realiza correctamente, el script de seguimiento que debe agregar a su sitio web se incluye en un UetTag correspondiente dentro del mensaje de respuesta.	Matriz uetTag

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 AddUetTagsResponse 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 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
UetTags	Matriz de objetos UetTag que se van a agregar a la biblioteca de etiquetas de UET compartida del cliente. El cliente viene determinado por el elemento de encabezado CustomerId necesario. Puede agregar un máximo de 100 etiquetas UET en una sola llamada, aunque tenga en cuenta que puede usar una etiqueta UET con todos sus objetivos de conversión y listas de remarketing. Antes de crear varias etiquetas de UET, consulte Motivos para crear más de una etiqueta de UET. Si la llamada se realiza correctamente, el script de seguimiento que debe agregar a su sitio web se incluye en un UetTag correspondiente dentro del mensaje de respuesta.	Matriz uetTag

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">AddUetTags</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>
    <AddUetTagsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <UetTags i:nil="false">
        <UetTag>
          <CustomerShare i:nil="false">
            <CustomerAccountShares i:nil="false">
              <CustomerAccountShare>
                <AccountId i:nil="false">ValueHere</AccountId>
                <Associations i:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount i:nil="false">ValueHere</AssociationCount>
                    <UsageType i:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId i:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId i:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description i:nil="false">ValueHere</Description>
          <Id i:nil="false">ValueHere</Id>
          <Name i:nil="false">ValueHere</Name>
          <TrackingNoScript i:nil="false">ValueHere</TrackingNoScript>
          <TrackingScript i:nil="false">ValueHere</TrackingScript>
          <TrackingStatus i:nil="false">ValueHere</TrackingStatus>
        </UetTag>
      </UetTags>
    </AddUetTagsRequest>
  </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>
    <AddUetTagsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <UetTags d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <UetTag>
          <CustomerShare d4p1:nil="false">
            <CustomerAccountShares d4p1:nil="false">
              <CustomerAccountShare>
                <AccountId d4p1:nil="false">ValueHere</AccountId>
                <Associations d4p1:nil="false">
                  <CustomerAccountShareAssociation>
                    <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
                    <UsageType d4p1:nil="false">ValueHere</UsageType>
                  </CustomerAccountShareAssociation>
                </Associations>
                <CustomerId d4p1:nil="false">ValueHere</CustomerId>
              </CustomerAccountShare>
            </CustomerAccountShares>
            <OwnerCustomerId d4p1:nil="false">ValueHere</OwnerCustomerId>
          </CustomerShare>
          <Description d4p1:nil="false">ValueHere</Description>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
          <TrackingNoScript d4p1:nil="false">ValueHere</TrackingNoScript>
          <TrackingScript d4p1:nil="false">ValueHere</TrackingScript>
          <TrackingStatus d4p1:nil="false">ValueHere</TrackingStatus>
        </UetTag>
      </UetTags>
      <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:e60="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e60:KeyValuePairOfstringstring>
              <e60:key d4p1:nil="false">ValueHere</e60:key>
              <e60:value d4p1:nil="false">ValueHere</e60:value>
            </e60: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>
    </AddUetTagsResponse>
  </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<AddUetTagsResponse> AddUetTagsAsync(
	IList<UetTag> uetTags)
{
	var request = new AddUetTagsRequest
	{
		UetTags = uetTags
	};

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

static AddUetTagsResponse addUetTags(
	ArrayOfUetTag uetTags) throws RemoteException, Exception
{
	AddUetTagsRequest request = new AddUetTagsRequest();

	request.setUetTags(uetTags);

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

static function AddUetTags(
	$uetTags)
{

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

	$request = new AddUetTagsRequest();

	$request->UetTags = $uetTags;

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

response=campaignmanagement_service.AddUetTags(
	UetTags=UetTags)

Requisitos

Servicio: CampaignManagementService.svc v13
Nombres: https://bingads.microsoft.com/CampaignManagement/v13

Compartir a través de