GOgoogle
buyers

POST /v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients

Changed on

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.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace

Path parameters

buyersIdstring required
auctionPackagesIdstring required

Request body

clientsstring[]

Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format buyers/{accountId}/clients/{clientAccountId}. The current buyer will be subscribed to the auction package regardless of the list contents if not already.

Response

Successful response

createTimestring google-datetime

Output only. Time the auction package was created.

creatorstring

Output only. The buyer that created this auction package. Format: buyers/{buyerAccountId}

dealOwnerSeatIdstring

Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.

descriptionstring

Output only. A description of the auction package.

displayNamestring

The display_name assigned to the auction package.

eligibleSeatIdsstring[]

Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.

namestring

Immutable. The unique identifier for the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId} The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.

subscribedBuyersstring[]

Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: buyers/{buyerAccountId}

subscribedClientsstring[]

Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: buyers/{buyerAccountId}/clients/{clientAccountId}

updateTimestring google-datetime

Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.

Changes