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

詳細については、認証の概要をご覧ください。