Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/realtimebidding:v1.ts";

§Classes

GoogleAuth
realtimeBidding

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.

§Variables

auth

§Interfaces

ActivatePretargetingConfigRequest

A request to activate a pretargeting configuration. Sets the configuration's state to ACTIVE.

AddTargetedAppsRequest

A request to start targeting the provided app IDs in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.

AddTargetedPublishersRequest

A request to start targeting the provided publishers in a specific pretargeting configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.

AddTargetedSitesRequest

A request to start targeting the provided sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.

AdTechnologyProviders

The list of detected Ad Technology Providers for this creative. Bids placed for inventory that will serve to EEA or UK users are expected to comply with GDPR requirements. You must ensure that the creatives used in such bids should contain only user consented ad technology providers as indicated in the bid request. Google reserves the right to filter non-compliant bids. User consented ad technology providers can be found in the Google Protocol with the BidRequest.adslot.consented_providers_settings field, and can be found as an OpenRTB extension with the BidRequest.user.ext.consented_providers_settings and BidRequest.user.ext.consent fields. See https://support.google.com/authorizedbuyers/answer/9789378 for additional information about the Google TCF v2 integration.

AdvertiserAndBrand

Detected advertiser and brand information.

AppTargeting

A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent.

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.

BiddersCreativesListOptions

Additional options for realtimeBidding#biddersCreativesList.

BiddersEndpointsListOptions

Additional options for realtimeBidding#biddersEndpointsList.

BiddersEndpointsPatchOptions

Additional options for realtimeBidding#biddersEndpointsPatch.

BiddersListOptions

Additional options for realtimeBidding#biddersList.

BiddersPretargetingConfigsListOptions

Additional options for realtimeBidding#biddersPretargetingConfigsList.

BiddersPretargetingConfigsPatchOptions

Additional options for realtimeBidding#biddersPretargetingConfigsPatch.

BiddersPublisherConnectionsListOptions

Additional options for realtimeBidding#biddersPublisherConnectionsList.

Buyer

RTB Buyer account information.

BuyersCreativesGetOptions

Additional options for realtimeBidding#buyersCreativesGet.

BuyersCreativesListOptions

Additional options for realtimeBidding#buyersCreativesList.

BuyersCreativesPatchOptions

Additional options for realtimeBidding#buyersCreativesPatch.

BuyersListOptions

Additional options for realtimeBidding#buyersList.

BuyersUserListsListOptions

Additional options for realtimeBidding#buyersUserListsList.

CloseUserListRequest

A request to close a specified user list.

Creative

A creative and its classification data.

CreativeDimensions

The dimensions of a creative. This applies to only HTML and Native creatives.

CreativeServingDecision

Top level status and detected attributes of a creative.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

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.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Endpoint

Bidder endpoint that receives bid requests.

GetRemarketingTagResponse

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Response for a request to get remarketing tag.

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. You may provide a larger image than was requested, so long as the aspect ratio is preserved.

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.

OpenUserListRequest

A request to open a specified user list.

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. These control which inventory a bidder will receive bid requests for.

PublisherConnection

An Open Bidding exchange's connection to a publisher. This is initiated by the publisher for the bidder to review. If approved by the bidder, this means that the bidder agrees to receive bid requests from the publisher.

RemoveTargetedAppsRequest

A request to stop targeting the provided apps in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.

RemoveTargetedPublishersRequest

A request to stop targeting publishers in a specific configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.

RemoveTargetedSitesRequest

A request to stop targeting sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.

StringTargetingDimension

Generic targeting with string values used in app, website and publisher targeting.

SuspendPretargetingConfigRequest

A request to suspend a pretargeting configuration. Sets the configuration's state to SUSPENDED.

UrlDownloadSize

The URL-level breakdown for the download size.

UrlRestriction

Deprecated. This will be removed in October 2023. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Represents the URL restriction (for the URL captured by the pixel callback) for a user list.

UserList

Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page.

VideoContent

Video content for a creative.

VideoMetadata

Video metadata for a creative.

WatchCreativesRequest

A request to receive push notifications when any of the creatives belonging to the bidder changes status.

WatchCreativesResponse

A response for the request to receive push notification when a bidder's creatives change status.