![[Google Cloud Documentation]](https://www.gstatic.com/devrel-devsite/prod/v0f3a5b8b76e4a120372a69044e02756e703b6140f9f1812c6e4a0407b19864b7/clouddocs/images/lockup_full_color.svg){kind=link}
![[]](https://docs.cloud.google.com/_static/clouddocs/images/icons/categories/ai-and-machine-learning-color.svg){kind=link}
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided in the ListLocationsRequest.name field:
- Global locations: If
nameis empty, the method lists the public locations available to all projects. - Project-specific locations: If
namefollows the formatprojects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.
For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
HTTP request
GET https://{endpoint}/v2/{name=projects/*}/locations
Where {endpoint} is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
The resource that owns the locations collection, if applicable. |
Query parameters
| Parameters | |
|---|---|
filter |
A filter to narrow down results to a preferred subset. The filtering language accepts strings like |
pageSize |
The maximum number of results to return. If not set, the service selects a default. |
pageToken |
A page token received from the |
extraLocationTypes[] |
Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
Request body
The request body must be empty.
Response body
The response message for Locations.ListLocations.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"locations": [
{
object ( |
| Fields | |
|---|---|
locations[] |
A list of locations that matches the specified filter in the request. |
nextPageToken |
The standard List next-page token. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/dialogflow
For more information, see the Authentication Overview.