Skip to content
OpenParablePublic APIs

Ad Exchange Buyer API II API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

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

Ad Exchange Buyer API II is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 50 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://adexchangebuyer.googleapis.com/
Version
v2beta1
Endpoints
50
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://adexchangebuyer.googleapis.com/v2beta1/accounts/ACCOUNTID/clients" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://adexchangebuyer.googleapis.com/v2beta1/accounts/ACCOUNTID/clients", {
  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://adexchangebuyer.googleapis.com/v2beta1/accounts/ACCOUNTID/clients",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v2beta1/accounts/{accountId}/clientsLists all the clients for the current sponsor buyer.
POST/v2beta1/accounts/{accountId}/clientsCreates a new client buyer.
GET/v2beta1/accounts/{accountId}/clients/{clientAccountId}Gets a client buyer with a given client account ID.
PUT/v2beta1/accounts/{accountId}/clients/{clientAccountId}Updates an existing client buyer.
GET/v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitationsLists all the client users invitations for a client with a given account ID.
POST/v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitationsCreates and sends out an email invitation to access an Ad Exchange client buyer account.
GET/v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}Retrieves an existing client user invitation.
GET/v2beta1/accounts/{accountId}/clients/{clientAccountId}/usersLists all the known client users for a specified sponsor buyer account ID.
GET/v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}Retrieves an existing client user.
PUT/v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}Updates an existing client user. Only the user status can be changed on update.
GET/v2beta1/accounts/{accountId}/creativesLists creatives.
POST/v2beta1/accounts/{accountId}/creativesCreates a creative.
GET/v2beta1/accounts/{accountId}/creatives/{creativeId}Gets a creative.
PUT/v2beta1/accounts/{accountId}/creatives/{creativeId}Updates a creative.
GET/v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociationsList all creative-deal associations.
POST/v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:addAssociate an existing deal with a creative.
POST/v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:removeRemove the association between a deal and a creative.
POST/v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatchingStops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.
POST/v2beta1/accounts/{accountId}/creatives/{creativeId}:watchWatches a creative. Will result in push notifications being sent to the topic when the creative changes status.
GET/v2beta1/accounts/{accountId}/finalizedProposalsList finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will
POST/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 req
POST/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 r
GET/v2beta1/accounts/{accountId}/productsList all products visible to the buyer (optionally filtered by the specified PQL query).
GET/v2beta1/accounts/{accountId}/products/{productId}Gets the requested product by ID.
GET/v2beta1/accounts/{accountId}/proposalsList proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being r
POST/v2beta1/accounts/{accountId}/proposalsCreate the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.
GET/v2beta1/accounts/{accountId}/proposals/{proposalId}Gets a proposal given its ID. The proposal is returned at its head revision.
PUT/v2beta1/accounts/{accountId}/proposals/{proposalId}Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED
POST/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 returne
POST/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 associated
POST/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 negotiatio
POST/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 fina
POST/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 pro
POST/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 p
GET/v2beta1/accounts/{accountId}/publisherProfilesList all publisher profiles visible to the buyer
GET/v2beta1/accounts/{accountId}/publisherProfiles/{publisherProfileId}Gets the requested publisher profile by id.
GET/v2beta1/{filterSetName}/bidMetricsLists all metrics that are measured in terms of number of bids.
GET/v2beta1/{filterSetName}/bidResponseErrorsList all errors that occurred in bid responses, with the number of bid responses affected for each reason.
GET/v2beta1/{filterSetName}/bidResponsesWithoutBidsList all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
GET/v2beta1/{filterSetName}/filteredBidRequestsList 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.
GET/v2beta1/{filterSetName}/filteredBidsList all reasons for which bids were filtered, with the number of bids filtered for each reason.
GET/v2beta1/{filterSetName}/filteredBids/{creativeStatusId}/creativesList all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
GET/v2beta1/{filterSetName}/filteredBids/{creativeStatusId}/detailsList all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
GET/v2beta1/{filterSetName}/impressionMetricsLists all metrics that are measured in terms of number of impressions.
GET/v2beta1/{filterSetName}/losingBidsList all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
GET/v2beta1/{filterSetName}/nonBillableWinningBidsList all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
GET/v2beta1/{name}Retrieves the requested filter set for the account with the given account ID.
DELETE/v2beta1/{name}Deletes the requested filter set from the account with the given account ID.
GET/v2beta1/{ownerName}/filterSetsLists all filter sets for the account with the given account ID.
POST/v2beta1/{ownerName}/filterSetsCreates the specified filter set for the account with the given account ID.

Questions

Does the Ad Exchange Buyer API II API need an API key?

Yes. The Ad Exchange Buyer API II API uses OAuth authentication; the documentation explains how to get credentials.

Does the Ad Exchange Buyer API II API support HTTPS?

Yes, the Ad Exchange Buyer API II API is served over HTTPS.

How many endpoints does the Ad Exchange Buyer API II API have?

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

What are alternatives to the Ad Exchange Buyer API II 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).