Method: accounts.gbpAccounts.linkGbpAccount
Stay organized with collections
Save and categorize content based on your preferences.
Link the specified merchant to a GBP account for all countries.
To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message User is not an administrator of account {ACCOUNT_ID}.
HTTP request
POST https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/gbpAccounts:linkGbpAccount
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the parent resource to which the GBP account is linked. Format: accounts/{account}.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"gbpEmail": string
} |
| Fields |
gbpEmail |
string
Required. The email address of the Business Profile account.
|
Response body
Response message for the gbpAccounts.linkGbpAccount method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"response": {
object
}
} |
| Fields |
response |
object
Empty response.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
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 2025-07-31 UTC.
[null,null,["Last updated 2025-07-31 UTC."],[],[],null,["# Method: accounts.gbpAccounts.linkGbpAccount\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 - [JSON representation](#body.LinkGbpAccountResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLink the specified merchant to a GBP account for all countries.\n\nTo run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message `User is not an administrator of account {ACCOUNT_ID}`.\n\n### HTTP request\n\n`POST https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/gbpAccounts:linkGbpAccount`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the parent resource to which the GBP account is linked. Format: `accounts/{account}`. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------|\n| ``` { \"gbpEmail\": string } ``` |\n\n| Fields ||\n|------------|-----------------------------------------------------------------------|\n| `gbpEmail` | `string` Required. The email address of the Business Profile account. |\n\n### Response body\n\nResponse message for the gbpAccounts.linkGbpAccount method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------|\n| ``` { \"response\": { object } } ``` |\n\n| Fields ||\n|------------|--------------------------|\n| `response` | `object` Empty response. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
