Method: projects.databases.documents.commit

מבצע טרנזקציה, מעדכן מסמכים באופן אופציונלי.

בקשת HTTP

POST https://firestore.googleapis.com/v1beta1/{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 תואמת לכתיבה ה-i שבבקשה.
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

מידע נוסף זמין בסקירה הכללית על אימות.