版本说明

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

版本 2

此版本引入了以下变更，以移除已废弃的功能，并使 AdSense Management API 与当前的 Google API 标准保持一致。根据 Google API 版本方案，此版本将随着时间的推移而更新，以添加其他（向后兼容）功能，而不是以单独的次要版本发布新功能。

2025-02-24

PolicyIssues

• 添加了 policyTopics[].type 字段，用于确定政策主题是政策方面的问题、监管方面的问题还是广告客户偏好设置问题。 这将替换 policyTopics[].must_fix，后者现已标记为已废弃的字段。

2024-04-03

PolicyIssues

• 添加了一个新集合，用于报告账号当前存在的违规行为和警告。

2023-06-19

支付

• payments.list 现在会返回有关付费频道的付款详情。

2023-06-13

报告

• 添加了 FUNNEL_REQUESTS、FUNNEL_IMPRESSIONS、FUNNEL_CLICKS 和 FUNNEL_RPM 指标，这些指标可提供有关非广告单元（例如相关搜索广告单元）效果的信息。

2023-03-30

报告

• 添加了 PAGE_URL 维度，可按网页网址对指标进行细分（存在一些注意事项，请参阅网页网址细分）。

2022-09-21

AdUnits

• 添加了 create 和 patch 方法。请注意，只有启用了 AdSense for Platforms 产品的项目才能使用这些方法。

CustomChannels

• 添加了 create、patch 和 update 方法。请注意，只有启用了 AdSense for Platforms 产品的项目才能使用这些方法。
• 向资源添加了“有效”字段。

账号

• 添加了 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/unpaid，用于查看未付（当前）AdSense 收入。
  • accounts/{account}/payments/yyyy-MM-dd，用于查看 AdSense 付费收入。

2021-06-30

报告

• 添加了维度 AD_FORMAT_NAME 和 AD_FORMAT_CODE，用于指示在您的网站上向用户展示广告的方式（页内广告、穿插广告等）。请注意，v1.4 中存在名称相同但成员不同的（已废弃）维度；v2 中添加的两个维度与 v1.4 中的维度不同。

2021-04-19（初始版本）

常规

• 移除了 v1.4 中的所有已废弃的方法。这包括不需要 accountId 的资源方法。在 v2 中，accountId 在 parent 字段中指定。
• 根据 Google API 标准，资源现在由 name 字段标识。例如，AdClient 的名称如下所示：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 自定义方法实现类似的功能。通过递归调用 listChildAccounts，可以在 v2 中生成完整的子账号树。

AdClient

• 移除了 arc_opt_in 字段，因为该字段已从 AdSense 界面中移除。
• supports_reporting 字段会替换为 reporting_dimension_id 字段，该字段表示 AD_CLIENT_ID 报告维度中使用的广告客户的唯一 ID。如果 reporting_dimension_id 为空，则表示 AdClient 不支持报告。

AdUnit

• status 字段已重命名为 state。 此外，ACTIVE 状态不再指示此广告单元在过去 7 天内的活动情况。在 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 JPY”“$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 字段。