Method: projects.databases.documents.listCollectionIds

Wyświetla listę wszystkich identyfikatorów kolekcji pod dokumentem.

Żądanie HTTP

POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Dokument nadrzędny. W formacie: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Przykład: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Pola
pageSize

integer

Maksymalna liczba wyników do zwrócenia.
pageToken

string

Token strony. Musi to być wartość z ListCollectionIdsResponse.
Pole sumy consistency_selector. Tryb spójności dla tego żądania. Jeśli nie jest skonfigurowana, domyślnie stosowana jest silna spójność. consistency_selector może być tylko jedną z tych wartości:
readTime

string (Timestamp format)

Odczytuje dokumenty w takiej postaci, w jakiej były w danym momencie.

Musi to być sygnatura czasowa precyzji określona w mikrosekundach z ostatniej godziny lub jeśli włączona jest funkcja odzyskiwania do określonego momentu, może to być dodatkowo sygnatura czasowa obejmująca całą minutę z ostatnich 7 dni.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Treść odpowiedzi

Odpowiedź od użytkownika Firestore.ListCollectionIds.

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

Zapis JSON 
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Pola
collectionIds[]

string

Identyfikatory kolekcji.
nextPageToken

string

Token strony, który może służyć do kontynuowania listy.

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.