2026-11-10
▼ ▲ mybusinessbusinessinformation.accounts.locations.create
Description : Creates a new Location that will be owned by the logged in user.
Flat Path : v1alpha/accounts/{accountsId}/locations
Parameter Order : parent
Parameters :
parent
Pattern : ^accounts/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the account in which to create this location.
Type : string
requestId
Type : string
Location : query
Description : Optional. A unique request ID for the server to detect duplicated requests. We recommend using UUIDs. Max length is 50 characters.
validateOnly
Location : query
Description : Optional. If true, the request is validated without actually creating the location.
Type : boolean
HTTP Method : POST
Path : v1alpha/{+parent}/locations
▼ ▲ mybusinessbusinessinformation.accounts.locations.list
Parameter Order : parent
HTTP Method : GET
Description : Lists the locations for the specified account.
Path : v1alpha/{+parent}/locations
Flat Path : v1alpha/accounts/{accountsId}/locations
Parameters :
pageToken
Type : string
Description : Optional. If specified, it fetches the next `page` of locations. The page token is returned by previous calls to `ListLocations` when there were more locations than could fit in the requested page size.
Location : query
orderBy
Description : Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.
parent
Pattern : ^accounts/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the account to fetch locations from. * **Specific Account ID**: If the account is of type `AccountType.PERSONAL`, the response returns only locations directly owned by that account. For all other types (e.g., `AccountType.LOCATION_GROUP`), it returns all accessible locations. * **Wildcard (`-`)**: Using `accounts/-` identifies the authenticated user. This scope defaults to `AccountType.PERSONAL` but includes both directly and indirectly owned locations (e.g., those accessible via member groups).
Location : path
filter
Type : string
Description : Optional. A filter constraining the locations to return. The response includes only entries that match the filter. If `filter` is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see [Work with Location Data Guide](https://developers.google.com/my-business/content/location-data#filter_results_when_you_list_locations).
Location : query
readMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. Read mask to specify what fields will be returned in the response.
▼ ▲ mybusinessbusinessinformation.locations.patch
Path : v1alpha/{+name}
Flat Path : v1alpha/locations/{locationsId}
HTTP Method : PATCH
Description : Updates the specified location.
Parameters :
validateOnly
Type : boolean
Location : query
Description : Optional. If true, the request is validated without actually updating the location. When this field is set, we will only return validation errors if there were any. The response will be empty if no errors were found.
updateMask
Description : Required. The specific fields to update.
Type : string
Format : google-fieldmask
Location : query
name
Required : Yes
Pattern : ^locations/[^/]+$
Description : Identifier. Google identifier for this location in the form: `locations/{location_id}`.
Location : path
Type : string
Parameter Order : name
▼ ▲ mybusinessbusinessinformation.locations.getExtended
Parameters :
name
Pattern : ^locations/[^/]+$
Required : Yes
Description : Required. The name of the location to fetch.
Location : path
Type : string
HTTP Method : GET
Parameter Order : name
Flat Path : v1alpha/locations/{locationsId}:getExtended
Path : v1alpha/{+name}:getExtended
Description : Returns the specified location with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes a mapping of field paths to metadata describing the current state of edits on that field, its origin source, and rejection details.
▼ ▲ mybusinessbusinessinformation.locations.get
Parameter Order : name
Description : Returns the specified location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.
Parameters :
readMask
Format : google-fieldmask
Location : query
Description : Required. Read mask to specify what fields will be returned in the response.
Type : string
name
Description : Required. The name of the location to fetch.
Required : Yes
Pattern : ^locations/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/locations/{locationsId}
Path : v1alpha/{+name}
HTTP Method : GET
▼ ▲ mybusinessbusinessinformation.locations.getGoogleUpdated
Parameter Order : name
Parameters :
readMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. Read mask to specify what fields will be returned in the response.
name
Required : Yes
Pattern : ^locations/[^/]+$
Location : path
Description : Required. The name of the location to fetch.
Type : string
Path : v1alpha/{+name}:getGoogleUpdated
HTTP Method : GET
Flat Path : v1alpha/locations/{locationsId}:getGoogleUpdated
Description : Returns the specified location as it appears live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version. The returned GoogleUpdatedLocation contains masks that indicate which fields differ from the merchant's information.
▼ ▲ mybusinessbusinessinformation.locations.delete
Flat Path : v1alpha/locations/{locationsId}
Parameters :
name
Type : string
Description : Required. The name of the location to delete.
Location : path
Pattern : ^locations/[^/]+$
Required : Yes
Path : v1alpha/{+name}
Parameter Order : name
Description : Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.
HTTP Method : DELETE
▼ ▲ mybusinessbusinessinformation.locations.updateAttributes
Parameter Order : name
Flat Path : v1alpha/locations/{locationsId}/attributes
Description : Update attributes for a given location.
Path : v1alpha/{+name}
HTTP Method : PATCH
Parameters :
name
Required : Yes
Description : Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
Location : path
Pattern : ^locations/[^/]+/attributes$
Type : string
attributeMask
Format : google-fieldmask
Description : Required. Attribute name of attributes that you'd like to update. Represented by `attributes/{attribute}`. Updates: All attributes provided in the attributes field that you would like to update must be set in the `attribute_mask`. Attributes set in the above list but not in the `attribute_mask` will be ignored. Deletes: If you'd like to delete certain attributes, they must be specified in the `attribute_mask` with no matching entry in the attributes list. If you'd like to delete all attributes set on a location, you should look up all the applicable attributes for the location and then add them to the `attribute_mask` with an empty attributes field.
Type : string
Location : query
▼ ▲ mybusinessbusinessinformation.locations.getAttributes
HTTP Method : GET
Path : v1alpha/{+name}
Parameters :
name
Location : path
Required : Yes
Pattern : ^locations/[^/]+/attributes$
Description : Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
Type : string
Description : Retrieves attributes for a location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.
Flat Path : v1alpha/locations/{locationsId}/attributes
Parameter Order : name
▼ ▲ mybusinessbusinessinformation.locations.attributes.getExtended
Parameters :
name
Type : string
Location : path
Description : Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
Pattern : ^locations/[^/]+/attributes$
Required : Yes
Description : Returns the specified attributes with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes metadata describing the current state of edits on each attribute, its origin source, and rejection details.
HTTP Method : GET
Parameter Order : name
Flat Path : v1alpha/locations/{locationsId}/attributes:getExtended
Path : v1alpha/{+name}:getExtended
▼ ▲ mybusinessbusinessinformation.locations.attributes.getGoogleUpdated
Description : Retrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version.
Path : v1alpha/{+name}:getGoogleUpdated
Parameter Order : name
Flat Path : v1alpha/locations/{locationsId}/attributes:getGoogleUpdated
Parameters :
name
Pattern : ^locations/[^/]+/attributes$
Location : path
Description : Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
Required : Yes
Type : string
HTTP Method : GET
▼ ▲ mybusinessbusinessinformation.googleLocations.search
Description : Search all of the possible locations that are a match to the specified request.
Flat Path : v1alpha/googleLocations:search
HTTP Method : POST
Path : v1alpha/googleLocations:search
▼ ▲ mybusinessbusinessinformation.attributes.list
Description : Returns the list of attributes that would be available for a location with the given primary category and country.
Flat Path : v1alpha/attributes
Path : v1alpha/attributes
Parameters :
pageToken
Description : If specified, the next page of attribute metadata is retrieved.
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
Description : How many attributes to include per page. Default is 200, minimum is 1.
categoryName
Location : query
Description : Optional. The primary category stable ID to find available attributes. Must be of the format `categories/{category_id}` (e.g., `categories/gcid:restaurant`). Required if `parent` is not set and `show_all` is false.
Type : string
regionCode
Location : query
Description : Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if `parent` is not set.
Type : string
showAll
Type : boolean
Location : query
Description : Optional. If set to true, metadata for all available attributes are returned, disregarding `parent` and `category_name` fields. `language_code` and `region_code` are required when `show_all` is set to true.
parent
Description : Optional. Resource name of the location to look up available attributes. If this field is set, `category_name`, `region_code`, `language_code` and `show_all` are not required and must not be set. Format: `locations/{location_id}` (e.g., `locations/1234567890`).
Location : query
Type : string
languageCode
Type : string
Location : query
Description : Optional. The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.
HTTP Method : GET
▼ ▲ mybusinessbusinessinformation.categories.list
Flat Path : v1alpha/categories
Path : v1alpha/categories
Parameters :
filter
Description : Optional. Filter string from user. The only field that supported is `displayName`. Eg: `filter=displayName=foo`.
Location : query
Type : string
pageToken
Description : Optional. If specified, the next page of categories will be fetched.
Type : string
Location : query
languageCode
Description : Required. The BCP 47 code of language.
Location : query
Type : string
view
Enum Descriptions :
Type : string
Enum :
Description : Required. Specifies which parts to the Category resource should be returned in the response.
Location : query
regionCode
Description : Required. The ISO 3166-1 alpha-2 country code.
Type : string
Location : query
pageSize
Type : integer
Description : Optional. How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.
Format : int32
Location : query
HTTP Method : GET
Description : Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').
▼ ▲ mybusinessbusinessinformation.categories.batchGet
Description : Returns a list of business categories for the provided language and GConcept ids.
HTTP Method : GET
Parameters :
names
Repeated : Yes
Type : string
Description : Required. At least one name must be set. The GConcept ids the localized category names should be returned for. To return details for more than one category, repeat this parameter in the request.
Location : query
regionCode
Description : Optional. The ISO 3166-1 alpha-2 country code used to infer non-standard language.
Type : string
Location : query
view
Location : query
Type : string
Enum :
Enum Descriptions :
Description : Required. Specifies which parts to the Category resource should be returned in the response.
languageCode
Type : string
Location : query
Description : Required. The BCP 47 code of language that the category names should be returned in.
Path : v1alpha/categories:batchGet
Flat Path : v1alpha/categories:batchGet
▼ ▲ mybusinessbusinessinformation.chains.get
Path : v1alpha/{+name}
Description : Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.
Flat Path : v1alpha/chains/{chainsId}
Parameter Order : name
HTTP Method : GET
Parameters :
name
Description : Required. The chain's resource name, in the format `chains/{chain_place_id}`.
Location : path
Type : string
Required : Yes
Pattern : ^chains/[^/]+$
▼ ▲ mybusinessbusinessinformation.chains.search
Path : v1alpha/chains:search
Description : Searches the chain based on chain name.
Flat Path : v1alpha/chains:search
HTTP Method : GET
Parameters :
pageSize
Location : query
Description : The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.
Type : integer
Format : int32
chainName
Location : query
Type : string
Description : Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"