Method: projects.databases.documents.delete

文書を削除します。

HTTPリクエスト

DELETE https://firestore.googleapis.com/v1beta1/{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

詳細については、 「認証の概要」を参照してください。