Ad Exchange Buyer API
Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.
E-commerce#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.
Endpoints 38
accounts
- GETadexchangebuyer.accounts.list
/accounts?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringRetrieves the authenticated user's list of accounts. - GETadexchangebuyer.accounts.get
/accounts/:id?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringGets one account by ID. - PUTadexchangebuyer.accounts.update
/accounts/:id?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&confirmUnsafeAccountChange=trueUpdates an existing account. - PATCHadexchangebuyer.accounts.patch
/accounts/:id?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&confirmUnsafeAccountChange=trueUpdates an existing account. This method supports patch semantics.
billingInfo
- GETadexchangebuyer.billingInfo.list
/billinginfo?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringRetrieves a list of billing information for all accounts of the authenticated user. - GETadexchangebuyer.billingInfo.get
/billinginfo/:accountId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringReturns the billing information for one account specified by account ID.
budget
- GETadexchangebuyer.budget.get
/billinginfo/:accountId/:billingId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringReturns the budget information for the adgroup specified by the accountId and billingId. - PUTadexchangebuyer.budget.update
/billinginfo/:accountId/:billingId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. - PATCHadexchangebuyer.budget.patch
/billinginfo/:accountId/:billingId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdates 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…
creatives
- GETadexchangebuyer.creatives.list
/creatives?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&accountId=0&buyerCreativeId=string&dealsStatusFilter=approved&maxResults=1&openAuctionStatusFilter=approved&pageToken=stringRetrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. - POSTadexchangebuyer.creatives.insert
/creatives?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringSubmit a new creative. - GETadexchangebuyer.creatives.get
/creatives/:accountId/:buyerCreativeId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringGets the status for a single creative. A creative will be available 30-40 minutes after submission. - POSTadexchangebuyer.creatives.addDeal
/creatives/:accountId/:buyerCreativeId/addDeal/:dealId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringAdd a deal id association for the creative. - GETadexchangebuyer.creatives.listDeals
/creatives/:accountId/:buyerCreativeId/listDeals?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringLists the external deal ids associated with the creative. - POSTadexchangebuyer.creatives.removeDeal
/creatives/:accountId/:buyerCreativeId/removeDeal/:dealId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringRemove a deal id associated with the creative.
marketplacedeals
- GETadexchangebuyer.marketplacedeals.list
/proposals/:proposalId/deals?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&pqlQuery=stringList all the deals for a given proposal - POSTadexchangebuyer.marketplacedeals.delete
/proposals/:proposalId/deals/delete?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringDelete the specified deals from the proposal - POSTadexchangebuyer.marketplacedeals.insert
/proposals/:proposalId/deals/insert?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringAdd new deals for the specified proposal - POSTadexchangebuyer.marketplacedeals.update
/proposals/:proposalId/deals/update?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringReplaces all the deals in the proposal with the passed in deals
marketplacenotes
- GETadexchangebuyer.marketplacenotes.list
/proposals/:proposalId/notes?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&pqlQuery=stringGet all the notes associated with a proposal - POSTadexchangebuyer.marketplacenotes.insert
/proposals/:proposalId/notes/insert?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringAdd notes to the proposal
marketplaceprivateauction
- POSTadexchangebuyer.marketplaceprivateauction.updateproposal
/privateauction/:privateAuctionId/updateproposal?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdate a given private auction proposal
performanceReport
- GETadexchangebuyer.performanceReport.list
/performancereport?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&accountId=string&endDateTime=string&startDateTime=string&maxResults=1&pageToken=stringRetrieves the authenticated user's list of performance metrics.
pretargetingConfig
- GETadexchangebuyer.pretargetingConfig.list
/pretargetingconfigs/:accountId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringRetrieves a list of the authenticated user's pretargeting configurations. - POSTadexchangebuyer.pretargetingConfig.insert
/pretargetingconfigs/:accountId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringInserts a new pretargeting configuration. - GETadexchangebuyer.pretargetingConfig.get
/pretargetingconfigs/:accountId/:configId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringGets a specific pretargeting configuration - PUTadexchangebuyer.pretargetingConfig.update
/pretargetingconfigs/:accountId/:configId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdates an existing pretargeting config. - DELETEadexchangebuyer.pretargetingConfig.delete
/pretargetingconfigs/:accountId/:configId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringDeletes an existing pretargeting config. - PATCHadexchangebuyer.pretargetingConfig.patch
/pretargetingconfigs/:accountId/:configId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdates an existing pretargeting config. This method supports patch semantics.
products
- GETadexchangebuyer.products.search
/products/search?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&pqlQuery=stringGets the requested product. - GETadexchangebuyer.products.get
/products/:productId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringGets the requested product by id.
proposals
- POSTadexchangebuyer.proposals.insert
/proposals/insert?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringCreate the given list of proposals - GETadexchangebuyer.proposals.search
/proposals/search?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string&pqlQuery=stringSearch for proposals using pql query - GETadexchangebuyer.proposals.get
/proposals/:proposalId?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringGet a proposal given its id - POSTadexchangebuyer.proposals.setupcomplete
/proposals/:proposalId/setupcomplete?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdate the given proposal to indicate that setup has been completed. - PUTadexchangebuyer.proposals.update
/proposals/:proposalId/:revisionNumber/:updateAction?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdate the given proposal - PATCHadexchangebuyer.proposals.patch
/proposals/:proposalId/:revisionNumber/:updateAction?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringUpdate the given proposal. This method supports patch semantics.
pubprofiles
- GETadexchangebuyer.pubprofiles.list
/publisher/:accountId/profiles?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=stringGets the requested publisher profile(s) by publisher accountId.
API details
- Base URL
https://www.googleapis.com/adexchangebuyer/v1.4- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
OAuth 2.0 (authorization code flow) with 1 scope - Operations
- 38 operations on 28 pathsGET 18POST 11PUT 4PATCH 4DELETE 1
- Main resources
- creatives 6pretargetingConfig 6proposals 6accounts 4marketplacedeals 4budget 3billingInfo 2marketplacenotes 2products 2marketplaceprivateauction 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v1.4 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Ad Exchange Buyer API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Ad Exchange Buyer API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “adexchangebuyer.accounts.list” (GET /accounts?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&userIp=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Ad Exchange Buyer API?
Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports. It is listed under E-commerce and has 38 endpoints.
Who publishes the Ad Exchange Buyer API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Ad Exchange Buyer API?
Requests go to https://www.googleapis.com/adexchangebuyer/v1.4. Endpoint paths are added to this base URL.
How do I authenticate with the Ad Exchange Buyer API?
It accepts 2 methods: OAuth 2.0 (implicit flow) with 1 scope; OAuth 2.0 (authorization code flow) with 1 scope.
How many endpoints does the Ad Exchange Buyer API have?
38 operations on 28 paths (18 GET, 11 POST, 4 PUT, 4 PATCH, 1 DELETE). The largest groups are creatives, pretargetingConfig, proposals, accounts.
Is forking the Ad Exchange Buyer API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.