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

传单扩展使广告客户能够向潜在客户分发产品或商店目录 (传单) 。

它们可以在广泛的查询(如“每周交易”或“每周销售额”)上突出显示,从而鼓励购物者点击你的广告,而不是竞争对手的广告。 根据其性质,它们有助于更好地通知搜索者,因此,提高用户参与度,例如点击率。

注意

功能试点 (GetCustomerPilotFeatures 返回 802) ,客户可以使用传单扩展。

语法

<xs:complexType name="FlyerAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q62="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q62:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q63="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q63:ArrayOfstring" />
        <xs:element minOccurs="0" name="FlyerName" nillable="true" type="xs:string" />
        <xs:element xmlns:q64="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q64:ArrayOflong" />
        <xs:element xmlns:q65="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaUrls" nillable="true" type="q65:ArrayOfstring" />
        <xs:element minOccurs="0" name="StoreId" nillable="true" type="xs:long" />
        <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>

元素

FlyerAdExtension 对象具有以下元素:DescriptionFinalAppUrlsFinalMobileUrlsFinalUrlsFinalUrlSuffixFlyerNameImageMediaIdsImageMediaUrlsStoreIdTrackingUrlTemplateUrlCustomParameters

元素 说明 数据类型
说明 广告客户、代理或客户经理可用于跟踪、标记或管理传单扩展的说明。

此说明不会随广告或图像一起显示。

此元素的最大长度为 1,024 个字符。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
string
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
FlyerName 传单名称。

此元素的最大长度为 150 个字符。

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
string
ImageMediaIds 要包含在广告中的图像的标识符。

只能设置一个媒体 ID。 数据类型是长值列表,以防以后添加对多个图像的支持。

每个媒体 ID 对应于“GenericImage”媒体子类型的图像

在将每个 图像添加到图像 库时,可以通过调用 AddMedia 操作来获取这些图像的标识符。 否则,在将媒体添加到映像库后,可以使用 GetMediaMetaDataByAccountId 操作获取媒体标识符。 图像的最小宽度和高度应为 220px,最大文件大小应为 3.9MB。

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
long 数组
ImageMediaUrls 已添加的媒体的 URL。

加: 只读
更新: 只读
字符串 数组
StoreId 用于产品广告的Microsoft商家中心商店的唯一标识符。

加: 自选
更新: 只读。 设置后,无法更新存储 ID。
long
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

FlyerAdExtension 对象具有 Inherited Elements

继承的元素

从 AdExtension 继承的元素

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

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

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

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

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

加: 计划 StartDateEndDate 是传单广告扩展所必需的。
更新: 自选。 如果将此元素设置为 null,则广告扩展的任何现有计划集都将保持不变。 如果将此设置为任何非 null Schedule 对象,则实际上将替换广告扩展的现有计划设置。 不能将此元素设置为空 的 Schedule 对象,因为这将有效地尝试删除所有计划。 这将导致错误,因为传单广告扩展需要 StartDateEndDate
Schedule
状态 广告扩展的状态。 该值将始终为 “活动” ,因为市场活动管理服务不会返回已删除的广告扩展。

加: 只读
更新: 只读
AdExtensionStatus
类型 广告扩展的类型。 检索传单广告扩展时,此值为 FlyerAdExtension

加: 只读
更新: 只读

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

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

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

要求

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