Method: buyers.auctionPackages.subscribe
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.
HTTP request
POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/auctionPackages/*}:subscribe
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of AuctionPackage
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/authorized-buyers-marketplace
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["Subscribe to an auction package to receive inventory call outs matching specified criteria for a particular buyer."],["The API request is a POST request sent to the URL `https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/auctionPackages/*}:subscribe`, replacing placeholders with specific buyer and auction package IDs."],["An empty request body is required, and a successful response returns an AuctionPackage object."],["Authorization requires the `https://www.googleapis.com/auth/authorized-buyers-marketplace` OAuth scope."]]],["This document details the process to subscribe a buyer to an auction package. A `POST` request is sent to the specified URL, including the required `name` parameter in the path, which indicates the auction package's ID. The request body should be empty. Upon success, the response returns an `AuctionPackage` instance. This process uses gRPC Transcoding and requires the `authorized-buyers-marketplace` OAuth scope for authorization. Subscription enables bidders to receive call outs for relevant inventory.\n"]]