Method: projects.databases.documents.commit

إتمام معاملة، مع تعديل المستندات اختياريًا

طلب HTTP

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

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

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

المَعلمات
database

string

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

نص الطلب

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

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

object (Write)

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

يتم تنفيذها دائمًا بشكل كامل وبالترتيب.
transaction

string (bytes format)

في حال ضبط هذه السياسة، يتم تطبيق جميع عمليات الشراء في هذه المعاملة والالتزام بها.

سلسلة بترميز base64.

نص الاستجابة

تمثّل هذه السمة الردّ على Firestore.Commit.

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

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

object (WriteResult)

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

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

string (Timestamp format)

وقت حدوث الالتزام. يمكن ضمان ظهور تأثيرات إتمام عملية الشراء عند قراءة قيمة مساوية لقيمة readTime أو أكبر.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

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

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

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

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