Method: projects.databases.documents.batchGet

Birden fazla doküman alır.

Bu yöntemle geri gönderilen dokümanların istendiği sırayla gönderileceği garanti edilmez.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
database

string

Zorunlu. Veritabanı adı. Belirtilen biçimde: projects/{projectId}/databases/{databaseId}.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "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.
}
Alanlar
documents[]

string

Alınacak dokümanların adları. Belirtilen biçimde: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Belgelerden herhangi biri belirtilen database öğesinin alt kaynağı değilse istek başarısız olur. Yinelenen adlar çıkarılır.
mask

object (DocumentMask)

Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür.

Bir dokümanda, bu maskede bulunmayan bir alan varsa bu alan yanıtta döndürülmez.
Birleştirme alanı consistency_selector. Bu işlem için tutarlılık modu. Ayarlanmazsa varsayılan olarak güçlü tutarlılık kullanılır. consistency_selector şunlardan yalnızca biri olabilir:
transaction

string (bytes format)

Bir işlemdeki belgeleri okur.

base64 kodlu bir dize.
newTransaction

object (TransactionOptions)

Yeni bir işlem başlatır ve belgeleri okur. Varsayılan olarak salt okunur işlem kullanılır. Yeni işlem kimliği, akıştaki ilk yanıt olarak döndürülür.
readTime

string (Timestamp format)

Belgeleri belirtilen zamanda olduğu gibi okur.

Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

Yanıt gövdesi

Firestore.BatchGetDocuments için akışlı yanıt.

Başarılı olursa yanıt gövdesi aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "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.
}
Alanlar
transaction

string (bytes format)

Bu istek kapsamında başlatılan işlem. Yalnızca ilk yanıtta ve istekte BatchGetDocumentsRequest.new_transaction ayarlanmışsa ayarlanır.

base64 kodlu bir dize.
readTime

string (Timestamp format)

Belgenin okunma zamanı. Bu değer tekdüze şekilde artıyor olabilir. Bu durumda, sonuç akışında yer alan önceki dokümanların ReadTime ile bu doküman arasında değişmediği garanti edilir.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
Birleştirme alanı result. Tek bir sonuç. Sunucu yalnızca bir işlem döndürüyorsa bu alan boş olabilir. result şunlardan yalnızca biri olabilir:
found

object (Document)

İstenen bir belge.
missing

string

İstenen ancak mevcut olmayan bir belge adı. Belirtilen biçimde: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.