通过

关键字数据对象 - 市场活动管理

  • 项目

定义关键字 (keyword) 。

关键字是查找产品或服务时搜索的字词或短语。 例如，关键字可以是以下任一项：

  • 鞋
  • 乘船巡游度假
  • 纽约网球课程

如上所示，关键字 (keyword) 可以是一个单词、几个单词，甚至是一个短语。 在搜索广告的上下文中，所有这些仅称为关键字 (keyword) 。

重要

自 2021 年 4 月起，无法为广告组或关键字设置任何出价策略。 如果尝试为广告组或关键字设置出价策略，请求将被忽略，而不会出错。 广告组和关键字将继承其市场活动的出价策略。

语法

<xs:complexType name="Keyword" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Bid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="BiddingScheme" nillable="true" type="tns:BiddingScheme" />
    <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:KeywordEditorialStatus" />
    <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
    <xs:element xmlns:q33="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q33:ArrayOfstring" />
    <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
    <xs:element xmlns:q34="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q34:ArrayOfstring" />
    <xs:element xmlns:q35="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q35:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="MatchType" nillable="true" type="tns:MatchType" />
    <xs:element minOccurs="0" name="Param1" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Param2" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Param3" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:KeywordStatus" />
    <xs:element minOccurs="0" name="Text" 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:sequence>
</xs:complexType>

元素

Keyword 对象具有以下元素：Bid、BidScheme、DestinationUrl、EditorialStatus、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、ForwardCompatibilityMap、Id、MatchType、Param1、Param2、Param3、Status、Text、TrackingUrlTemplate、UrlCustomParameters。

元素 说明 数据类型
竞价 每次有人点击广告时要支付的最高金额。

你使用相同的关键字 (keyword) 向其他广告客户出价，因此，通常，更高的出价有助于你的广告显示在搜索结果页面上更理想的位置。

可以为每个关键字 (keyword) 设置自定义出价，而不是使用默认广告组级别出价。 关键字的自定义出价将覆盖这些特定关键字的广告组默认出价。 使用自定义出价，可以将时间和金钱集中在最有利可图的关键字上，但需要花费更多时间来管理单个出价。

如果未设置关键字 (keyword) 级别出价，则使用广告组 CpcBid。 有关详细信息，请参阅 预算和投标策略。

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 若要删除关键字 (keyword) 出价并使用 AdGroup 默认匹配类型出价，请将 Bid 对象的 Amount 元素设置为 null。		 竞价
BiddingScheme 要如何管理出价的出价策略类型。

有关每个市场活动类型支持的出价策略的详细信息，请参阅 预算和出价策略。

注意： 自 2021 年 4 月起，无法为广告组或关键字设置任何出价策略。 如果尝试为广告组或关键字设置出价策略，请求将被忽略，而不会出错。 广告组和关键字将继承其市场活动的出价策略。

加： 自选。 如果未设置此元素，则默认使用 InheritFromParentBiddingScheme 。
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。		 BiddingScheme
DestinationUrl 用户在单击广告时要访问的网页的 URL。 如果指定，将使用关键字 (keyword) 的目标 URL;否则，使用广告的目标 URL。

重要：自 2018 年 11 月起，无法添加或更新关键字 (keyword) 目标 URL。 可以改用 最终 URL 。 有关详细信息，请参阅将关键字 (keyword) 目标 URL 迁移到最终 URL。

加： 不允许
更新： 不允许		 string
编辑状态 关键字 (keyword) 的编辑评审状态，指示关键字 (keyword) 正在等待评审、已批准还是已被拒批。

加： 只读
更新： 只读		 KeywordEditorialStatus
FinalAppUrls 供将来使用。 AppUrl 数组
FinalMobileUrls 移动登陆页 URL。 如果指定，将使用关键字 (keyword) 的最终移动 URL;否则，使用广告的最终移动 URL。

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。		 字符串 数组
FinalUrls 登陆页 URL。 如果指定，将使用关键字 (keyword) 的最终 URL;否则，使用广告的最终 URL。

以下验证规则适用于最终 URL 和最终移动 URL。
- URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 最多可为 FinalUrls 和 FinalMobileUrls 指定 10 个项目;但是，每个列表中的第一项仅用于传递。 该服务最多允许 10 个，以确保潜在的向前兼容性。
- 仅允许使用“{”和“}”来描述标记，例如 {lpurl}。
- 最终 URL 必须是格式正确的 URL，以 http:// 或 https:// 开头。
- 如果指定 FinalMobileUrls，还必须指定 FinalUrls。
- 如果设备首选项设置为移动，则不能指定 FinalMobileUrls 。 另请注意，如果设置了 TrackingUrlTemplate 或 UrlCustomParameters 元素，则至少需要一个最终 URL。 有关详细信息，请参阅 使用已升级 URL 进行 URL 跟踪。

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

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 如果将此元素设置为空字符串 (“ ”) ，则会删除以前的设置。		 string
ForwardCompatibilityMap 用于向前兼容性的键和值字符串列表，以避免在当前 API 版本中添加新元素时发生重大更改。

将来的版本中将在此处记录向前兼容性更改。 此对象当前没有向前兼容性更改。		 KeyValuePairOfstringstring 数组
ID 关键字 (keyword) 的系统生成的标识符。

加： 只读
更新： 必填		 long
MatchType 要比较关键字 (keyword) 和用户的搜索词的匹配类型。

加： 必填
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。		 MatchType
Param1 如果广告的标题、文本、显示 URL 或目标 URL 包含 {Param1} 动态替换字符串，则用作广告中替换值的字符串。

尽管您可以使用 {Param1} 指定广告的目标 URL，但建议不要。 相反，应设置关键字 (keyword) 的 DestinationUrl 元素。

该字符串最多可以包含 1,022 个字符。 实际限制取决于引用替换字符串的元素的长度。 例如，文本广告标题的长度最多可以包含 25 个字符。

在广告副本中实现动态文本时，应提供一个默认字符串，例如{Param1：default}，如果关键字 (keyword) 的 Param1 为 null 或为空，或者如果包含 Param1 替换值将导致扩展的字符串超出元素的限制，则系统将使用该字符串;否则，广告将不会提供此关键字 (keyword) 。 有关详细信息，请参阅Microsoft广告帮助文章 使用动态文本参数自动自定义广告。

另请注意，如果广告组只有一个广告，并且该广告使用 {Param1} 但未提供默认字符串（例如 {Param1：default}），则必须为该替换提供有效的 Param1 值。 否则，无法添加或更新此关键字 (keyword) 。

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 如果将此元素设置为空字符串 (“ ”) ，则会删除以前的设置。		 string
Param2 如果标题、文本、显示 URL 或目标 URL 包含 {Param2} 动态替换字符串，则用作广告中替换值的字符串。

通常，在标题或文本中使用 {Param2} 替换字符串， (广告副本说明) 广告元素。

字符串最多可以包含 70 个字符。 实际限制取决于引用替换字符串的元素的长度。 例如，文本广告标题的长度最多可以包含 25 个字符。

在广告副本中实现动态文本时，应提供一个默认字符串，例如{Param2：default}，如果用于关键字 (keyword) 的 Param2 为 null 或为空，或者如果包含 Param2 替换值将导致扩展的字符串超出元素的限制，则系统将使用该字符串;否则，广告将不会提供此关键字 (keyword) 。 有关详细信息，请参阅Microsoft广告帮助文章 使用动态文本参数自动自定义广告。

另请注意，如果广告组只有一个广告，并且该广告使用 {Param2} 但不提供默认字符串（例如 {Param2：default}），则必须为该替换提供有效的 Param2 值。 否则，无法添加或更新此关键字 (keyword) 。

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 如果将此元素设置为空字符串 (“ ”) ，则会删除以前的设置。		 string
Param3 如果标题、文本、显示 URL 或目标 URL 包含 {Param3} 动态替换字符串，则用作广告中替换值的字符串。

通常，在标题或文本中使用 {Param3} 替换字符串 (广告副本说明) 广告元素。

字符串最多可以包含 70 个字符。 实际限制取决于引用替换字符串的元素的长度。 例如，文本广告标题的长度最多可以包含 25 个字符。

在广告副本中实现动态文本时，应提供一个默认字符串，例如{Param3：default}，如果 param3 for a 关键字 (keyword) 为 null 或为空，或者如果包含 Param3 替换值将导致扩展的字符串超出元素的限制，则系统将使用该字符串;否则，此关键字 (keyword) 将不会提供广告。 有关详细信息，请参阅Microsoft广告帮助文章 使用动态文本参数自动自定义广告。

另请注意，如果广告组只有一个广告，并且该广告使用 {Param3} 但不提供默认字符串（例如 {Param3：default}），则必须为该替换提供有效的 Param3 值。 否则，无法添加或更新此关键字 (keyword) 。

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。 如果将此元素设置为空字符串 (“ ”) ，则会删除以前的设置。		 string
状态 关键字 (keyword) 的状态。 默认情况下，状态设置为“活动”。

加： 自选
更新： 自选。 如果未为更新设置任何值，则不会更改此设置。		 KeywordStatus
发短信 关键字 (keyword) 文本。 文本最多可以包含 100 个字符。 应在为关键字 (keyword) 所属广告组指定的 Language 值的区域设置中指定关键字 (keyword) 。

加： 必填
更新： 只读		 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 对象中包含的前 8 个 CustomParameter 对象 ，如果包含 8 个以上的自定义参数，则会返回错误。 每个 CustomParameter 都包含 键 和 值 元素。

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

要求

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

使用者

AddKeywords
GetKeywordsByAdGroupId
GetKeywordsByEditorialStatus
GetKeywordsByIds
UpdateKeywords