Documentation

Google_Service_AdExchangeBuyerII_Resource_AccountsProposals extends Google_Service_Resource
in package

Application

The "proposals" collection of methods.

Typical usage is: $adexchangebuyer2Service = new Google_Service_AdExchangeBuyerII(...); $proposals = $adexchangebuyer2Service->proposals;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
accept() : Google_Service_AdExchangeBuyerII_Proposal: 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`.
addNote() : Google_Service_AdExchangeBuyerII_Note: 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)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
cancelNegotiation() : Google_Service_AdExchangeBuyerII_Proposal: 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() : Google_Service_AdExchangeBuyerII_Proposal: Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal. (proposals.completeSetup)
create() : Google_Service_AdExchangeBuyerII_Proposal: Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server. (proposals.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_AdExchangeBuyerII_Proposal: Gets a proposal given its ID. The proposal is returned at its head revision.
listAccountsProposals() : Google_Service_AdExchangeBuyerII_ListProposalsResponse: 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() : Google_Service_AdExchangeBuyerII_Proposal: 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() : Google_Service_AdExchangeBuyerII_Proposal: 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() : Google_Service_AdExchangeBuyerII_Proposal: 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)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

accept()

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`.


    public
                accept(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_AcceptProposalRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

(proposals.accept)

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The ID of the proposal to accept.
$postBody : Google_Service_AdExchangeBuyerII_AcceptProposalRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

addNote()

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)


    public
                addNote(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_AddNoteRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Note

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The ID of the proposal to attach the note to.
$postBody : Google_Service_AdExchangeBuyerII_AddNoteRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Note —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

cancelNegotiation()

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)


    public
                cancelNegotiation(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_CancelNegotiationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The ID of the proposal to cancel negotiation for.
$postBody : Google_Service_AdExchangeBuyerII_CancelNegotiationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

completeSetup()

Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal. (proposals.completeSetup)


    public
                completeSetup(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_CompleteSetupRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The ID of the proposal to mark as setup completed.
$postBody : Google_Service_AdExchangeBuyerII_CompleteSetupRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

create()

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


    public
                create(string $accountId, Google_Service_AdExchangeBuyerII_Proposal $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

Parameters

$accountId : string: Account ID of the buyer.
$postBody : Google_Service_AdExchangeBuyerII_Proposal
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

get()

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


    public
                get(string $accountId, string $proposalId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

(proposals.get)

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The unique ID of the proposal
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

listAccountsProposals()

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)


    public
                listAccountsProposals(string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ListProposalsResponse

Parameters

$accountId : string: Account ID of the buyer.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_ListProposalsResponse —

pause()

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)


    public
                pause(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_PauseProposalRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The ID of the proposal to pause.
$postBody : Google_Service_AdExchangeBuyerII_PauseProposalRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

resume()

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)


    public
                resume(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_ResumeProposalRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The ID of the proposal to resume.
$postBody : Google_Service_AdExchangeBuyerII_ResumeProposalRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

update()

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)


    public
                update(string $accountId, string $proposalId, Google_Service_AdExchangeBuyerII_Proposal $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Proposal

Parameters

$accountId : string: Account ID of the buyer.
$proposalId : string: The unique ID of the proposal.
$postBody : Google_Service_AdExchangeBuyerII_Proposal
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyerII_Proposal —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —