An abstract interface that provides location-related information for a service. Service-specific metadata is provided through theLocation.metadatafield.
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 inAIP-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 thenext_page_tokenfield in the response. Send that page token to receive the subsequent page.
[[["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-16 UTC."],[[["\u003cp\u003eThis document outlines the \u003ccode\u003eLocations\u003c/code\u003e interface, which provides location-related information for Google Cloud services, accessible through the \u003ccode\u003eGetLocation\u003c/code\u003e and \u003ccode\u003eListLocations\u003c/code\u003e methods.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetLocation\u003c/code\u003e method allows you to retrieve information about a specific location, requiring specific OAuth scopes for authorization, and utilizes the \u003ccode\u003eGetLocationRequest\u003c/code\u003e and \u003ccode\u003eLocation\u003c/code\u003e messages.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListLocations\u003c/code\u003e method lets you list supported locations for a service, supporting filtering and pagination through the \u003ccode\u003eListLocationsRequest\u003c/code\u003e and returning results in a \u003ccode\u003eListLocationsResponse\u003c/code\u003e message.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eLocation\u003c/code\u003e messages contain details like the location's name, ID, display name, labels, and service-specific metadata, providing comprehensive details for each location.\u003c/p\u003e\n"],["\u003cp\u003eBoth the \u003ccode\u003eGetLocation\u003c/code\u003e and \u003ccode\u003eListLocations\u003c/code\u003e methods need to have authorization scopes such as \u003ccode\u003ehttps://www.googleapis.com/auth/appengine.admin\u003c/code\u003e , \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform.read-only\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Package google.cloud.location\n\nIndex\n-----\n\n- [Locations](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations) (interface)\n- [GetLocationRequest](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.GetLocationRequest) (message)\n- [ListLocationsRequest](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsRequest) (message)\n- [ListLocationsResponse](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.ListLocationsResponse) (message)\n- [Location](/appengine/docs/admin-api/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](/appengine/docs/admin-api/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](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations.GetLocation).\n\nListLocationsRequest\n--------------------\n\nThe request message for [Locations.ListLocations](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nListLocationsResponse\n---------------------\n\nThe response message for [Locations.ListLocations](/appengine/docs/admin-api/reference/rpc/google.cloud.location#google.cloud.location.Locations.ListLocations).\n\nLocation\n--------\n\nA resource that represents Google Cloud Platform location."]]
