This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.
Resource types
- Accounts
- Accounts.adclients
- Accounts.adunits
- Accounts.adunits.customchannels
- Accounts.alerts
- Accounts.customchannels
- Accounts.customchannels.adunits
- Accounts.payments
- Accounts.reports
- Accounts.reports.saved
- Accounts.savedadstyles
- Accounts.urlchannels
- Metadata.dimensions
- Metadata.metrics
The following resource types and their methods are deprecated:
- Adclients
- Adunits
- Adunits.customchannels
- Alerts
- Customchannels
- Customchannels.adunits
- Payments
- Reports
- Reports.saved
- Savedadstyles
- Urlchannels
Accounts
For Accounts Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /accounts/accountId
|
Get information about the selected AdSense account. |
| list |
GET /accounts
|
List all accounts available to this AdSense account. |
Accounts.adclients
For Accounts.adclients Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /accounts/accountId/adclients
|
List all ad clients in the specified account. |
Accounts.adunits
For Accounts.adunits Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /accounts/accountId/adclients/adClientId/adunits/adUnitId
|
Gets the specified ad unit in the specified ad client for the specified account. |
| getAdCode |
GET /accounts/accountId/adclients/adClientId/adunits/adUnitId/adcode
|
Get ad code for the specified ad unit. |
| list |
GET /accounts/accountId/adclients/adClientId/adunits
|
List all ad units in the specified ad client for the specified account. |
Accounts.adunits.customchannels
For Accounts.adunits.customchannels Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /accounts/accountId/adclients/adClientId/adunits/adUnitId/customchannels
|
List all custom channels which the specified ad unit belongs to. |
Accounts.alerts
For Accounts.alerts Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| delete |
DELETE /accounts/accountId/alerts/alertId
|
Dismiss (delete) the specified alert from the specified publisher AdSense account. |
| list |
GET /accounts/accountId/alerts
|
List the alerts for the specified AdSense account. |
Accounts.customchannels
For Accounts.customchannels Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /accounts/accountId/adclients/adClientId/customchannels/customChannelId
|
Get the specified custom channel from the specified ad client for the specified account. |
| list |
GET /accounts/accountId/adclients/adClientId/customchannels
|
List all custom channels in the specified ad client for the specified account. |
Accounts.customchannels.adunits
For Accounts.customchannels.adunits Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /accounts/accountId/adclients/adClientId/customchannels/customChannelId/adunits
|
List all ad units in the specified custom channel. |
Accounts.payments
For Accounts.payments Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /accounts/accountId/payments
|
List the payments for the specified AdSense account. |
Accounts.reports
For Accounts.reports Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| generate |
GET /accounts/accountId/reports
|
Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
Required query parameters:
endDate, startDate |
Accounts.reports.saved
For Accounts.reports.saved Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| generate |
GET /accounts/accountId/reports/savedReportId
|
Generate an AdSense report based on the saved report ID sent in the query parameters. |
| list |
GET /accounts/accountId/reports/saved
|
List all saved reports in the specified AdSense account. |
Accounts.savedadstyles
For Accounts.savedadstyles Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /accounts/accountId/savedadstyles/savedAdStyleId
|
List a specific saved ad style for the specified account. |
| list |
GET /accounts/accountId/savedadstyles
|
List all saved ad styles in the specified account. |
Accounts.urlchannels
For Accounts.urlchannels Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /accounts/accountId/adclients/adClientId/urlchannels
|
List all URL channels in the specified ad client for the specified account. |
Metadata.dimensions
For Metadata.dimensions Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /metadata/dimensions
|
List the metadata for the dimensions available to this AdSense account. |
Metadata.metrics
For Metadata.metrics Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /metadata/metrics
|
List the metadata for the metrics available to this AdSense account. |
Deprecated Resource Types
Adclients
For Adclients Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /adclients
|
List all ad clients in this AdSense account. |
Adunits
For Adunits Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /adclients/adClientId/adunits/adUnitId
|
Gets the specified ad unit in the specified ad client. |
| getAdCode |
GET /adclients/adClientId/adunits/adUnitId/adcode
|
Get ad code for the specified ad unit. |
| list |
GET /adclients/adClientId/adunits
|
List all ad units in the specified ad client for this AdSense account. |
Adunits.customchannels
For Adunits.customchannels Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /adclients/adClientId/adunits/adUnitId/customchannels
|
List all custom channels which the specified ad unit belongs to. |
Alerts
For Alerts Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| delete |
DELETE /alerts/alertId
|
Dismiss (delete) the specified alert from the publisher's AdSense account. |
| list |
GET /alerts
|
List the alerts for this AdSense account. |
Customchannels
For Customchannels Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /adclients/adClientId/customchannels/customChannelId
|
Get the specified custom channel from the specified ad client. |
| list |
GET /adclients/adClientId/customchannels
|
List all custom channels in the specified ad client for this AdSense account. |
Customchannels.adunits
For Customchannels.adunits Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /adclients/adClientId/customchannels/customChannelId/adunits
|
List all ad units in the specified custom channel. |
Payments
For Payments Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /payments
|
List the payments for this AdSense account. |
Reports
For Reports Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| generate |
GET /reports
|
Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
Required query parameters:
endDate, startDate |
Reports.saved
For Reports.saved Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| generate |
GET /reports/savedReportId
|
Generate an AdSense report based on the saved report ID sent in the query parameters. |
| list |
GET /reports/saved
|
List all saved reports in this AdSense account. |
Savedadstyles
For Savedadstyles Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| get |
GET /savedadstyles/savedAdStyleId
|
Get a specific saved ad style from the user's account. |
| list |
GET /savedadstyles
|
List all saved ad styles in the user's account. |
Urlchannels
For Urlchannels Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/adsense/v1.4, unless otherwise noted | ||
| list |
GET /adclients/adClientId/urlchannels
|
List all URL channels in the specified ad client for this AdSense account. |