Skip to content
OpenParablePublic APIs

Authorized Buyers Marketplace API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

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

Authorized Buyers Marketplace API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 27 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://authorizedbuyersmarketplace.googleapis.com/
Version
v1
Endpoints
27
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://authorizedbuyersmarketplace.googleapis.com/v1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://authorizedbuyersmarketplace.googleapis.com/v1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://authorizedbuyersmarketplace.googleapis.com/v1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/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, a
POST/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.
POST/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 te
POST/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 approve
POST/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 default
GET/v1/{name}Gets the requested publisher profile by name.
PATCH/v1/{name}Updates 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 m
DELETE/v1/{name}Deletes 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 U
POST/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 returned
POST/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 alr
POST/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 a
POST/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 metho
POST/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 me
POST/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 targeti
POST/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 an
GET/v1/{parent}/auctionPackagesList the auction packages subscribed by a buyer and its clients.
GET/v1/{parent}/clientsLists all the clients for the current buyer.
POST/v1/{parent}/clientsCreates a new client.
GET/v1/{parent}/dealsLists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
POST/v1/{parent}/deals:batchUpdateBatch updates multiple deals in the same proposal.
GET/v1/{parent}/finalizedDealsLists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use t
GET/v1/{parent}/proposalsLists proposals. A filter expression (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are be
GET/v1/{parent}/publisherProfilesLists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear
GET/v1/{parent}/usersLists all client users for a specified client.
POST/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.
POST/v1/{proposal}:addNoteCreates a note for this proposal and sends to the seller.
POST/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 been

Questions

Does the Authorized Buyers Marketplace API API need an API key?

Yes. The Authorized Buyers Marketplace API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Authorized Buyers Marketplace API API support HTTPS?

Yes, the Authorized Buyers Marketplace API API is served over HTTPS.

How many endpoints does the Authorized Buyers Marketplace API API have?

Its OpenAPI description lists 27 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Authorized Buyers Marketplace API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).