API Reference

The Ad Exchange Buyer API is being sunset in July 2021. Users of this API should migrate to the Real-time Bidding API to avoid interruptions.

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. BillingInfo
3. Budget
4. Creatives
5. DirectDeals
6. PerformanceReport
7. PretargetingConfig

Accounts

For Accounts Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
get	GET  /accounts/id	Gets one account by ID.
list	GET  /accounts	Retrieves the authenticated user's list of accounts.
patch	PATCH  /accounts/id	Updates an existing account. This method supports patch semantics.
update	PUT  /accounts/id	Updates an existing account.

BillingInfo

For BillingInfo Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
get	GET  /billinginfo/accountId	Returns the billing information for one account specified by account ID.
list	GET  /billinginfo	Retrieves a list of billing information for all accounts of the authenticated user.

Budget

For Budget Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
get	GET  /billinginfo/accountId/billingId	Returns the budget information for the adgroup specified by the accountId and billingId.
patch	PATCH  /billinginfo/accountId/billingId	Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.
update	PUT  /billinginfo/accountId/billingId	Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Creatives

For Creatives Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
get	GET  /creatives/accountId/buyerCreativeId	Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
insert	POST  /creatives	Inserts a new creative into Google's creative verification pipeline.
list	GET  /creatives	Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

DirectDeals

For DirectDeals Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
get	GET  /directdeals/id	Gets one direct deal by ID.
list	GET  /directdeals	Retrieves the authenticated user's list of direct deals. Also retrieves all direct deals for the authenticated user's RTB account buyer seats.

PerformanceReport

For PerformanceReport Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
list	GET  /performancereport	Retrieves the authenticated user's list of performance metrics. Required query parameters: accountId, endDateTime, startDateTime

PretargetingConfig

For PretargetingConfig Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.3, unless otherwise noted
delete	DELETE  /pretargetingconfigs/accountId/configId	Deletes an existing pretargeting config.
get	GET  /pretargetingconfigs/accountId/configId	Gets a specific pretargeting configuration
insert	POST  /pretargetingconfigs/accountId	Inserts a new pretargeting configuration.
list	GET  /pretargetingconfigs/accountId	Retrieves a list of the authenticated user's pretargeting configurations.
patch	PATCH  /pretargetingconfigs/accountId/configId	Updates an existing pretargeting config. This method supports patch semantics.
update	PUT  /pretargetingconfigs/accountId/configId	Updates an existing pretargeting config.