* $adexchangebuyer2Service = new Google\Service\AdExchangeBuyerII(...); * $proposals = $adexchangebuyer2Service->accounts_proposals; * */ class AccountsProposals extends \Google\Service\Resource { /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The ID of the proposal to accept. * @param AcceptProposalRequest $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function accept($accountId, $proposalId, AcceptProposalRequest $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('accept', [$params], Proposal::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The ID of the proposal to attach the note to. * @param AddNoteRequest $postBody * @param array $optParams Optional parameters. * @return Note * @throws \Google\Service\Exception */ public function addNote($accountId, $proposalId, AddNoteRequest $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('addNote', [$params], Note::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The ID of the proposal to cancel negotiation for. * @param CancelNegotiationRequest $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function cancelNegotiation($accountId, $proposalId, CancelNegotiationRequest $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('cancelNegotiation', [$params], Proposal::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The ID of the proposal to mark as setup completed. * @param CompleteSetupRequest $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function completeSetup($accountId, $proposalId, CompleteSetupRequest $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('completeSetup', [$params], Proposal::class); } /** * Create the given proposal. Each created proposal and any deals it contains * are assigned a unique ID by the server. (proposals.create) * * @param string $accountId Account ID of the buyer. * @param Proposal $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function create($accountId, Proposal $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Proposal::class); } /** * Gets a proposal given its ID. The proposal is returned at its head revision. * (proposals.get) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The unique ID of the proposal * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function get($accountId, $proposalId, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Proposal::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param array $optParams Optional parameters. * * @opt_param string filter An optional PQL filter query used to query for * proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, * cannot be filtered. * @opt_param string filterSyntax Syntax the filter is written in. Current * implementation defaults to PQL but in the future it will be LIST_FILTER. * @opt_param int pageSize Requested page size. The server may return fewer * results than requested. If unspecified, the server will pick an appropriate * default. * @opt_param string pageToken The page token as returned from * ListProposalsResponse. * @return ListProposalsResponse * @throws \Google\Service\Exception */ public function listAccountsProposals($accountId, $optParams = []) { $params = ['accountId' => $accountId]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListProposalsResponse::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The ID of the proposal to pause. * @param PauseProposalRequest $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function pause($accountId, $proposalId, PauseProposalRequest $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('pause', [$params], Proposal::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The ID of the proposal to resume. * @param ResumeProposalRequest $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function resume($accountId, $proposalId, ResumeProposalRequest $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('resume', [$params], Proposal::class); } /** * 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) * * @param string $accountId Account ID of the buyer. * @param string $proposalId The unique ID of the proposal. * @param Proposal $postBody * @param array $optParams Optional parameters. * @return Proposal * @throws \Google\Service\Exception */ public function update($accountId, $proposalId, Proposal $postBody, $optParams = []) { $params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('update', [$params], Proposal::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(AccountsProposals::class, 'Google_Service_AdExchangeBuyerII_Resource_AccountsProposals');