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

History

ユーザーのメールボックスの変更の記録。履歴が変更されるたびに、複数のメッセージにさまざまな形で影響が及ぶことがあります。

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 を削除しました。