Method: projects.databases.collectionGroups.fields.list

Wyświetla konfigurację pola i metadane tej bazy danych.

Obecnie FirestoreAdmin.ListFields obsługuje tylko pola listy, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj to zdarzenie FirestoreAdmin.ListFields z filtrem ustawionym na wartość 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 zostanie zastosowany do wyników z listy. Obecnie FirestoreAdmin.ListFields obsługuje tylko pola listy, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj to zdarzenie FirestoreAdmin.ListFields z filtrem ustawionym na wartość 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ź dotycząca: 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 służyć do żądania innej strony wyników. Jeśli to pole jest puste, jest to ostatnia strona.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.