Authorized Buyers Marketplace API

The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.

Service: authorizedbuyersmarketplace.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 documents:

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://authorizedbuyersmarketplace.googleapis.com

REST Resource: v1beta.curators.dataSegments

Methods
activate POST /v1beta/{name=curators/*/dataSegments/*}:activate
Activates a data segment.
create POST /v1beta/{parent=curators/*}/dataSegments
Creates a data segment owned by the listed curator.
deactivate POST /v1beta/{name=curators/*/dataSegments/*}:deactivate
Deactivates a data segment.
get GET /v1beta/{name=curators/*/dataSegments/*}
Gets a data segment given its name.
list GET /v1beta/{parent=curators/*}/dataSegments
List the data segments owned by a curator.
patch PATCH /v1beta/{dataSegment.name=curators/*/dataSegments/*}
Updates a data segment.

REST Resource: v1alpha.bidders.auctionPackages

Methods
list GET /v1alpha/{parent=bidders/*}/auctionPackages
List the auction packages.

REST Resource: v1alpha.bidders.finalizedDeals

Methods
list GET /v1alpha/{parent=bidders/*}/finalizedDeals
Lists finalized deals.

REST Resource: v1alpha.buyers.auctionPackages

Methods
get GET /v1alpha/{name=buyers/*/auctionPackages/*}
Gets an auction package given its name.
list GET /v1alpha/{parent=buyers/*}/auctionPackages
List the auction packages.
subscribe POST /v1alpha/{name=buyers/*/auctionPackages/*}:subscribe
Subscribe to the auction package for the specified buyer.
subscribeClients POST /v1alpha/{auctionPackage=buyers/*/auctionPackages/*}:subscribeClients
Subscribe the specified clients of the buyer to the auction package.
unsubscribe POST /v1alpha/{name=buyers/*/auctionPackages/*}:unsubscribe
Unsubscribe from the auction package for the specified buyer.
unsubscribeClients POST /v1alpha/{auctionPackage=buyers/*/auctionPackages/*}:unsubscribeClients
Unsubscribe from the auction package for the specified clients of the buyer.

REST Resource: v1alpha.buyers.clients

Methods
activate POST /v1alpha/{name=buyers/*/clients/*}:activate
Activates an existing client.
create POST /v1alpha/{parent=buyers/*}/clients
Creates a new client.
deactivate POST /v1alpha/{name=buyers/*/clients/*}:deactivate
Deactivates an existing client.
get GET /v1alpha/{name=buyers/*/clients/*}
Gets a client with a given resource name.
list GET /v1alpha/{parent=buyers/*}/clients
Lists all the clients for the current buyer.
patch PATCH /v1alpha/{client.name=buyers/*/clients/*}
Updates an existing client.

REST Resource: v1alpha.buyers.clients.users

Methods
activate POST /v1alpha/{name=buyers/*/clients/*/users/*}:activate
Activates an existing client user.
create POST /v1alpha/{parent=buyers/*/clients/*}/users
Creates a new client user in "INVITED" state.
deactivate POST /v1alpha/{name=buyers/*/clients/*/users/*}:deactivate
Deactivates an existing client user.
delete DELETE /v1alpha/{name=buyers/*/clients/*/users/*}
Deletes an existing client user.
get GET /v1alpha/{name=buyers/*/clients/*/users/*}
Retrieves an existing client user.
list GET /v1alpha/{parent=buyers/*/clients/*}/users
Lists all client users for a specified client.

REST Resource: v1alpha.buyers.dataSegments

Methods
activate POST /v1alpha/{name=buyers/*/dataSegments/*}:activate
Activates a data segment.
create POST /v1alpha/{parent=buyers/*}/dataSegments
Creates a data segment owned by the listed curator.
deactivate POST /v1alpha/{name=buyers/*/dataSegments/*}:deactivate
Deactivates a data segment.
get GET /v1alpha/{name=buyers/*/dataSegments/*}
Gets a data segment given its name.
list GET /v1alpha/{parent=buyers/*}/dataSegments
List the data segments owned by a curator.
patch PATCH /v1alpha/{dataSegment.name=buyers/*/dataSegments/*}
Updates a data segment.

REST Resource: v1alpha.buyers.finalizedDeals

Methods
addCreative POST /v1alpha/{deal=buyers/*/finalizedDeals/*}:addCreative
Add creative to be used in the bidding process for a finalized deal.
get GET /v1alpha/{name=buyers/*/finalizedDeals/*}
Gets a finalized deal given its name.
list GET /v1alpha/{parent=buyers/*}/finalizedDeals
Lists finalized deals.
pause POST /v1alpha/{name=buyers/*/finalizedDeals/*}:pause
Pauses serving of the given finalized deal.
resume POST /v1alpha/{name=buyers/*/finalizedDeals/*}:resume
Resumes serving of the given finalized deal.
setReadyToServe POST /v1alpha/{deal=buyers/*/finalizedDeals/*}:setReadyToServe
Sets the given finalized deal as ready to serve.

REST Resource: v1alpha.buyers.proposals

Methods
accept POST /v1alpha/{name=buyers/*/proposals/*}:accept
Accepts the proposal at the given revision number.
addNote POST /v1alpha/{proposal=buyers/*/proposals/*}:addNote
Creates a note for this proposal and sends to the seller.
cancelNegotiation POST /v1alpha/{proposal=buyers/*/proposals/*}:cancelNegotiation
Cancels an ongoing negotiation on a proposal.
get GET /v1alpha/{name=buyers/*/proposals/*}
Gets a proposal using its resource name.
list GET /v1alpha/{parent=buyers/*}/proposals
Lists proposals.
patch PATCH /v1alpha/{proposal.name=buyers/*/proposals/*}
Updates the proposal at the given revision number.
sendRfp POST /v1alpha/{buyer=buyers/*}/proposals:sendRfp
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory.

REST Resource: v1alpha.buyers.proposals.deals

Methods
batchUpdate POST /v1alpha/{parent=buyers/*/proposals/*}/deals:batchUpdate
Batch updates multiple deals in the same proposal.
get GET /v1alpha/{name=buyers/*/proposals/*/deals/*}
Gets a deal given its name.
list GET /v1alpha/{parent=buyers/*/proposals/*}/deals
Lists all deals in a proposal.
patch PATCH /v1alpha/{deal.name=buyers/*/proposals/*/deals/*}
Updates the given deal at the buyer known revision number.

REST Resource: v1alpha.buyers.publisherProfiles

Methods
get GET /v1alpha/{name=buyers/*/publisherProfiles/*}
Gets the requested publisher profile by name.
list GET /v1alpha/{parent=buyers/*}/publisherProfiles
Lists publisher profiles.

REST Resource: v1.bidders.auctionPackages

Methods
list GET /v1/{parent=bidders/*}/auctionPackages
List the auction packages.

REST Resource: v1.bidders.finalizedDeals

Methods
list GET /v1/{parent=bidders/*}/finalizedDeals
Lists finalized deals.

REST Resource: v1.buyers.auctionPackages

Methods
get GET /v1/{name=buyers/*/auctionPackages/*}
Gets an auction package given its name.
list GET /v1/{parent=buyers/*}/auctionPackages
List the auction packages.
subscribe POST /v1/{name=buyers/*/auctionPackages/*}:subscribe
Subscribe to the auction package for the specified buyer.
subscribeClients POST /v1/{auctionPackage=buyers/*/auctionPackages/*}:subscribeClients
Subscribe the specified clients of the buyer to the auction package.
unsubscribe POST /v1/{name=buyers/*/auctionPackages/*}:unsubscribe
Unsubscribe from the auction package for the specified buyer.
unsubscribeClients POST /v1/{auctionPackage=buyers/*/auctionPackages/*}:unsubscribeClients
Unsubscribe from the auction package for the specified clients of the buyer.

REST Resource: v1.buyers.clients

Methods
activate POST /v1/{name=buyers/*/clients/*}:activate
Activates an existing client.
create POST /v1/{parent=buyers/*}/clients
Creates a new client.
deactivate POST /v1/{name=buyers/*/clients/*}:deactivate
Deactivates an existing client.
get GET /v1/{name=buyers/*/clients/*}
Gets a client with a given resource name.
list GET /v1/{parent=buyers/*}/clients
Lists all the clients for the current buyer.
patch PATCH /v1/{client.name=buyers/*/clients/*}
Updates an existing client.

REST Resource: v1.buyers.clients.users

Methods
activate POST /v1/{name=buyers/*/clients/*/users/*}:activate
Activates an existing client user.
create POST /v1/{parent=buyers/*/clients/*}/users
Creates a new client user in "INVITED" state.
deactivate POST /v1/{name=buyers/*/clients/*/users/*}:deactivate
Deactivates an existing client user.
delete DELETE /v1/{name=buyers/*/clients/*/users/*}
Deletes an existing client user.
get GET /v1/{name=buyers/*/clients/*/users/*}
Retrieves an existing client user.
list GET /v1/{parent=buyers/*/clients/*}/users
Lists all client users for a specified client.

REST Resource: v1.buyers.finalizedDeals

Methods
addCreative POST /v1/{deal=buyers/*/finalizedDeals/*}:addCreative
Add creative to be used in the bidding process for a finalized deal.
get GET /v1/{name=buyers/*/finalizedDeals/*}
Gets a finalized deal given its name.
list GET /v1/{parent=buyers/*}/finalizedDeals
Lists finalized deals.
pause POST /v1/{name=buyers/*/finalizedDeals/*}:pause
Pauses serving of the given finalized deal.
resume POST /v1/{name=buyers/*/finalizedDeals/*}:resume
Resumes serving of the given finalized deal.
setReadyToServe POST /v1/{deal=buyers/*/finalizedDeals/*}:setReadyToServe
Sets the given finalized deal as ready to serve.

REST Resource: v1.buyers.proposals

Methods
accept POST /v1/{name=buyers/*/proposals/*}:accept
Accepts the proposal at the given revision number.
addNote POST /v1/{proposal=buyers/*/proposals/*}:addNote
Creates a note for this proposal and sends to the seller.
cancelNegotiation POST /v1/{proposal=buyers/*/proposals/*}:cancelNegotiation
Cancels an ongoing negotiation on a proposal.
get GET /v1/{name=buyers/*/proposals/*}
Gets a proposal using its resource name.
list GET /v1/{parent=buyers/*}/proposals
Lists proposals.
patch PATCH /v1/{proposal.name=buyers/*/proposals/*}
Updates the proposal at the given revision number.
sendRfp POST /v1/{buyer=buyers/*}/proposals:sendRfp
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory.

REST Resource: v1.buyers.proposals.deals

Methods
batchUpdate POST /v1/{parent=buyers/*/proposals/*}/deals:batchUpdate
Batch updates multiple deals in the same proposal.
get GET /v1/{name=buyers/*/proposals/*/deals/*}
Gets a deal given its name.
list GET /v1/{parent=buyers/*/proposals/*}/deals
Lists all deals in a proposal.
patch PATCH /v1/{deal.name=buyers/*/proposals/*/deals/*}
Updates the given deal at the buyer known revision number.

REST Resource: v1.buyers.publisherProfiles

Methods
get GET /v1/{name=buyers/*/publisherProfiles/*}
Gets the requested publisher profile by name.
list GET /v1/{parent=buyers/*}/publisherProfiles
Lists publisher profiles.