Method: projects.locations.list

Lista informacji o obsługiwanych lokalizacjach dla tej usługi.

Żądanie HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Zasób, do którego należy kolekcja lokalizacji (w stosownych przypadkach).

Parametry zapytania

Parametry
filter

string

Filtr zawężający wyniki do preferowanego podzbioru. Język filtrowania akceptuje ciągi takie jak "displayName=tokyo". Szczegółowy opis tego języka zawiera AIP-160.
pageSize

integer

Maksymalna liczba wyników do zwrócenia. Jeśli zasada nie jest skonfigurowana, usługa wybiera wartość domyślną.
pageToken

string

Token strony odebrany z pola nextPageToken w odpowiedzi. Wyślij token tej strony, aby otrzymać kolejną stronę.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią dla: Locations.ListLocations.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Pola
locations[]

object (Location)

Lista lokalizacji, które pasują do określonego filtra w żądaniu.
nextPageToken

string

Standardowy token listy następnej strony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).