# Release Notes

This page provides release notes for the AdSense Management API.

### Version 2

This version introduces the following changes in order to remove deprecated
functionality and to align the AdSense Management API with
[current Google API standards](https://google.aip.dev/). Per the [Google API versioning
scheme](https://cloud.google.com/apis/design/versioning), this version will be updated over time to include additional
(backwards compatible) functionality rather than new functionality being
released in separate minor versions.

#### 2026-02-05

**Reports**

- Added the `OS_TYPE`, `BROWSER_TYPE`, and `WEBVIEW_TYPE` dimensions, which allow metrics to be broken down by operating system, browser, and hosting app (webview). For more information, see the [Operating
  system breakdown](https://support.google.com/adsense/answer/16853822), [Browser
  breakdown](https://support.google.com/adsense/answer/16851903), and [Hosting app
  breakdown](https://support.google.com/adsense/answer/16853515) help center articles.

#### 2025-10-02

**Reports**

- Added the `TRAFFIC_SOURCE` dimension, which allows metrics to be broken down by traffic source (e.g. "Google", "Bing", "Facebook", "Other"). For more information, see [Traffic source breakdown](https://support.google.com/adsense/answer/16474600).

#### 2025-05-06

**PolicyIssues**

- The deprecated `policyTopics[].must_fix` field (see previous update) will now always be set to `false`.

#### 2025-02-24

**PolicyIssues**

- Added a `policyTopics[].type` field to identify whether a policy topic represents a [policy issue, regulatory issue, or advertiser preference](https://support.google.com/adsense/answer/15689616). This replaces `policyTopics[].must_fix`, which is now marked as a deprecated field.

#### 2024-04-03

**PolicyIssues**

- Added a new collection to report on current policy violations and warnings present for an account.

#### 2023-06-19

**Payments**

- payments.list now returns details about payments for premium publishers.

#### 2023-06-13

**Reports**

- Added the `FUNNEL_REQUESTS`, `FUNNEL_IMPRESSIONS`, `FUNNEL_CLICKS`, and `FUNNEL_RPM` metrics, which provide information about the performance of non-ad units (for example, related search units).

#### 2023-03-30

**Reports**

- Added the `PAGE_URL` dimension, which allows metrics to be broken down by page URL (with some caveats, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478)).

#### 2022-09-21

**AdUnits**

- Added create and patch methods. Note that these methods can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

**CustomChannels**

- Added create, patch and update methods. Note that these methods can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.
- Added the active field to the resource.

**Accounts**

- Added the getAdBlockingRecoveryTag method.

#### 2022-08-25

**Reports**

- Added the `HOSTED_AD_CLIENT_ID` dimension, which allows host and platform publishers to break down metrics by their publisher's accounts (host publishers) and by sub-accounts (platform publishers).

#### 2022-05-03

**AdClient**

- Added get method.

**Reports**

- Added getSaved method.

**UrlChannels**

- Added get method.

#### 2022-03-31

**Account**

- Inactive accounts are now returned by the API, with a `state` field [indicating the
  state of the account](https://developers.google.com/adsense/management/reference/rest/v2/accounts#State).

**AdClient**

- Similar to the Account changes, inactive ad clients are now returned by the API, with a `state` field [indicating the
  state of the ad client](https://developers.google.com/adsense/management/reference/rest/v2/accounts.adclients#State).

#### 2022-02-24

**Payment**

- The resource name format has been extended to support separate resources for YouTube earnings. This change is prior to the phased rollout of the [improved AdSense
  experience for YouTube creators](https://support.google.com/adsense/answer/11622510), in which YouTube earnings will be separated into its own payments account. YouTube payment information will also be returned from the payments list method, once you have a [dedicated payments
  account for YouTube earnings](https://support.google.com/adsense/answer/11558397). YouTube earnings will have the following resource name format:
  - accounts/{account}/payments/youtube-unpaid for unpaid (current) YouTube earnings.
  - accounts/{account}/payments/youtube-yyyy-MM-dd for paid YouTube earnings.

  <br />

  **Note:** The resource names for AdSense earnings remain unchanged:
  - accounts/{account}/payments/unpaid for unpaid (current) AdSense earnings.
  - accounts/{account}/payments/yyyy-MM-dd for paid AdSense earnings.

#### 2021-06-30

**Report**

- Added dimensions `AD_FORMAT_NAME` and `AD_FORMAT_CODE`, indicating the way an ad is shown to the users on your site (in-page, vignette, etc). Note that v1.4 had (deprecated) dimensions with the same names but different members; the two dimensions added in v2 are distinct from those that were present in v1.4.

#### 2021-04-19 (Initial release)

**General**

- All deprecated methods in v1.4 have been removed. This includes resource methods that did not require an `accountId`. In v2, the `accountId` is specified in the `parent` field.
- Per Google API standards, resources are now identified by a `name` field. For example, an AdClient's name would look like `accounts/{accountId}/adclients/{adClientId}`. Additionally, in v1.4 the resource ID was used as a reporting dimension, but in v2 that value is now available through a `reporting_dimension_id` field on several resources.
- The `kind` field has been removed from all resources.

**Account**

- The `name` field has been changed to `display_name`.
- The `timezone` field has been changed from a string to a `google.type.TimeZone`.
- The `creation_time` field (type int64) has been changed to `create_time` (type `google.protobuf.Timestamp`).
- Added a `pending_tasks` field which is a list of outstanding tasks that need to be completed as part of the sign-up process for a new account. For example, tasks could be related to your billing profile or phone verification.
- The `sub_accounts` field has been removed. Similar functionality can be achieved in v2 with the `listChildAccounts` custom method. The full child account tree can be generated in v2 by calling `listChildAccounts` recursively.

**AdClient**

- Removed the `arc_opt_in` field since it has already been removed from the AdSense UI.
- The `supports_reporting` field is replaced with the `reporting_dimension_id` field, which represents the unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. If `reporting_dimension_id` is empty, then the AdClient doesn't support reporting.

**AdUnit**

- The `status` field has been renamed to `state`. Also, the `ACTIVE` state no longer indicates whether there has been activity on this ad unit in the last seven days. In v2, it means the ad unit has been activated by the user and can serve ads.
- The `code` field has been removed. This value can still be found at the end of the `name` field (after the last forward slash).
- The `contentAdsSettings.backupOption` field has been removed.
- The `type` field has been restricted to the values `TYPE_UNSPECIFIED`, `DISPLAY`, `FEED`, `ARTICLE`, `MATCHED_CONTENT`, and `LINK`.
- Other fields that have already been removed in the AdSense UI are also removed: `custom_style`, `saved_style_id`, ` mobile_content_ads_settings`, `feed_ads_settings`.

**Alert**

- The `delete` method has been removed.
- The `is_dismissible` field has been removed.
- The `locale` field has been renamed to `language_code`.

**CustomChannel**

- The `code` field has been removed. This value can still be found at the end of the `name` field (after the last forward slash).
- The `targeting_info` field has been removed since it has already been removed from the AdSense UI.

**Payment**

- The `payment_date` field has been renamed to `date` and changed from type string to type `google.type.Date`.
- The `payment_amount` field and the `payment_amount_currency_code` field have been combined into a single `payment` field (e.g., "¥1,235 JPY", "$1,234.57", "£87.65").

**Report**

- With v2, the AdSense Management API reporting data now aligns with the AdSense UI. This means that AdMob and YouTube properties are no longer supported. Additionally, the API will only support report data going back 3 years.
- The `Metadata.dimensions` resource and the `Metadata.metrics` resource have been removed.
- New methods have been added to generate a CSV version of the report, replacing the query parameters in v1.4. Note: for compression, you can still use the HTTP header "Accept-Encoding: gzip".
- Some fields have been changed on ad hoc report generation.
  - The `account_id` field has been renamed to `account`.
  - The `dimension` field has been renamed to `dimensions`.
  - The `metric` field has been renamed to `metrics`.
  - The `filter` field has been renamed to `filters`.
  - The `sort` field has been renamed to `order_by`.
  - The `locale` field has been renamed to `language_code`.
  - The `currency` field has been renamed to `currency_code`.
  - You can now specify several common ranges with `date_range` (e.g., `TODAY`, `YESTERDAY`, `MONTH_TO_DATE`, `YEAR_TO_DATE`, `LAST_7_DAYS`, and `LAST_30_DAYS`), or you can specify a `start_date` and `end_date` by setting `date_range` to `CUSTOM`.
  - The `start_date` and `end_date` fields have been changed from type string to type `google.type.Date`. Note: as a result, relative date keywords (e.g., "today-6d") are no longer supported.
  - The boolean field `use_timezone_reporting` has been replaced with `reporting_time_zone`, which can have one of two values: `ACCOUNT_TIME_ZONE` or `GOOGLE_TIME_ZONE` (which means PST/PDT). The default in v2 is `ACCOUNT_TIME_ZONE`, which differs from the default in v1.4.
  - The `start_index` field has been removed.
  - The `max_results` field has been renamed to `limit`.
- Some fields have been changed on saved report generation.
  - Added date fields (`date_range`, `start_date`, `end_date`, `reporting_time_zone`).
  - Added a `currency_code` field.
  - The `locale` field has been renamed to `language_code`.
  - The `start_index` field has been removed.
  - The `max_results` field has been removed.

**SavedAdStyle**

- `SavedAdStyle` has been removed since it has already been removed from the AdSense UI.

**Site**

- `Sites` have been added to fetch data about websites you've added to your AdSense account.
- The `state` field represents whether the site is any of the following states: `REQUIRES_REVIEW`, `GETTING_READY`, `READY`, `NEEDS_ATTENTION`.
- The `auto_ads_enabled` field is a boolean that represents whether auto ads have been enabled on a particular site.

### Version 1.4

This version introduces the following functionality:

- You can now list your AdSense account payments in the corresponding currency.
- You can now dismiss an alert by calling the `delete` method that will hide the alert in the API and AdSense web interface.
- The report response now includes start and end dates. This is important if you're using relative dates when generating reports (such as `today`, `yesterday`, `firstDayOfMonth-1m`), the response now includes the date range you requested.

**Known Issues**

The `currency` field in reports is not supported in this release.

### Version 1.3

This version introduces the following functionality:

- The ability to retrieve alerts.
- The ability to retrieve metrics and dimensions metadata.
- The ability to run reports in the account's local time zone.

**Known Issues**

The `currency` field in reports is not supported in this release.

### Version 1.2

This version introduces the following functionality:

- The ability to retrieve ad styles.
- The ability to retrieve and execute the saved reports defined in the frontend.

**Known Issues**

The `currency` field in reports is not supported in this release.

### Version 1.1

This version introduces the following functionality:

- The ability to [list accounts](https://developers.google.com/adsense/management/v2/reference/accounts.adclients/list) to which the user has access
- The ability to do a GET call on a [specific account](https://developers.google.com/adsense/management/v2/reference/accounts/get)
- The ability to do GET calls on [ad units](https://developers.google.com/adsense/management/v2/reference/accounts/adclients/adunits/get) and [custom channels](https://developers.google.com/adsense/management/v2/reference/accounts/adclients/customchannels/get)
- The ability to determine the [connections](https://developers.google.com/adsense/management/v2/reference/accounts/adclients/adunits/customchannels/list) between ad units and custom channels
- Custom channels contain more data about targeting information

In addition, you can now access data either under your default account or under a specific account.

**Known Issues**

The `currency` field in reports is not supported in this release.

### Version 1

This is the first release of the API. It includes support for retrieving ad clients,
ad units, custom channels, URL channels, as well as to run reports.

**Known Issues**

The `currency` field in reports is not supported in this release.