广告系列的效果指标和配置属性。
只有异步请求(即通过 Reports.request() 方法)。
请求摘录
发送普通
Reports.request()
请求正文,但请指定 "reportType": "campaign"
。
{ ... "reportType": "campaign", "columns": [ { "columnName": string, "headerText": string, "startDate": string, "endDate": string } ], "filters": [ { "column": { "columnName": string, }, ... }, ... ], ... }
对于您想在报告中返回或过滤的每一列,
指定下表中列出的 columnName
。
您还可以视需要指定
headerText、
startDate,
和 endDate。
请注意,某些列无法过滤;指“可过滤”。
columnName | 说明 | 行为 | 类型 | 可过滤 |
---|---|---|---|---|
status |
campaignStatus 属性的别名。 |
属性 | Status |
是 |
engineStatus |
外部引擎账号中广告系列的其他状态。可能的状态(取决于外部账号类型)包括“disapproved ”“budget constrained ”等。 |
属性 | 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 |
广告系列的状态:Active 、Paused 或 Removed 。请注意,广告系列、广告组、关键字、广告和定位条件都有自己的状态。查看状态。 |
属性 | Status |
是 |
campaignEngineId |
外部引擎账号中广告系列的 ID。 | 属性 | ID |
是 |
campaignStartDate |
广告系列的开始日期。 | 属性 | Date |
是 |
campaignEndDate |
广告系列的结束日期。 | 属性 | Date |
是 |
bingAdsBudgetType |
Bing Ads 广告系列的预算控制方式:Daily budget 、Monthly even spend 、Monthly accelerated spend 、Daily accelerated spend 或 Daily even spend 。 |
属性 | Microsoft Advertising budget type |
是 |
dailyBudget |
广告系列的每日预算。 | 属性 | Money |
是 |
monthlyBudget |
广告系列的每月预算。 | 属性 | Money |
是 |
deliveryMethod |
广告系列的预算投放方式:Standard 或 Accelerated 。 |
属性 | Budget delivery method |
是 |
adWordsBidStrategy |
Google Ads 为此广告系列使用的出价策略:Manual cpc 、Manual cpm 、Percent cpa 、Budget optimizer 或 Conversion optimizer 。使用 DS 出价策略的广告系列设置为 Manual cpc 或 Manual cpm 。 |
属性 | AdWords bid strategy |
是 |
yahooJapanBidStrategy |
出价策略 Yahoo!JAPAN 用于此广告系列:Manual cpc 或 Budget optimizer 。使用 DS 出价策略的广告系列被设为“Manual cpc ”。 |
属性 | Yahoo! JAPAN bid strategy |
是 |
keywordNearMatchEnabled |
是否为广告系列启用了近似关键字匹配:Enabled 还是Disabled 。 |
属性 | Keyword match setting |
是 |
campaignMobileBidAdjustment |
针对移动设备调整出价的百分比。例如,0.2 表示提高 20%,因此移动设备出价是默认出价的 1.2 倍。有效值的范围因外部引擎而异。 | 属性 | Number |
是 |
campaignTabletBidAdjustment |
针对平板电脑调整出价所依据的百分比。例如,0.2 表示提高 20%,因此平板电脑出价是默认出价的 1.2 倍。有效值的范围因外部引擎而异。 | 属性 | Number |
是 |
campaignDesktopBidAdjustment |
针对桌面设备出价调整的百分比。例如,0.2 表示提高 20%,因此桌面设备出价是默认出价的 1.2 倍。有效值的范围因外部引擎而异。 | 属性 | Number |
是 |
networkTarget |
进行广告活动宣传的广告网络类型。 | 属性 | String |
否 |
yahooGeoTargets |
Yahoo Search Marketing 广告系列的地理位置定位条件。请参阅下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
campaignLabels |
直接分配给该广告系列的标签名称;未包含继承的标签。 | 属性 | String list |
是 |
campaignType |
表示广告系列的类型:Manual 、Inventory 、Inventory - PLA 、Shopping 、Comparison shopping 、Mobile app install 、Universal app 或 Smart shopping 。 |
属性 | Campaign type |
是 |
effectiveBidStrategyId |
分配给此实体或由该实体继承的出价策略的 DS ID。 | 属性 | ID |
是 |
effectiveBidStrategy |
分配给此实体或由该实体继承的出价策略的名称。 | 属性 | String |
是 |
bidStrategyInherited |
指明此实体的出价策略是否继承。 | 属性 | Boolean |
是 |
deviceTargets |
在广告系列一级设置设备定位条件;Desktop 、Mobile 、Tablet 或 Other 的组合。 |
属性 | String |
否 |
effectiveDeviceTargets |
在广告系列一级设置设备定位条件;Desktop 、Mobile 、Tablet 或 Other 的组合。 |
属性 | String |
否 |
languageTargets |
广告系列级语言定位。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
countryTargets |
广告系列中包含的国家/地区定位条件。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
provinceTargets |
广告系列中包含的省/自治区/直辖市定位条件。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
metroTargets |
广告系列中包含的都市圈定位条件。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
cityTargets |
广告系列中包含的目标城市。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
effectiveCountryTargets |
广告系列中包含的国家/地区定位条件。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
effectiveProvinceTargets |
广告系列中包含的省/自治区/直辖市定位条件。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
effectiveMetroTargets |
广告系列中包含的都市圈定位条件。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
effectiveCityTargets |
广告系列中包含的目标城市。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
excludedCountryTargets |
国家/地区定位条件已从广告系列中排除。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
excludedProvinceTargets |
州/省/自治区/直辖市定位条件已从广告系列中排除。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
excludedMetroTargets |
都市圈定位条件已从广告系列中排除。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
excludedCityTargets |
城市定位条件已从广告系列中排除。下载上传模板和地理位置/语言代码。 | 属性 | String |
否 |
effectiveLabels |
继承或直接分配给此广告系列的所有标签的名称。 | 属性 | String list |
是 |
clicksWithFeedItemShowing |
在 Feed 项显示期间点击广告中的任何链接。此列只会在 Feed 项报告或按“Feed 项”列细分的报告中返回值。 | 指标 | Integer |
是 |
costWithFeedItemShowing |
在 Feed 项显示时所有广告的费用。此列只会在 Feed 项报告或按“Feed 项”列细分的报告中返回值。 | 指标 | Money |
是 |
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 |
是 |
searchImpressionShare |
仅适用于 Google Ads 和 Bing Ads。您在搜索网络中实际获得的展示次数除以您有资格获得的估算展示次数所得到的百分比。以 0.1 到 1 之间的数字的形式返回,如果份额小于 0.1,则返回字符串 < 10% 。 |
指标 | Impression share |
是 |
searchBudgetLostImpressionShare |
仅适用于 Google Ads 和 Bing Ads。广告因预算不足而未能在搜索网络上展示的次数百分比。以 0 到 0.9 之间的数字的形式返回,如果份额大于 0.9,则返回字符串 > 90% 。 |
指标 | Impression share |
是 |
searchRankLostImpressionShare |
仅适用于 Google Ads 和 Bing Ads。广告因广告评级较低而未能在搜索网络上展示的次数百分比。以 0 到 0.9 之间的数字的形式返回,如果份额大于 0.9,则返回字符串 > 90% 。 |
指标 | Impression share |
是 |
displayImpressionShare |
仅限 Google Ads。您在展示广告网络中实际获得的展示次数除以您有资格获得的估算展示次数所得到的百分比。以 0.1 到 1 之间的数字的形式返回,如果份额小于 0.1,则返回字符串 < 10% 。 |
指标 | Impression share |
是 |
displayBudgetLostImpressionShare |
仅限 Google Ads。该列是指广告因预算不足而未能在展示广告网络上获得的展示次数所占的百分比。以 0 到 0.9 之间的数字的形式返回,如果份额大于 0.9,则返回字符串 > 90% 。 |
指标 | Impression share |
是 |
displayRankLostImpressionShare |
仅限 Google Ads。广告因广告评级较低而未能在展示广告网络上获得的展示次数所占的百分比。以 0 到 0.9 之间的数字的形式返回,如果份额大于 0.9,则返回字符串 > 90% 。 |
指标 | Impression share |
是 |
qualityScoreAvg |
仅适用于 Google Ads 和 Bing Ads。引擎质量得分 (QS) 按展示次数加权平均,针对报告范围内所有日期和关键字。 | 指标 | Number |
是 |
topOfPageBidAvg |
仅限 Google Ads。此列可以估算出在报表时间范围内要让广告定期显示在搜索结果上方页首位置所需的平均 CPC 出价。 | 指标 | Money |
是 |
absoluteTopImpressionPercentage |
广告在自然搜索结果上方作为头条广告进行展示的次数所占百分比。 | 指标 | Impression share |
是 |
searchAbsoluteTopImpressionShare |
您实际获得的绝对页首(自然搜索结果上方的头条广告)展示次数除以您有资格获得的估算页首展示次数所得到的百分比。 | 指标 | Impression share |
是 |
topImpressionPercentage |
在自然搜索结果上方任意位置展示广告的展示次数所占的百分比。 | 指标 | Impression share |
是 |
searchTopImpressionShare |
您实际获得的页首(自然搜索结果上方的任意位置)展示次数除以您有资格获得的估算页首展示次数所得到的百分比。 | 指标 | Impression share |
是 |
searchBudgetLostAbsoluteTopImpressionShare |
估算您的广告因预算不足而未能在自然搜索结果上方作为首条广告进行展示的频率。 | 指标 | Impression share |
是 |
searchBudgetLostTopImpressionShare |
可帮助您了解广告因预算不足而未能在自然搜索结果上方任意位置展示的频率。 | 指标 | Impression share |
是 |
searchRankLostAbsoluteTopImpressionShare |
估算您的广告因广告评级较低而未能在自然搜索结果上方作为首条广告进行展示的频率。 | 指标 | Impression share |
是 |
searchRankLostTopImpressionShare |
估算您的广告因广告评级较低而未能在自然搜索结果上方任意位置展示的频率。 | 指标 | Impression share |
是 |
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 |
是 |
sitelinkDisplayText |
按附加链接细分报告;每行及其汇总指标都会拆分为多行,每行对应一个附加链接。此列会返回每行的附加链接显示文字。 | 细分 | String |
是 |
sitelinkDescription1 |
按附加链接细分报告;每行及其汇总指标都会拆分为多行,每行对应一个附加链接。此列会返回每行的附加链接说明 1。 | 细分 | String |
是 |
sitelinkDescription2 |
按附加链接细分报告;每行及其汇总指标都会拆分为多行,每行对应一个附加链接。此列会返回每行的附加链接说明 2。 | 细分 | String |
是 |
sitelinkLandingPageUrl |
按附加链接细分报告;每行及其汇总指标都会拆分为多行,每行对应一个附加链接。此列会返回相应附加链接在各行中的着陆页网址。 | 细分 | String |
是 |
sitelinkClickserverUrl |
按附加链接细分报告;每行及其汇总指标都会拆分为多行,每行对应一个附加链接。此列会返回每行的附加链接的 Clickserver 网址。 | 细分 | String |
是 |
locationBusinessName |
按与商家资料账号相关联的升级版附加地址信息细分报告;每行及其汇总指标都会拆分为多行,每个具有可用指标的地理位置对应一行。此列会返回每行对应的营业地点商家名称。 | 细分 | String |
是 |
locationCategory |
按与商家资料账号相关联的升级版附加地址信息细分报告;每行及其汇总指标都会拆分为多行,每个具有可用指标的地理位置对应一行。此列会返回每行的营业地点类别。 | 细分 | String |
是 |
locationDetails |
按与商家资料账号相关联的升级版附加地址信息细分报告;每行及其汇总指标都会拆分为多行,每个具有可用指标的地理位置对应一行。此列会返回有关每行中营业地点的详细信息。 | 细分 | String |
是 |
locationFilter |
按与商家资料账号相关联的升级版附加地址信息细分报告;每行及其汇总指标都会拆分为多行,每个具有可用指标的地理位置对应一行。此列会返回各行的地理位置过滤条件。 | 细分 | String |
否 |
callPhoneNumber |
按附加电话信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加电话信息。此列会返回附加电话信息的电话号码。 | 细分 | String |
是 |
callCountryCode |
按附加电话信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加电话信息。此列会返回各行中附加电话信息的国家/地区代码。 | 细分 | String |
是 |
callIsTracked |
按附加电话信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加电话信息。如果跟踪附加电话信息的来电次数,此列返回 true,否则返回 false。 | 细分 | Boolean |
是 |
callCallOnly |
按附加电话信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加电话信息。如果附加电话信息仅显示电话号码,此列返回 true;如果该附加电话信息同时显示电话号码和链接,此列返回 false。 | 细分 | Boolean |
是 |
callConversionTracker |
按附加电话信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加电话信息。此列返回与 Feed 项相关联的转化跟踪器的名称(如果存在)。 | 细分 | String |
是 |
callConversionTrackerId |
按附加电话信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加电话信息。此列返回与附加电话信息相关联的转化跟踪器的 ID(如果存在)。 | 细分 | ID |
是 |
appId |
按附加应用信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加应用信息。此列会返回应用 ID(如果存在)。 | 细分 | String |
是 |
appStore |
按附加应用信息细分报告;每行及其汇总指标都会拆分为多行,每行对应一条附加应用信息。此列会返回应用商店类型(Apple App Store、Google Play Store)(如果存在)。 | 细分 | App store |
是 |
feedItemId |
按 Feed 项细分报告;每行及其汇总指标都会拆分为多个行,每个 Feed 项对应一行。此列会返回各行的 DS Feed 项行 ID。 | 细分 | ID |
是 |
feedId |
按 Feed 项细分报告;每行及其汇总指标都会拆分为多个行,每个 Feed 项对应一行。此列会返回每行的 DS Feed 表格 ID。 | 细分 | ID |
是 |
feedType |
按 Feed 项细分报告;每行及其汇总指标都会拆分为多个行,每个 Feed 项对应一行。此列会返回各行的 Feed 项类型。 | 细分 | Feed type |
是 |