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. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
[[["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-06-13 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eLocations\u003c/code\u003e interface provides location-related information for a service, with service-specific metadata available through the \u003ccode\u003eLocation.metadata\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetLocation\u003c/code\u003e method retrieves information about a specific location using a \u003ccode\u003eGetLocationRequest\u003c/code\u003e, and it requires specific OAuth scopes for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListLocations\u003c/code\u003e method lists supported locations for a service using a \u003ccode\u003eListLocationsRequest\u003c/code\u003e, supporting filtering, pagination, and also requires specific OAuth scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eLocation\u003c/code\u003e message represents a Google Cloud location, containing details like the resource name, location ID, display name, labels, and service-specific metadata.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetLocationRequest\u003c/code\u003e and \u003ccode\u003eListLocationsRequest\u003c/code\u003e are the request messages used by \u003ccode\u003eGetLocation\u003c/code\u003e and \u003ccode\u003eListLocations\u003c/code\u003e respectively, and \u003ccode\u003eListLocationsResponse\u003c/code\u003e is the message that is returned by \u003ccode\u003eListLocations\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Package google.cloud.location\n\nIndex\n-----\n\n- [Locations](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations) (interface)\n- [GetLocationRequest](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest) (message)\n- [ListLocationsRequest](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest) (message)\n- [ListLocationsResponse](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse) (message)\n- [Location](/artifact-registry/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](/artifact-registry/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](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.GetLocation).\n\nListLocationsRequest\n--------------------\n\nThe request message for [Locations.ListLocations](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nListLocationsResponse\n---------------------\n\nThe response message for [Locations.ListLocations](/artifact-registry/docs/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nLocation\n--------\n\nA resource that represents a Google Cloud location."]]
