Method: projects.databases.documents.commit

Xác nhận giao dịch, đồng thời cập nhật tài liệu (không bắt buộc).

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
database

string

Bắt buộc. Tên cơ sở dữ liệu. Theo định dạng: projects/{projectId}/databases/{databaseId}.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
Trường
writes[]

object (Write)

Ghi để áp dụng.

Luôn được thực thi tỉ mỉ và theo thứ tự.
transaction

string (bytes format)

Nếu được đặt, sẽ áp dụng tất cả lượt ghi trong giao dịch này và thay đổi tuỳ chọn đó.

Một chuỗi được mã hoá base64.

Nội dung phản hồi

Câu trả lời cho Firestore.Commit.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
Trường
writeResults[]

object (WriteResult)

Kết quả của việc áp dụng các lượt ghi.

Kết quả ghi thứ i này tương ứng với lượt ghi thứ i trong yêu cầu.
commitTime

string (Timestamp format)

Thời gian diễn ra cam kết. Bất kỳ lượt đọc nào có readTime bằng hoặc lớn hơn đều đảm bảo thấy được tác động của lệnh xác nhận.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.