Method: projects.databases.documents.batchGet

Birden çok dokümanı alır.

Bu yöntemle döndürülen dokümanların istenen sırayla iade edileceği garanti edilmez.

HTTP isteği

POST https://firestore.googleapis.com/v1/{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ı. Biçimi: projects/{projectId}/databases/{databaseId}.

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler 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ı. Biçimi: 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ümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez.
Birleştirme alanı consistency_selector. Bu işlem için tutarlılık modu. Politika ayarlanmazsa varsayılan olarak güçlü tutarlılık sağlanı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 dokümanları okur. Varsayılan olarak işlem salt okunurdur. Yeni işlem kimliği, akışta ilk yanıt olarak döndürülür.
readTime

string (Timestamp format)

Dokümanları verilen zaman olduğu gibi okur.

Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

Yanıt gövdesi

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

Başarılı olursa yanıt metni 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 isteğin bir parçası olarak 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 okunduğu saat. Bu durum tek bir şekilde artıyor olabilir. Bu durumda, sonuç akışındaki önceki dokümanlarda, bunların ReadTime ve bu doküman arasında değişmemesi garanti edilir.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
Birleştirme alanı result. Tek bir sonuç. Sunucu sadece 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ı. Biçimi: 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ış sayfasına göz atın.