Method: accounts.proposals.accept
Stay organized with collections
Save and categorize content based on your preferences.
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 proposalState from PROPOSED
to BUYER_ACCEPTED
, or from SELLER_ACCEPTED
to FINALIZED
. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.
HTTP request
POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/proposals/{proposalId}:accept
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
accountId |
string
Account ID of the buyer.
|
proposalId |
string
The ID of the proposal to accept.
|
Request body
The request body contains data with the following structure:
JSON representation |
{
"proposalRevision": string
} |
Fields |
proposalRevision |
string (int64 format)
The last known client revision number of the proposal.
|
Response body
If successful, the response body contains an instance of Proposal
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adexchange.buyer
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThis endpoint allows buyers to accept a proposal, implicitly agreeing to its terms and conditions.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the buyer's account ID, the proposal ID, and the proposal's revision number.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the updated Proposal object with a state of \u003ccode\u003eBUYER_ACCEPTED\u003c/code\u003e or \u003ccode\u003eFINALIZED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required with the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThis action updates the proposal's state from \u003ccode\u003ePROPOSED\u003c/code\u003e to \u003ccode\u003eBUYER_ACCEPTED\u003c/code\u003e or from \u003ccode\u003eSELLER_ACCEPTED\u003c/code\u003e to \u003ccode\u003eFINALIZED\u003c/code\u003e.\u003c/p\u003e\n"]]],["This API endpoint facilitates the acceptance of a proposal. A `POST` request is sent to the specified URL, including the `accountId` and `proposalId` in the path. The request body requires a JSON object with `proposalRevision`, representing the last known revision number. Successful execution updates the proposal's state to `BUYER_ACCEPTED` or `FINALIZED`. The response contains a `Proposal` object. The action requires the `https://www.googleapis.com/auth/adexchange.buyer` OAuth scope.\n"],null,["# Method: accounts.proposals.accept\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nMark 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 proposalState from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.\n\n### HTTP request\n\n`POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/proposals/{proposalId}:accept`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|--------------------------------------------|\n| `accountId` | `string` Account ID of the buyer. |\n| `proposalId` | `string` The ID of the proposal to accept. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|----------------------------------------|---|\n| ``` { \"proposalRevision\": string } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| `proposalRevision` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The last known client revision number of the proposal. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Proposal](/authorized-buyers/apis/reference/rest/v2beta1/accounts.proposals#Proposal).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]