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. BillingInfo
  3. Budget
  4. Creatives
  5. MarketplaceDeals
  6. MarketplaceNotes
  7. MarketplacePrivateAuction
  8. PerformanceReport
  9. PretargetingConfig
  10. Products
  11. Proposals
  12. Pubprofiles

Accounts

For Accounts Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, 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.4, 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.4, 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.4, unless otherwise noted
addDeal POST  /creatives/accountId/buyerCreativeId/addDeal/dealId Add a deal id association for the creative.
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.
listDeals GET  /creatives/accountId/buyerCreativeId/listDeals Lists the external deal ids associated with the creative.
removeDeal POST  /creatives/accountId/buyerCreativeId/removeDeal/dealId Remove a deal id associated with the creative.

MarketplaceDeals

For MarketplaceDeals Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, unless otherwise noted
delete POST  /proposals/proposalId/deals/delete Delete the specified deals from the proposal
insert POST  /proposals/proposalId/deals/insert Add new deals for the specified proposal
list GET  /proposals/proposalId/deals List all the deals for a given proposal
update POST  /proposals/proposalId/deals/update Replaces all the deals in the proposal with the passed in deals

MarketplaceNotes

For MarketplaceNotes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, unless otherwise noted
insert POST  /proposals/proposalId/notes/insert Add notes to the proposal
list GET  /proposals/proposalId/notes Get all the notes associated with a proposal

MarketplacePrivateAuction

For MarketplacePrivateAuction Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, unless otherwise noted
updateproposal POST  /privateauction/privateAuctionId/updateproposal Update a given private auction proposal

PerformanceReport

For PerformanceReport Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, 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.4, 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.

Products

For Products Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, unless otherwise noted
get GET  /products/productId Gets the requested product by id.
search GET  /products/search Gets the requested product.

Proposals

For Proposals Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, unless otherwise noted
get GET  /proposals/proposalId Get a proposal given its id
insert POST  /proposals/insert Create the given list of proposals
patch PATCH  /proposals/proposalId/revisionNumber/updateAction Update the given proposal. This method supports patch semantics.
search GET  /proposals/search Search for proposals using PQL query
setupcomplete POST  /proposals/proposalId/setupcomplete Update the given proposal to indicate that setup has been completed.
update PUT  /proposals/proposalId/revisionNumber/updateAction Update the given proposal

Pubprofiles

For Pubprofiles Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/adexchangebuyer/v1.4, unless otherwise noted
list GET  /publisher/accountId/profiles Gets the requested publisher profile(s) by publisher accountId.

Send feedback about...

Buyer REST API
Buyer REST API