Real-time Bidding API

Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive with pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.

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

REST Resource: v1.bidders

Methods
get GET /v1/{name=bidders/*}
Gets a bidder account by its name.
list GET /v1/bidders
Lists all the bidder accounts that belong to the caller.

REST Resource: v1.bidders.creatives

Methods
list GET /v1/{parent=bidders/*}/creatives
Lists creatives as they are at the time of the initial request.
watch POST /v1/{parent=bidders/*}/creatives:watch
Watches all creatives pertaining to a bidder.

REST Resource: v1.bidders.endpoints

Methods
get GET /v1/{name=bidders/*/endpoints/*}
Gets a bidder endpoint by its name.
list GET /v1/{parent=bidders/*}/endpoints
Lists all the bidder's endpoints.
patch PATCH /v1/{endpoint.name=bidders/*/endpoints/*}
Updates a bidder's endpoint.

REST Resource: v1.bidders.pretargetingConfigs

Methods
activate POST /v1/{name=bidders/*/pretargetingConfigs/*}:activate
Activates a pretargeting configuration.
addTargetedApps POST /v1/{pretargetingConfig=bidders/*/pretargetingConfigs/*}:addTargetedApps
Adds targeted apps to the pretargeting configuration.
addTargetedPublishers POST /v1/{pretargetingConfig=bidders/*/pretargetingConfigs/*}:addTargetedPublishers
Adds targeted publishers to the pretargeting config.
addTargetedSites POST /v1/{pretargetingConfig=bidders/*/pretargetingConfigs/*}:addTargetedSites
Adds targeted sites to the pretargeting configuration.
create POST /v1/{parent=bidders/*}/pretargetingConfigs
Creates a pretargeting configuration.
delete DELETE /v1/{name=bidders/*/pretargetingConfigs/*}
Deletes a pretargeting configuration.
get GET /v1/{name=bidders/*/pretargetingConfigs/*}
Gets a pretargeting configuration.
list GET /v1/{parent=bidders/*}/pretargetingConfigs
Lists all pretargeting configurations for a single bidder.
patch PATCH /v1/{pretargetingConfig.name=bidders/*/pretargetingConfigs/*}
Updates a pretargeting configuration.
removeTargetedApps POST /v1/{pretargetingConfig=bidders/*/pretargetingConfigs/*}:removeTargetedApps
Removes targeted apps from the pretargeting configuration.
removeTargetedPublishers POST /v1/{pretargetingConfig=bidders/*/pretargetingConfigs/*}:removeTargetedPublishers
Removes targeted publishers from the pretargeting config.
removeTargetedSites POST /v1/{pretargetingConfig=bidders/*/pretargetingConfigs/*}:removeTargetedSites
Removes targeted sites from the pretargeting configuration.
suspend POST /v1/{name=bidders/*/pretargetingConfigs/*}:suspend
Suspends a pretargeting configuration.

REST Resource: v1.bidders.publisherConnections

Methods
batchApprove POST /v1/{parent=bidders/*}/publisherConnections:batchApprove
Batch approves multiple publisher connections.
batchReject POST /v1/{parent=bidders/*}/publisherConnections:batchReject
Batch rejects multiple publisher connections.
get GET /v1/{name=bidders/*/publisherConnections/*}
Gets a publisher connection.
list GET /v1/{parent=bidders/*}/publisherConnections
Lists publisher connections for a given bidder.

REST Resource: v1.buyers

Methods
get GET /v1/{name=buyers/*}
Gets a buyer account by its name.
getRemarketingTag GET /v1/{name=buyers/*}:getRemarketingTag
This has been sunset as of October 2023, and will return an error response if called.
list GET /v1/buyers
Lists all buyer account information the calling buyer user or service account is permissioned to manage.

REST Resource: v1.buyers.creatives

Methods
create POST /v1/{parent=buyers/*}/creatives
Creates a creative.
get GET /v1/{name=buyers/*/creatives/*}
Gets a creative.
list GET /v1/{parent=buyers/*}/creatives
Lists creatives as they are at the time of the initial request.
patch PATCH /v1/{creative.name=buyers/*/creatives/*}
Updates a creative.

REST Resource: v1.buyers.userLists

Methods
close POST /v1/{name=buyers/*/userLists/*}:close
Changes the status of a user list to CLOSED.
create POST /v1/{parent=buyers/*}/userLists
Creates a new user list.
get GET /v1/{name=buyers/*/userLists/*}
Gets a user list by its name.
getRemarketingTag GET /v1/{name=buyers/*/userLists/*}:getRemarketingTag
This has been sunset as of October 2023, and will return an error response if called.
list GET /v1/{parent=buyers/*}/userLists
Lists the user lists visible to the current user.
open POST /v1/{name=buyers/*/userLists/*}:open
Changes the status of a user list to OPEN.
update PUT /v1/{userList.name=buyers/*/userLists/*}
Updates the given user list.