Method: projects.databases.documents.delete

یک سند را حذف می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.