通过

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

  • 项目

使用视频和行动号召按钮定义广告扩展。

语法

<xs:complexType name="VideoAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="ActionText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q66="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q66:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q67="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q67:ArrayOfstring" />
        <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ThumbnailId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="ThumbnailUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
        <xs:element minOccurs="0" name="VideoId" nillable="true" type="xs:long" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

元素

VideoAdExtension 对象具有以下元素：ActionText、AlternativeText、DisplayText、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、Name、ThumbnailId、ThumbnailUrl、TrackingUrlTemplate、UrlCustomParameters、VideoId。

元素 说明 数据类型
ActionText 视频资产的操作文本。 string
AlternativeText 视频资产的替换文字。 string
DisplayText 视频资产的显示文本。 string
FinalAppUrls 供将来使用。 AppUrl 数组
FinalMobileUrls 移动设备的登陆页 URL。

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

加： 自选
更新： 自选。 如果未为更新设置任何值，则会删除以前的设置。		 字符串 数组
FinalUrls 登陆页 URL。

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

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

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

加： 自选
更新： 自选。 如果未为更新设置任何值，则会删除以前的设置。		 string
名称 视频资产的名称。 string
ThumbnailId 缩略图资产的 ID。 long
ThumbnailUrl 视频资产的缩略图 URL。

添加：不支持
更新：不支持		 string
TrackingUrlTemplate 用作所有 FinalUrl 和 FinalMobileUrls 的默认跟踪模板。

以下验证规则适用于跟踪模板。 有关支持的模板和参数的更多详细信息，请参阅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 将相同。

加： 自选
更新： 自选。 如果将此元素设置为 null，则会删除以前的设置。		 string
UrlCustomParameters 用于 URL 跟踪的键和值参数的自定义集合。

Microsoft Advertising 将接受在 CustomParameters 对象中包含的前 8 个 CustomParameter 对象 ，如果包含 8 个以上的自定义参数，则会返回错误。 每个 CustomParameter 都包含 键 和 值 元素。 对于自定义参数限制增加阶段 3 试点 (GetCustomerPilotFeatures 返回 635) 的客户，Microsoft Advertising 将接受你包含的前 8 个自定义参数键和值对，如果包含的自定义参数超过 8 个，将返回错误。

加： 自选
更新： 自选。 如果将此元素设置为 null，则会删除以前的设置。		 CustomParameters
VideoId 视频的 ID。 long

VideoAdExtension 对象具有 Inherited Elements。

继承的元素

从 AdExtension 继承的元素

VideoAdExtension 对象派生自 AdExtension 对象，并继承以下元素：DevicePreference、ForwardCompatibilityMap、Id、Schedule、Status、Type、Version。 以下说明特定于 VideoAdExtension，可能不适用于从 AdExtension 对象继承相同元素的其他对象。

元素 说明 数据类型
DevicePreference 此元素确定首选项是在移动设备还是所有设备上显示广告扩展。

若要指定移动设备的首选项，请将此元素设置为 30001。

若要指定所有设备，请将此元素设置为 0 (零) 或将元素保留为 nil。 默认情况下，此元素将为 nil。

此元素仅适用于 AppAdExtension 和 SitelinkAdExtension 类型。		 long
ForwardCompatibilityMap 用于向前兼容性的键和值字符串列表，以避免在当前 API 版本中添加新元素时发生重大更改。

将来的版本中将在此处记录向前兼容性更改。 此对象当前没有向前兼容性更改。		 KeyValuePairOfstringstring 数组
ID 广告扩展的唯一Microsoft广告标识符。 long
计划 确定广告扩展插件有资格显示在广告中的日历日期和时间范围。 Schedule
状态 广告扩展的状态。 该值将始终为 “活动” ，因为市场活动管理服务不会返回已删除的广告扩展。 AdExtensionStatus
类型 广告扩展的类型。

有关详细信息，请参阅备注。		 string
版本 跟踪广告扩展已更新的次数。

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

要求

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