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

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