Method: projects.databases.documents.patch

מעדכן או מוסיף מסמך.

בקשת HTTP

PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
document.name

string

שם המשאב של המסמך, למשל projects/{projectId}/databases/{databaseId}/documents/{document_path}.

פרמטרים של שאילתה

פרמטרים
updateMask

object (DocumentMask)

השדות שצריך לעדכן. אף אחד מנתיבי השדות במסכה לא יכול להכיל שם שמור.

אם המסמך קיים בשרת ויש בו שדות שלא הפניה אליהם במסכה, הם יישארו ללא שינוי. שדות שיש אליהם הפניה במסכה אבל לא נמצאים במסמך הקלט, יימחקו מהמסמך בשרת.
mask

object (DocumentMask)

השדות שיש להחזיר. אם המדיניות לא מוגדרת, כל השדות מוחזרים.

אם המסמך כולל שדה שלא נמצא במסכה הזו, השדה הזה לא יוחזר.
currentDocument

object (Precondition)

תנאי מוקדם אופציונלי במסמך. הבקשה תיכשל אם ההגדרה הזו לא תעמוד בדרישות מסמך היעד.

גוף הבקשה

גוף הבקשה מכיל מופע של Document.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Document.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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