class BuyersProposalsDeals extends Resource (View source)

The "deals" collection of methods.

Typical usage is:

 $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
 $deals = $authorizedbuyersmarketplaceService->buyers_proposals_deals;

Methods

batchUpdate(string $parent, BatchUpdateDealsRequest $postBody, array $optParams = [])

Batch updates multiple deals in the same proposal. (deals.batchUpdate)

get(string $name, array $optParams = [])

Gets a deal given its name. The deal is returned at its head revision.

listBuyersProposalsDeals(string $parent, array $optParams = [])

Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.

patch(string $name, Deal $postBody, array $optParams = [])

Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.

Details

BatchUpdateDealsResponse batchUpdate(string $parent, BatchUpdateDealsRequest $postBody, array $optParams = [])

Batch updates multiple deals in the same proposal. (deals.batchUpdate)

Parameters

string $parent

Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}

BatchUpdateDealsRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchUpdateDealsResponse

Exceptions

Exception

Deal get(string $name, array $optParams = [])

Gets a deal given its name. The deal is returned at its head revision.

(deals.get)

Parameters

string $name

Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}

array $optParams

Optional parameters.

Return Value

Deal

Exceptions

Exception

ListDealsResponse listBuyersProposalsDeals(string $parent, array $optParams = [])

Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.

(deals.listBuyersProposalsDeals)

Parameters

string $parent

Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}

array $optParams

Optional parameters.

Return Value

ListDealsResponse

Exceptions

Exception

Deal patch(string $name, Deal $postBody, array $optParams = [])

Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.

(deals.patch)

Parameters

string $name

Immutable. The unique identifier of the deal. Auto- generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}

Deal $postBody
array $optParams

Optional parameters.

Return Value

Deal

Exceptions

Exception