通过

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

  • 项目

定义一个广告扩展插件，该扩展插件指定要包含在扩展文本广告中的可选文本的图像。

可以将图像广告扩展插件与帐户或帐户中的市场活动及广告组相关联。 对于每个帐户，只能将 1,000 个市场活动与 1,000 个广告组关联到图像广告扩展。 (帐户、市场活动或广告组) 的每个实体最多可以与 6 个图像广告扩展相关联。

语法

<xs:complexType name="ImageAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q44="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q44:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q45="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q45:ArrayOfstring" />
        <xs:element xmlns:q46="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q46:ArrayOflong" />
        <xs:element minOccurs="0" name="Images" nillable="true" type="tns:ArrayOfAssetLink">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element xmlns:q47="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Layouts" nillable="true" type="q47:ArrayOfstring">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="SourceType" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <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>

元素

ImageAdExtension 对象具有以下元素：AlternativeText、Description、DestinationUrl、DisplayText、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、ImageMediaIds、Images、Layouts、SourceType、TrackingUrlTemplate、UrlCustomParameters。

元素 说明 数据类型
AlternativeText 可用性的图像媒体的替代说明。 如果无法显示图像，则改用备用文本。

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

加： 必填
更新： 必填		 string
说明 广告客户、代理机构或客户经理可用于跟踪、标记或管理图像媒体的说明。

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

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

加： 自选
更新： 自选。 如果将此元素设置为 null，则会删除以前的设置。		 string
DestinationUrl 当用户单击图像时要访问的网页的 URL。

URL 可以包含动态文本字符串，例如 {关键字 (keyword) }。 有关详细信息，请参阅 我可以使用哪些跟踪或 URL 参数？。

URL 最多可以包含 1,024 个字符。 如果 URL 未指定协议，则当用户单击广告时，系统会使用 HTTP 协议。 如果在添加广告时 URL 指定了 HTTP 协议，则服务将删除 http:// 协议字符串， (HTTP 协议字符串不计入 1,024 个字符限制) ;但是，该服务不会从 URL 中删除 HTTPS 协议字符串 (https：//) 。

如果未为图像广告扩展指定 URL，则使用广告的 URL。

加： 自选
更新： 自选。 如果将此元素设置为 null，则会删除以前的设置。		 string
DisplayText 图像扩展的显示文本。

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

加： 当 布局 包含 SearchMultiple 时是必需的，否则为可选。
更新： 当 布局 包含 SearchMultiple 时是必需的，否则为可选。 如果将此元素设置为 null，则会删除以前的设置。		 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
ImageMediaIds 要包含在广告中的图像的标识符。 不能为同一纵横比的多个图像指定媒体标识符。 换句话说，每个引用的图像必须具有不同的纵横比。

最多可以指定 4 (4) 图像媒体标识符。 虽然最低要求是一个图像媒体 ID，但为了符合所有广告放置条件，必须提供 四个图像 媒体标识符，其中每个 ID 对应于四种受支持的 媒体 类型之一的图像， (纵横比) 。 受众广告支持的纵横比为 16：9、1.5：1、4：3 和 1.2：1。 有关详细信息，请参阅 图像 数据对象参考文档。

在将每个 图像添加到图像 库时，可以通过调用 AddMedia 操作来获取这些图像的标识符。 否则，在将媒体添加到映像库后，可以使用 GetMediaMetaDataByAccountId 操作获取媒体标识符。

加： 必填
更新： 必填		 long 数组
Images 具有不同大小和纵横比的图像资产，因此它们可以在各种发布者和位置之间灵活显示。

包括一个或多个 AssetLink 对象，每个对象都包含一个具有 SubType 的 ImageAsset 和与所需纵横比匹配的裁剪设置。

加： 必填
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 如果在更新期间包含映像，则会替换以前设置的任何映像。		 AssetLink 数组
布局 符合条件的图像布局列表。

支持的值为 SearchSingle 和 SearchMultiple。 将来可能会添加新布局，因此不应依赖于一组固定值。

加： 必填
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 如果在更新期间包含布局，则将替换以前设置的任何布局。		 字符串 数组
SourceType 源的类型。 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 将相同。

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

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

加： 自选
更新： 自选。 如果未为更新设置任何值，则会删除以前的设置。		 CustomParameters

ImageAdExtension 对象具有 Inherited Elements。

继承的元素

从 AdExtension 继承的元素

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

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

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

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

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

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

加： 只读
更新： 只读		 AdExtensionStatus
类型 广告扩展的类型。 检索图像广告扩展插件时，此值为 ImageAdExtension 。

加： 只读
更新： 只读

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

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

加： 不允许
更新： 不允许		 int

要求

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