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…
Developer tools#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
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.
Endpoints 29
buyers.userLists
- GETGets a user list by its name.
/v1/:nameGets a user list by its name. - PUTUpdates the given user list
/v1/:nameUpdates the given user list. Only user lists with URLRestrictions can be updated. - GETThis has been sunset as of October 2023, and will return an error response if called
/v1/:name:getRemarketingTagThis has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes:… - POSTChanges the status of a user list to CLOSED
/v1/:name:closeChanges the status of a user list to CLOSED. This prevents new users from being added to the user list. - GETLists the user lists visible to the current user.
/v1/:parent/userLists?pageSize=0&pageToken=stringLists the user lists visible to the current user. - POSTCreates a new user list.
/v1/:parent/userListsCreates a new user list. - POSTChanges the status of a user list to OPEN
/v1/:name:openChanges the status of a user list to OPEN. This allows new users to be added to the user list.
bidders.pretargetingConfigs
- DELETEDeletes a pretargeting configuration.
/v1/:nameDeletes a pretargeting configuration. - POSTActivates a pretargeting configuration.
/v1/:name:activateActivates a pretargeting configuration. - POSTAdds targeted apps to the pretargeting configuration.
/v1/:pretargetingConfig:addTargetedAppsAdds targeted apps to the pretargeting configuration. - POSTAdds targeted publishers to the pretargeting config.
/v1/:pretargetingConfig:addTargetedPublishersAdds targeted publishers to the pretargeting config. - POSTAdds targeted sites to the pretargeting configuration.
/v1/:pretargetingConfig:addTargetedSitesAdds targeted sites to the pretargeting configuration. - GETLists all pretargeting configurations for a single bidder.
/v1/:parent/pretargetingConfigs?pageSize=0&pageToken=stringLists all pretargeting configurations for a single bidder. - POSTCreates a pretargeting configuration
/v1/:parent/pretargetingConfigsCreates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect… - POSTRemoves targeted apps from the pretargeting configuration.
/v1/:pretargetingConfig:removeTargetedAppsRemoves targeted apps from the pretargeting configuration. - POSTRemoves targeted publishers from the pretargeting config.
/v1/:pretargetingConfig:removeTargetedPublishersRemoves targeted publishers from the pretargeting config. - POSTRemoves targeted sites from the pretargeting configuration.
/v1/:pretargetingConfig:removeTargetedSitesRemoves targeted sites from the pretargeting configuration. - POSTSuspends a pretargeting configuration.
/v1/:name:suspendSuspends a pretargeting configuration.
buyers.creatives
- PATCHUpdates a creative.
/v1/:name?updateMask=stringUpdates a creative. - GETLists creatives as they are at the time of the initial request
/v1/:parent/creatives?adCategoryTaxonomyOverride=AD_CATEGORY_TAXONOMY_UNSPECIFIED&filter=string&pageSize=0&pageToken=string&view=CREATIVE_VIEW_UNSPECIFIEDLists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method… - POSTCreates a creative.
/v1/:parent/creativesCreates a creative. - POSTAdds a list of deals to a creative, which submits the creative for publisher review
/v1/:name:addDealsAdds a list of deals to a creative, which submits the creative for publisher review. Returns the updated creative.
bidders
- GETLists all the bidder accounts that belong to the caller.
/v1/bidders?pageSize=0&pageToken=stringLists all the bidder accounts that belong to the caller.
bidders.creatives
- POSTWatches all creatives pertaining to a bidder
/v1/:parent/creatives:watchWatches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will…
bidders.endpoints
- GETLists all the bidder's endpoints.
/v1/:parent/endpoints?pageSize=0&pageToken=stringLists all the bidder's endpoints.
bidders.publisherConnections
- POSTBatch approves multiple publisher connections.
/v1/:parent/publisherConnections:batchApproveBatch approves multiple publisher connections. - POSTBatch rejects multiple publisher connections.
/v1/:parent/publisherConnections:batchRejectBatch rejects multiple publisher connections. - GETLists publisher connections for a given bidder.
/v1/:parent/publisherConnections?filter=string&orderBy=string&pageSize=0&pageToken=stringLists publisher connections for a given bidder.
buyers
- GETLists all buyer account information the calling buyer user or service account is permissioned to manage.
/v1/buyers?pageSize=0&pageToken=stringLists all buyer account information the calling buyer user or service account is permissioned to manage.
API details
- Base URL
https://realtimebidding.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 29 operations on 23 pathsPOST 17GET 9PUT 1PATCH 1DELETE 1
- Main resources
- bidders.pretargetingConfigs 11buyers.userLists 7buyers.creatives 4bidders.publisherConnections 3bidders 1bidders.creatives 1bidders.endpoints 1buyers 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Real-time Bidding API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Real-time Bidding API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Gets a user list by its name.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Developer tools and has 29 endpoints.
Who publishes the Real-time Bidding 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 Real-time Bidding API?
Requests go to https://realtimebidding.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Real-time Bidding 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 Real-time Bidding API have?
29 operations on 23 paths (17 POST, 9 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are bidders.pretargetingConfigs, buyers.userLists, buyers.creatives, bidders.publisherConnections.
Is forking the Real-time Bidding API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.