Method: projects.databases.documents.delete

מחיקת מסמך.

בקשת HTTP

DELETE https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}

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

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

פרמטרים
name

string

חובה. שם המשאב של המסמך למחיקה. בפורמט: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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

פרמטרים
currentDocument

object (Precondition)

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי הרשאות

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

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

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