Google

Authorized Buyers Marketplace API

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

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

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

Endpoints 27

buyers.auctionPackages

  • GETList the auction packages/v1/:parent/auctionPackages?filter=string&orderBy=string&pageSize=0&pageToken=stringList the auction packages. Buyers can use the URL path "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its…
  • POSTSubscribe to the auction package for the specified buyer/v1/:name:subscribeSubscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package…
  • POSTSubscribe the specified clients of the buyer to the auction package/v1/:auctionPackage:subscribeClientsSubscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned,…
  • POSTUnsubscribe from the auction package for the specified buyer/v1/:name:unsubscribeUnsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID…
  • POSTUnsubscribe from the auction package for the specified clients of the buyer/v1/:auctionPackage:unsubscribeClientsUnsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.

buyers.finalizedDeals

  • GETLists finalized deals/v1/:parent/finalizedDeals?filter=string&orderBy=string&pageSize=0&pageToken=stringLists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use…
  • POSTSets the given finalized deal as ready to serve/v1/:deal:setReadyToServeSets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the…
  • POSTAdd creative to be used in the bidding process for a finalized deal/v1/:deal:addCreativeAdd creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one…
  • POSTPauses serving of the given finalized deal/v1/:name:pausePauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this…
  • POSTResumes serving of the given finalized deal/v1/:name:resumeResumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this…

buyers.publisherProfiles

  • GETGets the requested publisher profile by name./v1/:nameGets the requested publisher profile by name.
  • GETLists publisher profiles/v1/:parent/publisherProfiles?filter=string&pageSize=0&pageToken=stringLists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can…

buyers.clients.users

  • DELETEDeletes an existing client user/v1/:nameDeletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the…
  • POSTActivates an existing client user/v1/:name:activateActivates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is…
  • POSTDeactivates an existing client user/v1/:name:deactivateDeactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is…
  • GETLists all client users for a specified client./v1/:parent/users?pageSize=0&pageToken=stringLists all client users for a specified client.
  • POSTCreates a new client user in "INVITED" state/v1/:parent/usersCreates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

buyers.proposals.deals

  • PATCHUpdates the given deal at the buyer known revision number/v1/:name?updateMask=stringUpdates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error…
  • POSTBatch updates multiple deals in the same proposal./v1/:parent/deals:batchUpdateBatch updates multiple deals in the same proposal.
  • GETLists all deals in a proposal/v1/:parent/deals?pageSize=0&pageToken=stringLists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.

buyers.clients

  • GETLists all the clients for the current buyer./v1/:parent/clients?filter=string&pageSize=0&pageToken=stringLists all the clients for the current buyer.
  • POSTCreates a new client./v1/:parent/clientsCreates a new client.

buyers.proposals

  • POSTAccepts the proposal at the given revision number/v1/:name:acceptAccepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be…
  • POSTCreates a note for this proposal and sends to the seller/v1/:proposal:addNoteCreates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
  • POSTCancels an ongoing negotiation on a proposal/v1/:proposal:cancelNegotiationCancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not…
  • GETLists proposals/v1/:parent/proposals?filter=string&pageSize=0&pageToken=stringLists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.
  • POSTSends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory/v1/:buyer/proposals:sendRfpSends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal…

API details

Base URL
https://authorizedbuyersmarketplace.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
27 operations on 23 pathsPOST 17GET 8PATCH 1DELETE 1
Main resources
buyers.auctionPackages 5buyers.clients.users 5buyers.finalizedDeals 5buyers.proposals 5buyers.proposals.deals 3buyers.clients 2buyers.publisherProfiles 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Authorized Buyers Marketplace API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Authorized Buyers Marketplace API collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “List the auction packages” (GET /v1/:parent/auctionPackages?filter=string&orderBy=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Authorized Buyers Marketplace API?

The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers. It is listed under E-commerce and has 27 endpoints.

Who publishes the Authorized Buyers Marketplace 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 Authorized Buyers Marketplace API?

Requests go to https://authorizedbuyersmarketplace.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Authorized Buyers Marketplace API?

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 Authorized Buyers Marketplace API have?

27 operations on 23 paths (17 POST, 8 GET, 1 PATCH, 1 DELETE). The largest groups are buyers.auctionPackages, buyers.clients.users, buyers.finalizedDeals, buyers.proposals.

Is forking the Authorized Buyers Marketplace API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.