EventGoal 数据对象 - 市场活动管理
定义自定义事件转换目标。
使用此类型的目标在每次有人完成特定操作(例如订阅新闻稿或下载文档作为转换)时进行计数。
默认情况下,UET 标记记录用户访问您的网站上允许Microsoft广告支持目标类型(如 UrlGoal、 DurationGoal 和 PagesViewedPerVisitGoal)的页面。 但是,你可能想要跟踪其他类型的事件,例如订阅新闻稿或下载文档。 Microsoft广告使用 EventGoal 启用此方案。 除了创建 EventGoal 之外,还必须自定义 UET 标记跟踪代码,以报告一个或多个自定义事件参数的值。 若要了解详细信息,请参阅 如何使用 UET 报告自定义事件。
提示
有关实现概述,请参阅 通用事件跟踪 技术指南。
重要
每次通过 Microsoft Advertising Web 应用程序或市场活动管理 API 添加或更新新的 DurationGoal、EventGoal、OfflineConversionGoal、PagesViewedPerVisitGoal 或 UrlGoal 时,相应 AccountProperty 的 MSCLKIDAutoTaggingEnabled 值会自动设置为 True。 如果目标的范围设置为 “客户 级别”,则将设置“客户”下所有帐户的 AccountProperty 。
语法
<xs:complexType name="EventGoal" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:ConversionGoal">
<xs:sequence>
<xs:element minOccurs="0" name="ActionExpression" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ActionOperator" nillable="true" type="tns:ExpressionOperator" />
<xs:element minOccurs="0" name="CategoryExpression" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CategoryOperator" nillable="true" type="tns:ExpressionOperator" />
<xs:element minOccurs="0" name="LabelExpression" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="LabelOperator" nillable="true" type="tns:ExpressionOperator" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:decimal" />
<xs:element minOccurs="0" name="ValueOperator" nillable="true" type="tns:ValueOperator" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
元素
EventGoal 对象具有以下元素:ActionExpression、ActionOperator、CategoryExpression、CategoryOperator、LabelExpression、LabelOperator、Value、ValueOperator。
元素 | 说明 | 数据类型 |
---|---|---|
ActionExpression | 要跟踪的用户交互的类型。例如“播放”或“暂停”。 如果在添加或更新操作期间指定了此元素,则还需要 ActionOperator 元素。 字符串的最大长度不能超过 100。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新期间不包括 ActionOperator 和 ActionExpression ,则将删除任何现有的 ActionOperator 和 ActionExpression 设置。 |
string |
ActionOperator | 可应用于 ActionExpression 元素值的运算符。 如果在添加或更新操作期间指定了此元素,则还需要 ActionExpression 元素。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新期间不包括 ActionOperator 和 ActionExpression ,则将删除任何现有的 ActionOperator 和 ActionExpression 设置。 |
ExpressionOperator |
CategoryExpression | 要跟踪的事件类别。例如,“video”。 如果在添加或更新操作期间指定了此元素,则 还需要 CategoryOperator 元素。 字符串的最大长度不能超过 100。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新期间未包括 CategoryOperator 和 CategoryExpression ,则将删除所有现有的 CategoryOperator 和 CategoryExpression 设置。 |
string |
CategoryOperator | 可应用于 CategoryExpression 元素的值的运算符。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新期间未包括 CategoryOperator 和 CategoryExpression ,则将删除所有现有的 CategoryOperator 和 CategoryExpression 设置。 |
ExpressionOperator |
LabelExpression | 导致操作的元素的名称。 例如“trailer”或“behindthescenes”。 如果在添加或更新操作期间指定了此元素,则还需要 LabelOperator 元素。 字符串的最大长度不能超过 100。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新过程中未包括 LabelOperator 和 LabelExpression ,则将删除所有现有的 LabelOperator 和 LabelExpression 设置。 |
string |
LabelOperator | 可应用于 LabelExpression 元素值的运算符。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新过程中未包括 LabelOperator 和 LabelExpression ,则将删除所有现有的 LabelOperator 和 LabelExpression 设置。 |
ExpressionOperator |
值 | 与该事件关联的数值。 例如,该值可以是视频播放的持续时间。 如果在添加或更新操作期间指定了此元素,则还需要 ValueOperator 元素。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新过程中不包括 ValueOperator 和 Value ,则将删除任何现有的 ValueOperator 和 Value 设置 |
十进制 |
ValueOperator | 可应用于 Value 元素的值的运算符。 加: 如果包含一个或多个其他事件,则为可选;必须包含以下一个或多个事件运算符对: (ActionOperator 和 ActionExpression) 、 (CategoryOperator 和 CategoryExpression) 、 (LabelOperator 和 LabelExpression) 、 (ValueOperator 和 Value) 。 更新: 如果包含一个或多个其他事件,则为可选;如果在更新过程中不包括 ValueOperator 和 Value ,则将删除任何现有的 ValueOperator 和 Value 设置。 |
ValueOperator |
EventGoal 对象具有 Inherited Elements。
继承的元素
从 ConversionGoal 继承的元素
EventGoal 对象派生自 ConversionGoal 对象,并继承以下元素:AttributionModelType、ConversionWindowInMinutes、CountType、ExcludeFromBidding、GoalCategory、Id、IsEnhancedConversionsEnabled、Name、Revenue、Scope、Status、TagId、TrackingStatus、Type、 ViewThroughConversionWindowInMinutes。 下面的说明特定于 EventGoal,可能不适用于从 ConversionGoal 对象继承相同元素的其他对象。
元素 | 说明 | 数据类型 |
---|---|---|
AttributionModelType | 确定将哪个归因模型 LastTouch 或 LastClick 用于转换目标。 | AttributionModelType |
ConversionWindowInMinutes | 转换窗口是单击后要跟踪转换的时间长度(以分钟为单位)。 如果将此值设置为 43200 分钟 (30 天) ,则跟踪单击后 30 天内发生的转换。 过去的转换不受影响。 支持的最小值为 1 分钟,但请记住,较短的转换窗口将减少帐户记录的转换次数。 支持的最大值为 129600 分钟 (90 天) 。 加: 自选 更新: 自选 |
int |
CountType | 这决定了如何在所选转换窗口中记录转换。 有两个选项,如果未设置值,则默认值为 “全部”: - 全部:将统计广告点击后发生的所有转换。 这是销售的常见选择。 - 唯一:仅对广告点击后发生的一次转换进行计数。 这是潜在顾客的常见选择。 例如:跟踪两个转换:潜在顾客和销售额。 对于潜在顾客,选择 “唯一 ”,选择 “全部 ”用于销售。 当一个广告点击变成两个潜在顾客和两个销售时,将计为三个转换:一个用于唯一的潜在顾客,两个用于所有销售。 加: 自选 更新: 自选 |
ConversionGoalCountType |
ExcludeFromBidding | 确定是否从性能报告列的子集中排除与此转换目标相关的数据。 此元素仅适用于启用了“转换中包括”功能的客户, (GetCustomerPilotFeatures 返回 574) 。 如果此元素设置为 true,则从 、、、 ConversionRate ReturnOnAdSpend CostPerConversion 、 RevenuePerConversion 和 Revenue 报表列中排除Conversions 与此转换目标相关的其他数据。 此外,如果使用自动出价出价策略,将此属性设置为 true 将导致目标转换不再考虑自动出价计算。 将此属性设置为“true”实际上与取消选中Microsoft广告 Web 应用程序中的“包含在转换中”相同。无论此元素值如何, AllConversions 、AllConversionRate 、、AllCostPerConversion AllReturnOnAdSpend 、 AllRevenuePerConversion 和 AllRevenue 报表列都将包括所有转换目标的数据。 默认情况下,此元素为 false,并且与此转换目标相关的数据包含在所有报表列中。有关详细信息,请参阅报表属性和性能统计信息和帮助文章转换目标:“转换”与“所有转换”。 加: 自选 更新: 自选 |
boolean |
GoalCategory | 用于对转换目标进行分段的类别。 但是,对转换目标进行分类对业务有意义。 目标类别不会影响性能 - 它们可帮助你对目标及其性能指标进行细分。 支持的类别值因转换目标类型而异。 事件目标支持 AddToCart、 BeginCheckout、 BookAppointment、 Contact、 GetDirections、 Other、 OutboundClick、 PageView、 Purchase、 RequestQuote、 Signup、 SubmitLeadForm 和 Subscribe 类别。 加: 自 2021 年 6 月起是必需的。 以前,如果将此元素保留为 nil 或空,则默认类别设置为 None。 更新: 如果转换目标已设置了非 “无”类别,则为可选。 如果未为更新设置任何值,则不会更改此设置。 |
ConversionGoalCategory |
ID | 转换目标的唯一Microsoft广告标识符。 加: 只读 更新: 必需和 Read-Only |
long |
IsEnhancedConversionsEnabled | 确定是否为转换目标启用增强转换。 注意:若要创建增强的转换目标并设置 isEnhancedConversionsEnabled=true ,必须通过Microsoft广告 UI 为帐户创建转换目标,并且选中了增强转换设置并选中了关联的复选框。 |
boolean |
名称 | 转换目标名称。 名称的最大长度为 100,并且名称在属于同一客户的所有转换目标中必须是唯一的。 加: 必填 更新: 自选 |
string |
收入 | 确定每个转换对业务的价值。 添加转换目标时,如果未指定任何收入跟踪首选项,则每个 ConversionGoalRevenue 将设置为各自的默认值。 更新转换目标时,如果 Revenue 元素为零或为空,则不会更新任何嵌套属性。 但是,如果此元素不为零或为空,则实际上将替换任何现有的收入属性。 加: 自选 更新: 自选 |
ConversionGoalRevenue |
范围 | 确定目标是应用于所有帐户,还是仅适用于在所需的 CustomerAccountId 标头元素中指定的帐户。 如果你有多个Microsoft广告帐户,则可以跟踪所有这些帐户的转换。 如果将一个目标与一个帐户相关联,将仅跟踪该帐户的转换。 可能的值为 Account 和 Customer。 如果未指定,则默认情况下,范围将设置为 Customer 。 设置范围后,便无法更改范围。 如果要更改范围,需要创建新的转换目标并暂停旧目标。 加: 自选 更新: 自选 |
EntityScope |
状态 | 定义转换目标的可能由用户确定的状态值。 这些是用户可以决定设置的状态值,例如,如果不再希望跟踪该目标的转换,可以将目标设置为 Paused 。 有关可由系统设置的状态值(例如是否验证 UET 标记),请参阅 TrackingStatus 元素。 加: 自选 更新: 自选 |
ConversionGoalStatus |
TagId | 添加到网站的 UET 标记的唯一Microsoft广告标识符,允许Microsoft广告收集用户在你的网站上执行的操作。 在依赖标记 ID 之前,请注意,UET 标记可以与其他客户共享或从其他客户共享。 共享 UET 标记和访问群体仅适用于试点客户。 有关在客户层次结构中共享访问群体和 UET 标记的概述,请参阅 共享受众和 UET 标记 技术指南。 加: 必填 更新: 自选 |
long |
TrackingStatus | 定义转换目标的可能系统确定的状态值。 这些是系统可以设置的状态值,例如,如果 UET 标记尚未验证,系统会将状态设置为 TagUnverified 。 对于用户可以决定设置的状态值,例如,如果不想再跟踪该目标的转换,请将状态设置为 “已暂停 ”,请参阅 Status 元素。 加: 只读 更新: 只读 |
ConversionGoalTrackingStatus |
类型 | 转换目标的类型。 检索 事件 目标时,此值为 Event。 有关转换目标类型的详细信息,请参阅 ConversionGoal 数据对象备注。 加: 只读 更新: 只读 |
ConversionGoalType |
ViewThroughConversionWindowInMinutes | 查看转换窗口是单击后要跟踪浏览转换的时间长度(以分钟为单位)。 如果将此值设置为 43200 分钟 (30 天) ,则跟踪单击后 30 天内发生的查看转换。 过去的转换不受影响。 支持的最小值为 1 分钟,但请记住,较短的转换窗口将减少帐户记录的转换次数。 支持的最大值为 43200 分钟 (30 天) 。 还必须将 IncludeViewThroughConversions 帐户属性设置为 true 才能跟踪查看转换。 默认情况下不返回此元素。 若要获取此元素,请在调用 GetConversionGoalsByIds 和 GetConversionGoalsByTagIds 服务操作时,在 ReturnAdditionalFields 元素中包含 ViewThroughConversionWindowInMinutes 值。 加: 自选 更新: 自选 |
int |
要求
服务: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13