Method: projects.databases.documents.get

Pobiera pojedynczy dokument.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Nazwa zasobu dokumentu do pobrania. W formacie: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parametry zapytania

Parametry
mask

object (DocumentMask)

Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola.

Jeśli dokument zawiera pole, którego nie ma w masce, nie zostanie ono zwrócone w odpowiedzi.
Parametr sumy funkcji consistency_selector. Tryb spójności tej transakcji. Jeśli nie jest skonfigurowana, domyślnie stosowana jest silna spójność. consistency_selector może być tylko jedną z tych wartości:
transaction

string (bytes format)

Odczytuje dokument w transakcji.

Ciąg zakodowany w standardzie base64.
readTime

string (Timestamp format)

Odczytywanie wersji dokumentu 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ść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Document.

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.