Method: projects.databases.documents.delete

दस्तावेज़ मिटाता है.

एचटीटीपी अनुरोध

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

यह यूआरएल 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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.