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.reports
- Adclients
- Associationsessions
- Customchannels
- Reports
- Urlchannels
Accounts
For Accounts Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
get |
GET /accounts/accountId
|
Get information about the selected associated AdSense account. |
list |
GET /accounts
|
List hosted accounts associated with this AdSense account by ad client id.
Required query parameters:
filterAdClientId |
Accounts.adclients
For Accounts.adclients Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
get |
GET /accounts/accountId/adclients/adClientId
|
Get information about one of the ad clients in the specified publisher's AdSense account. |
list |
GET /accounts/accountId/adclients
|
List all hosted ad clients in the specified hosted account. |
Accounts.adunits
For Accounts.adunits Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
delete |
DELETE /accounts/accountId/adclients/adClientId/adunits/adUnitId
|
Delete the specified ad unit from the specified publisher AdSense account. |
get |
GET /accounts/accountId/adclients/adClientId/adunits/adUnitId
|
Get the specified host ad unit in this AdSense account. |
getAdCode |
GET /accounts/accountId/adclients/adClientId/adunits/adUnitId/adcode
|
Get ad code for the specified ad unit, attaching the specified host custom channels. |
insert |
POST /accounts/accountId/adclients/adClientId/adunits
|
Insert the supplied ad unit into the specified publisher AdSense account. |
list |
GET /accounts/accountId/adclients/adClientId/adunits
|
List all ad units in the specified publisher's AdSense account. |
patch |
PATCH /accounts/accountId/adclients/adClientId/adunits
|
Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
Required query parameters:
adUnitId |
update |
PUT /accounts/accountId/adclients/adClientId/adunits
|
Update the supplied ad unit in the specified publisher 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/adsensehost/v4.1, 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 |
Adclients
For Adclients Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
get |
GET /adclients/adClientId
|
Get information about one of the ad clients in the Host AdSense account. |
list |
GET /adclients
|
List all host ad clients in this AdSense account. |
Associationsessions
For Associationsessions Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
start |
GET /associationsessions/start
|
Create an association session for initiating an association with an AdSense user.
Required query parameters:
productCode , websiteUrl |
verify |
GET /associationsessions/verify
|
Verify an association session after the association callback returns from AdSense signup.
Required query parameters:
token |
Customchannels
For Customchannels Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
delete |
DELETE /adclients/adClientId/customchannels/customChannelId
|
Delete a specific custom channel from the host AdSense account. |
get |
GET /adclients/adClientId/customchannels/customChannelId
|
Get a specific custom channel from the host AdSense account. |
insert |
POST /adclients/adClientId/customchannels
|
Add a new custom channel to the host AdSense account. |
list |
GET /adclients/adClientId/customchannels
|
List all host custom channels in this AdSense account. |
patch |
PATCH /adclients/adClientId/customchannels
|
Update a custom channel in the host AdSense account. This method supports patch semantics.
Required query parameters:
customChannelId |
update |
PUT /adclients/adClientId/customchannels
|
Update a custom channel in the host AdSense account. |
Reports
For Reports Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, 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 |
Urlchannels
For Urlchannels Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/adsensehost/v4.1, unless otherwise noted | ||
delete |
DELETE /adclients/adClientId/urlchannels/urlChannelId
|
Delete a URL channel from the host AdSense account. |
insert |
POST /adclients/adClientId/urlchannels
|
Add a new URL channel to the host AdSense account. |
list |
GET /adclients/adClientId/urlchannels
|
List all host URL channels in the host AdSense account. |