- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- HistoryType
- 履歴
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- 試してみる
指定したメールボックスに対するすべての変更履歴を一覧表示します。履歴の結果は時系列(historyId
昇順)で返されます。
HTTP リクエスト
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
userId |
ユーザーのメールアドレス。特別な値 |
クエリ パラメータ
パラメータ | |
---|---|
maxResults |
返される履歴レコードの最大数。このフィールドのデフォルトは 100 です。このフィールドに指定できる最大値は 500 です。 |
pageToken |
リスト内の結果の特定のページを取得するためのページトークン。 |
startHistoryId |
必須。指定した |
labelId |
ID に一致するラベルを持つメールのみを返します。 |
historyTypes[] |
関数が返す履歴タイプ |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"history": [
{
object ( |
フィールド | |
---|---|
history[] |
履歴レコードのリスト。通常、レスポンスに含まれるすべての |
nextPageToken |
リスト内の次のページの結果を取得するページトークン。 |
historyId |
メールボックスの現在の履歴レコードの 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 ( |
フィールド | |
---|---|
id |
メールボックスのシーケンス ID。 |
messages[] |
この履歴レコード内で変更されたメッセージのリスト。 |
messagesAdded[] |
この履歴レコードでメールボックスに追加されたメッセージ。 |
messagesDeleted[] |
この履歴レコード内のメールボックスから削除された(ゴミ箱ではない)メッセージ。 |
labelsAdded[] |
この履歴レコードのメッセージに追加されたラベル。 |
labelsRemoved[] |
この履歴レコード内のメッセージから削除されたラベル。 |
MessageAdded
JSON 表現 |
---|
{
"message": {
object ( |
フィールド | |
---|---|
message |
|
MessageDeleted
JSON 表現 |
---|
{
"message": {
object ( |
フィールド | |
---|---|
message |
|
LabelAdded
JSON 表現 |
---|
{
"message": {
object ( |
フィールド | |
---|---|
message |
|
labelIds[] |
メッセージに追加されたラベル ID。 |
LabelRemoved
JSON 表現 |
---|
{
"message": {
object ( |
フィールド | |
---|---|
message |
|
labelIds[] |
メッセージからラベル ID を削除しました。 |