根据提供的规范生成广告系列报告。
HTTP 请求
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
要为其生成报告的帐号的资源名称。示例:accounts/pub-9876543210987654 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"reportSpec": {
object ( |
字段 | |
---|---|
reportSpec |
广告系列报告规范。 |
响应正文
广告系列报告 API 响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"rows": [
{
object ( |
字段 | |
---|---|
rows[] |
来自指定发布商的广告系列报表数据。该 API 最多返回 100,000 行。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
有关详情,请参阅 OAuth 2.0 概览。
CampaignReportSpec
用于生成广告系列报告的规范。例如,获取按 CAMPAIGN_ID 划分的 IMPRESSIONS 和 CLICK 的规范可能如下例所示:
{
"dateRange": {
"startDate": {"year": 2021, "month": 12, "day": 1},
"endDate": {"year": 2021, "month": 12, "day": 30}
},
"dimensions": ["CAMPAIGN_ID"],
"metrics": ["IMPRESSIONS", "CLICKS"],
}
JSON 表示法 |
---|
{ "dateRange": { object ( |
字段 | |
---|---|
dateRange |
所生成的报告的日期范围。范围上限为 30 天。 |
dimensions[] |
报告的维度列表。这些维度的值组合决定了报告对应的行。如果未指定维度,报告会返回整个帐号所请求的指标的一行。 |
metrics[] |
报告的指标列表。报告必须至少指定一个指标。 |
languageCode |
任何本地化文字(例如某些适用的维度值)所使用的语言。语言标记在 IETF BCP47 中定义。如果未指定或无效,则默认为“en-US”。 |
维度
广告系列报告的维度。
枚举 | |
---|---|
DIMENSION_UNSPECIFIED |
未指定维度的默认值。请勿使用。 |
DATE |
采用 YYYYMMDD 格式的日期(例如“20210701”)。 |
CAMPAIGN_ID |
广告系列的唯一 ID,例如“123456789”,与广告系列列表 API 中的广告系列 ID 一致。 |
CAMPAIGN_NAME |
广告系列的名称。 |
AD_ID |
广告的唯一 ID,例如“123456789”。 |
AD_NAME |
广告的名称,可能不是唯一的。 |
PLACEMENT_ID |
广告展示位置的应用的供应商特定唯一 ID。例如,对于 Android 应用,为 com.goog.bar,对于 iOS 应用,为 123456789。 |
PLACEMENT_NAME |
展示广告的应用的名称。 |
PLACEMENT_PLATFORM |
用于展示广告的应用平台。 |
COUNTRY |
目标国家/地区的名称。 |
FORMAT |
广告单元的格式(例如“横幅”“原生”),即广告投放维度。 |
指标
广告系列报告的指标。
枚举 | |
---|---|
METRIC_UNSPECIFIED |
未设置的字段的默认值。请勿使用。 |
IMPRESSIONS |
广告向用户展示的次数。 |
CLICKS |
用户点击广告的次数。 |
CLICK_THROUGH_RATE |
广告获得的点击次数除以其展示次数所得的比值。 |
INSTALLS |
应用下载到设备的次数。 |
ESTIMATED_COST |
投放广告系列广告(而非赚取收入的广告)的估算费用。币种是广告系列的收入报告所用币种。 |
AVERAGE_CPI |
平均每次安装费用。也就是说,为获取一位新用户所花费的平均金额。币种是广告系列的收入报告所用币种。 |
INTERACTIONS |
用户与广告互动的次数。其中包括点击次数和互动次数。 |