class AccountsProposals extends Resource (View source)

The "proposals" collection of methods.

Typical usage is:

 $adexchangebuyer2Service = new Google\Service\AdExchangeBuyerII(...);
 $proposals = $adexchangebuyer2Service->accounts_proposals;

Methods

accept(string $accountId, string $proposalId, AcceptProposalRequest $postBody, array $optParams = [])

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. (proposals.accept)

addNote(string $accountId, string $proposalId, AddNoteRequest $postBody, array $optParams = [])

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. (proposals.addNote)

cancelNegotiation(string $accountId, string $proposalId, CancelNegotiationRequest $postBody, array $optParams = [])

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. (proposals.cancelNegotiation)

completeSetup(string $accountId, string $proposalId, CompleteSetupRequest $postBody, array $optParams = [])

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.

create(string $accountId, Proposal $postBody, array $optParams = [])

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

get(string $accountId, string $proposalId, array $optParams = [])

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

listAccountsProposals(string $accountId, array $optParams = [])

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. (proposals.listAccountsProposals)

pause(string $accountId, string $proposalId, PauseProposalRequest $postBody, array $optParams = [])

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. (proposals.pause)

resume(string $accountId, string $proposalId, ResumeProposalRequest $postBody, array $optParams = [])

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. (proposals.resume)

update(string $accountId, string $proposalId, Proposal $postBody, array $optParams = [])

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. (proposals.update)

Details

Proposal accept(string $accountId, string $proposalId, AcceptProposalRequest $postBody, array $optParams = [])

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. (proposals.accept)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The ID of the proposal to accept.

AcceptProposalRequest $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

Note addNote(string $accountId, string $proposalId, AddNoteRequest $postBody, array $optParams = [])

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. (proposals.addNote)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The ID of the proposal to attach the note to.

AddNoteRequest $postBody
array $optParams

Optional parameters.

Return Value

Note

Exceptions

Exception

Proposal cancelNegotiation(string $accountId, string $proposalId, CancelNegotiationRequest $postBody, array $optParams = [])

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. (proposals.cancelNegotiation)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The ID of the proposal to cancel negotiation for.

CancelNegotiationRequest $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

Proposal completeSetup(string $accountId, string $proposalId, CompleteSetupRequest $postBody, array $optParams = [])

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.

(proposals.completeSetup)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The ID of the proposal to mark as setup completed.

CompleteSetupRequest $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

Proposal create(string $accountId, Proposal $postBody, array $optParams = [])

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

Parameters

string $accountId

Account ID of the buyer.

Proposal $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

Proposal get(string $accountId, string $proposalId, array $optParams = [])

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

(proposals.get)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The unique ID of the proposal

array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

ListProposalsResponse listAccountsProposals(string $accountId, array $optParams = [])

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. (proposals.listAccountsProposals)

Parameters

string $accountId

Account ID of the buyer.

array $optParams

Optional parameters.

Return Value

ListProposalsResponse

Exceptions

Exception

Proposal pause(string $accountId, string $proposalId, PauseProposalRequest $postBody, array $optParams = [])

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. (proposals.pause)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The ID of the proposal to pause.

PauseProposalRequest $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

Proposal resume(string $accountId, string $proposalId, ResumeProposalRequest $postBody, array $optParams = [])

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. (proposals.resume)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The ID of the proposal to resume.

ResumeProposalRequest $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception

Proposal update(string $accountId, string $proposalId, Proposal $postBody, array $optParams = [])

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. (proposals.update)

Parameters

string $accountId

Account ID of the buyer.

string $proposalId

The unique ID of the proposal.

Proposal $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Exceptions

Exception