Class AccountsResource.ProposalsResource

The "proposals" collection of methods.

Inheritance

object

AccountsResource.ProposalsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.AdExchangeBuyerII.v2beta1

Assembly: Google.Apis.AdExchangeBuyerII.v2beta1.dll

Syntax

public class AccountsResource.ProposalsResource

Constructors

ProposalsResource(IClientService)

Constructs a new resource.

Declaration

public ProposalsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Accept(AcceptProposalRequest, string, string)

Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an ABORTED error message will be returned. This call updates the proposal_state from PROPOSED to BUYER_ACCEPTED, or from SELLER_ACCEPTED to FINALIZED. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.

Declaration

public virtual AccountsResource.ProposalsResource.AcceptRequest Accept(AcceptProposalRequest body, string accountId, string proposalId)

Parameters

Type	Name	Description
AcceptProposalRequest	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The ID of the proposal to accept.

Returns

Type	Description
AccountsResource.ProposalsResource.AcceptRequest

AddNote(AddNoteRequest, string, string)

Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.

Declaration

public virtual AccountsResource.ProposalsResource.AddNoteRequest AddNote(AddNoteRequest body, string accountId, string proposalId)

Parameters

Type	Name	Description
AddNoteRequest	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The ID of the proposal to attach the note to.

Returns

Type	Description
AccountsResource.ProposalsResource.AddNoteRequest

CancelNegotiation(CancelNegotiationRequest, string, string)

Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.

Declaration

public virtual AccountsResource.ProposalsResource.CancelNegotiationRequest CancelNegotiation(CancelNegotiationRequest body, string accountId, string proposalId)

Parameters

Type	Name	Description
CancelNegotiationRequest	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The ID of the proposal to cancel negotiation for.

Returns

Type	Description
AccountsResource.ProposalsResource.CancelNegotiationRequest

CompleteSetup(CompleteSetupRequest, string, string)

You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API. This call updates the is_setup_completed field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To mark an individual deal as ready to serve, call buyers.finalizedDeals.setReadyToServe in the Marketplace API.

Declaration

public virtual AccountsResource.ProposalsResource.CompleteSetupRequest CompleteSetup(CompleteSetupRequest body, string accountId, string proposalId)

Parameters

Type	Name	Description
CompleteSetupRequest	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The ID of the proposal to mark as setup completed.

Returns

Type	Description
AccountsResource.ProposalsResource.CompleteSetupRequest

Create(Proposal, string)

Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.

Declaration

public virtual AccountsResource.ProposalsResource.CreateRequest Create(Proposal body, string accountId)

Parameters

Type	Name	Description
Proposal	body	The body of the request.
string	accountId	Account ID of the buyer.

Returns

Type	Description
AccountsResource.ProposalsResource.CreateRequest

Get(string, string)

Gets a proposal given its ID. The proposal is returned at its head revision.

Declaration

public virtual AccountsResource.ProposalsResource.GetRequest Get(string accountId, string proposalId)

Parameters

Type	Name	Description
string	accountId	Account ID of the buyer.
string	proposalId	The unique ID of the proposal

Returns

Type	Description
AccountsResource.ProposalsResource.GetRequest

List(string)

List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.

Declaration

public virtual AccountsResource.ProposalsResource.ListRequest List(string accountId)

Parameters

Type	Name	Description
string	accountId	Account ID of the buyer.

Returns

Type	Description
AccountsResource.ProposalsResource.ListRequest

Pause(PauseProposalRequest, string, string)

Update the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.

Declaration

public virtual AccountsResource.ProposalsResource.PauseRequest Pause(PauseProposalRequest body, string accountId, string proposalId)

Parameters

Type	Name	Description
PauseProposalRequest	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The ID of the proposal to pause.

Returns

Type	Description
AccountsResource.ProposalsResource.PauseRequest

Resume(ResumeProposalRequest, string, string)

Update the given proposal to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all deals in the proposal. Note that if the has_seller_paused bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.

Declaration

public virtual AccountsResource.ProposalsResource.ResumeRequest Resume(ResumeProposalRequest body, string accountId, string proposalId)

Parameters

Type	Name	Description
ResumeProposalRequest	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The ID of the proposal to resume.

Returns

Type	Description
AccountsResource.ProposalsResource.ResumeRequest

Update(Proposal, string, string)

Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision, an ABORTED error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a deal_id, the server will assign a new unique ID and create the deal. If passed-in deal has a deal_id, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a deal_id not present at head.

Declaration

public virtual AccountsResource.ProposalsResource.UpdateRequest Update(Proposal body, string accountId, string proposalId)

Parameters

Type	Name	Description
Proposal	body	The body of the request.
string	accountId	Account ID of the buyer.
string	proposalId	The unique ID of the proposal.

Returns

Type	Description
AccountsResource.ProposalsResource.UpdateRequest