- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- HistoryType
- ประวัติ
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- ลองใช้งาน
แสดงประวัติการเปลี่ยนแปลงทั้งหมดในกล่องจดหมายที่ระบุ ผลลัพธ์ของประวัติจะแสดงตามลำดับเวลา (เพิ่มขึ้น historyId
)
คำขอ HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
userId |
อีเมลของผู้ใช้ สามารถใช้ค่าพิเศษ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
maxResults |
จำนวนระเบียนประวัติสูงสุดที่จะแสดงผล ช่องนี้จะมีค่าเริ่มต้นเป็น 100 ค่าสูงสุดที่อนุญาตสำหรับช่องนี้คือ 500 |
pageToken |
โทเค็นหน้าเพื่อดึงหน้าผลลัพธ์ที่ต้องการในรายการ |
startHistoryId |
ต้องระบุ แสดงผลระเบียนประวัติหลังจาก |
labelId |
แสดงเฉพาะข้อความที่มีป้ายกำกับตรงกับรหัส |
historyTypes[] |
ประเภทประวัติที่ฟังก์ชันจะแสดงผล |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"history": [
{
object ( |
ช่อง | |
---|---|
history[] |
รายการประวัติบันทึก |
nextPageToken |
โทเค็นหน้าสำหรับเรียกหน้าถัดไปของผลการค้นหาในรายการ |
historyId |
รหัสของระเบียนประวัติปัจจุบันของกล่องจดหมาย |
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต 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
Enum | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
ประวัติ
ระเบียนของการเปลี่ยนแปลงในกล่องจดหมายของผู้ใช้ การเปลี่ยนแปลงประวัติแต่ละครั้งอาจส่งผลต่อข้อความหลายรายการในหลายลักษณะ
การแสดง JSON |
---|
{ "id": string, "messages": [ { object ( |
ช่อง | |
---|---|
id |
รหัสลำดับของกล่องจดหมาย |
messages[] |
รายการข้อความในบันทึกประวัตินี้มีการเปลี่ยนแปลง ช่องสำหรับประเภทการเปลี่ยนแปลงที่เฉพาะเจาะจง เช่น |
messagesAdded[] |
ข้อความที่เพิ่มลงในกล่องจดหมายในบันทึกประวัตินี้ |
messagesDeleted[] |
ข้อความที่ลบ (ไม่ทิ้งลงถังขยะ) จากกล่องจดหมายในบันทึกประวัตินี้ |
labelsAdded[] |
ป้ายกำกับที่เพิ่มลงในข้อความในบันทึกประวัตินี้ |
labelsRemoved[] |
นำป้ายกำกับออกจากข้อความในบันทึกประวัตินี้แล้ว |
MessageAdded
การแสดง JSON |
---|
{
"message": {
object ( |
ช่อง | |
---|---|
message |
|
MessageDeleted
การแสดง JSON |
---|
{
"message": {
object ( |
ช่อง | |
---|---|
message |
|
LabelAdded
การแสดง JSON |
---|
{
"message": {
object ( |
ช่อง | |
---|---|
message |
|
labelIds[] |
เพิ่มรหัสป้ายกำกับในข้อความแล้ว |
LabelRemoved
การแสดง JSON |
---|
{
"message": {
object ( |
ช่อง | |
---|---|
message |
|
labelIds[] |
นำรหัสป้ายกำกับออกจากข้อความแล้ว |