BuyersProposals
class BuyersProposals extends Resource (View source)
The "proposals" collection of methods.
Typical usage is:
$authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
$proposals = $authorizedbuyersmarketplaceService->buyers_proposals;Methods
Accepts the proposal at the given revision number. If the revision number in
the request is behind the latest from the server, an error message will be
returned. This call updates the Proposal.state from
BUYER_ACCEPTANCE_REQUESTED to FINALIZED; it has no side effect if the
Proposal.state is already FINALIZED and throws exception if the
Proposal.state is not either BUYER_ACCEPTANCE_REQUESTED or FINALIZED.
Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
Cancels an ongoing negotiation on a proposal. This does not cancel or end
serving for the deals if the proposal has been finalized. If the proposal has
not been finalized before, calling this method will set the Proposal.state to
TERMINATED and increment the Proposal.proposal_revision. If the proposal
has been finalized before and is under renegotiation now, calling this method
will reset the Proposal.state to FINALIZED and increment the
Proposal.proposal_revision. This method does not support private auction
proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
Gets a proposal using its resource name. The proposal is returned at the latest revision. (proposals.get)
Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.
Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged.
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher.
Details
Proposal
accept(string $name, AcceptProposalRequest $postBody, array $optParams = [])
Accepts the proposal at the given revision number. If the revision number in
the request is behind the latest from the server, an error message will be
returned. This call updates the Proposal.state from
BUYER_ACCEPTANCE_REQUESTED to FINALIZED; it has no side effect if the
Proposal.state is already FINALIZED and throws exception if the
Proposal.state is not either BUYER_ACCEPTANCE_REQUESTED or FINALIZED.
Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller. (proposals.accept)
Proposal
addNote(string $proposal, AddNoteRequest $postBody, array $optParams = [])
Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
(proposals.addNote)
Proposal
cancelNegotiation(string $proposal, CancelNegotiationRequest $postBody, array $optParams = [])
Cancels an ongoing negotiation on a proposal. This does not cancel or end
serving for the deals if the proposal has been finalized. If the proposal has
not been finalized before, calling this method will set the Proposal.state to
TERMINATED and increment the Proposal.proposal_revision. If the proposal
has been finalized before and is under renegotiation now, calling this method
will reset the Proposal.state to FINALIZED and increment the
Proposal.proposal_revision. This method does not support private auction
proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
(proposals.cancelNegotiation)
Proposal
get(string $name, array $optParams = [])
Gets a proposal using its resource name. The proposal is returned at the latest revision. (proposals.get)
ListProposalsResponse
listBuyersProposals(string $parent, array $optParams = [])
Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.
(proposals.listBuyersProposals)
Proposal
patch(string $name, Proposal $postBody, array $optParams = [])
Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged.
Updating a private auction proposal is not allowed and will result in an error. (proposals.patch)
Proposal
sendRfp(string $buyer, SendRfpRequest $postBody, array $optParams = [])
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher.
Once the RFP is sent, a proposal in SELLER_REVIEW_REQUESTED state will be
created and returned in the response. The publisher may review your request
and respond with detailed deals in the proposal. (proposals.sendRfp)