Method: users.history.list

दिए गए मेलबॉक्स में हुए सभी बदलावों का इतिहास दिखाता है. इतिहास के नतीजे, समय के हिसाब से क्रम में दिखाए जाते हैं (historyId बढ़ते हुए).

एचटीटीपी अनुरोध

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

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
userId

string

उपयोगकर्ता का ईमेल पता. पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.

क्वेरी पैरामीटर

पैरामीटर
maxResults

integer (uint32 format)

इतिहास के ज़्यादा से ज़्यादा रिकॉर्ड दिखाने के लिए. यह फ़ील्ड डिफ़ॉल्ट रूप से 100 पर सेट होता है. इस फ़ील्ड के लिए ज़्यादा से ज़्यादा वैल्यू 500 है.
pageToken

string

सूची में नतीजों के किसी खास पेज को वापस लाने के लिए पेज टोकन.
startHistoryId

string

ज़रूरी है. तय किए गए startHistoryId के बाद के इतिहास के रिकॉर्ड दिखाता है. दिया गया startHistoryId, किसी मैसेज, थ्रेड या पिछले list जवाब के historyId से लिया जाना चाहिए. इतिहास के आईडी, समय के हिसाब से बढ़ते हैं. हालांकि, मान्य आईडी के बीच में कोई गैप नहीं होता. अमान्य या पुराना startHistoryId सबमिट करने पर, आम तौर पर HTTP 404 गड़बड़ी कोड दिखता है. आम तौर पर, historyId कम से कम एक हफ़्ते के लिए मान्य होता है. हालांकि, कुछ मामलों में यह सिर्फ़ कुछ घंटों के लिए मान्य हो सकता है. अगर आपको गड़बड़ी का HTTP 404 कोड मिलता है, तो आपका ऐप्लिकेशन पूरा सिंक कर लेगा. अगर आपको जवाब में कोई nextPageToken नहीं मिलता है, तो इसका मतलब है कि कोई अपडेट नहीं है. साथ ही, आने वाले समय में किसी अनुरोध के लिए, वापस मिले historyId को सेव किया जा सकता है.
labelId

string

सिर्फ़ ऐसे मैसेज दिखाता है जिनका लेबल आईडी से मेल खाता है.
historyTypes[]

enum (HistoryType)

फ़ंक्शन से मिलने वाले इतिहास के टाइप

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
फ़ील्ड
history[]

object (History)

इतिहास के रिकॉर्ड की सूची. जवाब में मौजूद किसी भी messages में, आम तौर पर सिर्फ़ id और threadId फ़ील्ड भरे होंगे.
nextPageToken

string

सूची में नतीजों का अगला पेज पाने के लिए पेज टोकन.
historyId

string

मेलबॉक्स के मौजूदा इतिहास रिकॉर्ड का आईडी.

अनुमति के दायरे

इसके लिए, 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

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

इतिहास

उपयोगकर्ता के मेलबॉक्स में किए गए बदलाव का रिकॉर्ड. इतिहास में किए गए हर बदलाव से, कई मैसेज पर कई तरह से असर पड़ सकता है.

JSON के काेड में दिखाना 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
फ़ील्ड
id

string

मेलबॉक्स का क्रम आईडी.
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

मैसेज में जोड़े गए लेबल आईडी.

LabelRemoved

JSON के काेड में दिखाना 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
फ़ील्ड
message

object (Message)
labelIds[]

string

मैसेज से लेबल आईडी हटा दिए गए.