الحصول على مستندات متعددة
لا تضمن هذه الطريقة إرجاع المستندات بالترتيب نفسه الذي تم طلبه بها.
طلب HTTP
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchGet
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات المسار
المَعلمات | |
---|---|
database |
مطلوبة. اسم قاعدة البيانات بالتنسيق: |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "documents": [ string ], "mask": { object ( |
الحقول | |
---|---|
documents[] |
أسماء المستندات المراد استردادها. بالتنسيق: |
mask |
الحقول المطلوب عرضها. وفي حال تم ترك السياسة بدون ضبط، سيتم عرض جميع الحقول. إذا كان المستند يحتوي على حقل غير متوفّر في هذا القناع، لن يتم عرض هذا الحقل في الاستجابة. |
حقل الاتحاد consistency_selector وضع الاتّساق لهذه المعاملة وفي حال تم ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على تناسق قوي. يمكن أن يكون الحقل "consistency_selector " واحدًا فقط مما يلي: |
|
transaction |
لقراءة المستندات في معاملة. سلسلة بترميز base64. |
newTransaction |
يبدأ معاملة جديدة ويقرأ المستندات. يكون الإعداد التلقائي هو معاملة القراءة فقط. سيظهر معرِّف المعاملة الجديد كأول ردّ في ساحة المشاركات. |
readTime |
يقرأ المستندات كما كانت في الوقت المحدَّد. يجب أن يكون هذا الطابع الزمني بدقة ميكرو ثانية خلال الساعة الماضية، أو إذا تم تفعيل ميزة "استرداد نقطة زمنية"، يمكن أيضًا أن يكون طابعًا زمنيًا لدقيقة كاملة خلال آخر 7 أيام. طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
نص الاستجابة
الاستجابة المباشرة لـ Firestore.BatchGetDocuments
.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "transaction": string, "readTime": string, // Union field |
الحقول | |
---|---|
transaction |
المعاملة التي بدأت كجزء من هذا الطلب سيتم ضبطها فقط في الردّ الأول، وفقط في حال ضبط سلسلة بترميز base64. |
readTime |
الوقت الذي تمت فيه قراءة المستند. قد تتم زيادة هذا العدد بشكل أحادي، وفي هذه الحالة يمكننا ضمان عدم تغيير المستندات السابقة في تدفق النتائج بين readTime وهذه الحالة. طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
حقل الاتحاد result نتيجة واحدة وقد يكون هذا الحقل فارغًا إذا كان الخادم يعرض معاملة فقط. يمكن أن يكون الحقل "result " واحدًا فقط مما يلي: |
|
found |
المستند الذي تم طلبه. |
missing |
اسم المستند الذي تم طلبه لكنه غير موجود. بالتنسيق: |
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.