Method: users.history.list

Mencantumkan histori semua perubahan pada kotak surat tertentu. Hasil histori ditampilkan dalam urutan kronologis (naik historyId).

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna yang diautentikasi.

Parameter kueri

Parameter
maxResults

integer (uint32 format)

Jumlah maksimum catatan histori yang akan ditampilkan. Nilai default kolom ini adalah 100. Nilai maksimum yang diizinkan untuk kolom ini adalah 500.
pageToken

string

Token halaman untuk mengambil halaman hasil tertentu dalam daftar.
startHistoryId

string

Wajib. Menampilkan data histori setelah startHistoryId yang ditentukan. startHistoryId yang disediakan harus diperoleh dari historyId pesan, rangkaian pesan, atau respons list sebelumnya. ID histori meningkat secara kronologis, tetapi tidak diikuti dengan kesenjangan acak di antara ID yang valid. Menyediakan startHistoryId yang tidak valid atau sudah tidak berlaku biasanya akan menampilkan kode error HTTP 404. historyId biasanya valid setidaknya selama seminggu, tetapi dalam beberapa keadaan yang jarang terjadi mungkin hanya valid selama beberapa jam. Jika Anda menerima respons error HTTP 404, aplikasi Anda harus melakukan sinkronisasi penuh. Jika Anda tidak menerima nextPageToken dalam respons, tidak ada update yang akan diambil dan Anda dapat menyimpan historyId yang ditampilkan untuk permintaan mendatang.
labelId

string

Hanya tampilkan pesan dengan label yang cocok dengan ID.
historyTypes[]

enum (HistoryType)

Jenis histori yang akan ditampilkan oleh fungsi

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Kolom
history[]

object (History)

Daftar catatan riwayat. Setiap messages yang ada dalam respons biasanya hanya akan memiliki kolom id dan threadId yang terisi.
nextPageToken

string

Token halaman untuk mengambil halaman hasil berikutnya dalam daftar.
historyId

string

ID catatan histori kotak surat saat ini.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Histori

Data perubahan pada kotak surat pengguna. Setiap perubahan histori dapat memengaruhi beberapa pesan dalam beberapa cara.

Representasi JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Kolom
id

string

ID urutan kotak surat.
messages[]

object (Message)

Daftar pesan yang diubah dalam catatan histori ini. Kolom untuk jenis perubahan tertentu, seperti messagesAdded mungkin menduplikasi pesan dalam kolom ini. Sebaiknya gunakan kolom jenis perubahan yang spesifik, bukan kolom ini.
messagesAdded[]

object (MessageAdded)

Pesan yang ditambahkan ke kotak surat dalam catatan histori ini.
messagesDeleted[]

object (MessageDeleted)

Pesan yang dihapus (bukan Dibuang) dari kotak surat dalam catatan histori ini.
labelsAdded[]

object (LabelAdded)

Label ditambahkan ke pesan dalam catatan histori ini.
labelsRemoved[]

object (LabelRemoved)

Label dihapus dari pesan dalam catatan histori ini.

MessageAdded

Representasi JSON 
{
  "message": {
    object (Message)
  }
}
Kolom
message

object (Message)

MessageDeleted

Representasi JSON 
{
  "message": {
    object (Message)
  }
}
Kolom
message

object (Message)

LabelAdded

Representasi JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Kolom
message

object (Message)
labelIds[]

string

ID label ditambahkan ke pesan.

LabelRemoved

Representasi JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Kolom
message

object (Message)
labelIds[]

string

ID label dihapus dari pesan.