AddUetTags Service Operation - Campaign Management

Article
03/20/2023

Adds new Universal Event Tracking (UET) tags that you can add to your website to allow Microsoft Advertising to collect actions people take on your website.

After you create a UET tag, the next step is to add the UET tag tracking code to your website. We recommend that you, or your website administrator, add it to your entire website in either the head or body sections. If your website has a site-wide layout page, then that is the best place to add it because you add it once and it is included on all pages. For more information, see How do I add the UET tag to my website?.

You can use one UET tag with all of your conversion goals and remarketing lists. Before you create multiple UET tags, see Reasons for creating more than one UET tag.

Tip

For an implementation overview, see the Universal Event Tracking technical guide.

Request Elements

The AddUetTagsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
UetTags	An array of UetTag objects to add to the customer's shared UET tag library. The customer is determined by the required CustomerId header element. You can add a maximum of 100 UET tags in a single call, although please note that you can use one UET tag with all of your conversion goals and remarketing lists. Before you create multiple UET tags, see Reasons for creating more than one UET tag. If the call is successful, the tracking script that you should add to your website is included in a corresponding UetTag within the response message.	UetTag array

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The AddUetTagsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.	BatchError array
UetTags	An array of UetTag objects to add to the customer's shared UET tag library. The customer is determined by the required CustomerId header element. You can add a maximum of 100 UET tags in a single call, although please note that you can use one UET tag with all of your conversion goals and remarketing lists. Before you create multiple UET tags, see Reasons for creating more than one UET tag. If the call is successful, the tracking script that you should add to your website is included in a corresponding UetTag within the response message.	UetTag array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13