通过

关键字

  • 项目

包含用于管理关键字 (keyword) 的方法。 有关关键字的信息，请参阅 关键字。

方法

方法名称 返回类型 说明
adParams AdParamSelector 获取用于获取此关键字 (keyword) 广告中使用的所有替换参数的选择器。
applyLabel (字符串名称) void 将标签应用于此关键字 (keyword) 。
投标 KeywordBidding 获取用于管理此关键字 (keyword) 的出价金额的方法。
clearDestinationUrl void 删除此关键字 (keyword) 的目标 URL。
使 void 启用此关键字 (keyword) 。
getAdGroup AdGroup 获取此关键字 (keyword) 所属的广告组。
getApprovalStatus string 获取此关键字 (keyword) 的编辑审批状态。
getCampaign 市场活动 获取此关键字 (keyword) 所属的营销活动。
getEntityType string 获取此实体的类型。
getFirstPageCpc double 获取在搜索结果的第一页上所需的估计出价。
getId string 获取唯一标识此关键字 (keyword) 的 ID。
getMatchType string 获取此关键字 (keyword) 的匹配类型。
getQualityScore integer 获取此关键字 (keyword) 的质量分数。
getStats 统计 获取此关键字 (keyword) 的性能数据。
getText string 获取关键字 (keyword) 的文本。
getTopOfPageCpc double 获取在搜索结果顶部所需的估计出价。
isEnabled 布尔值 获取一个布尔值，该值指示是否启用此关键字 (keyword) 。
isPaused 布尔值 获取一个布尔值，该值指示此关键字 (keyword) 是否暂停。
标签 LabelSelector 获取用于筛选与此关键字 (keyword) 关联的标签列表的选择器。
暂停 void 暂停此关键字 (keyword) 。
remove void 删除此关键字 (keyword) 。
removeLabel (字符串名称) void 从此关键字 (keyword) 中删除标签。
setAdParam (int index、string insertText) void 添加替换参数并将其值设置为指定的文本。
Url KeywordUrls 获取用于管理此关键字的最终 URL、跟踪模板和自定义参数的方法。

adParams

获取此关键字 (keyword) 的广告中使用的所有替换参数选择器。

如果广告的标题、文本、显示 URL 或目标 URL 包含 {Param1}、{Param2}或 {Param3} 动态替换字符串，则广告中将使用替换值。

返回

类型 说明
AdParamSelector 包含此关键字 (keyword) 替换参数列表的选择器。

applyLabel (字符串名称)

将标签应用于关键字 (keyword) 。

最多可以向关键字 (keyword) 应用 50 个标签。 有关向关键字 (keyword) 添加标签的示例，请参阅使用标签。

参数

名称 类型 说明
name string 标签的区分大小写的名称。 若要获取此帐户中可以应用的标签列表，请参阅 AdsApp.labels。

返回

类型 说明
void 不返回任何内容。

投标

获取用于管理此关键字 (keyword) 的出价金额的方法。

返回

类型 说明
KeywordBidding 包含用于管理此关键字 (keyword) 的出价金额的方法。

clearDestinationUrl

删除此关键字 (keyword) 的目标 URL。

返回

类型 说明
void 不返回任何内容。

使

启用此关键字 (keyword) 。

返回

类型 说明
void 不返回任何内容。

getAdGroup

获取此关键字 (keyword) 所属的广告组。

返回

类型 说明
AdGroup 此关键字 (keyword) 所属的广告组。

getApprovalStatus

获取此关键字 (keyword) 的编辑审批状态。

返回

类型 说明
string 关键字 (keyword) 的编辑审批状态。 状态指示关键字 (keyword) 正在审查、已批准还是不允许。 可能的值是：
  • 批准
  • APPROVED_LIMITED
  • 反对
  • UNDER_REVIEW
有关这些状态值如何映射到必应广告 API 的信息，请参阅 映射编辑审批状态值。

getCampaign

获取此关键字 (keyword) 所属的营销活动。

返回

类型 说明
市场活动 此关键字 (keyword) 所属的竞选活动。

getEntityType

返回此实体的类型。

返回

类型 说明
string 此实体的类型为 Keyword。

getId

获取唯一标识此关键字 (keyword) 的 ID。

返回

类型 说明
string 唯一标识此关键字 (keyword) 的 ID。

getFirstPageCpc

获取广告显示在侧边栏中所需的估计出价。

返回

类型 说明
double 广告显示在侧边栏中所需的估计出价。

getMatchType

获取此关键字 (keyword) 的匹配类型。

返回

类型 说明
string 关键字 (keyword) 的匹配类型。 可能的值是：
  • 广泛
  • PHRASE
  • 确切
有关这些类型的信息，请参阅什么是关键字 (keyword) 匹配类型，以及如何使用它们？

getQualityScore

获取此关键字 (keyword) 的质量分数。

返回

类型 说明
integer 关键字 (keyword) 的质量分数。 分数在 1 到 10 (最高) 。 如果无法计算关键字 (keyword) 的质量分数，此方法返回 NULL。

分数通过衡量关键字和登陆页面与客户搜索词的相关性来显示广告在市场中具有的竞争力。 有关详细信息，请参阅 关键字性能报告。

getStats

获取此关键字性能数据。

若要调用此方法，必须在关键字 (keyword) 选择器的链中包含其中一个forDateRange方法。

返回

类型 说明
统计 关键字 (keyword) 的性能数据。 例如，点击次数和展示次数。

getText

获取关键字 (keyword) 的文本。 文本包含关键字 (keyword) 的匹配类型语法（如果有）。 例如：

  • 如果匹配类型广泛，则关键字 (keyword) 为书籍;如果关键字 (keyword) 使用宽类型修饰符，则为书籍;如果关键字 (keyword) 为广泛类型修饰符，则为书籍
  • 如果匹配类型为短语，则关键字 (keyword) 为“books”
  • 如果匹配类型精确，则关键字 (keyword) 为 [精装书籍]

有关这些类型的信息，请参阅什么是关键字 (keyword) 匹配类型，以及如何使用它们？

返回

类型 说明
string 关键字 (keyword) 的文本。

getTopOfPageCpc

获取广告显示在自然搜索结果上方所需的估计出价。

返回

类型 说明
double 广告显示在自然搜索结果上方所需的估计出价。

isEnabled

获取一个布尔值，该值指示是否启用此关键字 (keyword) 。

返回

类型 说明
Boolean 如果启用此关键字 (keyword) ，则为 true;否则为 false。

isPaused

获取一个布尔值，该值指示此关键字 (keyword) 是否暂停。

返回

类型 说明
Boolean 如果暂停此关键字 (keyword) ，则为 true;否则为 false。

标签

获取用于筛选与此关键字 (keyword) 关联的标签列表的选择器。

返回

类型 说明
LabelSelector 用于筛选与此关键字 (keyword) 关联的标签列表的选择器。

暂停

暂停此关键字 (keyword) 。

返回

类型 说明
void 不返回任何内容。

删除

删除此关键字 (keyword) 。

返回

类型 说明
void 不返回任何内容。

removeLabel (字符串名称)

从关键字 (keyword) 中删除标签。

参数

名称 类型 说明
name string 标签的区分大小写的名称。 若要获取与此关键字 (keyword) 关联的标签列表，请参阅标签。

返回

类型 说明
void 不返回任何内容。

setAdParam (int index、string insertText)

添加替换参数并将其值设置为指定的文本。 如果替换参数存在，则会覆盖其文本。

如果广告的标题、文本、显示 URL 或最终 URL 包含 {Param1}、{Param2}或 {Param3} 动态替换字符串，则广告中将使用替换值。 有关使用这些参数的限制和信息，请参阅 Param1、 Param2 和 Param3。

如果模板指定 {param1：default}、{param2：default}或 {param3：default} 占位符，则跟踪模板中也会使用替换值。

参数

名称 类型 说明
index int 要设置的替换参数的索引。 有效索引值为 1 到 3（含）。 对 Param1 使用 1，对 Param2 使用 2，对 Param3 使用 3。
插入文本 string 要设置替换参数的文本。

返回

类型 说明
void 不返回任何内容。

urls

获取用于管理此关键字的最终 URL、跟踪模板和自定义参数的方法。

返回

类型 说明
KeywordUrls 包含使用关键字 (keyword) 的最终 URL、跟踪模板和自定义参数的方法。

另请参阅