Export (0) Print
Expand All

Goal Data Object

Defines a Campaign Analytics goal and the steps that make up the goal.

<xs:complexType name="Goal">
  <xs:sequence>
    <xs:element minOccurs="0" name="CostModel" nillable="true" type="tns:CostModel" />
    <xs:element minOccurs="0" name="DaysApplicableForConversion" nillable="true" type="tns:DaysApplicableForConversion" />
    <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="RevenueModel" nillable="true" type="tns:RevenueModel" />
    <xs:element minOccurs="0" name="Steps" nillable="true" type="tns:ArrayOfStep" />
    <xs:element minOccurs="0" name="YEventId" nillable="true" type="xs:int" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

CostModel

The costs associated with the conversion. For example, you can include the sales tax and shipping fees with the conversion data. You can specify one or more costs to track.

For possible values, see CostModel. The default is None.

CostModel

Optional

Optional

DaysApplicableForConversion

The number of days in which an assist must occur in order for it to be considered an assist.

For possible values, see DaysApplicableForConversion.

DaysApplicableForConversion

Required

Optional

Id

The system-generated identifier of the goal.

long

Read-only

Required

Name

The name of the goal. The name must be unique among all goals specified for the account. The name must contain a minimum of one character and can contain a maximum of 1,200 characters.

string

Required

Optional

RevenueModel

Determines whether the conversion is revenue related, and if so, whether the revenue is a fixed or variable value. If the revenue is fixed, the object contains the fixed revenue value.

For possible values, see RevenueModel. The default is None.

RevenueModel

Optional

Optional

Steps

The list of steps that make up the goal. A goal can contain a maximum of six steps. At a minimum, you must include a conversion step.

After adding the goal, you can add a step but you cannot delete a step.

Step[]

Required

Optional

YEventId

For internal use only.

int

Read-only

Read-only

Requirements

CampaignManagementService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

Show:
© 2014 Microsoft