本页提供了 AdSense Management API 的版本说明。
版本 2
此版本引入了以下更改,以移除已弃用的功能,并使 AdSense Management API 与现行 Google API 标准保持一致。根据 Google API 版本控制方案,此版本将不断更新,以包含其他(向后兼容)功能,而不是在单独的次要版本中发布新功能。
2023-06-19
付款
- payments.list 现在会返回有关 premium 发布商付款的详细信息。
2023-06-13
报告
- 添加了
FUNNEL_REQUESTS
、FUNNEL_IMPRESSIONS
、FUNNEL_CLICKS
和FUNNEL_RPM
指标,这些指标可提供有关非广告单元(例如相关搜索单元)的广告效果的信息。
2023-03-30
报告
- 新增了
PAGE_URL
维度,以便按网页网址对指标进行细分(有一些注意事项,请参阅网页网址细分)。
2022-09-21
AdUnits
- 添加了 create 和 patch 方法。请注意,这些方法只能由启用了 AdSense 平台广告产品的项目使用。
CustomChannels
- 添加了 create、patch 和 update 方法。请注意,这些方法只能由启用了 AdSense 平台广告产品的项目使用。
- 向资源添加了活跃字段。
账号
- 添加了 getAdBlockingRecoveryTag 方法。
2022-08-25
报告
- 新增了
HOSTED_AD_CLIENT_ID
维度,以便托管发布商和平台发布商按发布商的帐号(托管发布商)和子帐号(平台发布商)对指标进行细分。
2022-05-03
AdClient
- 新增了 get 方法。
报告
- 添加了 getSaved 方法。
UrlChannels
- 新增了 get 方法。
2022-03-31
账号
- 现在,该 API 会返回非活跃帐号,并使用一个
state
字段来指示帐号的状态。
AdClient
- 与上述帐号更改类似,API 现在会返回无效广告客户,并提供一个
state
字段,指示相应广告客户的状态。
2022-02-24
付款
-
资源名称格式经过扩展,可支持针对 YouTube 收入使用单独的资源。在此次变更之前,我们将分阶段推出为 YouTube 创作者改进 AdSense 体验,届时,YouTube 收入会划分到各自的付款帐号中。您拥有用于 YouTube 收入的专用付款帐号后,系统还会通过付款列表方法返回 YouTube 付款信息。YouTube 收入将采用以下资源名称格式:
- accounts/{account}/payments/youtube-unpaid 用于支付未付(当前)YouTube 收入。
- accounts/{account}/payments/youtube-yyyy-MM-dd(针对已支付的 YouTube 收入)。
注意:AdSense 收入的资源名称保持不变:- accounts/{account}/payments/未支付的未付(当前)AdSense 收入。
- accounts/{account}/payments/yyyy-MM-dd(已付 AdSense 收入)。
2021-06-30
报告
- 添加了维度
AD_FORMAT_NAME
和AD_FORMAT_CODE
,以指明广告在您的网站上向用户展示的方式(页内、穿插广告等)。请注意,v1.4 中的维度名称相同但成员不同(已废弃);v2 中添加的两个维度与 v1.4 中的维度不同。
2021 年 4 月 19 日(初始版本)
常规
- v1.4 中所有已弃用的方法都已移除。这包括不需要
accountId
的资源方法。在 v2 中,accountId
在parent
字段中指定。 - 根据 Google API 标准,资源现在由
name
字段标识。例如,9 的名称应类似于accounts/{accountId}/adclients/{adClientId}
。此外,在 v1.4 中,资源 ID 曾用作报告维度,但在 v2 中,该值现在可通过多种资源的reporting_dimension_id
字段获取。 kind
字段已从所有资源中移除。
账号
name
字段已更改为display_name
。timezone
字段已从字符串更改为google.type.TimeZone
。creation_time
字段(类型 int64)已更改为create_time
(类型google.protobuf.Timestamp
)。- 新增了
pending_tasks
字段,该字段用于列出在注册新帐号时需要完成的待处理任务。例如,任务可能与结算资料或电话验证有关。 sub_accounts
字段已移除。在 v2 中,您可以使用listChildAccounts
自定义方法实现类似的功能。在 v2 中,可以通过递归调用listChildAccounts
来生成完整的子帐号树。
AdClient
- 移除了
arc_opt_in
字段,因为它已从 AdSense 界面中移除。 supports_reporting
字段已替换为reporting_dimension_id
字段,该字段表示AD_CLIENT_ID
报告维度中使用的广告客户的唯一 ID。如果reporting_dimension_id
为空,则 9 不支持报告。
AdUnit
status
字段已重命名为state
。此外,ACTIVE
状态将不再指示此广告单元在过去七天内是否有活动。在 v2 中,它表示广告单元已被用户激活,可以投放广告。code
字段已移除。您仍然可以在name
字段的末尾(最后一个正斜杠之后)找到此值。contentAdsSettings.backupOption
字段已移除。type
字段仅限于TYPE_UNSPECIFIED
、DISPLAY
、FEED
、ARTICLE
、MATCHED_CONTENT
和LINK
值。- AdSense 界面中已移除的其他字段也会一并移除:
custom_style
、saved_style_id
、mobile_content_ads_settings
、feed_ads_settings
。
提醒
- 移除了
delete
方法。 is_dismissible
字段已移除。locale
字段已重命名为language_code
。
CustomChannel
code
字段已移除。您仍然可以在name
字段的末尾(最后一个正斜杠之后)找到此值。targeting_info
字段已被移除,因为该字段已从 AdSense 界面中移除。
付款
payment_date
字段已重命名为date
,并从类型字符串更改为google.type.Date
。payment_amount
字段和payment_amount_currency_code
字段已合并为单个payment
字段(例如,“1,235 日元”“$1,234.57”“£87.65”)。
报告
- 在 v2 中,AdSense Management API 报告数据现在与 AdSense 界面保持一致。这意味着 AdMob 和 YouTube 媒体资源已不再受支持。此外,该 API 仅支持过去 3 年的报告数据。
- 已移除
Metadata.dimensions
资源和Metadata.metrics
资源。 - 新增了一些方法来生成 CSV 版本的报告,替换了 v1.4 中的查询参数。注意:若要进行压缩,您仍可以使用 HTTP 标头“Accept-Encoding: gzip”。
-
在生成临时报表时,某些字段已更改。
account_id
字段已重命名为account
。dimension
字段已重命名为dimensions
。metric
字段已重命名为metrics
。filter
字段已重命名为filters
。sort
字段已重命名为order_by
。locale
字段已重命名为language_code
。currency
字段已重命名为currency_code
。- 您现在可以使用
date_range
指定多个常用范围(例如,TODAY
、YESTERDAY
、MONTH_TO_DATE
、YEAR_TO_DATE
、LAST_7_DAYS
和LAST_30_DAYS
),或者您也可以通过将date_range
设置为CUSTOM
来指定start_date
和end_date
。 start_date
和end_date
字段已从字符串类型更改为google.type.Date
。注意:因此,相对日期关键字(例如,“today-6d”)将不再受支持。- 布尔值字段
use_timezone_reporting
已替换为reporting_time_zone
,后者可以有两个值之一:ACCOUNT_TIME_ZONE
或GOOGLE_TIME_ZONE
(表示 PST/PDT)。v2 中的默认值为ACCOUNT_TIME_ZONE
,这与 v1.4 中的默认值不同。 start_index
字段已移除。max_results
字段已重命名为limit
。
-
某些字段在已保存的报表生成时发生了更改。
- 添加了日期字段(
date_range
、start_date
、end_date
、reporting_time_zone
)。 - 添加了
currency_code
字段。 locale
字段已重命名为language_code
。start_index
字段已移除。max_results
字段已移除。
- 添加了日期字段(
SavedAdStyle
SavedAdStyle
已被移除,因为它已从 AdSense 界面中移除。
网站
-
已添加
Sites
,用于提取您已添加到 AdSense 帐号中的网站的相关数据。 state
字段表示网站是否处于以下任何状态:REQUIRES_REVIEW
、GETTING_READY
、READY
、NEEDS_ATTENTION
。auto_ads_enabled
字段是一个布尔值,表示特定网站是否已启用自动广告。
版本 1.4
此版本引入了以下功能:
- 您现在能够以相应的币种列出您的 AdSense 帐号付款。
- 您现在可以通过调用
delete
方法来关闭提醒,该方法会在 API 和 AdSense 网页界面中隐藏提醒。 - 报告响应现在包含开始日期和结束日期。如果您在生成报告时使用相对日期(例如
today
、yesterday
、firstDayOfMonth-1m
),这一点非常重要,因为响应现在会包含您请求的日期范围。
已知问题
此版本不支持报告中的currency
字段。
1.3 版
此版本引入了以下功能:
- 检索提醒的功能。
- 检索指标和维度元数据的功能。
- 能够按照帐号的当地时区生成报告。
已知问题
此版本不支持报告中的currency
字段。
1.2 版
此版本引入了以下功能:
- 检索广告样式的功能。
- 能够检索并执行在前端中定义的已保存报告。
已知问题
此版本不支持报告中的currency
字段。
版本 1.1
此版本引入了以下功能:
- 能够列出用户有访问权限的帐号
- 能够对特定帐号执行 GET 调用
- 对广告单元和自定义渠道进行 GET 调用的功能
- 确定广告单元和自定义渠道之间的关联的功能
- 自定义渠道包含有关定位信息的更多数据
此外,您现在可以访问默认帐号或特定帐号下的数据。
已知问题
此版本不支持报告中的currency
字段。
版本 1
这是此 API 的第一个版本。它支持检索广告客户、广告单元、自定义渠道、网址渠道以及生成报告。
已知问题
此版本不支持报告中的currency
字段。