AuthorizedBuyersMarketplace

import { AuthorizedBuyersMarketplace } from "https://googleapis.deno.dev/v1/authorizedbuyersmarketplace:v1.ts";

The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.

class AuthorizedBuyersMarketplace {

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

async biddersAuctionPackagesList(parent: string, opts?: BiddersAuctionPackagesListOptions): Promise<ListAuctionPackagesResponse>;

async biddersFinalizedDealsList(parent: string, opts?: BiddersFinalizedDealsListOptions): Promise<ListFinalizedDealsResponse>;

async buyersAuctionPackagesGet(name: string): Promise<AuctionPackage>;

async buyersAuctionPackagesList(parent: string, opts?: BuyersAuctionPackagesListOptions): Promise<ListAuctionPackagesResponse>;

async buyersAuctionPackagesSubscribe(name: string, req: SubscribeAuctionPackageRequest): Promise<AuctionPackage>;

async buyersAuctionPackagesSubscribeClients(auctionPackage: string, req: SubscribeClientsRequest): Promise<AuctionPackage>;

async buyersAuctionPackagesUnsubscribe(name: string, req: UnsubscribeAuctionPackageRequest): Promise<AuctionPackage>;

async buyersAuctionPackagesUnsubscribeClients(auctionPackage: string, req: UnsubscribeClientsRequest): Promise<AuctionPackage>;

async buyersClientsActivate(name: string, req: ActivateClientRequest): Promise<Client>;

async buyersClientsCreate(parent: string, req: Client): Promise<Client>;

async buyersClientsDeactivate(name: string, req: DeactivateClientRequest): Promise<Client>;

async buyersClientsGet(name: string): Promise<Client>;

async buyersClientsList(parent: string, opts?: BuyersClientsListOptions): Promise<ListClientsResponse>;

async buyersClientsPatch(

req: Client,

opts?: BuyersClientsPatchOptions,

): Promise<Client>;

async buyersClientsUsersActivate(name: string, req: ActivateClientUserRequest): Promise<ClientUser>;

async buyersClientsUsersCreate(parent: string, req: ClientUser): Promise<ClientUser>;

async buyersClientsUsersDeactivate(name: string, req: DeactivateClientUserRequest): Promise<ClientUser>;

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

async buyersClientsUsersGet(name: string): Promise<ClientUser>;

async buyersClientsUsersList(parent: string, opts?: BuyersClientsUsersListOptions): Promise<ListClientUsersResponse>;

async buyersFinalizedDealsAddCreative(deal: string, req: AddCreativeRequest): Promise<FinalizedDeal>;

async buyersFinalizedDealsGet(name: string): Promise<FinalizedDeal>;

async buyersFinalizedDealsList(parent: string, opts?: BuyersFinalizedDealsListOptions): Promise<ListFinalizedDealsResponse>;

async buyersFinalizedDealsPause(name: string, req: PauseFinalizedDealRequest): Promise<FinalizedDeal>;

async buyersFinalizedDealsResume(name: string, req: ResumeFinalizedDealRequest): Promise<FinalizedDeal>;

async buyersFinalizedDealsSetReadyToServe(deal: string, req: SetReadyToServeRequest): Promise<FinalizedDeal>;

async buyersProposalsAccept(name: string, req: AcceptProposalRequest): Promise<Proposal>;

async buyersProposalsAddNote(proposal: string, req: AddNoteRequest): Promise<Proposal>;

async buyersProposalsCancelNegotiation(proposal: string, req: CancelNegotiationRequest): Promise<Proposal>;

async buyersProposalsDealsBatchUpdate(parent: string, req: BatchUpdateDealsRequest): Promise<BatchUpdateDealsResponse>;

async buyersProposalsDealsGet(name: string): Promise<Deal>;

async buyersProposalsDealsList(parent: string, opts?: BuyersProposalsDealsListOptions): Promise<ListDealsResponse>;

async buyersProposalsDealsPatch(

req: Deal,

opts?: BuyersProposalsDealsPatchOptions,

): Promise<Deal>;

async buyersProposalsGet(name: string): Promise<Proposal>;

async buyersProposalsList(parent: string, opts?: BuyersProposalsListOptions): Promise<ListProposalsResponse>;

async buyersProposalsPatch(

req: Proposal,

opts?: BuyersProposalsPatchOptions,

): Promise<Proposal>;

async buyersProposalsSendRfp(buyer: string, req: SendRfpRequest): Promise<Proposal>;

async buyersPublisherProfilesGet(name: string): Promise<PublisherProfile>;

async buyersPublisherProfilesList(parent: string, opts?: BuyersPublisherProfilesListOptions): Promise<ListPublisherProfilesResponse>;

}

§Constructors

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

[src]

§Methods

biddersAuctionPackagesList(parent: string, opts?: BiddersAuctionPackagesListOptions): Promise<ListAuctionPackagesResponse>

[src]

List the auction packages. Buyers can use the URL path "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

@param parent

Required. Name of the parent buyer that can access the auction package. Format: buyers/{accountId}. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format bidders/{accountId}.

biddersFinalizedDealsList(parent: string, opts?: BiddersFinalizedDealsListOptions): Promise<ListFinalizedDealsResponse>

[src]

Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

@param parent

Required. The buyer to list the finalized deals for, in the format: buyers/{accountId}. When used to list finalized deals for a bidder, its buyers and clients, in the format bidders/{accountId}.

buyersAuctionPackagesGet(name: string): Promise<AuctionPackage>

[src]

Gets an auction package given its name.

@param name

Required. Name of auction package to get. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}

buyersAuctionPackagesList(parent: string, opts?: BuyersAuctionPackagesListOptions): Promise<ListAuctionPackagesResponse>

[src]

@param parent

buyersAuctionPackagesSubscribe(name: string, req: SubscribeAuctionPackageRequest): Promise<AuctionPackage>

[src]

Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.

@param name

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}

buyersAuctionPackagesSubscribeClients(auctionPackage: string, req: SubscribeClientsRequest): Promise<AuctionPackage>

[src]

Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.

@param auctionPackage

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}

buyersAuctionPackagesUnsubscribe(name: string, req: UnsubscribeAuctionPackageRequest): Promise<AuctionPackage>

[src]

Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.

@param name

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}

buyersAuctionPackagesUnsubscribeClients(auctionPackage: string, req: UnsubscribeClientsRequest): Promise<AuctionPackage>

[src]

Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.

@param auctionPackage

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}

buyersClientsActivate(name: string, req: ActivateClientRequest): Promise<Client>

[src]

Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.

@param name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}

buyersClientsCreate(parent: string, req: Client): Promise<Client>

[src]

Creates a new client.

@param parent

Required. The name of the buyer. Format: buyers/{accountId}

buyersClientsDeactivate(name: string, req: DeactivateClientRequest): Promise<Client>

[src]

Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.

@param name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}

buyersClientsGet(name: string): Promise<Client>

[src]

Gets a client with a given resource name.

@param name

Required. Format: buyers/{accountId}/clients/{clientAccountId}

buyersClientsList(parent: string, opts?: BuyersClientsListOptions): Promise<ListClientsResponse>

[src]

Lists all the clients for the current buyer.

@param parent

Required. The name of the buyer. Format: buyers/{accountId}

buyersClientsPatch(name: string, req: Client, opts?: BuyersClientsPatchOptions): Promise<Client>

[src]

Updates an existing client.

@param name

Output only. The resource name of the client. Format: buyers/{accountId}/clients/{clientAccountId}

buyersClientsUsersActivate(name: string, req: ActivateClientUserRequest): Promise<ClientUser>

[src]

Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.

@param name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

buyersClientsUsersCreate(parent: string, req: ClientUser): Promise<ClientUser>

[src]

Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

@param parent

Required. The name of the client. Format: buyers/{accountId}/clients/{clientAccountId}

buyersClientsUsersDeactivate(name: string, req: DeactivateClientUserRequest): Promise<ClientUser>

[src]

Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.

@param name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

buyersClientsUsersDelete(name: string): Promise<Empty>

[src]

Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.

@param name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

buyersClientsUsersGet(name: string): Promise<ClientUser>

[src]

Retrieves an existing client user.

@param name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

buyersClientsUsersList(parent: string, opts?: BuyersClientsUsersListOptions): Promise<ListClientUsersResponse>

[src]

Lists all client users for a specified client.

@param parent

Required. The name of the client. Format: buyers/{buyerAccountId}/clients/{clientAccountId}

buyersFinalizedDealsAddCreative(deal: string, req: AddCreativeRequest): Promise<FinalizedDeal>

[src]

Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.

@param deal

Required. Name of the finalized deal in the format of: buyers/{accountId}/finalizedDeals/{dealId}

buyersFinalizedDealsGet(name: string): Promise<FinalizedDeal>

[src]

Gets a finalized deal given its name.

@param name

Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

buyersFinalizedDealsList(parent: string, opts?: BuyersFinalizedDealsListOptions): Promise<ListFinalizedDealsResponse>

[src]

@param parent

Required. The buyer to list the finalized deals for, in the format: buyers/{accountId}. When used to list finalized deals for a bidder, its buyers and clients, in the format bidders/{accountId}.

buyersFinalizedDealsPause(name: string, req: PauseFinalizedDealRequest): Promise<FinalizedDeal>

[src]

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.

@param name

Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

buyersFinalizedDealsResume(name: string, req: ResumeFinalizedDealRequest): Promise<FinalizedDeal>

[src]

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.

@param name

Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

buyersFinalizedDealsSetReadyToServe(deal: string, req: SetReadyToServeRequest): Promise<FinalizedDeal>

[src]

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call setReadyToServe, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

@param deal

Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

buyersProposalsAccept(name: string, req: AcceptProposalRequest): Promise<Proposal>

[src]

Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from BUYER_ACCEPTANCE_REQUESTED to FINALIZED; it has no side effect if the Proposal.state is already FINALIZED and throws exception if the Proposal.state is not either BUYER_ACCEPTANCE_REQUESTED or FINALIZED. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.

@param name

Name of the proposal. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsAddNote(proposal: string, req: AddNoteRequest): Promise<Proposal>

[src]

Creates a note for this proposal and sends to the seller.

@param proposal

Name of the proposal. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsCancelNegotiation(proposal: string, req: CancelNegotiationRequest): Promise<Proposal>

[src]

Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to TERMINATED and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to FINALIZED and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.

@param proposal

Name of the proposal. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsDealsBatchUpdate(parent: string, req: BatchUpdateDealsRequest): Promise<BatchUpdateDealsResponse>

[src]

Batch updates multiple deals in the same proposal.

@param parent

Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsDealsGet(name: string): Promise<Deal>

[src]

Gets a deal given its name. The deal is returned at its head revision.

@param name

Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}

buyersProposalsDealsList(parent: string, opts?: BuyersProposalsDealsListOptions): Promise<ListDealsResponse>

[src]

Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.

@param parent

Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsDealsPatch(name: string, req: Deal, opts?: BuyersProposalsDealsPatchOptions): Promise<Deal>

[src]

Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.

@param name

Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}

buyersProposalsGet(name: string): Promise<Proposal>

[src]

Gets a proposal using its resource name. The proposal is returned at the latest revision.

@param name

Required. Name of the proposal. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsList(parent: string, opts?: BuyersProposalsListOptions): Promise<ListProposalsResponse>

[src]

Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.

@param parent

Required. Parent that owns the collection of proposals Format: buyers/{accountId}

buyersProposalsPatch(name: string, req: Proposal, opts?: BuyersProposalsPatchOptions): Promise<Proposal>

[src]

Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.

@param name

Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}

buyersProposalsSendRfp(buyer: string, req: SendRfpRequest): Promise<Proposal>

[src]

Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in SELLER_REVIEW_REQUESTED state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.

@param buyer

Required. The current buyer who is sending the RFP in the format: buyers/{accountId}.

buyersPublisherProfilesGet(name: string): Promise<PublisherProfile>

[src]

Gets the requested publisher profile by name.

@param name

Required. Name of the publisher profile. Format: buyers/{buyerId}/publisherProfiles/{publisherProfileId}

buyersPublisherProfilesList(parent: string, opts?: BuyersPublisherProfilesListOptions): Promise<ListPublisherProfilesResponse>

[src]

Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.

@param parent

Required. Parent that owns the collection of publisher profiles Format: buyers/{buyerId}