Method: projects.databases.documents.batchWrite

يُطبق مجموعة من عمليات الكتابة.

لا تطبق طريقة Document.batchWrite عمليات الكتابة على نحو ذري ويمكن أن تطبقها بدون ترتيب. لا تسمح الطريقة بأكثر من عملية كتابة واحدة لكل مستند. تنجح كل عملية كتابة أو تفشل بشكل مستقل. راجِع BatchWriteResponse لمعرفة حالة نجاح كل عملية كتابة.

إذا كنت تتطلّب مجموعة من عمليات الكتابة المطبَّقة بشكلٍ كامل، استخدِم documents.commit بدلاً من ذلك.

طلب HTTP

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

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

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

المَعلمات
database

string

مطلوب. اسم قاعدة البيانات. بالتنسيق: projects/{projectId}/databases/{databaseId}.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
الحقول
writes[]

object (Write)

العبارات التي سيتم تطبيقها.

لا تنطبق الطريقة على الكتابة بشكل كامل ولا تضمن الطلب. تنجح كل عملية كتابة أو تفشل بشكل مستقل. لا يمكنك الكتابة إلى المستند نفسه أكثر من مرة لكل طلب.
labels

map (key: string, value: string)

التصنيفات المرتبطة بالكتابة المجمّعة

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

نص الاستجابة

الرد من Firestore.BatchWrite

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
الحقول
writeResults[]

object (WriteResult)

هي نتيجة تطبيق عمليات الكتابة.

تتوافق نتيجة i-th write هذه مع الكتابة i-th في الطلب.
status[]

object (Status)

حالة تطبيق عمليات الكتابة.

تتوافق حالة i-th write هذه مع i-th write في الطلب.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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