Method: users.messages.batchDelete
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
メッセージ ID で複数のメッセージを削除します。メッセージがすでに削除されていないこと、または存在していたことについて、保証はいたしません。
HTTP リクエスト
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
userId |
string
ユーザーのメールアドレスです。認証されたユーザーを示すには、特別な値 me を使用できます。
|
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
{
"ids": [
string
]
} |
フィールド |
ids[] |
string
削除するメッセージの ID。
|
レスポンスの本文
成功すると、レスポンスの本文は空になります。
認可スコープ
次の OAuth スコープが必要です。
詳しくは、認可ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: users.messages.batchDelete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------|\n| ``` { \"ids\": [ string ] } ``` |\n\n| Fields ||\n|---------|---------------------------------------------|\n| `ids[]` | `string` The IDs of the messages to delete. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://mail.google.com/`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]