Class BuyersResource.FinalizedDealsResource

The "finalizedDeals" collection of methods.

Inheritance

object

BuyersResource.FinalizedDealsResource

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.FinalizedDealsResource

Constructors

FinalizedDealsResource(IClientService)

Constructs a new resource.

Declaration

public FinalizedDealsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AddCreative(AddCreativeRequest, string)

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.

Declaration

public virtual BuyersResource.FinalizedDealsResource.AddCreativeRequest AddCreative(AddCreativeRequest body, string deal)

Parameters

Type	Name	Description
AddCreativeRequest	body	The body of the request.
string	deal	Required. Name of the finalized deal in the format of: buyers/{accountId}/finalizedDeals/{dealId}

Returns

Type	Description
BuyersResource.FinalizedDealsResource.AddCreativeRequest

Get(string)

Gets a finalized deal given its name.

Declaration

public virtual BuyersResource.FinalizedDealsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

Returns

Type	Description
BuyersResource.FinalizedDealsResource.GetRequest

List(string)

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

Declaration

public virtual BuyersResource.FinalizedDealsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	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}.

Returns

Type	Description
BuyersResource.FinalizedDealsResource.ListRequest

Pause(PauseFinalizedDealRequest, string)

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 and preferred deals.

Declaration

public virtual BuyersResource.FinalizedDealsResource.PauseRequest Pause(PauseFinalizedDealRequest body, string name)

Parameters

Type	Name	Description
PauseFinalizedDealRequest	body	The body of the request.
string	name	Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

Returns

Type	Description
BuyersResource.FinalizedDealsResource.PauseRequest

Resume(ResumeFinalizedDealRequest, string)

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 and preferred deals.

Declaration

public virtual BuyersResource.FinalizedDealsResource.ResumeRequest Resume(ResumeFinalizedDealRequest body, string name)

Parameters

Type	Name	Description
ResumeFinalizedDealRequest	body	The body of the request.
string	name	Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

Returns

Type	Description
BuyersResource.FinalizedDealsResource.ResumeRequest

SetReadyToServe(SetReadyToServeRequest, string)

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.

Declaration

public virtual BuyersResource.FinalizedDealsResource.SetReadyToServeRequest SetReadyToServe(SetReadyToServeRequest body, string deal)

Parameters

Type	Name	Description
SetReadyToServeRequest	body	The body of the request.
string	deal	Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

Returns

Type	Description
BuyersResource.FinalizedDealsResource.SetReadyToServeRequest