关键字的效果指标和配置属性。
只有异步请求(即通过 Reports.request() 方法)。
请求摘录
发送普通
Reports.request()
请求正文,但请指定 "reportType": "keyword"
。
{ ... "reportType": "keyword", "columns": [ { "columnName": string, "headerText": string, "startDate": string, "endDate": string } ], "filters": [ { "column": { "columnName": string, }, ... }, ... ], ... }
对于您想在报告中返回或过滤的每一列,
指定下表中列出的 columnName
。
您还可以视需要指定
headerText、
startDate,
和 endDate。
请注意,有些列无法过滤;指“可过滤”。
columnName | 说明 | 行为 | 类型 | 可过滤 |
---|---|---|---|---|
status |
关键字的状态:Active 、Paused 或 Removed 。请注意,广告系列、广告组、关键字和广告都拥有自己的状态。查看状态。 |
属性 | Status |
是 |
engineStatus |
关键字在外部引擎账号中的其他状态。可能的状态(取决于外部账号类型)包括:criterion rarely served 、criterion below first page bid 、criterion low quality score 、review 、campaign paused 等。 |
属性 | String |
是 |
creationTimestamp |
关键字创建的时间戳,采用 ISO 8601 格式。 | 属性 | Timestamp |
是 |
lastModifiedTimestamp |
关键字最近一次修改的时间戳,采用 ISO 8601 格式。 | 属性 | Timestamp |
是 |
agency |
代理机构名称。 | 属性 | String |
是 |
agencyId |
DS 代理机构 ID。 | 属性 | ID |
是 |
advertiser |
广告客户名称。 | 属性 | String |
是 |
advertiserId |
DS 广告客户 ID。 | 属性 | ID |
是 |
account |
引擎账号名称。 | 属性 | String |
是 |
accountId |
DS 引擎账号 ID。 | 属性 | ID |
是 |
accountEngineId |
外部引擎账号中账号的 ID。 | 属性 | String |
是 |
accountType |
引擎账号类型:Google AdWords 、Bing Ads 、Yahoo Japan Listing Ads 、Yahoo Search Marketing 、Yahoo Gemini 、Baidu 或 Comparison Shopping 。 |
属性 | Engine type |
是 |
campaign |
广告系列名称。 | 属性 | String |
是 |
campaignId |
DS 广告系列 ID。 | 属性 | ID |
是 |
campaignStatus |
包含此项目的广告系列的状态。 | 属性 | Status |
是 |
adGroup |
广告组名称。 | 属性 | String |
是 |
adGroupId |
DS 广告组 ID。 | 属性 | ID |
是 |
adGroupStatus |
包含此项目的广告组的状态。 | 属性 | Status |
是 |
keywordId |
DS 关键字 ID。值为 0 表示关键字未归因。 | 属性 | ID |
是 |
keywordMatchType |
关键字匹配类型:Broad 、Exact 、Phrase 或 Content 。 |
属性 | Match type |
是 |
keywordText |
关键字文本。 | 属性 | String |
是 |
keywordEngineId |
外部引擎账号中关键字的 ID。 | 属性 | ID |
是 |
keywordMaxCpc |
替换广告组的最高每次点击费用,并设置每当有用户使用此特定关键字投放广告时,您愿意支付的最高金额。如果此字段为空,关键字将使用广告组的最高每次点击费用。 | 属性 | Money |
是 |
effectiveKeywordMaxCpc |
对此关键字有效的最高每次点击费用。此值要么与广告组的最高每次点击费用相同,要么是关键字自己的最高每次点击费用(如果关键字覆盖了广告组的设置)。 | 属性 | Money |
是 |
keywordLandingPage |
用户在点击您的广告后会访问的最终到达网址。请参阅着陆页网址和 Clickserver 网址。 | 属性 | String |
是 |
keywordClickserverUrl |
DS 用于跟踪活动的网址。点击广告后,系统会先访问 Clickserver 网址,然后再重定向至最终着陆页。请参阅着陆页网址和 Clickserver 网址。 | 属性 | String |
是 |
isDisplayKeyword |
指明此关键字是否为用于展示广告报表和展示位置报表的占位符关键字。 | 属性 | Boolean |
是 |
keywordMaxBid |
如果此关键字由 DS 出价策略管理,则该出价策略的出价绝不会超过此限制。请参阅向关键字应用出价策略。 | 属性 | Money |
是 |
keywordMinBid |
如果此关键字是由 DS 出价策略管理,则该出价策略的出价绝不会低于此限制。请参阅向关键字应用出价策略。 | 属性 | Money |
是 |
keywordUrlParams |
向着陆页添加了额外的网址参数。请参阅添加网址参数。 | 属性 | String |
是 |
bingKeywordParam2 |
Bing Ads 关键字的 Param2。 | 属性 | String |
是 |
bingKeywordParam3 |
Bing Ads 关键字的 Param3。 | 属性 | String |
是 |
keywordLabels |
直接分配给此关键字的标签名称;未包含继承的标签。 | 属性 | String list |
是 |
qualityScoreCurrent |
仅适用于 Google Ads 和 Bing Ads。引擎对关键字的质量得分 (QS) 的最新值。请注意,无论报表的时间范围如何,此列始终会报告关键字的最新质量得分。 | 属性 | Integer |
是 |
topOfPageBidCurrent |
仅限 Google Ads。此列可以估算出要将您的广告定期显示在搜索结果上方页首位置所需的当前每次点击费用出价。请注意,无论报表的时间范围如何,此列一律会报告当前所需的每次点击费用。 | 属性 | Money |
是 |
effectiveBidStrategyId |
分配给此实体或由该实体继承的出价策略的 DS ID。 | 属性 | ID |
是 |
effectiveBidStrategy |
分配给此实体或由该实体继承的出价策略的名称。 | 属性 | String |
是 |
bidStrategyInherited |
指明此实体的出价策略是否继承。 | 属性 | Boolean |
是 |
effectiveLabels |
继承或直接分配给此关键字的所有标签的名称。 | 属性 | String list |
是 |
dfaActions |
Campaign Manager 操作的总次数。 | 指标 | Integer |
是 |
dfaRevenue |
Campaign Manager 交易产生的总收入。 | 指标 | Money |
是 |
dfaTransactions |
Campaign Manager 交易的总次数。 | 指标 | Integer |
是 |
dfaWeightedActions |
Campaign Manager 操作的加权总和。 | 指标 | Number |
是 |
dfaActionsCrossEnv |
跨环境 Campaign Manager 操作的总次数。 | 指标 | Number |
是 |
dfaRevenueCrossEnv |
跨环境 Campaign Manager 交易产生的总收入。 | 指标 | Money |
是 |
dfaTransactionsCrossEnv |
跨环境 Campaign Manager 交易的总次数。 | 指标 | Number |
是 |
dfaWeightedActionsCrossEnv |
跨环境 Campaign Manager 操作的加权总和。 | 指标 | Number |
是 |
avgCpc |
平均每次点击费用。 | 指标 | Money |
是 |
avgCpm |
平均每千次展示费用。 | 指标 | Money |
是 |
avgPos |
平均排名。 | 指标 | Number |
是 |
clicks |
汇总点击次数。 | 指标 | Integer |
是 |
cost |
支付给引擎账号的总费用。 | 指标 | Money |
是 |
ctr |
平均点击率。 | 指标 | Number |
是 |
impr |
总展示次数。 | 指标 | Integer |
是 |
adWordsConversions |
广告客户设置为在“Google Ads 转化次数”列中报告的数据。创建 Google Ads 转化操作后,该广告客户可以选择是否在“转化次数”报告列中统计这些转化。 | 指标 | Number |
是 |
adWordsConversionValue |
Google Ads 转化的总价值。 | 指标 | Number |
是 |
adWordsViewThroughConversions |
Google Ads 浏览型转化的总次数。 | 指标 | Integer |
是 |
visits |
DS 总访问次数。 | 指标 | Integer |
是 |
qualityScoreAvg |
仅适用于 Google Ads 和 Bing Ads。引擎质量得分 (QS) 按展示次数加权平均,针对报告范围内所有日期和关键字。 | 指标 | Number |
是 |
topOfPageBidAvg |
仅限 Google Ads。此列可以估算出在报表时间范围内要让广告定期显示在搜索结果上方页首位置所需的平均 CPC 出价。 | 指标 | Money |
是 |
date |
按天细分报告;每行及其汇总指标都会拆分为多行,每一天对应一行。此列会返回各行的日期。 | 细分 | Date |
是 |
monthStart |
按月份细分报表;每行及其汇总指标都会拆分为多行,每行对应一个月份。此列会返回每行所在月份的第一天。 | 细分 | Date |
是 |
monthEnd |
按月份细分报表;每行及其汇总指标都会拆分为多行,每行对应一个月份。此列会返回每行所在月份的最后一天。 | 细分 | Date |
是 |
quarterStart |
按季度细分报告;每行及其汇总指标都会拆分为多行,每季度占一行。此列会返回每行相应季度的第一天。 | 细分 | Date |
是 |
quarterEnd |
按季度细分报告;每行及其汇总指标都会拆分为多行,每季度占一行。此列会返回每行相应季度的最后一天。 | 细分 | Date |
是 |
weekStart |
按周(从星期日到星期六)将报表细分;每行及其汇总指标都会拆分为多行,每一行对应一个星期。此列会返回每行的第一天(星期日)。 | 细分 | Date |
是 |
weekEnd |
按周(从星期日到星期六)将报表细分;每行及其汇总指标都会拆分为多行,每一行对应一个星期。此列会返回每行的最后一天(星期六)。 | 细分 | Date |
是 |
yearStart |
按年细分报告;每行及其汇总指标都会拆分为多行,每一行对应一年。此列返回每行当年的第一天。 | 细分 | Date |
是 |
yearEnd |
按年细分报告;每行及其汇总指标都会拆分为多行,每一行对应一年。此列返回每行当年的最后一天。 | 细分 | Date |
是 |
deviceSegment |
按设备细分报告;每行及其汇总指标都会拆分为多行,每个设备细分最多对应一行。此列会返回每行的设备细分。 | 细分 | Device segment |
是 |
floodlightGroup |
按 Floodlight 组细分报表;每行及其汇总指标都会拆分为多行,每个 Floodlight 组最多占一行。此列会返回每行对应的 Floodlight 活动组名称。请注意,某些指标没有 Floodlight 细分值,如点击次数和访问次数。 | 细分 | String |
是 |
floodlightGroupId |
按 Floodlight 组细分报表;每行及其汇总指标都会拆分为多行,每个 Floodlight 组最多占一行。此列会返回每行对应的 DS Floodlight 组 ID。请注意,某些指标没有 Floodlight 细分值,如点击次数和访问次数。 | 细分 | ID |
是 |
floodlightGroupTag |
按 Floodlight 组细分报表;每行及其汇总指标都会拆分为多行,每个 Floodlight 组最多占一行。此列会返回每行对应的 Floodlight 组代码。请注意,某些指标没有 Floodlight 细分值,如点击次数和访问次数。 | 细分 | String |
是 |
floodlightActivity |
按 Floodlight 活动细分报表;每行及其汇总指标都会拆分为多行,每个 Floodlight 活动对应一行。此列会返回每行的 Floodlight 活动名称。请注意,某些指标没有 Floodlight 细分值,如点击次数和访问次数。 | 细分 | String |
是 |
floodlightActivityId |
按 Floodlight 活动细分报表;每行及其汇总指标都会拆分为多行,每个 Floodlight 活动对应一行。此列会返回每行对应的 DS Floodlight 活动 ID。请注意,某些指标没有 Floodlight 细分值,如点击次数和访问次数。 | 细分 | ID |
是 |
floodlightActivityTag |
按 Floodlight 活动细分报表;每行及其汇总指标都会拆分为多行,每个 Floodlight 活动对应一行。此列会返回每行对应的 Floodlight 活动代码。请注意,某些指标没有 Floodlight 细分值,如点击次数和访问次数。 | 细分 | String |
是 |
ad |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中的广告名称。 | 细分 | String |
是 |
adId |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的 DS ID。 | 细分 | ID |
是 |
isUnattributedAd |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列用于指明此行中的指标是否无法归因于特定广告。 | 细分 | Boolean |
是 |
adHeadline |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的标题。 | 细分 | String |
是 |
adHeadline2 |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的标题 2。不适用于某些引擎。 | 细分 | String |
是 |
adHeadline3 |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的标题 3。不适用于某些引擎。 | 细分 | String |
是 |
adDescription1 |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的第 1 行广告内容描述。 | 细分 | String |
是 |
adDescription2 |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的第 2 行广告内容描述。 | 细分 | String |
是 |
adDisplayUrl |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的显示网址。 | 细分 | String |
是 |
adLandingPage |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中广告的着陆页。 | 细分 | String |
是 |
adType |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中的广告类型:Text 或 Product 。 |
细分 | Ad type |
是 |
adPromotionLine |
按广告细分报告;每行及其汇总指标都会拆分为多行,每个广告最多占一行。此列会返回每行中的产品广告的促销行。 | 细分 | String |
是 |