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

詳細については、OAuth 2.0 Overview をご覧ください。

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。