Method: projects.databases.documents.commit

یک معامله را انجام می دهد، در حالی که به صورت اختیاری اسناد را به روز می کند.

درخواست HTTP

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

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

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

مولفه های
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-ام با نوشتن i-ام در درخواست مطابقت دارد.

commitTime

string ( Timestamp format)

زمانی که ارتکاب در آن اتفاق افتاد. هر خواندنی با readTime برابر یا بیشتر تضمین می شود که اثرات commit را ببیند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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

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