Method: locations.get

  • Retrieves the details of a specified location using a GET request.

  • Requires providing the location's name as a path parameter and optionally a read mask as a query parameter to control the data returned.

  • The response includes the location information if authorized with the https://www.googleapis.com/auth/business.manage scope.

  • Request body should be empty for this operation.

Returns the specified location.

HTTP request

GET https://mybusinessbusinessinformation.googleapis.com/v1/{name=locations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the location to fetch.

Query parameters

Parameters
readMask

string (FieldMask format)

Required. Read mask to specify what fields will be returned in the response.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.