Show / Hide Table of Contents

Class BuyersResource.AuctionPackagesResource

The "auctionPackages" collection of methods.

Inheritance
object
BuyersResource.AuctionPackagesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.AuthorizedBuyersMarketplace.v1alpha
Assembly: Google.Apis.AuthorizedBuyersMarketplace.v1alpha.dll
Syntax
public class BuyersResource.AuctionPackagesResource

Constructors

AuctionPackagesResource(IClientService)

Constructs a new resource.

Declaration
public AuctionPackagesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Get(string)

Gets an auction package given its name.

Declaration
public virtual BuyersResource.AuctionPackagesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
BuyersResource.AuctionPackagesResource.GetRequest

List(string)

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

Declaration
public virtual BuyersResource.AuctionPackagesResource.ListRequest List(string parent)
Parameters
Type Name Description
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}.

Returns
Type Description
BuyersResource.AuctionPackagesResource.ListRequest

Subscribe(SubscribeAuctionPackageRequest, string)

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.

Declaration
public virtual BuyersResource.AuctionPackagesResource.SubscribeRequest Subscribe(SubscribeAuctionPackageRequest body, string name)
Parameters
Type Name Description
SubscribeAuctionPackageRequest body

The body of the request.

string name

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

Returns
Type Description
BuyersResource.AuctionPackagesResource.SubscribeRequest

SubscribeClients(SubscribeClientsRequest, string)

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.

Declaration
public virtual BuyersResource.AuctionPackagesResource.SubscribeClientsRequest SubscribeClients(SubscribeClientsRequest body, string auctionPackage)
Parameters
Type Name Description
SubscribeClientsRequest body

The body of the request.

string auctionPackage

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

Returns
Type Description
BuyersResource.AuctionPackagesResource.SubscribeClientsRequest

Unsubscribe(UnsubscribeAuctionPackageRequest, string)

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.

Declaration
public virtual BuyersResource.AuctionPackagesResource.UnsubscribeRequest Unsubscribe(UnsubscribeAuctionPackageRequest body, string name)
Parameters
Type Name Description
UnsubscribeAuctionPackageRequest body

The body of the request.

string name

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

Returns
Type Description
BuyersResource.AuctionPackagesResource.UnsubscribeRequest

UnsubscribeClients(UnsubscribeClientsRequest, string)

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

Declaration
public virtual BuyersResource.AuctionPackagesResource.UnsubscribeClientsRequest UnsubscribeClients(UnsubscribeClientsRequest body, string auctionPackage)
Parameters
Type Name Description
UnsubscribeClientsRequest body

The body of the request.

string auctionPackage

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

Returns
Type Description
BuyersResource.AuctionPackagesResource.UnsubscribeClientsRequest
In this article
Back to top Generated by DocFX