realtimebidding/v1 library
Real-time Bidding API - v1
Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.
For more information, see developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
Create an instance of RealTimeBiddingApi to access these resources:
Classes
- AddTargetedAppsRequest
- A request to start targeting the provided app IDs in a specific pretargeting configuration.
- AddTargetedPublishersRequest
- A request to start targeting the provided publishers in a specific pretargeting configuration.
- AddTargetedSitesRequest
- A request to start targeting the provided sites in a specific pretargeting configuration.
- AdTechnologyProviders
- The list of detected Ad Technology Providers for this creative.
- AdvertiserAndBrand
- Detected advertiser and brand information.
- AppTargeting
- A subset of app inventory to target.
- BatchApprovePublisherConnectionsRequest
- A request to approve a batch of publisher connections.
- BatchApprovePublisherConnectionsResponse
- A response for the request to approve a batch of publisher connections.
- BatchRejectPublisherConnectionsRequest
- A request to reject a batch of publisher connections.
- BatchRejectPublisherConnectionsResponse
- A response for the request to reject a batch of publisher connections.
- Bidder
- Bidder settings.
- BiddersCreativesResource
- BiddersEndpointsResource
- BiddersPretargetingConfigsResource
- BiddersPublisherConnectionsResource
- BiddersResource
- Buyer
- RTB Buyer account information.
- BuyersCreativesResource
- BuyersResource
- BuyersUserListsResource
- Creative
- A creative and its classification data.
- CreativeDimensions
- The dimensions of a creative.
- CreativeServingDecision
- Top level status and detected attributes of a creative.
- DestinationNotCrawlableEvidence
- Evidence that the creative's destination URL was not crawlable by Google.
- DestinationNotWorkingEvidence
- Evidence of the creative's destination URL not functioning properly or having been incorrectly set up.
- DestinationUrlEvidence
- The full landing page URL of the destination.
- DomainCallEvidence
- Number of HTTP calls made by a creative, broken down by domain.
- DomainCalls
- The number of HTTP calls made to the given domain.
- DownloadSizeEvidence
- Total download size and URL-level download size breakdown for resources in a creative.
- Endpoint
- Bidder endpoint that receives bid requests.
- GetRemarketingTagResponse
- This has been sunset as of October 2023, and will return an error response if called.
- HtmlContent
- HTML content for a creative.
- HttpCallEvidence
- HTTP calls made by a creative that resulted in policy violations.
- HttpCookieEvidence
- Evidence for HTTP cookie-related policy violations.
- Image
- An image resource.
- ListBiddersResponse
- A response containing bidders.
- ListBuyersResponse
- A response containing buyer account information.
- ListCreativesResponse
- A response for listing creatives.
- ListEndpointsResponse
- A response containing bidder endpoints.
- ListPretargetingConfigsResponse
- A response containing pretargeting configurations.
- ListPublisherConnectionsResponse
- A response to a request for listing publisher connections.
- ListUserListsResponse
- The list user list response.
- MediaFile
- Information about each media file in the VAST.
- NativeContent
- Native content for a creative.
- NumericTargetingDimension
- Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting.
- PolicyCompliance
- Policy compliance of the creative for a transaction type or a region.
- PolicyTopicEntry
- Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
- PolicyTopicEvidence
- Evidence associated with a policy topic entry.
- PretargetingConfig
- Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel.
- PublisherConnection
- An Open Bidding exchange's connection to a publisher.
- RealTimeBiddingApi
- Allows external bidders to manage their RTB integration with Google.
- RemoveTargetedAppsRequest
- A request to stop targeting the provided apps in a specific pretargeting configuration.
- RemoveTargetedPublishersRequest
- A request to stop targeting publishers in a specific configuration.
- RemoveTargetedSitesRequest
- A request to stop targeting sites in a specific pretargeting configuration.
- StringTargetingDimension
- Generic targeting with string values used in app, website and publisher targeting.
- UrlDownloadSize
- The URL-level breakdown for the download size.
- UrlRestriction
- This will be removed in October 2023.
- UserList
- Represents an Authorized Buyers user list.
- VideoContent
- Video content for a creative.
- VideoMetadata
- Video metadata for a creative.
- WatchCreativesResponse
- A response for the request to receive push notification when a bidder's creatives change status.
Typedefs
- ActivatePretargetingConfigRequest = $Empty
- A request to activate a pretargeting configuration.
- CloseUserListRequest = $Empty
- A request to close a specified user list.
- Date = $Date
- Represents a whole or partial calendar date, such as a birthday.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- OpenUserListRequest = $Empty
- A request to open a specified user list.
- SuspendPretargetingConfigRequest = $Empty
- A request to suspend a pretargeting configuration.
- WatchCreativesRequest = $Empty
- A request to receive push notifications when any of the creatives belonging to the bidder changes status.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.