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)

फ़ंक्शन से दिखाए जाने वाले इतिहास के टाइप

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

इतिहास

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

जेएसओएन के काेड में दिखाना 
{
  "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

जेएसओएन के काेड में दिखाना 
{
  "message": {
    object (Message)
  }
}
फ़ील्ड
message

object (Message)

MessageDeleted

जेएसओएन के काेड में दिखाना 
{
  "message": {
    object (Message)
  }
}
फ़ील्ड
message

object (Message)

LabelAdded

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

object (Message)
labelIds[]

string

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

LabelRemoved

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

object (Message)
labelIds[]

string

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