Edit

UetTag Data Object - Campaign Management

  • Article

Defines a Universal Event Tracking (UET) tag 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 (e.g. via AddUetTags), 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 audiences. 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.

Syntax

<xs:complexType name="UetTag" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="CustomerShare" nillable="true" type="tns:CustomerShare" />
    <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TrackingNoScript" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TrackingScript" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TrackingStatus" nillable="true" type="tns:UetTagTrackingStatus" />
  </xs:sequence>
</xs:complexType>

Elements

The UetTag object has the following elements: CustomerShare, Description, Id, Name, TrackingNoScript, TrackingScript, TrackingStatus.

Element Description Data Type
CustomerShare Determines the list of customers that share the UET tag. Details include UET tag to audience association counts.

Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed. Set this element to null or empty to retain any existing customer account shares. To remove all customer account shares, set the CustomerAccountShares element of the CustomerShare object to null or empty. To remove a subset of customer account shares, specify the customer account shares that you want to keep in the CustomerAccountShares element of the CustomerShare object.		 CustomerShare
Description Text to help you identify the UET tag. We recommend that you set this to the related website page name or URL.

Add: Optional
Update: Optional		 string
Id The unique Microsoft Advertising identifier of the UET tag.

Add: Read-only
Update: Required and Read-only		 long
Name The UET tag name.

The maximum length of the name is 100, and the name must be unique among all UET tags belonging to the same customer.

Add: Required
Update: Optional		 string
TrackingNoScript If your website doesn't support JavaScript, you can use this Non-JavaScript representation of the UET tag. If you use Non-JavaScript, you can't track custom events or variable revenue.

Add: Read-only
Update: Read-only		 string
TrackingScript The tracking script that you can add to your website to allow Microsoft Advertising to collect actions people take on your website.

Add: Read-only
Update: Read-only		 string
TrackingStatus The system-determined status values of a UET tag, for example the system sets the status to Unverified if the UET tag has not yet been verified.

Add: Read-only
Update: Read-only		 UetTagTrackingStatus

Requirements

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

Used By

AddUetTags
GetUetTagsByIds
UpdateUetTags