Method: users.messages.batchModify

指定されたメッセージのラベルと分類ラベルの値を変更します。組織内のユーザーのメッセージを変更する管理者の場合、リクエストには、https://www.googleapis.com/auth/gmail.modify.restricted スコープでユーザーに成り代わるためのドメイン全体の委任権限を持つサービス アカウントによる承認が必要です。

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
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
フィールド
ids[]

string

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

string

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

string

メッセージから削除するラベル ID のリスト。
addClassificationLabels[]

object (ClassificationLabelValue)

追加する分類ラベル値のリスト。同じラベル ID の分類ラベルがメッセージにすでに適用されている場合、既存のフィールド ID を持つフィールドは更新され、新しいフィールド ID を持つフィールドは追加されます。リクエストごとに指定できる分類ラベルの値は 20 個までです。メッセージがすでに分類されていて、分類ラベル値の最終的な合計数がメッセージあたりの分類ラベル値の最大許容数を超えている場合、変更は失敗します。
removeClassificationLabelIds[]

string

メッセージから削除する分類ラベル値のリスト。

レスポンスの本文

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

認可スコープ

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

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

詳しくは、承認ガイドをご覧ください。