1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AuthorizedBuyersMarketplace
  7. \
  8. Resource
  9. \
  10. BuyersAuctionPackages

BuyersAuctionPackages

class BuyersAuctionPackages extends Resource (View source)

The "auctionPackages" collection of methods.

Typical usage is:

 $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
 $auctionPackages = $authorizedbuyersmarketplaceService->buyers_auctionPackages;

Methods

AuctionPackage
get(string $name, array $optParams = [])

Gets an auction package given its name. (auctionPackages.get)

ListAuctionPackagesResponse
listBuyersAuctionPackages(string $parent, array $optParams = [])

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.

AuctionPackage
subscribe(string $name, SubscribeAuctionPackageRequest $postBody, array $optParams = [])

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.

AuctionPackage
subscribeClients(string $auctionPackage, SubscribeClientsRequest $postBody, array $optParams = [])

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.

AuctionPackage
unsubscribe(string $name, UnsubscribeAuctionPackageRequest $postBody, array $optParams = [])

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. (auctionPackages.unsubscribe)

AuctionPackage
unsubscribeClients(string $auctionPackage, UnsubscribeClientsRequest $postBody, array $optParams = [])

Unsubscribe from the auction package for the specified clients of the buyer.

Details

at line 46
AuctionPackage get(string $name, array $optParams = [])

Gets an auction package given its name. (auctionPackages.get)

Parameters

string $name

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

Optional parameters.

Return Value

AuctionPackage

Exceptions

Exception

at line 84
ListAuctionPackagesResponse listBuyersAuctionPackages(string $parent, array $optParams = [])

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.

(auctionPackages.listBuyersAuctionPackages)

Parameters

string $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}.
array $optParams

Optional parameters.

Return Value

ListAuctionPackagesResponse

Exceptions

Exception

at line 103
AuctionPackage subscribe(string $name, SubscribeAuctionPackageRequest $postBody, array $optParams = [])

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.

(auctionPackages.subscribe)

Parameters

string $name

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}
SubscribeAuctionPackageRequest $postBody
array $optParams

Optional parameters.

Return Value

AuctionPackage

Exceptions

Exception

at line 123
AuctionPackage subscribeClients(string $auctionPackage, SubscribeClientsRequest $postBody, array $optParams = [])

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.

(auctionPackages.subscribeClients)

Parameters

string $auctionPackage

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}
SubscribeClientsRequest $postBody
array $optParams

Optional parameters.

Return Value

AuctionPackage

Exceptions

Exception

at line 141
AuctionPackage unsubscribe(string $name, UnsubscribeAuctionPackageRequest $postBody, array $optParams = [])

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. (auctionPackages.unsubscribe)

Parameters

string $name

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}
UnsubscribeAuctionPackageRequest $postBody
array $optParams

Optional parameters.

Return Value

AuctionPackage

Exceptions

Exception

at line 159
AuctionPackage unsubscribeClients(string $auctionPackage, UnsubscribeClientsRequest $postBody, array $optParams = [])

Unsubscribe from the auction package for the specified clients of the buyer.

Unsubscribing a client that is not subscribed will have no effect. (auctionPackages.unsubscribeClients)

Parameters

string $auctionPackage

Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}
UnsubscribeClientsRequest $postBody
array $optParams

Optional parameters.

Return Value

AuctionPackage

Exceptions

Exception