版本说明

本页提供了 AdSense Management API 的版本说明。

版本 2

此版本引入了以下更改，以移除已弃用的功能并确保 AdSense Management API 与现行 Google API 标准保持一致。根据 Google API 版本控制方案，此版本将随着时间的推移而更新，以包含其他（向后兼容）功能，而不是在单独的次要版本中发布新功能。

2024-04-03

PolicyIssues

  • 添加了一个新集合，用于报告账号当前违反政策和收到的警告。

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

账号

AdClient

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 为空，则 AdClient 不支持报告。

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

此版本引入了以下功能：

此外，您现在可以访问默认帐号下或特定帐号下的数据。

已知问题

此版本不支持报告中的currency字段。

版本 1

这是该 API 的第一个版本。其中包括检索广告客户、广告单元、自定义渠道、网址渠道以及生成报告的支持。

已知问题

此版本不支持报告中的currency字段。