Local Administrator
114 lines
5.0 KiB
PHP
114 lines
5.0 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2014 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
* use this file except in compliance with the License. You may obtain a copy of
|
|
* the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations under
|
|
* the License.
|
|
*/
|
|
|
|
namespace Google\Service\AdExchangeBuyerII\Resource;
|
|
|
|
use Google\Service\AdExchangeBuyerII\ListProposalsResponse;
|
|
use Google\Service\AdExchangeBuyerII\PauseProposalDealsRequest;
|
|
use Google\Service\AdExchangeBuyerII\Proposal;
|
|
use Google\Service\AdExchangeBuyerII\ResumeProposalDealsRequest;
|
|
|
|
/**
|
|
* The "finalizedProposals" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $adexchangebuyer2Service = new Google\Service\AdExchangeBuyerII(...);
|
|
* $finalizedProposals = $adexchangebuyer2Service->accounts_finalizedProposals;
|
|
* </code>
|
|
*/
|
|
class AccountsFinalizedProposals extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* List finalized proposals, regardless if a proposal is being renegotiated. A
|
|
* filter expression (PQL query) may be specified to filter the results. The
|
|
* notes will not be returned.
|
|
* (finalizedProposals.listAccountsFinalizedProposals)
|
|
*
|
|
* @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 listAccountsFinalizedProposals($accountId, $optParams = [])
|
|
{
|
|
$params = ['accountId' => $accountId];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], ListProposalsResponse::class);
|
|
}
|
|
/**
|
|
* Update given deals to pause serving. This method will set the
|
|
* `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all
|
|
* listed deals in the request. Currently, this method only applies to PG and PD
|
|
* deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to
|
|
* pause already-paused deals. It is an error to call PauseProposalDeals for
|
|
* deals which are not part of the proposal of proposal_id or which are not
|
|
* finalized or renegotiating. (finalizedProposals.pause)
|
|
*
|
|
* @param string $accountId Account ID of the buyer.
|
|
* @param string $proposalId The proposal_id of the proposal containing the
|
|
* deals.
|
|
* @param PauseProposalDealsRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Proposal
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function pause($accountId, $proposalId, PauseProposalDealsRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('pause', [$params], Proposal::class);
|
|
}
|
|
/**
|
|
* Update given deals to resume serving. This method will set the
|
|
* `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all
|
|
* listed deals in the request. Currently, this method only applies to PG and PD
|
|
* deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op
|
|
* to resume running deals or deals paused by the other party. It is an error to
|
|
* call ResumeProposalDeals for deals which are not part of the proposal of
|
|
* proposal_id or which are not finalized or renegotiating.
|
|
* (finalizedProposals.resume)
|
|
*
|
|
* @param string $accountId Account ID of the buyer.
|
|
* @param string $proposalId The proposal_id of the proposal containing the
|
|
* deals.
|
|
* @param ResumeProposalDealsRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Proposal
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function resume($accountId, $proposalId, ResumeProposalDealsRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['accountId' => $accountId, 'proposalId' => $proposalId, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('resume', [$params], Proposal::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(AccountsFinalizedProposals::class, 'Google_Service_AdExchangeBuyerII_Resource_AccountsFinalizedProposals');
|