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

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.

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

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