Using the Ad Experience Report API

The Ad Experience Report API is a publicly available, open API (application programming interface) that allows you to get:

  • A list of sites that have a status of "Failing."
  • The status of any site.

The API lets developers build applications that interact directly with the Ad Experience Report. 

To learn more (English only), read the Ad Experience Report API documentation.

If you're not a developer, you can use the APIs explorer

If you're not a developer but want to use the Ad Experience Report API, you can do so via the APIs explorer to:

Get a list of sites that have a status of "Failing"

Note that sites that have a review status of "Passing" or "Not reviewed" ARE NOT included in the violatingSites response
  1. Visit the Ad Experience Report APIs explorer at https://developers.google.com/apis-explorer/#s/adexperiencereport/v1/adexperiencereport.violatingSites.list
  2. Click the Use field editor link.
  3. Enable the "violatingSites" check box, or the check boxes next to any other fields you'd like included in the API response.

    Ad Experience Report violating sites fields
    Above: fields to be returned by the API

  4. Click Close.
  5. Click Authorize and Execute if this is the first session using the explorer, or Execute if you're already authorized.

In the "Response" area of the page, sites that are in "Failing" status are listed. Results for both desktop and mobile environments are listed if those fields were selected.

Get the status of any site

  1. Visit the Ad Experience Report APIs explorer at https://developers.google.com/apis-explorer/#s/adexperiencereport/v1/adexperiencereport.sites.get
  2. In the name field, enter site/ followed by the URL-encoded site name. For example, for https://www.google.com, you'd enter site/https%3A%2F%2Fwww.google.com.
  3. To the right of fields, click the Use fields editor link.
  4. Use the selector to specify the fields you'd like returned in the API response. For example, select desktopSummary to include the status of the desktop site's compliance with the Better Ads Standards and, by default, the site's region and various other responses.

    Ad Experience Report API GET fields
    Above: fields to be returned by the API

  5. Click Close
  6. Click Authorize and Execute if this is the first session using the explorer, or Execute if you're already authorized. 

In the "Response" area of the page, responses for the fields you specified are listed for the named site.

Was this helpful?
How can we improve it?