UrlGoal Data Object - Campaign Management

Defines a URL conversion goal. Use this type of goal to count every time someone visits a web page as a conversion. For example you can count a conversion if someone visits the purchase confirmation page.

Tip

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

Important

Every time you add or update a new DurationGoal, EventGoal, OfflineConversionGoal, PagesViewedPerVisitGoal or UrlGoal via either the Microsoft Advertising web application or Campaign Management API, the MSCLKIDAutoTaggingEnabled value of the corresponding AccountProperty is set to True automatically. If the Scope of the goal is set to Customer level, then the AccountProperty for all accounts under the Customer will be set.

Syntax

<xs:complexType name="UrlGoal" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ConversionGoal">
      <xs:sequence>
        <xs:element minOccurs="0" name="UrlExpression" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlOperator" nillable="true" type="tns:ExpressionOperator" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element Description Data Type
UrlExpression The expression used to determine the page or pages the user has to visit in order to count as a conversion.

Add: Required
Update: Optional
string
UrlOperator The operator that can be applied to the value of the Url element.

Add: Optional; If not specified, the default operator is Equals.
Update: Optional; If not specified during update, the previous setting is retained.
ExpressionOperator

The UrlGoal object has Inherited Elements.

Inherited Elements

Inherited Elements from ConversionGoal

The UrlGoal object derives from the ConversionGoal object, and inherits the following elements. The descriptions below are specific to UrlGoal, and might not apply to other objects that inherit the same elements from the ConversionGoal object.

Element Description Data Type
ConversionWindowInMinutes The conversion window is the length of time in minutes after a click that you want to track conversions. If you set this value to 43200 minutes (30 days), then conversions that happen within 30 days after a click are tracked. Past conversions aren't affected. The minimum value supported is 1 minute, although keep in mind that a shorter conversion window will reduce the number of conversions your account records. The maximum value supported is 129600 minutes (90 days).

Add: Optional
Update: Optional
int
CountType This determines how your conversions are recorded within your chosen conversion window.

There are two choices, and if you do not set a value the default is All:

- All: All conversions that happen after an ad click will be counted. This is a common choice for sales.

- Unique: Only one conversion that happens after an ad click will be counted. This is a common choice for leads.

For example: You track two conversions: leads and sales. You pick Unique for leads and All for sales. When one ad click turns into two leads and two sales, it's counted as three conversions: one for the unique lead, and two for all the sales.

Add: Optional
Update: Optional
ConversionGoalCountType
Id The unique Microsoft Advertising identifier for the conversion goal.

Add: Read-only
Update: Required and Read-Only
long
Name The conversion goal name.

The maximum length of the name is 100, and the name must be unique among all conversion goals belonging to the same customer.
string
Revenue Determines how much each conversion is worth to your business.

When adding a conversion goal if you do not specify any revenue tracking preferences, then each ConversionGoalRevenue will be set to their respective default values.

When updating a conversion goal, if the Revenue element is nil or empty then none of the nested properties will be updated. However, if this element is not nil or empty then you are effectively replacing any existing revenue properties.

Add: Optional
Update: Optional
ConversionGoalRevenue
Scope Determines if the goal applies to all accounts or only the account specified in the required CustomerAccountId header element. If you have multiple Microsoft Advertising accounts, you can track conversions across all of those accounts. If you associate a goal with one account, conversions will be tracked for that account only.

Possible values are Account and Customer. If not specified, the scope will be set to Customer by default.

Once you set scope, you can't change it. If you want to change the scope, you need to create a new conversion goal and pause the old one.

Add: Optional
Update: Optional
EntityScope
Status Defines the possible user-determined status values of a conversion goal. These are the status values that a user can decide to set, for example a goal can be set to Paused if you no longer wish to track conversions for that goal.

For status values that can be set by the system, for example whether or not the UET tag is verified, see the TrackingStatus element.

Add: Optional
Update: Optional
ConversionGoalStatus
TagId The unique Microsoft Advertising identifier of the UET tag that you added to your website to allow Microsoft Advertising to collect actions people take on your website.

Add: Required
Update: Optional
long
TrackingStatus Defines the possible system-determined status values of a conversion goal. These are the status values that can be set by the system, for example the system sets the status to TagUnverified if the UET tag has not yet been verified.

For status values that a user can decide to set, for example setting the status to Paused if you no longer wish to track conversions for that goal, see the Status element.

Add: Read-only
Update: Read-only
ConversionGoalTrackingStatus
Type The type of the conversion goal. This value is Url when you retrieve a Url goal. For more information about conversion goal types, see the ConversionGoal Data Object Remarks.

Add: Read-only
Update: Read-only
ConversionGoalType

Requirements

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