1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AdExchangeBuyer
  7. \
  8. Resource
  9. \
  10. Proposals

Proposals

class Proposals extends Resource (View source)

The "proposals" collection of methods.

Typical usage is:

 $adexchangebuyerService = new Google\Service\AdExchangeBuyer(...);
 $proposals = $adexchangebuyerService->proposals;

Methods

Proposal
get(string $proposalId, array $optParams = [])

Get a proposal given its id (proposals.get)

CreateOrdersResponse
insert(CreateOrdersRequest $postBody, array $optParams = [])

Create the given list of proposals (proposals.insert)

Proposal
patch(string $proposalId, string $revisionNumber, string $updateAction, Proposal $postBody, array $optParams = [])

Update the given proposal. This method supports patch semantics.

GetOrdersResponse
search(array $optParams = [])

Search for proposals using pql query (proposals.search)

setupcomplete(string $proposalId, array $optParams = [])

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

Proposal
update(string $proposalId, string $revisionNumber, string $updateAction, Proposal $postBody, array $optParams = [])

Update the given proposal (proposals.update)

Details

at line 42
Proposal get(string $proposalId, array $optParams = [])

Get a proposal given its id (proposals.get)

Parameters

string $proposalId

Id of the proposal to retrieve.
array $optParams

Optional parameters.

Return Value

Proposal

at line 55
CreateOrdersResponse insert(CreateOrdersRequest $postBody, array $optParams = [])

Create the given list of proposals (proposals.insert)

Parameters

CreateOrdersRequest $postBody
array $optParams

Optional parameters.

Return Value

CreateOrdersResponse

at line 76
Proposal patch(string $proposalId, string $revisionNumber, string $updateAction, Proposal $postBody, array $optParams = [])

Update the given proposal. This method supports patch semantics.

(proposals.patch)

Parameters

string $proposalId

The proposal id to update.
string $revisionNumber

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.
string $updateAction

The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
Proposal $postBody
array $optParams

Optional parameters.

Return Value

Proposal

Search for proposals using pql query (proposals.search)

Parameters

array $optParams

Optional parameters.

Return Value

GetOrdersResponse

at line 103
setupcomplete(string $proposalId, array $optParams = [])

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

(proposals.setupcomplete)

Parameters

string $proposalId

The proposal id for which the setup is complete
array $optParams

Optional parameters.

at line 123
Proposal update(string $proposalId, string $revisionNumber, string $updateAction, Proposal $postBody, array $optParams = [])

Update the given proposal (proposals.update)

Parameters

string $proposalId

The proposal id to update.
string $revisionNumber

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.
string $updateAction

The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
Proposal $postBody
array $optParams

Optional parameters.

Return Value

Proposal