Method: projects.databases.documents.batchGet

Pobiera wiele dokumentów.

Nie możemy zagwarantować, że dokumenty zwrócone przez tę metodę zostaną zwrócone w takiej kolejności, w jakiej były żądane.

Żą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

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 nie powiedzie się, jeśli którykolwiek z dokumentów nie jest zasobem podrzędnym danego elementu database. Zduplikowane nazwy zostaną wykluczone.
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 tej masce, nie zostanie ono 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 być tylko jedną z tych wartości:
transaction

string (bytes format)

Odczytywanie dokumentów w transakcji.

Ciąg zakodowany w standardzie base64.
newTransaction

object (TransactionOptions)

Rozpoczyna nową transakcję i odczytuje dokumenty. Domyślnie transakcja jest 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 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

Przesłana odpowiedź przesłana strumieniowo dla użytkownika 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 parametr BatchGetDocumentsRequest.new_transaction.

Ciąg zakodowany w standardzie base64.
readTime

string (Timestamp format)

Godzina odczytu dokumentu. Wartość ta może rosnąć monologicznie. W tym przypadku na pewno poprzednie dokumenty w strumieniu wyników nie zmienią się między wartością readTime a tym dokumentem.

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".
Pole sumy result. Jeden wynik. To pole może być puste, jeśli serwer tylko zwraca transakcję. result może być tylko jedną z tych wartości:
found

object (Document)

Dokument, którego dotyczyło żądanie.
missing

string

Podana nazwa dokumentu nie istnieje. W formacie: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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.