- طلب 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
عمليات التعداد | |
---|---|
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[] |
تمت إزالة أرقام تعريف التصنيفات من الرسالة. |