Method: projects.databases.documents.batchGet

Pobiera wiele dokumentów.

Nie ma gwarancji, że dokumenty zwrócone za pomocą tej metody zostaną zwrócone w kolejności, w jakiej je żądano.

Żądanie HTTP

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
database

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{projectId}/databases/{databaseId}.

Treść żądania

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

Zapis JSON 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Pola
documents[]

string

Nazwy dokumentów do pobrania. W formacie: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Żądanie zakończy się niepowodzeniem, jeśli żaden z dokumentów nie jest zasobem podrzędnym danego elementu database. Zduplikowane nazwy zostaną usunięte.
mask

object (DocumentMask)

Pola do zwrócenia. Jeśli zasada nie jest skonfigurowana, zwraca wszystkie pola.

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

string (bytes format)

Odczytywanie dokumentów w ramach transakcji.

Ciąg zakodowany w formacie base64.
newTransaction

object (TransactionOptions)

Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie jest to transakcja tylko do odczytu. Nowy identyfikator transakcji zostanie zwrócony jako pierwsza odpowiedź w strumieniu.
readTime

string (Timestamp format)

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

Musi to być sygnatura czasowa z dokładnością do mikrosekundy z ostatniej godziny. Jeśli odzyskiwanie do określonego momentu jest włączone, może to być dodatkowo pełna sygnatura czasowa z ostatnich 7 dni.

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

Treść odpowiedzi

Przesłana odpowiedź na zapytanie Firestore.BatchGetDocuments.

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

Zapis JSON 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
Pola
transaction

string (bytes format)

Transakcja rozpoczęta w ramach tego żądania. Zostanie ustawiona tylko w pierwszej odpowiedzi i tylko wtedy, gdy w żądaniu ustawiono atrybut BatchGetDocumentsRequest.new_transaction.

Ciąg zakodowany w formacie base64.
readTime

string (Timestamp format)

Czas odczytu dokumentu. Liczba ta może rosnąć monotycznie, w tym przypadku poprzednie dokumenty w strumieniu wyników nie ulegają zmianie między readTime a tym jednym.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
Pole sumy result. Jeden wynik. To pole może być puste, jeśli serwer tylko zwraca transakcję. result może mieć tylko jedną z tych wartości:
found

object (Document)

Dokument, o który poproszono.
missing

string

Nazwa dokumentu, która została wysłana, ale nie istnieje. W formacie: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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