Documentation

Google_Service_AdExchangeBuyer_Resource_Proposals extends Google_Service_Resource
in package

Application

The "proposals" collection of methods.

Typical usage is: $adexchangebuyerService = new Google_Service_AdExchangeBuyer(...); $proposals = $adexchangebuyerService->proposals;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_AdExchangeBuyer_Proposal: Get a proposal given its id (proposals.get)
insert() : Google_Service_AdExchangeBuyer_CreateOrdersResponse: Create the given list of proposals (proposals.insert)
patch() : Google_Service_AdExchangeBuyer_Proposal: Update the given proposal. This method supports patch semantics.
search() : Google_Service_AdExchangeBuyer_GetOrdersResponse: Search for proposals using pql query (proposals.search)
setupcomplete() : mixed: Update the given proposal to indicate that setup has been completed.
update() : Google_Service_AdExchangeBuyer_Proposal: Update the given proposal (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 —

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 —

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()

Get a proposal given its id (proposals.get)


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

Parameters

$proposalId : string: Id of the proposal to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyer_Proposal —

insert()

Create the given list of proposals (proposals.insert)


    public
                insert(Google_Service_AdExchangeBuyer_CreateOrdersRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyer_CreateOrdersResponse

Parameters

$postBody : Google_Service_AdExchangeBuyer_CreateOrdersRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyer_CreateOrdersResponse —

patch()

Update the given proposal. This method supports patch semantics.


    public
                patch(string $proposalId, string $revisionNumber, string $updateAction, Google_Service_AdExchangeBuyer_Proposal $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyer_Proposal

(proposals.patch)

Parameters

$proposalId : string: The proposal id to update.
$revisionNumber : string: The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.
$updateAction : string: The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
$postBody : Google_Service_AdExchangeBuyer_Proposal
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyer_Proposal —

search()

Search for proposals using pql query (proposals.search)


    public
                search([array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyer_GetOrdersResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyer_GetOrdersResponse —

setupcomplete()

Update the given proposal to indicate that setup has been completed.


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

(proposals.setupcomplete)

Parameters

$proposalId : string: The proposal id for which the setup is complete
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

update()

Update the given proposal (proposals.update)


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

Parameters

$proposalId : string: The proposal id to update.
$revisionNumber : string: The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.
$updateAction : string: The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
$postBody : Google_Service_AdExchangeBuyer_Proposal
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AdExchangeBuyer_Proposal —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —