realtimeBidding

import { realtimeBidding } from "https://googleapis.deno.dev/v1/realtimebidding:v1.ts";

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.

class realtimeBidding {

constructor(client?: CredentialsClient, baseUrl?: string);

async biddersCreativesList(parent: string, opts?: BiddersCreativesListOptions): Promise<ListCreativesResponse>;

async biddersCreativesWatch(parent: string, req: WatchCreativesRequest): Promise<WatchCreativesResponse>;

async biddersEndpointsGet(name: string): Promise<Endpoint>;

async biddersEndpointsList(parent: string, opts?: BiddersEndpointsListOptions): Promise<ListEndpointsResponse>;

async biddersEndpointsPatch(

req: Endpoint,

opts?: BiddersEndpointsPatchOptions,

): Promise<Endpoint>;

async biddersGet(name: string): Promise<Bidder>;

async biddersList(opts?: BiddersListOptions): Promise<ListBiddersResponse>;

async biddersPretargetingConfigsActivate(name: string, req: ActivatePretargetingConfigRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsAddTargetedApps(pretargetingConfig: string, req: AddTargetedAppsRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsAddTargetedPublishers(pretargetingConfig: string, req: AddTargetedPublishersRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsAddTargetedSites(pretargetingConfig: string, req: AddTargetedSitesRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsCreate(parent: string, req: PretargetingConfig): Promise<PretargetingConfig>;

async biddersPretargetingConfigsDelete(name: string): Promise<Empty>;

async biddersPretargetingConfigsGet(name: string): Promise<PretargetingConfig>;

async biddersPretargetingConfigsList(parent: string, opts?: BiddersPretargetingConfigsListOptions): Promise<ListPretargetingConfigsResponse>;

async biddersPretargetingConfigsPatch(

req: PretargetingConfig,

opts?: BiddersPretargetingConfigsPatchOptions,

): Promise<PretargetingConfig>;

async biddersPretargetingConfigsRemoveTargetedApps(pretargetingConfig: string, req: RemoveTargetedAppsRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsRemoveTargetedPublishers(pretargetingConfig: string, req: RemoveTargetedPublishersRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsRemoveTargetedSites(pretargetingConfig: string, req: RemoveTargetedSitesRequest): Promise<PretargetingConfig>;

async biddersPretargetingConfigsSuspend(name: string, req: SuspendPretargetingConfigRequest): Promise<PretargetingConfig>;

async biddersPublisherConnectionsBatchApprove(parent: string, req: BatchApprovePublisherConnectionsRequest): Promise<BatchApprovePublisherConnectionsResponse>;

async biddersPublisherConnectionsBatchReject(parent: string, req: BatchRejectPublisherConnectionsRequest): Promise<BatchRejectPublisherConnectionsResponse>;

async biddersPublisherConnectionsGet(name: string): Promise<PublisherConnection>;

async biddersPublisherConnectionsList(parent: string, opts?: BiddersPublisherConnectionsListOptions): Promise<ListPublisherConnectionsResponse>;

async buyersCreativesCreate(parent: string, req: Creative): Promise<Creative>;

async buyersCreativesGet(name: string, opts?: BuyersCreativesGetOptions): Promise<Creative>;

async buyersCreativesList(parent: string, opts?: BuyersCreativesListOptions): Promise<ListCreativesResponse>;

async buyersCreativesPatch(

req: Creative,

opts?: BuyersCreativesPatchOptions,

): Promise<Creative>;

async buyersGet(name: string): Promise<Buyer>;

async buyersGetRemarketingTag(name: string): Promise<GetRemarketingTagResponse>;

async buyersList(opts?: BuyersListOptions): Promise<ListBuyersResponse>;

async buyersUserListsClose(name: string, req: CloseUserListRequest): Promise<UserList>;

async buyersUserListsCreate(parent: string, req: UserList): Promise<UserList>;

async buyersUserListsGet(name: string): Promise<UserList>;

async buyersUserListsGetRemarketingTag(name: string): Promise<GetRemarketingTagResponse>;

async buyersUserListsList(parent: string, opts?: BuyersUserListsListOptions): Promise<ListUserListsResponse>;

async buyersUserListsOpen(name: string, req: OpenUserListRequest): Promise<UserList>;

async buyersUserListsUpdate(name: string, req: UserList): Promise<UserList>;

}

§Constructors

new realtimeBidding(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

biddersCreativesList(parent: string, opts?: BiddersCreativesListOptions): Promise<ListCreativesResponse>

[src]

Lists 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 returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.

@param parent

Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either buyers/{buyerAccountId} or bidders/{bidderAccountId}. For buyers/{buyerAccountId}, the buyerAccountId can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456) under bidder account (123), you would use the pattern: buyers/456. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123), you would use buyers/123. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use bidders/{bidderAccountId}, for example, for all creatives pertaining to bidder (123), use bidders/123.

biddersCreativesWatch(parent: string, req: WatchCreativesRequest): Promise<WatchCreativesResponse>

[src]

Watches 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 be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.

@param parent

Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern bidders/{bidderAccountId}.

biddersEndpointsGet(name: string): Promise<Endpoint>

[src]

Gets a bidder endpoint by its name.

@param name

Required. Name of the bidder endpoint to get. Format: bidders/{bidderAccountId}/endpoints/{endpointId}

biddersEndpointsList(parent: string, opts?: BiddersEndpointsListOptions): Promise<ListEndpointsResponse>

[src]

Lists all the bidder's endpoints.

@param parent

Required. Name of the bidder whose endpoints will be listed. Format: bidders/{bidderAccountId}

biddersEndpointsPatch(name: string, req: Endpoint, opts?: BiddersEndpointsPatchOptions): Promise<Endpoint>

[src]

Updates a bidder's endpoint.

@param name

Output only. Name of the endpoint resource that must follow the pattern bidders/{bidderAccountId}/endpoints/{endpointId}, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.

biddersGet(name: string): Promise<Bidder>

[src]

Gets a bidder account by its name.

@param name

Required. Name of the bidder to get. Format: bidders/{bidderAccountId}

biddersList(opts?: BiddersListOptions): Promise<ListBiddersResponse>

[src]

Lists all the bidder accounts that belong to the caller.

biddersPretargetingConfigsActivate(name: string, req: ActivatePretargetingConfigRequest): Promise<PretargetingConfig>

[src]

Activates a pretargeting configuration.

@param name

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsAddTargetedApps(pretargetingConfig: string, req: AddTargetedAppsRequest): Promise<PretargetingConfig>

[src]

Adds targeted apps to the pretargeting configuration.

@param pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsAddTargetedPublishers(pretargetingConfig: string, req: AddTargetedPublishersRequest): Promise<PretargetingConfig>

[src]

Adds targeted publishers to the pretargeting config.

@param pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsAddTargetedSites(pretargetingConfig: string, req: AddTargetedSitesRequest): Promise<PretargetingConfig>

[src]

Adds targeted sites to the pretargeting configuration.

@param pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsCreate(parent: string, req: PretargetingConfig): Promise<PretargetingConfig>

[src]

Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.

@param parent

Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId}

biddersPretargetingConfigsDelete(name: string): Promise<Empty>

[src]

Deletes a pretargeting configuration.

@param name

Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsGet(name: string): Promise<PretargetingConfig>

[src]

Gets a pretargeting configuration.

@param name

Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsList(parent: string, opts?: BiddersPretargetingConfigsListOptions): Promise<ListPretargetingConfigsResponse>

[src]

Lists all pretargeting configurations for a single bidder.

@param parent

Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId}

biddersPretargetingConfigsPatch(name: string, req: PretargetingConfig, opts?: BiddersPretargetingConfigsPatchOptions): Promise<PretargetingConfig>

[src]

Updates a pretargeting configuration.

@param name

Output only. Name of the pretargeting configuration that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_id}

biddersPretargetingConfigsRemoveTargetedApps(pretargetingConfig: string, req: RemoveTargetedAppsRequest): Promise<PretargetingConfig>

[src]

Removes targeted apps from the pretargeting configuration.

@param pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsRemoveTargetedPublishers(pretargetingConfig: string, req: RemoveTargetedPublishersRequest): Promise<PretargetingConfig>

[src]

Removes targeted publishers from the pretargeting config.

@param pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsRemoveTargetedSites(pretargetingConfig: string, req: RemoveTargetedSitesRequest): Promise<PretargetingConfig>

[src]

Removes targeted sites from the pretargeting configuration.

@param pretargetingConfig

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPretargetingConfigsSuspend(name: string, req: SuspendPretargetingConfigRequest): Promise<PretargetingConfig>

[src]

Suspends a pretargeting configuration.

@param name

Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}

biddersPublisherConnectionsBatchApprove(parent: string, req: BatchApprovePublisherConnectionsRequest): Promise<BatchApprovePublisherConnectionsResponse>

[src]

Batch approves multiple publisher connections.

@param parent

Required. The bidder for whom publisher connections will be approved. Format: bidders/{bidder} where {bidder} is the account ID of the bidder.

biddersPublisherConnectionsBatchReject(parent: string, req: BatchRejectPublisherConnectionsRequest): Promise<BatchRejectPublisherConnectionsResponse>

[src]

Batch rejects multiple publisher connections.

@param parent

Required. The bidder for whom publisher connections will be rejected. Format: bidders/{bidder} where {bidder} is the account ID of the bidder.

biddersPublisherConnectionsGet(name: string): Promise<PublisherConnection>

[src]

Gets a publisher connection.

@param name

Required. Name of the publisher whose connection information is to be retrieved. In the pattern bidders/{bidder}/publisherConnections/{publisher} where {bidder} is the account ID of the bidder, and {publisher} is the ads.txt/app-ads.txt publisher ID. See publisherConnection.name.

biddersPublisherConnectionsList(parent: string, opts?: BiddersPublisherConnectionsListOptions): Promise<ListPublisherConnectionsResponse>

[src]

Lists publisher connections for a given bidder.

@param parent

Required. Name of the bidder for which publishers have initiated connections. The pattern for this resource is bidders/{bidder} where {bidder} represents the account ID of the bidder.

buyersCreativesCreate(parent: string, req: Creative): Promise<Creative>

[src]

Creates a creative.

@param parent

Required. The name of the parent buyer that the new creative belongs to that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.

buyersCreativesGet(name: string, opts?: BuyersCreativesGetOptions): Promise<Creative>

[src]

Gets a creative.

@param name

Required. Name of the creative to retrieve. See creative.name.

buyersCreativesList(parent: string, opts?: BuyersCreativesListOptions): Promise<ListCreativesResponse>

[src]

@param parent

buyersCreativesPatch(name: string, req: Creative, opts?: BuyersCreativesPatchOptions): Promise<Creative>

[src]

Updates a creative.

@param name

Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

buyersGet(name: string): Promise<Buyer>

[src]

Gets a buyer account by its name.

@param name

Required. Name of the buyer to get. Format: buyers/{buyerId}

buyersGetRemarketingTag(name: string): Promise<GetRemarketingTagResponse>

[src]

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 Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

@param name

Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.

buyersList(opts?: BuyersListOptions): Promise<ListBuyersResponse>

[src]

Lists all buyer account information the calling buyer user or service account is permissioned to manage.

buyersUserListsClose(name: string, req: CloseUserListRequest): Promise<UserList>

[src]

Changes the status of a user list to CLOSED. This prevents new users from being added to the user list.

@param name

Required. The name of the user list to close. See UserList.name

buyersUserListsCreate(parent: string, req: UserList): Promise<UserList>

[src]

Creates a new user list.

@param parent

Required. The name of the parent buyer of the user list to be retrieved, which must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.

buyersUserListsGet(name: string): Promise<UserList>

[src]

Gets a user list by its name.

@param name

Required. The name of the user list to be retrieved. See UserList.name.

buyersUserListsGetRemarketingTag(name: string): Promise<GetRemarketingTagResponse>

[src]

@param name

buyersUserListsList(parent: string, opts?: BuyersUserListsListOptions): Promise<ListUserListsResponse>

[src]

Lists the user lists visible to the current user.

@param parent

Required. The name of the parent buyer for the user lists to be returned that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , {buyerAccountId} should represent the account ID of the child seat buyer.

buyersUserListsOpen(name: string, req: OpenUserListRequest): Promise<UserList>

[src]

Changes the status of a user list to OPEN. This allows new users to be added to the user list.

@param name

Required. The name of the user list to open. See UserList.name

buyersUserListsUpdate(name: string, req: UserList): Promise<UserList>

[src]

Updates the given user list. Only user lists with URLRestrictions can be updated.

@param name

Output only. Name of the user list that must follow the pattern buyers/{buyer}/userLists/{user_list}, where {buyer} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyer} represents the account ID of the child seat buyer. {user_list} is an int64 identifier assigned by Google to uniquely identify a user list.