Method: projects.databases.documents.batchGet

چندین سند دریافت می کند.

اسنادی که با این روش بازگردانده می شوند، تضمینی برای بازگرداندن آنها به همان ترتیبی که درخواست شده است ندارند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
database

string

ضروری. نام پایگاه داده در قالب: projects/{projectId}/databases/{databaseId} .

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی 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.
}
زمینه های
documents[]

string

نام مدارکی که باید بازیابی شود. در قالب: projects/{projectId}/databases/{databaseId}/documents/{document_path} . اگر هر یک از اسناد منبع فرزند database داده شده نباشد، درخواست ناموفق خواهد بود. نام های تکراری حذف خواهند شد.

mask

object ( DocumentMask )

زمینه هایی برای بازگشت. اگر تنظیم نشود، همه فیلدها را برمی گرداند.

اگر سندی دارای فیلدی باشد که در این ماسک وجود ندارد، آن فیلد در پاسخ بازگردانده نخواهد شد.

اتحاد فیلد consistency_selector . حالت سازگاری برای این معامله. اگر تنظیم نشود، به طور پیش‌فرض روی سازگاری قوی تنظیم می‌شود. consistency_selector تنها می تواند یکی از موارد زیر باشد:
transaction

string ( bytes format)

اسناد را در یک معامله می خواند.

رشته ای با کد base64.

newTransaction

object ( TransactionOptions )

تراکنش جدیدی را شروع می کند و اسناد را می خواند. پیش‌فرض یک تراکنش فقط خواندنی. شناسه تراکنش جدید به عنوان اولین پاسخ در جریان بازگردانده می شود.

readTime

string ( Timestamp format)

اسناد را همانطور که در زمان معین بودند می خواند.

این باید یک مهر زمانی دقیق میکروثانیه در یک ساعت گذشته باشد، یا اگر بازیابی نقطه در زمان فعال باشد، می‌تواند یک مهر زمانی کامل در 7 روز گذشته باشد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

بدن پاسخگو

پاسخ جریانی برای Firestore.BatchGetDocuments .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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.
}
زمینه های
transaction

string ( bytes format)

معامله ای که به عنوان بخشی از این درخواست آغاز شد. فقط در اولین پاسخ تنظیم می شود و فقط در صورتی که BatchGetDocumentsRequest.new_transaction در درخواست تنظیم شده باشد.

رشته ای با کد base64.

readTime

string ( Timestamp format)

زمانی که سند خوانده شد. این ممکن است به طور یکنواخت در حال افزایش باشد، در این مورد اسناد قبلی در جریان نتیجه تضمین می شود که بین readTime و این یکی تغییر نکرده باشند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

result میدان اتحادیه یک نتیجه واحد اگر سرور فقط یک تراکنش را برمی گرداند، ممکن است خالی باشد. result می تواند تنها یکی از موارد زیر باشد:
found

object ( Document )

سندی که درخواست شد.

missing

string

نام سندی که درخواست شده است اما وجود ندارد. در قالب: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.