Ad Exchange Buyer API II

  • Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.

  • This service provides access to REST resources for managing accounts, clients, invitations, users, creatives, deal associations, finalized proposals, products, proposals, and publisher profiles.

  • The service also includes REST resources under bidders for managing filter sets and various bid and impression metrics related to those filter sets.

  • The service endpoint is https://adexchangebuyer.googleapis.com and a Discovery Document is available.

Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.

Service: adexchangebuyer.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://adexchangebuyer.googleapis.com

REST Resource: v2beta1.accounts.clients

Methods
create POST /v2beta1/accounts/{accountId}/clients
Creates a new client buyer.
get GET /v2beta1/accounts/{accountId}/clients/{clientAccountId}
Gets a client buyer with a given client account ID.
list GET /v2beta1/accounts/{accountId}/clients
Lists all the clients for the current sponsor buyer.
update PUT /v2beta1/accounts/{accountId}/clients/{clientAccountId}
Updates an existing client buyer.

REST Resource: v2beta1.accounts.clients.invitations

Methods
create POST /v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations
Creates and sends out an email invitation to access an Ad Exchange client buyer account.
get GET /v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}
Retrieves an existing client user invitation.
list GET /v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations
Lists all the client users invitations for a client with a given account ID.

REST Resource: v2beta1.accounts.clients.users

Methods
get GET /v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}
Retrieves an existing client user.
list GET /v2beta1/accounts/{accountId}/clients/{clientAccountId}/users
Lists all the known client users for a specified sponsor buyer account ID.
update PUT /v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}
Updates an existing client user.

REST Resource: v2beta1.accounts.creatives

Methods
create POST /v2beta1/accounts/{creative.accountId}/creatives
Creates a creative.
get GET /v2beta1/accounts/{accountId}/creatives/{creativeId}
Gets a creative.
list GET /v2beta1/accounts/{accountId}/creatives
Lists creatives.
stopWatching POST /v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching
Stops watching a creative.
update PUT /v2beta1/accounts/{creative.accountId}/creatives/{creative.creativeId}
Updates a creative.
watch POST /v2beta1/accounts/{accountId}/creatives/{creativeId}:watch
Watches a creative.

REST Resource: v2beta1.accounts.creatives.dealAssociations

Methods
add POST /v2beta1/accounts/{association.accountId}/creatives/{association.creativeId}/dealAssociations:add
Associate an existing deal with a creative.
list GET /v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations
List all creative-deal associations.
remove POST /v2beta1/accounts/{association.accountId}/creatives/{association.creativeId}/dealAssociations:remove
Remove the association between a deal and a creative.

REST Resource: v2beta1.accounts.finalizedProposals

Methods
list GET /v2beta1/accounts/{accountId}/finalizedProposals
List finalized proposals, regardless if a proposal is being renegotiated.
pause POST /v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause
Update given deals to pause serving.
resume POST /v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume
Update given deals to resume serving.

REST Resource: v2beta1.accounts.products

Methods
get GET /v2beta1/accounts/{accountId}/products/{productId}
Gets the requested product by ID.
list GET /v2beta1/accounts/{accountId}/products
List all products visible to the buyer (optionally filtered by the specified PQL query).

REST Resource: v2beta1.accounts.proposals

Methods
accept POST /v2beta1/accounts/{accountId}/proposals/{proposalId}:accept
Mark the proposal as accepted at the given revision number.
addNote POST /v2beta1/accounts/{accountId}/proposals/{proposalId}:addNote
Create a new note and attach it to the proposal.
cancelNegotiation POST /v2beta1/accounts/{accountId}/proposals/{proposalId}:cancelNegotiation
Cancel an ongoing negotiation on a proposal.
completeSetup POST /v2beta1/accounts/{accountId}/proposals/{proposalId}:completeSetup
Update the given proposal to indicate that setup has been completed.
create POST /v2beta1/accounts/{accountId}/proposals
Create the given proposal.
get GET /v2beta1/accounts/{accountId}/proposals/{proposalId}
Gets a proposal given its ID.
list GET /v2beta1/accounts/{accountId}/proposals
List proposals.
pause POST /v2beta1/accounts/{accountId}/proposals/{proposalId}:pause
Update the given proposal to pause serving.
resume POST /v2beta1/accounts/{accountId}/proposals/{proposalId}:resume
Update the given proposal to resume serving.
update PUT /v2beta1/accounts/{accountId}/proposals/{proposalId}
Update the given proposal at the client known revision number.

REST Resource: v2beta1.accounts.publisherProfiles

Methods
get GET /v2beta1/accounts/{accountId}/publisherProfiles/{publisherProfileId}
Gets the requested publisher profile by id.
list GET /v2beta1/accounts/{accountId}/publisherProfiles
List all publisher profiles visible to the buyer

REST Resource: v2beta1.bidders.accounts.filterSets

Methods
create POST /v2beta1/{ownerName=bidders/*/accounts/*}/filterSets
Creates the specified filter set for the account with the given account ID.
delete DELETE /v2beta1/{name=bidders/*/accounts/*/filterSets/*}
Deletes the requested filter set from the account with the given account ID.
get GET /v2beta1/{name=bidders/*/accounts/*/filterSets/*}
Retrieves the requested filter set for the account with the given account ID.
list GET /v2beta1/{ownerName=bidders/*/accounts/*}/filterSets
Lists all filter sets for the account with the given account ID.

REST Resource: v2beta1.bidders.accounts.filterSets.bidMetrics

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/bidMetrics
Lists all metrics that are measured in terms of number of bids.

REST Resource: v2beta1.bidders.accounts.filterSets.bidResponseErrors

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/bidResponseErrors
List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

REST Resource: v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/bidResponsesWithoutBids
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

REST Resource: v2beta1.bidders.accounts.filterSets.filteredBidRequests

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/filteredBidRequests
List 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.

REST Resource: v2beta1.bidders.accounts.filterSets.filteredBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/filteredBids
List all reasons for which bids were filtered, with the number of bids filtered for each reason.

REST Resource: v2beta1.bidders.accounts.filterSets.filteredBids.creatives

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/filteredBids/{creativeStatusId}/creatives
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

REST Resource: v2beta1.bidders.accounts.filterSets.filteredBids.details

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/filteredBids/{creativeStatusId}/details
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

REST Resource: v2beta1.bidders.accounts.filterSets.impressionMetrics

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/impressionMetrics
Lists all metrics that are measured in terms of number of impressions.

REST Resource: v2beta1.bidders.accounts.filterSets.losingBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/losingBids
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

REST Resource: v2beta1.bidders.accounts.filterSets.nonBillableWinningBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/accounts/*/filterSets/*}/nonBillableWinningBids
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.

REST Resource: v2beta1.bidders.filterSets

Methods
create POST /v2beta1/{ownerName=bidders/*}/filterSets
Creates the specified filter set for the account with the given account ID.
delete DELETE /v2beta1/{name=bidders/*/filterSets/*}
Deletes the requested filter set from the account with the given account ID.
get GET /v2beta1/{name=bidders/*/filterSets/*}
Retrieves the requested filter set for the account with the given account ID.
list GET /v2beta1/{ownerName=bidders/*}/filterSets
Lists all filter sets for the account with the given account ID.

REST Resource: v2beta1.bidders.filterSets.bidMetrics

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/bidMetrics
Lists all metrics that are measured in terms of number of bids.

REST Resource: v2beta1.bidders.filterSets.bidResponseErrors

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/bidResponseErrors
List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

REST Resource: v2beta1.bidders.filterSets.bidResponsesWithoutBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/bidResponsesWithoutBids
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

REST Resource: v2beta1.bidders.filterSets.filteredBidRequests

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/filteredBidRequests
List 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.

REST Resource: v2beta1.bidders.filterSets.filteredBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/filteredBids
List all reasons for which bids were filtered, with the number of bids filtered for each reason.

REST Resource: v2beta1.bidders.filterSets.filteredBids.creatives

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/filteredBids/{creativeStatusId}/creatives
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

REST Resource: v2beta1.bidders.filterSets.filteredBids.details

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/filteredBids/{creativeStatusId}/details
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

REST Resource: v2beta1.bidders.filterSets.impressionMetrics

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/impressionMetrics
Lists all metrics that are measured in terms of number of impressions.

REST Resource: v2beta1.bidders.filterSets.losingBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/losingBids
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

REST Resource: v2beta1.bidders.filterSets.nonBillableWinningBids

Methods
list GET /v2beta1/{filterSetName=bidders/*/filterSets/*}/nonBillableWinningBids
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.