An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the Location.metadata field.
The resource that owns the locations collection, if applicable.
filter
string
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
page_size
int32
The maximum number of results to return. If not set, the service selects a default.
page_token
string
A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
extra_location_types[]
string
Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[],[],null,["# Package google.cloud.location\n\nIndex\n-----\n\n- [Locations](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Locations) (interface)\n- [GetLocationRequest](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest) (message)\n- [ListLocationsRequest](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest) (message)\n- [ListLocationsResponse](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse) (message)\n- [Location](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Location) (message)\n\nLocations\n---------\n\nAn abstract interface that provides location-related information for a service. Service-specific metadata is provided through the [Location.metadata](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Location.FIELDS.google.protobuf.Any.google.cloud.location.Location.metadata) field.\n\n| GetLocation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` rpc GetLocation(`[GetLocationRequest](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest)`) returns (`[Location](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Location)`) ` Gets information about a location. Authorization scopes : Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/datastore` - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2). |\n\n| ListLocations |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` rpc ListLocations(`[ListLocationsRequest](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest)`) returns (`[ListLocationsResponse](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse)`) ` Lists information about the supported locations for this service. Authorization scopes : Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/datastore` - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2). |\n\nGetLocationRequest\n------------------\n\nThe request message for [Locations.GetLocation](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Locations.GetLocation).\n\n| Fields ||\n|--------|------------------------------------------|\n| `name` | `string` Resource name for the location. |\n\nListLocationsRequest\n--------------------\n\nThe request message for [Locations.ListLocations](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\n| Fields ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource that owns the locations collection, if applicable. |\n| `filter` | `string` A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |\n| `page_size` | `int32` The maximum number of results to return. If not set, the service selects a default. |\n| `page_token` | `string` A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |\n| `extra_location_types[]` | `string` Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. |\n\nListLocationsResponse\n---------------------\n\nThe response message for [Locations.ListLocations](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locations[]` | [Location](/docs/firestore/reference/rpc/google.cloud.location#google.cloud.location.Location) A list of locations that matches the specified filter in the request. |\n| `next_page_token` | `string` The standard List next-page token. |\n\nLocation\n--------\n\nA resource that represents a Google Cloud location.\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"` |\n| `location_id` | `string` The canonical id for this location. For example: `\"us-east1\"`. |\n| `display_name` | `string` The friendly name for this location, typically a nearby city name. For example, \"Tokyo\". |\n| `labels` | `map\u003cstring, string\u003e` Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} |\n| `metadata` | [Any](https://protobuf.dev/reference/protobuf/google.protobuf/#any) Service-specific metadata. For example the available capacity at the given location. |"]]
