REST Resource: accounts.sites
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Site
Representation of a Site.
| JSON representation |
{
"name": string,
"reportingDimensionId": string,
"domain": string,
"state": enum (State),
"autoAdsEnabled": boolean
} |
| Fields |
name |
string
Output only. Resource name of a site. Format: accounts/{account}/sites/{site}
|
reportingDimensionId |
string
Output only. Unique ID of the site as used in the OWNED_SITE_ID reporting dimension.
|
domain |
string
Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the OWNED_SITE_DOMAIN_NAME reporting dimension.
|
state |
enum (State)
Output only. State of a site.
|
autoAdsEnabled |
boolean
Whether auto ads is turned on for the site.
|
State
| Enums |
STATE_UNSPECIFIED |
State unspecified. |
REQUIRES_REVIEW |
Either:
|
GETTING_READY |
Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks. |
READY |
The site is ready to show ads. Learn how to set up ads on the site. |
NEEDS_ATTENTION |
Publisher needs to fix some issues before the site is ready to show ads. Learn what to do if a new site isn't ready. |
Methods |
|
|
Gets information about the selected site. |
|
|
Lists all the sites available in an account. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[null,null,["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eA Site resource represents a website or domain within your AdSense account and provides information like its name, domain, and current state.\u003c/p\u003e\n"],["\u003cp\u003eSites can be in various states, such as requiring review, getting ready, ready to show ads, or needing attention due to issues.\u003c/p\u003e\n"],["\u003cp\u003eYou can get information about a specific site or list all sites associated with your AdSense account using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eA site's JSON representation includes fields for name, reporting dimension ID, domain, state, and whether auto ads are enabled.\u003c/p\u003e\n"],["\u003cp\u003eSite state is crucial for ad serving, with states like "READY" indicating ad readiness and "NEEDS_ATTENTION" signifying issues requiring publisher action.\u003c/p\u003e\n"]]],["The document outlines the representation and status of a \"Site\" resource. Key information includes: site name, unique ID (`reportingDimensionId`), domain, current state, and whether auto ads are enabled. Site states can be `STATE_UNSPECIFIED`, `REQUIRES_REVIEW`, `GETTING_READY`, `READY`, or `NEEDS_ATTENTION`. Actions include retrieving information about a site (`get`) or listing all sites within an account (`list`). The `get` method retrieves information about one site. The `list` method retrieves all the sites in an account.\n"],null,["# REST Resource: accounts.sites\n\n- [Resource: Site](#Site)\n - [JSON representation](#Site.SCHEMA_REPRESENTATION)\n- [State](#State)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Site\n--------------\n\nRepresentation of a Site.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"reportingDimensionId\": string, \"domain\": string, \"state\": enum (/adsense/management/reference/rest/v2/accounts.sites#State), \"autoAdsEnabled\": boolean } ``` |\n\n| Fields ||\n|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of a site. Format: accounts/{account}/sites/{site} |\n| `reportingDimensionId` | `string` Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension. |\n| `domain` | `string` Domain (or subdomain) of the site, e.g. \"example.com\" or \"www.example.com\". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension. |\n| `state` | `enum (`[State](/adsense/management/reference/rest/v2/accounts.sites#State)`)` Output only. State of a site. |\n| `autoAdsEnabled` | `boolean` Whether auto ads is turned on for the site. |\n\nState\n-----\n\nState of the site. See [Check the status of AdSense sites](https://support.google.com/adsense/answer/9128461) for more information.\n\n| Enums ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | State unspecified. |\n| `REQUIRES_REVIEW` | Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996). |\n| `GETTING_READY` | Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks. |\n| `READY` | The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624). |\n| `NEEDS_ATTENTION` | Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852). |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------|----------------------------------------------|\n| ### [get](/adsense/management/reference/rest/v2/accounts.sites/get) | Gets information about the selected site. |\n| ### [list](/adsense/management/reference/rest/v2/accounts.sites/list) | Lists all the sites available in an account. |"]]
