Method: projects.databases.documents.createDocument

יצירת מסמך חדש.

בקשת HTTP

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

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

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

פרמטרים
parent

string

חובה. משאב ההורה. לדוגמה: projects/{projectId}/databases/{databaseId}/documents או projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}
collectionId

string

חובה. מזהה הקולקציה, ביחס ל-parent, לרשימה. לדוגמה: chatrooms.

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

פרמטרים
documentId

string

מזהה המסמך שהוקצה על ידי הלקוח וצריך להשתמש בו במסמך הזה.

זה שינוי אופציונלי. אם לא מציינים זאת, השירות יקצה מזהה.
mask

object (DocumentMask)

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

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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