Method: users.messages.batchModify

指定したメールのラベルを変更します。

HTTP リクエスト

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId

string

ユーザーのメールアドレス。特別な値 me を使用して、認証済みユーザーを示すことができます。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
フィールド
ids[]

string

変更するメッセージの ID。リクエストごとの ID 数の上限は 1,000 個です。
addLabelIds[]

string

メッセージに追加するラベル ID のリスト。
removeLabelIds[]

string

メールから削除するラベル ID のリストです。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify

詳細については、承認ガイドをご覧ください。