Method: projects.databases.collectionGroups.fields.list

Zawiera konfigurację pól i metadane tej bazy danych.

Obecnie FirestoreAdmin.ListFields obsługuje tylko te pola, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj funkcję FirestoreAdmin.ListFields z filtrem ustawionym na indexConfig.usesAncestorConfig:false.

Żądanie HTTP

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Nazwa elementu nadrzędnego formularza projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parametry zapytania

Parametry
filter

string

Filtr, który ma być stosowany do listy wyników. Obecnie FirestoreAdmin.ListFields obsługuje tylko te pola, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj funkcję FirestoreAdmin.ListFields z filtrem ustawionym na indexConfig.usesAncestorConfig:false.
pageSize

integer

Liczba wyników do zwrócenia.
pageToken

string

Token strony zwrócony z poprzedniego wywołania funkcji FirestoreAdmin.ListFields, który może zostać użyty do wyświetlenia następnej strony wyników.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź dla: FirestoreAdmin.ListFields.

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

Zapis JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Pola
fields[]

object (Field)

Wymagane pola.
nextPageToken

string

Token strony, który może być używany do żądania innej strony wyników. Jeśli pole jest puste, oznacza to, że jest to ostatnia strona.

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).