Method: accounts.gbpAccounts.list

    List the GBP accounts for a given merchant.

    HTTP request

    GET https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/gbpAccounts

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account} .

    Query parameters

    Parameters
    pageSize

    integer

    Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize . The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
    pageToken

    string

    Optional. A page token, received from a previous gbpAccounts.list call. Provide the page token to retrieve the subsequent page.

    When paginating, all other parameters provided to gbpAccounts.list must match the call that provided the page token.

    Request body

    The request body must be empty.

    Response body

    Response message for the gbpAccounts.list method.

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "gbpAccounts" 
 : 
 [ 
 { 
 object (  GbpAccount 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    gbpAccounts[]

    object ( GbpAccount )

    The GBP accounts from the specified merchant in the specified country.
    nextPageToken

    string

    A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    GbpAccount

    Collection of information related to a Google Business Profile (GBP) account.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "gbpAccountId" 
 : 
 string 
 , 
 "type" 
 : 
 enum (  Type 
 
) 
 , 
 "gbpAccountName" 
 : 
 string 
 , 
 "listingCount" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. The resource name of the GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}

    type

    enum ( Type )

    The type of the Business Profile.
    listingCount

    string ( int64 format)

    Number of listings under this account.

    Type

    The type of the GBP account.

    Enums
    TYPE_UNSPECIFIED Default value. This value is unused.
    USER The GBP account is a user account.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: