Method: users.threads.modify
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
スレッドに適用されているラベルを変更します。これはスレッド内のすべてのメールに適用されます。
HTTP リクエスト
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/modify
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
userId |
string
ユーザーのメールアドレスです。認証されたユーザーを示すには、特別な値 me を使用できます。
|
id |
string
変更するスレッドの ID。
|
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
{
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
フィールド |
addLabelIds[] |
string
このスレッドに追加するラベルの ID のリスト。1 回の更新で最大 100 個のラベルを追加できます。
|
removeLabelIds[] |
string
このスレッドから削除するラベルの ID のリスト。1 回の更新で削除できるラベルは最大 100 個です。
|
レスポンスの本文
成功した場合、レスポンスの本文には Thread
のインスタンスが含まれます。
認可スコープ
以下のいずれかの OAuth スコープが必要です。
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
詳しくは、認可ガイドをご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: users.threads.modify\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\nModifies the labels applied to the thread. This applies to all messages in the thread.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/modify`\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| `id` | `string` The ID of the thread to modify. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------|\n| ``` { \"addLabelIds\": [ string ], \"removeLabelIds\": [ string ] } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------|\n| `addLabelIds[]` | `string` A list of IDs of labels to add to this thread. You can add up to 100 labels with each update. |\n| `removeLabelIds[]` | `string` A list of IDs of labels to remove from this thread. You can remove up to 100 labels with each update. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Thread](/workspace/gmail/api/reference/rest/v1/users.threads#Thread).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]