Method: accounts.gbpAccounts.linkGbpAccount

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.