Method: users.history.list

指定したメールボックスに対するすべての変更履歴を一覧表示します。履歴の結果は時系列で返されます（historyId の昇順）。

HTTP リクエスト

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

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

パスパラメータ

パラメータ
userId

string

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

クエリ パラメータ

パラメータ
maxResults

integer (uint32 format)

返される履歴レコードの最大数。このフィールドのデフォルトは 100 です。このフィールドに指定できる最大値は 500 です。
pageToken

string

リスト内の特定の結果ページを取得するためのページトークン。
startHistoryId

string

必須。指定された startHistoryId の後の履歴レコードを返します。指定された startHistoryId は、メッセージ、スレッド、または前の list レスポンスの historyId から取得する必要があります。履歴 ID は時系列で増加しますが、有効な ID 間にランダムなギャップが生じることはありません。無効または古くなった startHistoryId を指定すると、通常は HTTP 404 エラーコードが返されます。historyId は通常、少なくとも 1 週間有効ですが、まれに数時間のみ有効な場合もあります。HTTP 404 エラー レスポンスが返された場合は、アプリケーションで完全同期を実行する必要があります。レスポンスに nextPageToken がない場合は、取得するアップデートはなく、返された historyId を今後のリクエストのために保存できます。
labelId

string

ラベルが ID と一致するメールのみを返します。
historyTypes[]

enum (HistoryType)

関数によって返される履歴の型

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
フィールド
history[]

object (History)

履歴レコードのリスト。レスポンスに含まれる messages には通常、id フィールドと threadId フィールドにデータが入力されます。
nextPageToken

string

リスト内の次のページの結果を取得するページトークン。
historyId

string

メールボックスの現在の履歴レコードの ID。

認可スコープ

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

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

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

HistoryType

列挙型
messageAdded
messageDeleted
labelAdded
labelRemoved

履歴

ユーザーのメールボックスに対する変更の記録。履歴が変更されると、複数のメッセージに影響する可能性があります。

JSON 表現 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
フィールド
id

string

メールボックス シーケンス ID。
messages[]

object (Message)

この履歴レコードで変更されたメッセージのリスト。特定の変更タイプのフィールド（messagesAdded など）では、このフィールドのメッセージが重複することがあります。このフィールドの代わりに、特定の変更タイプのフィールドを使用することをおすすめします。
messagesAdded[]

object (MessageAdded)

この履歴レコードのメールボックスに追加されたメッセージ。
messagesDeleted[]

object (MessageDeleted)

この履歴レコードのメールボックスから削除されたメッセージ（ゴミ箱にあるメッセージではありません）。
labelsAdded[]

object (LabelAdded)

この履歴レコードのメッセージに追加されたラベル。
labelsRemoved[]

object (LabelRemoved)

この履歴レコードのメッセージから削除されたラベル。

MessageAdded

JSON 表現 
{
  "message": {
    object (Message)
  }
}
フィールド
message

object (Message)

MessageDeleted

JSON 表現 
{
  "message": {
    object (Message)
  }
}
フィールド
message

object (Message)

LabelAdded

JSON 表現 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
フィールド
message

object (Message)
labelIds[]

string

メッセージに追加されたラベル ID。

LabelRemoved

JSON 表現 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
フィールド
message

object (Message)
labelIds[]

string

メッセージからラベル ID を削除しました。