PromotionAdExtension 数据对象 - 市场活动管理

促销扩展插件在文本广告中突出显示特殊销售和优惠。 通过突出产品/服务,潜在客户更有可能点击你的广告,从而帮助你创造更多的销售。

可以将促销广告扩展插件与帐户或帐户中的市场活动及广告组相关联。 (帐户、市场活动或广告组) 的每个实体最多可与 20 个促销广告扩展相关联。

注意

促销扩展适用于澳大利亚、CA、DE、FR、美国和英国的客户。

语法

<xs:complexType name="PromotionAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DiscountModifier" nillable="true" type="tns:PromotionDiscountModifier" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q57="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q57:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q58="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q58:ArrayOfstring" />
        <xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="MoneyAmountOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="OrdersOverAmount" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PercentOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PromotionCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionEndDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="PromotionItem" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionOccasion" nillable="true" type="tns:PromotionOccasion" />
        <xs:element minOccurs="0" name="PromotionStartDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

元素

PromotionAdExtension 对象具有以下元素:CurrencyCodeDiscountModifierFinalAppUrlsFinalMobileUrlsFinalUrlsFinalUrlSuffixLanguageMoneyAmountOffOrdersOverAmountPercentOffPromotionCodePromotionEndDatePromotionItemPromotionOccasionPromotionStartDateTrackingUrlTemplateUrlCustomParameters

元素 说明 数据类型
CurrencyCode 促销价格或折扣的货币代码。

仅当设置了 MoneyAmountOffOrdersOverAmount 时,此字段才适用。

支持的货币代码包括 ARS、AUD、DC、CAD、瑞士法郎、CLP、CNY、COP、0000 美元、EUR、GBP、HK、D0000、NZD、PEN、PHP、、2000000000000000000000000000000000 美元。。

加: 如果设置了 MoneyAmountOffOrdersOverAmount ,则是必需的。
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果设置 PercentOffPromotionCode,此设置不再适用,并且将被删除。
string
DiscountModifier 促销折扣修饰符。

例如,假设折扣修饰符设置为 UpTo。 然后,如果未修改的促销折扣为“20 美元脱鞋”,则修改后的促销为“最高 20 美元的脱鞋”。

加: 自选。 如果未指定此元素或将其留空,则将设置默认值 None
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
PromotionDiscountModifier
FinalAppUrls 供将来使用。 AppUrl 数组
FinalMobileUrls 移动设备的登陆页 URL。

以下验证规则适用于最终 URL 和最终移动 URL。
- URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 最多可为 FinalUrlsFinalMobileUrls 指定 10 个列表项;但是,每个列表中的第一项仅用于传递。 该服务最多允许 10 个列表项,以便实现潜在的向前兼容性。
- 仅允许使用“{”和“}”来描述标记,例如 {lpurl}
- 最终 URL 必须是格式正确的 URL,以 http:// 或 https:// 开头。
- 如果指定 FinalMobileUrls,还必须指定 FinalUrls

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为空列表,则会删除以前的设置。
字符串 数组
FinalUrls 登陆页 URL。

以下验证规则适用于最终 URL 和最终移动 URL。
- URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 最多可为 FinalUrlsFinalMobileUrls 指定 10 个列表项;但是,每个列表中的第一项仅用于传递。 该服务最多允许 10 个列表项,以便实现潜在的向前兼容性。
- 仅允许使用“{”和“}”来描述标记,例如 {lpurl}
- 最终 URL 必须是格式正确的 URL,以 http:// 或 https:// 开头。
- 如果指定 FinalMobileUrls,还必须指定 FinalUrls

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
字符串 数组
FinalUrlSuffix 最终 URL 后缀可以包括跟踪参数,这些参数将追加到登陆页 URL 的末尾。 建议将登陆页面所需的跟踪参数放在最终 URL 后缀中,以便始终将客户发送到登陆页面。 有关更多详细信息和验证规则,请参阅技术指南中的 最终 URL 后缀

此功能仅适用于最终 URL 后缀阶段 3 试点 (GetCustomerPilotFeatures 返回 636) 的客户。 如果你不在试点中,则将忽略此属性,并且不会返回任何错误。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为空字符串 ( ”) ,则会删除以前的设置。
string
语言 广告扩展将使用的语言。

无论市场活动或广告组的语言设置如何,扩展都将始终以此语言提供。

支持的语言字符串为:丹麦语、荷兰语、英语、芬兰语、法语、德语、意大利语、挪威语、葡萄牙语、西班牙语、瑞典语和繁体中文。

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
string
MoneyAmountOff 促销价值。

例如,若要提升“20 美元脱鞋 - 订单超过 100 美元”,请将 PromotionItem 设置为“shoes”,将 CurrencyCode 设置为“USD”,将 MoneyAmountOff 设置为 20,并将 OrdersOverAmount 设置为 100。

加: 必填。 必须设置 MoneyAmountOffPercentOff,但不能同时设置这两者。
更新: 自选。 可以设置 MoneyAmountOffPercentOff,但不能同时设置这两者。
OrdersOverAmount 追加到促销目标的订单超过金额值。

例如,若要提升“20 美元脱鞋 - 订单超过 100 美元”,请将 PromotionItem 设置为“shoes”,将 CurrencyCode 设置为“USD”,将 MoneyAmountOff 设置为 20,并将 OrdersOverAmount 设置为 100。

加: 自选。 不能同时设置 OrdersOverAmountPromotionCode
更新: 自选。 不能同时设置 OrdersOverAmountPromotionCode。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为“0” (零) ,则会删除以前的设置。
PercentOff 提升值的百分比。

例如,10.0 表示 10% 的折扣。

加: 必填。 必须设置 MoneyAmountOffPercentOff,但不能同时设置这两者。
更新: 自选。 可以设置 MoneyAmountOffPercentOff,但不能同时设置这两者。 如果设置了此属性,则 CurrencyCode 设置不再适用,并且如果之前已设置,则会将其删除。
PromotionCode 追加到升级目标的升级代码。

例如,若要提升“$20 off shoes - 促销码 SAVE20”,请将 PromotionItem 设置为“shoes”,将 CurrencyCode 设置为“USD”,将 MoneyAmountOff 设置为 20,并将 PromotionCode 设置为“SAVE20”。

字符串最多可以包含 15 个字符。

加: 自选。 不能同时设置 OrdersOverAmountPromotionCode
更新: 自选。 不能同时设置 OrdersOverAmountPromotionCode。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为空字符串 ( ”) ,则会删除以前的设置。 如果设置了此属性,则 CurrencyCode 设置不再适用,并且如果之前已设置,则会将其删除。
string
PromotionEndDate 结束日期有助于通知将在广告中显示的促销日期。

例如,如果 PromotionStartDatePromotionEndDate 日期都设置为 2 月 14 日,则显示的促销中可能包含文本“2 月 14 日有效”。

PromotionStartDate 日期必须早于或等于 PromotionEndDate 日期。

此属性不会替代促销的固有传递范围。 促销促销日程安排都决定了何时有资格在广告中显示促销。

如果已过当前年份的结束日期,则必须为下一年的日期设置每个开始日期和结束日期。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 若要删除当前结束日期并有效地不设置结束日期,请将 “日”、“ ”和 “年 ”分别设置为“0” (零) 。 下次检索促销广告扩展时,不会设置此元素。
Date
PromotionItem 促销目标或项。

例如,你可以以 20 美元或 20% 的折扣为“鞋子”进行促销。 若要运行“最多 20 美元脱鞋”的促销,请将 PromotionItem 设置为“shoes”,将 DiscountModifier 设置为 UpTo,将 CurrencyCode 设置为“USD”,并将 MoneyAmountOff 设置为 20。

该字符串最多可以包含 20 个字符。

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
string
PromotionOccasion 促销场合。

PromotionOccasionSchedule 元素确定何时有资格在广告中显示促销。

PromotionOccasion 确定时间段或季节性,例如每年 2 月 15 日至 3 月 31 日的妇女节。 促销仅在与所设置的场合相对应的日期内运行。 有关每个场合的已定义日期范围的详细信息,请参阅 PromotionOccasion

计划可以将升级限制在活动日期范围内的较短时间范围内,例如,将促销限制为从 2 月 20 日至 3 月 8 日。 日程安排还可用于多年运行相同的促销,例如,每年从 2 月 15 日至 3 月 31 日运行妇女节促销。

加: 自选。 如果未指定此元素或将其留空,则将设置默认值 None
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果设置此元素,还必须将 PromotionStartDatePromotionEndDate 设置为保留或更新以前的设置。
PromotionOccasion
PromotionStartDate 开始日期有助于通知广告中显示的促销日期。

例如,如果 PromotionStartDatePromotionEndDate 日期都设置为 2 月 14 日,则显示的促销中可能包含文本“2 月 14 日有效”。

PromotionStartDate 日期必须早于或等于 PromotionEndDate 日期。

此属性不会替代促销的固有传递范围。 促销促销日程安排都决定了何时有资格在广告中显示促销。

如果已过当前年份的结束日期,则必须为下一年的日期设置每个开始日期和结束日期。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 若要删除当前结束日期并有效地不设置结束日期,请将 “日”、“ ”和 “年 ”分别设置为“0” (零) 。 下次检索促销广告扩展时,不会设置此元素。
Date
TrackingUrlTemplate 用作所有 FinalUrlFinalMobileUrls 的默认跟踪模板。

以下验证规则适用于跟踪模板。 有关支持的模板和参数的更多详细信息,请参阅Microsoft广告帮助文章 可以使用哪些跟踪或 URL 参数?
- 为较低级别的实体(例如广告)定义的跟踪模板将覆盖为较高级别的实体(例如市场活动)设置的模板。 有关详细信息,请参阅 实体限制
- 跟踪模板的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 跟踪模板必须是格式正确的 URL,以下列项之一开头: http://https://{lpurl}{unescapedlpurl}
- Microsoft广告不验证自定义参数是否存在。 如果在跟踪模板中使用自定义参数,并且这些参数不存在,则登陆页 URL 将包含自定义参数的键和值占位符,而不进行替换。 例如,如果您的跟踪模板为 https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} ,并且未在市场活动、广告组、条件、关键字 (keyword) 或广告级别定义 {_season}{_promocode},则登陆页 URL 将相同。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为空字符串 ( ”) ,则会删除以前的设置。
string
UrlCustomParameters 用于 URL 跟踪的键和值参数的自定义集合。

Microsoft Advertising 将接受包含在 CustomParameters 对象中的前 3 个 CustomParameter 对象 ,并且将忽略任何其他自定义参数。 每个 CustomParameter 都包含 元素。 对于自定义参数限制增加阶段 3 试点 (GetCustomerPilotFeatures 返回 635) 的客户,Microsoft Advertising 将接受你包含的前 8 个自定义参数键和值对,如果包含的自定义参数超过 8 个,将返回错误。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 将 UrlCustomParameters 元素设置为 null 或空,以保留任何现有自定义参数。 若要删除所有自定义参数,请将 CustomParameters 对象的 Parameters 元素设置为 null 或空。 若要删除自定义参数的子集,请指定要保留在 CustomParameters 对象的 Parameters 元素中的自定义参数。
CustomParameters

PromotionAdExtension 对象具有 Inherited Elements

继承的元素

从 AdExtension 继承的元素

PromotionAdExtension 对象派生自 AdExtension 对象,并继承以下元素:DevicePreferenceForwardCompatibilityMapIdScheduleStatusTypeVersion。 以下说明特定于 PromotionAdExtension,可能不适用于从 AdExtension 对象继承相同元素的其他对象。

元素 说明 数据类型
DevicePreference 此广告扩展类型不支持。 long
ForwardCompatibilityMap 用于向前兼容性的键和值字符串列表,以避免在当前 API 版本中添加新元素时发生重大更改。

AdExtension 对象当前没有向前兼容性更改。

加: 只读
更新: 只读
KeyValuePairOfstringstring 数组
ID 广告扩展的唯一Microsoft广告标识符。

加: 只读
更新: 只读和必需
long
计划 确定广告扩展插件有资格显示在广告中的日历日期和时间范围。

加: 自选
更新: 自选。 如果将此元素设置为 null,则广告扩展的任何现有计划集都将保持不变。 如果将此设置为任何非 null Schedule 对象,则实际上将替换广告扩展的现有计划设置。 若要删除所有计划,请将此元素设置为空 Schedule 对象。
Schedule
状态 广告扩展的状态。 该值将始终为 “活动” ,因为市场活动管理服务不会返回已删除的广告扩展。

加: 只读
更新: 只读
AdExtensionStatus
类型 广告扩展的类型。 检索促销广告扩展时,此值为 PromotionAdExtension

加: 只读
更新: 只读

有关广告扩展插件类型的详细信息,请参阅 Ad 扩展插件数据对象备注
string
版本 跟踪广告扩展已更新的次数。

创建广告扩展时,版本设置为 1,并在每次更新后递增 1

加: 不允许
更新: 不允许
int

要求

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