Ad Exchange Buyer API II
Access the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.
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
Access the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.
Endpoints 50
accounts.clients
- GETLists all the clients for the current sponsor buyer.
/v2beta1/accounts/:accountId/clients?pageSize=0&pageToken=string&partnerClientId=stringLists all the clients for the current sponsor buyer. - POSTCreates a new client buyer.
/v2beta1/accounts/:accountId/clientsCreates a new client buyer. - GETGets a client buyer with a given client account ID.
/v2beta1/accounts/:accountId/clients/:clientAccountIdGets a client buyer with a given client account ID. - PUTUpdates an existing client buyer.
/v2beta1/accounts/:accountId/clients/:clientAccountIdUpdates an existing client buyer.
accounts.clients.invitations
- GETLists all the client users invitations for a client with a given account ID.
/v2beta1/accounts/:accountId/clients/:clientAccountId/invitations?pageSize=0&pageToken=stringLists all the client users invitations for a client with a given account ID. - POSTCreates and sends out an email invitation to access an Ad Exchange client buyer account.
/v2beta1/accounts/:accountId/clients/:clientAccountId/invitationsCreates and sends out an email invitation to access an Ad Exchange client buyer account. - GETRetrieves an existing client user invitation.
/v2beta1/accounts/:accountId/clients/:clientAccountId/invitations/:invitationIdRetrieves an existing client user invitation.
accounts.clients.users
- GETRetrieves an existing client user.
/v2beta1/accounts/:accountId/clients/:clientAccountId/users/:userIdRetrieves an existing client user. - PUTUpdates an existing client user
/v2beta1/accounts/:accountId/clients/:clientAccountId/users/:userIdUpdates an existing client user. Only the user status can be changed on update. - GETLists all the known client users for a specified sponsor buyer account ID.
/v2beta1/accounts/:accountId/clients/:clientAccountId/users?pageSize=0&pageToken=stringLists all the known client users for a specified sponsor buyer account ID.
accounts.creatives
- GETLists creatives.
/v2beta1/accounts/:accountId/creatives?pageSize=0&pageToken=string&query=stringLists creatives. - POSTCreates a creative.
/v2beta1/accounts/:accountId/creatives?duplicateIdMode=NO_DUPLICATESCreates a creative. - GETGets a creative.
/v2beta1/accounts/:accountId/creatives/:creativeIdGets a creative. - PUTUpdates a creative.
/v2beta1/accounts/:accountId/creatives/:creativeIdUpdates a creative. - POSTStops watching a creative
/v2beta1/accounts/:accountId/creatives/:creativeId:stopWatchingStops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. - POSTWatches a creative
/v2beta1/accounts/:accountId/creatives/:creativeId:watchWatches a creative. Will result in push notifications being sent to the topic when the creative changes status.
accounts.creatives.dealAssociations
- POSTAssociate an existing deal with a creative.
/v2beta1/accounts/:accountId/creatives/:creativeId/dealAssociations:addAssociate an existing deal with a creative. - GETList all creative-deal associations.
/v2beta1/accounts/:accountId/creatives/:creativeId/dealAssociations?pageSize=0&pageToken=string&query=stringList all creative-deal associations. - POSTRemove the association between a deal and a creative.
/v2beta1/accounts/:accountId/creatives/:creativeId/dealAssociations:removeRemove the association between a deal and a creative.
accounts.finalizedProposals
- GETList finalized proposals, regardless if a proposal is being renegotiated
/v2beta1/accounts/:accountId/finalizedProposals?filter=string&filterSyntax=FILTER_SYNTAX_UNSPECIFIED&pageSize=0&pageToken=stringList finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes… - POSTUpdate given deals to pause serving
/v2beta1/accounts/:accountId/finalizedProposals/:proposalId:pauseUpdate given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the… - POSTUpdate given deals to resume serving
/v2beta1/accounts/:accountId/finalizedProposals/:proposalId:resumeUpdate given deals to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all listed deals in the…
accounts.products
- GETGets the requested product by ID.
/v2beta1/accounts/:accountId/products/:productIdGets the requested product by ID. - GETList all products visible to the buyer (optionally filtered by the specified PQL query).
/v2beta1/accounts/:accountId/products?filter=string&pageSize=0&pageToken=stringList all products visible to the buyer (optionally filtered by the specified PQL query).
accounts.proposals
- POSTMark the proposal as accepted at the given revision number
/v2beta1/accounts/:accountId/proposals/:proposalId:acceptMark the proposal as accepted at the given revision number. If the number does not match the server's revision number an ABORTED error message will be… - POSTCreate a new note and attach it to the proposal
/v2beta1/accounts/:accountId/proposals/:proposalId:addNoteCreate a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when… - POSTCancel an ongoing negotiation on a proposal
/v2beta1/accounts/:accountId/proposals/:proposalId:cancelNegotiationCancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a… - POSTYou can opt-in to manually update proposals to indicate that setup is complete
/v2beta1/accounts/:accountId/proposals/:proposalId:completeSetupYou can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are… - GETList proposals
/v2beta1/accounts/:accountId/proposals?filter=string&filterSyntax=FILTER_SYNTAX_UNSPECIFIED&pageSize=0&pageToken=stringList proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being… - POSTCreate the given proposal
/v2beta1/accounts/:accountId/proposalsCreate the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server. - GETGets a proposal given its ID
/v2beta1/accounts/:accountId/proposals/:proposalIdGets a proposal given its ID. The proposal is returned at its head revision. - PUTUpdate the given proposal at the client known revision number
/v2beta1/accounts/:accountId/proposals/:proposalIdUpdate the given proposal at the client known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision, an ABORTED… - POSTUpdate the given proposal to pause serving
/v2beta1/accounts/:accountId/proposals/:proposalId:pauseUpdate the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the… - POSTUpdate the given proposal to resume serving
/v2beta1/accounts/:accountId/proposals/:proposalId:resumeUpdate the given proposal to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all deals in the…
accounts.publisherProfiles
- GETGets the requested publisher profile by id.
/v2beta1/accounts/:accountId/publisherProfiles/:publisherProfileIdGets the requested publisher profile by id. - GETList all publisher profiles visible to the buyer
/v2beta1/accounts/:accountId/publisherProfiles?pageSize=0&pageToken=stringList all publisher profiles visible to the buyer
buyers.filterSets
- GETLists all filter sets for the account with the given account ID.
/v2beta1/:ownerName/filterSets?pageSize=0&pageToken=stringLists all filter sets for the account with the given account ID. - POSTCreates the specified filter set for the account with the given account ID.
/v2beta1/:ownerName/filterSets?isTransient=trueCreates the specified filter set for the account with the given account ID. - GETRetrieves the requested filter set for the account with the given account ID.
/v2beta1/:nameRetrieves the requested filter set for the account with the given account ID. - DELETEDeletes the requested filter set from the account with the given account ID.
/v2beta1/:nameDeletes the requested filter set from the account with the given account ID.
buyers.filterSets.bidMetrics
- GETLists all metrics that are measured in terms of number of bids.
/v2beta1/:filterSetName/bidMetrics?pageSize=0&pageToken=stringLists all metrics that are measured in terms of number of bids.
buyers.filterSets.bidResponseErrors
- GETList all errors that occurred in bid responses, with the number of bid responses affected for each reason.
/v2beta1/:filterSetName/bidResponseErrors?pageSize=0&pageToken=stringList all errors that occurred in bid responses, with the number of bid responses affected for each reason.
buyers.filterSets.bidResponsesWithoutBids
- GETList all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses…
/v2beta1/:filterSetName/bidResponsesWithoutBids?pageSize=0&pageToken=stringList all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
buyers.filterSets.filteredBidRequests
- GETList all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent…
/v2beta1/:filterSetName/filteredBidRequests?pageSize=0&pageToken=stringList all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
buyers.filterSets.filteredBids
- GETList all reasons for which bids were filtered, with the number of bids filtered for each reason.
/v2beta1/:filterSetName/filteredBids?pageSize=0&pageToken=stringList all reasons for which bids were filtered, with the number of bids filtered for each reason.
buyers.filterSets.filteredBids.creatives
- GETList all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered…
/v2beta1/:filterSetName/filteredBids/:creativeStatusId/creatives?pageSize=0&pageToken=stringList all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
buyers.filterSets.filteredBids.details
- GETList all details associated with a specific reason for which bids were filtered, with the number of bids filtered for…
/v2beta1/:filterSetName/filteredBids/:creativeStatusId/details?pageSize=0&pageToken=stringList all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
buyers.filterSets.impressionMetrics
- GETLists all metrics that are measured in terms of number of impressions.
/v2beta1/:filterSetName/impressionMetrics?pageSize=0&pageToken=stringLists all metrics that are measured in terms of number of impressions.
buyers.filterSets.losingBids
- GETList all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
/v2beta1/:filterSetName/losingBids?pageSize=0&pageToken=stringList all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
buyers.filterSets.nonBillableWinningBids
- GETList all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
/v2beta1/:filterSetName/nonBillableWinningBids?pageSize=0&pageToken=stringList all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
API details
- Base URL
https://adexchangebuyer.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 50 operations on 40 pathsGET 28POST 17PUT 4DELETE 1
- Main resources
- accounts.proposals 10accounts.creatives 6accounts.clients 4buyers.filterSets 4accounts.clients.invitations 3accounts.clients.users 3accounts.creatives.dealAssociations 3accounts.finalizedProposals 3accounts.products 2accounts.publisherProfiles 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v2beta1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Ad Exchange Buyer API II 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 II collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code 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 “Lists all the clients for the current sponsor buyer.” (GET /v2beta1/accounts/:accountId/clients?pageSize=0&pageToken=string&partnerClientId=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 II?
Access the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals. It is listed under E-commerce and has 50 endpoints.
Who publishes the Ad Exchange Buyer API II?
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 II?
Requests go to https://adexchangebuyer.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Ad Exchange Buyer API II?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Ad Exchange Buyer API II have?
50 operations on 40 paths (28 GET, 17 POST, 4 PUT, 1 DELETE). The largest groups are accounts.proposals, accounts.creatives, accounts.clients, buyers.filterSets.
Is forking the Ad Exchange Buyer API II free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.