Method: projects.databases.documents.batchGet

الحصول على مستندات متعددة

لا نضمن أن يتم إرجاع المستندات التي تم إرجاعها باستخدام هذه الطريقة بالترتيب نفسه الذي تم طلبها به.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.