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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis documentation describes the \u003ccode\u003eLocations\u003c/code\u003e interface, which provides location-related information for Google Cloud services, and uses the \u003ccode\u003eLocation.metadata\u003c/code\u003e field for service-specific details.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetLocation\u003c/code\u003e method retrieves detailed information about a specific location, requiring specific OAuth scopes for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListLocations\u003c/code\u003e method enables listing supported locations for a service, and supports filtering, page sizing, and pagination with a page token.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetLocationRequest\u003c/code\u003e and \u003ccode\u003eListLocationsRequest\u003c/code\u003e are used for requesting location data, where the List variant is able to use specific field parameters to customize the list.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListLocationsResponse\u003c/code\u003e and \u003ccode\u003eLocation\u003c/code\u003e contain the actual data returned, where a \u003ccode\u003eListLocationsResponse\u003c/code\u003e returns a list of \u003ccode\u003eLocation\u003c/code\u003e fields, which contains information such as name, id, display name, labels, and service-specific metadata.\u003c/p\u003e\n"]]],[],null,["# Package google.cloud.location\n\nIndex\n-----\n\n- [Locations](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations) (interface)\n- [GetLocationRequest](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest) (message)\n- [ListLocationsRequest](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest) (message)\n- [ListLocationsResponse](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse) (message)\n- [Location](/firestore/docs/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](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.Location.FIELDS.google.protobuf.Any.google.cloud.location.Location.metadata) field.\n\nGetLocationRequest\n------------------\n\nThe request message for [Locations.GetLocation](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.GetLocation).\n\nListLocationsRequest\n--------------------\n\nThe request message for [Locations.ListLocations](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nListLocationsResponse\n---------------------\n\nThe response message for [Locations.ListLocations](/firestore/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nLocation\n--------\n\nA resource that represents a Google Cloud location."]]
