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

定义广告活动中的资产组。

语法

<xs:complexType name="AssetGroup" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AssetGroupSearchThemes" nillable="true" type="tns:ArrayOfAssetGroupSearchTheme">
      <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="AssetGroupUrlTargets" nillable="true" type="tns:ArrayOfAssetGroupUrlTarget">
      <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="BusinessName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CallToAction" nillable="true" type="tns:CallToAction" />
    <xs:element minOccurs="0" name="Descriptions" nillable="true" type="tns:ArrayOfAssetLink" />
    <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:AssetGroupEditorialStatus" />
    <xs:element minOccurs="0" name="EndDate" nillable="true" type="tns:Date" />
    <xs:element xmlns:q115="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q115:ArrayOfstring" />
    <xs:element xmlns:q116="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q116:ArrayOfstring" />
    <xs:element xmlns:q117="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q117:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Headlines" nillable="true" type="tns:ArrayOfAssetLink" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Images" nillable="true" type="tns:ArrayOfAssetLink" />
    <xs:element minOccurs="0" name="LongHeadlines" nillable="true" type="tns:ArrayOfAssetLink" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Path1" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Path2" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="StartDate" nillable="true" type="tns:Date" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:AssetGroupStatus" />
    <xs:element minOccurs="0" name="Videos" 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:sequence>
</xs:complexType>

元素

AssetGroup 对象具有以下元素:AssetGroupSearchThemesAssetGroupUrlTargetsBusinessNameCallToActionDescriptionsEditorialStatusEndDateFinalMobileUrlsFinalUrlsForwardCompatibilityMapHeadlinesIdImagesLongHeadlinesNamePath1Path2StartDate状态视频

元素 说明 数据类型
AssetGroupSearchThemes 资产组搜索主题的列表。 AssetGroupSearchTheme 数组
AssetGroupUrlTargets 保留。 AssetGroupUrlTarget 数组
BusinessName 企业名称。

你的企业名称可能会显示在广告中,具体取决于广告位置。

字符串的长度限制为 25 个字符。

加: 必填。 如果未提供和父市场活动关联到商店,商店名称将用作业务名称。
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
string
CallToAction 客户立即点击广告的简短而有力的理由。

此操作显示在“行动号召”按钮上。

加: 必填。 如果未提供和父市场活动关联到商店,它将默认为 LearnMore
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
CallToAction
说明 广告中路径下方显示的说明。

必须在 2-5 个说明之间设置。 每个说明的文本必须至少包含一个单词。 Text 不能包含换行符 (\n) 。

如果父市场活动关联到某个商店,并且你指定了“说明”,则还必须指定“标题”、“长标题”和“图像”。

添加:如果父市场活动关联到商店,则为可选;如果父市场活动未关联到商店,则为必需项。
更新:可选。 若要保留所有现有资产链接,请设置或保留此元素为 nil。 如果为此元素设置值,则会替换以前链接到此资产组的任何说明。 如果父市场活动关联到某个商店,并且你将此元素设置为空列表,则会删除以前的设置。
AssetLink 数组
编辑状态 资产组的编辑评审状态,指示资产组是等待评审、已批准还是已遭拒批。

添加:只读
更新:只读
AssetGroupEditorialStatus
EndDate 资产组到期的日期。

如果未指定结束日期,则资产组不会过期。 可以延长结束日期,使资产组符合交付条件,即使在资产组过期后也是如此。

结束日期是包含的。 例如,如果将 EndDate 设置为 12/31/2020,广告组中的广告将在 2020 年 12 月 31 日晚上 11:59 过期。 时间基于在市场活动级别指定的时区。

添加:可选。 若要在添加资产组时不设置结束日期,请将此元素设置为 null。
更新:可选。 如果未为更新设置任何值,则不会更改此设置。 若要删除现有结束日期设置,并在更新资产组时有效地不设置结束日期,请将结束日期设置为等于或晚于 2050 年 1 月 2 日。 下次检索资产组时,此元素将为零,即不会将其设置为 2050 年 1 月 2 日。
Date
FinalMobileUrls 移动登陆页 URL。

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

添加:可选
更新:可选
字符串 数组
FinalUrls 登陆页 URL。

URL 的域部分与路径 1 和路径 2 字符串组合不能超过 67 个字符。

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

对于零售市场活动,最终 URL 必须与与市场活动关联的商店中的域匹配。

添加:必需。 如果未提供并且父市场活动关联到某个商店,则应用商店 URL 将用作最终 URL。
更新:可选
字符串 数组
ForwardCompatibilityMap 用于向前兼容性的键和值字符串列表,以避免在当前 API 版本中添加新元素时发生重大更改。

将来的版本中将在此处记录向前兼容性更改。 此对象当前没有向前兼容性更改。
KeyValuePairOfstringstring 数组
标题 标题是广告中显示的最醒目的文本,因此应充分利用可用字符。 我们需要多个标题,以便广告可以在各种发布者和位置上灵活显示。

从数据模型的角度来看,说明和标题都存储为文本资产,即每个 AssetLink 一个 TextAsset。 同一资产可由多个广告使用。 例如,如果“无缝集成”是文本资产,它将在同一Microsoft广告帐户中的所有广告中具有相同的资产标识符。

必须设置 3-15 个标题。 每个标题的文本必须至少包含一个单词。

Text 不能包含换行符 (\n) 。

如果父市场活动关联到商店,并且你指定了标题,则还必须指定长头线、说明和图像。

添加:如果父市场活动关联到商店,则为可选;如果父市场活动未关联到商店,则为必需项。
更新:可选。 若要保留所有现有资产链接,请设置或保留此元素为 nil。 如果为此元素设置值,则会替换以前链接到此资产组的所有标题。 如果父市场活动关联到某个商店,并且你将此元素设置为空列表,则会删除以前的设置。
AssetLink 数组
ID 系统生成的资产组 ID。

添加:只读
更新:只读
long
Images 具有不同大小和纵横比的图像资产,因此它们可以在各种发布者和位置之间灵活显示。

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

ImageAsset 包含 CropHeight、CropWidth、CropX、CropY 和 SubType 字段。

可能的子类型值包括 LandscapeImageMedia、SquareImageMedia、LandscapeLogoMedia、SquareLogoMedia、ImageMedia15X10、ImageMedia133X100、ImageMedia178X100、ImageMedia1X2 和 ImageMedia4X1。

必须至少提供 1 个 LandscapeImageMedia 和 1 个 SquareImageMedia。 总共最多可以保存 20 个图像和总共 5 个徽标。

如果父市场活动关联到某个商店,并且你指定了“图像”,则还必须指定“标题”、“长标题”和“说明”。

添加:如果父市场活动关联到商店,则为可选;如果父市场活动未关联到商店,则为必需项。
更新:可选。 如果未为更新设置任何值,则不会更改此设置。 如果在更新期间包含映像,则会替换以前设置的任何映像。 如果父市场活动关联到某个商店,并且你将此元素设置为空列表,则会删除以前的设置。
AssetLink 数组
LongHeadlines 必须设置 1-5 个长标题。 每个标题的文本必须至少包含一个单词。 Text 不能包含换行符 (\n) 。

如果父市场活动关联到某个商店,并且你指定了 LongHeadlines,则还必须指定标题、说明和图像。

添加:如果父市场活动关联到商店,则为可选;如果父市场活动未关联到商店,则为必需项。
更新:可选。 若要保留所有现有资产链接,请设置或保留此元素为 nil。 如果为此元素设置值,则会替换以前链接到此资产组的所有标题。 如果父市场活动关联到某个商店,并且你将此元素设置为空列表,则会删除以前的设置。
AssetLink 数组
名称 资产组的名称。 名称在市场活动中应是唯一的,并且区分大小写。 长度不能超过 256 个字符。

添加:必需
更新:可选
string
Path1 将追加到显示 URL 的域部分的可选路径的第一部分。 显示 URL 的域部分(例如 https://www.contoso.com )将从 final URL 的域 (FinalUrls 元素) 生成。 如果为 Path1 指定了值,则会将其追加到显示 URL。 如果还为 Path2 指定了一个值,则该值也将追加到 Path1 后面的显示 URL。 例如,如果 FinalUrl 包含 https://www.contoso.com,则 Path1 设置为 subdirectory1,将 Path2 设置为 subdirectory2,则显示的 URL 将为 https://www.contoso.com/subdirectory1/subdirectory2

输入不能超过 15 个字符。 如果最终 URL 域和路径的总长度超过 67 个字符,广告将无法显示。

对于具有双角字符的语言(例如繁体中文)可以输入不超过 7 个最终字符。 如果最终 URL 域和路径的总长度超过 33 个字符,广告将无法显示。 双角字符由你使用的字符而不是市场活动语言设置的字符集决定。 双角字符包括韩语、日语和中文字符以及表情符号。

路径不能包含正斜杠 (/) 或换行 (\n) 字符。

如果路径包含空格,则会在显示广告时将其替换为下划线 (_) 。

添加:可选
更新:可选
string
Path2 将追加到显示 URL 的域部分的可选路径的第二部分。 显示 URL 的域部分(例如 https://www.contoso.com )将从 final URL 的域 (FinalUrls 元素) 生成。 如果为 Path1 指定了值,则会将其追加到显示 URL。 如果还为 Path2 指定了一个值,则该值也将追加到 Path1 后面的显示 URL。 例如,如果 FinalUrl 包含 https://www.contoso.com,则 Path1 设置为 subdirectory1,将 Path2 设置为 subdirectory2,则显示的 URL 将为 https://www.contoso.com/subdirectory1/subdirectory2

如果还设置了 Path1,则只能指定 Path2。

输入不能超过 15 个字符。 如果最终 URL 域和路径的总长度超过 67 个字符,广告将无法显示。

对于具有双角字符的语言(例如繁体中文)可以输入不超过 7 个最终字符。 如果最终 URL 域和路径的总长度超过 33 个字符,广告将无法显示。 双角字符由你使用的字符而不是市场活动语言设置的字符集决定。 双角字符包括韩语、日语和中文字符以及表情符号。

路径不能包含正斜杠 (/) 或换行 (\n) 字符。

如果路径包含空格,则会在显示广告时将其替换为下划线 (_) 。

添加:可选
更新:可选
string
StartDate 资产组可以开始提供服务的日期;否则,服务可以在资产组处于活动状态的当天开始投放广告。

开始日期是包含的。 例如,如果将开始日期设置为 2021 年 5 月 5 日,则从资产组创建的广告将从 2021 年 5 月 5 日凌晨 12:00 开始。 时间基于在市场活动级别指定的时区。

添加:可选。 如果未设置开始日期,则它将默认为今天的日期,并且服务可以在资产组状态处于活动状态后立即开始投放广告。
更新:可选。 如果未为更新设置任何值,则不会更改此设置。 在提交资产组后(即开始日期到达后),无法更新开始日期。
Date
状态 资产组的状态。 可能的值为 ActiveExpiredPaused“已过期”状态为只读。

添加:可选。 默认值为 Paused
更新:可选
AssetGroupStatus
视频 保留。 AssetLink 数组

要求

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

使用者

AddAssetGroups
CreateAssetGroupRecommendation
GetAssetGroupsByCampaignId
GetAssetGroupsByIds
RefineAssetGroupRecommendation
UpdateAssetGroups