The AdX Seller REST API has been deprecated and will be sunset on July 23, 2018. New and existing users should migrate to the DoubleClick for Publishers API.

API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Accounts
  2. Accounts.adclients
  3. Accounts.alerts
  4. Accounts.customchannels
  5. Accounts.metadata.dimensions
  6. Accounts.metadata.metrics
  7. Accounts.preferreddeals
  8. Accounts.reports
  9. Accounts.reports.saved
  10. Accounts.urlchannels

Accounts

For Accounts Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
get GET  /accounts/accountId Get information about the selected Ad Exchange account.
list GET  /accounts List all accounts available to this Ad Exchange account.

Accounts.adclients

For Accounts.adclients Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
list GET  /accounts/accountId/adclients List all ad clients in this Ad Exchange account.

Accounts.alerts

For Accounts.alerts Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
list GET  /accounts/accountId/alerts List the alerts for this Ad Exchange account.

Accounts.customchannels

For Accounts.customchannels Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
get GET  /accounts/accountId/adclients/adClientId/customchannels/customChannelId Get the specified custom channel from the specified ad client.
list GET  /accounts/accountId/adclients/adClientId/customchannels List all custom channels in the specified ad client for this Ad Exchange account.

Accounts.metadata.dimensions

For Accounts.metadata.dimensions Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
list GET  /accounts/accountId/metadata/dimensions List the metadata for the dimensions available to this AdExchange account.

Accounts.metadata.metrics

For Accounts.metadata.metrics Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
list GET  /accounts/accountId/metadata/metrics List the metadata for the metrics available to this AdExchange account.

Accounts.preferreddeals

For Accounts.preferreddeals Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
get GET  /accounts/accountId/preferreddeals/dealId Get information about the selected Ad Exchange Preferred Deal.
list GET  /accounts/accountId/preferreddeals List the preferred deals for this Ad Exchange account.

Accounts.reports

For Accounts.reports Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
generate GET  /accounts/accountId/reports Generate an Ad Exchange 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/adexchangeseller/v2.0, unless otherwise noted
generate GET  /accounts/accountId/reports/savedReportId Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
list GET  /accounts/accountId/reports/saved List all saved reports in this Ad Exchange account.

Accounts.urlchannels

For Accounts.urlchannels Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangeseller/v2.0, unless otherwise noted
list GET  /accounts/accountId/adclients/adClientId/urlchannels List all URL channels in the specified ad client for this Ad Exchange account.

Send feedback about...

Seller REST API
Seller REST API