Method: users.watch

उपयोगकर्ता के दिए गए मेलबॉक्स पर पुश नोटिफ़िकेशन स्मार्टवॉच सेट अप या अपडेट करें.

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

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

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

पाथ पैरामीटर

पैरामीटर
userId

string

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

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

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
फ़ील्ड
labelIds[]

string

लेबल-आईडी की सूची, जिनके बारे में सूचनाएं पाने पर पाबंदी है. अगर इसकी जानकारी नहीं दी गई है, तो डिफ़ॉल्ट तौर पर सभी बदलावों को हटा दिया जाता है. अगर कहा जाए, तो यह बताता है कि पुश नोटिफ़िकेशन जनरेट करने के लिए कौनसे लेबल ज़रूरी हैं.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

labelIds list का फ़िल्टर करने का तरीका बताया गया. यह फ़ील्ड काम नहीं करता, क्योंकि इसकी वजह से कुछ मामलों में गलत व्यवहार हुआ; इसके बजाय, labelFilterBehavior का इस्तेमाल करें.
labelFilterBehavior

enum (LabelFilterAction)

labelIds list का फ़िल्टर करने का तरीका बताया गया. यह फ़ील्ड labelFilterAction को बदल देता है; अगर यह नीति सेट है, तो labelFilterAction को अनदेखा कर दिया जाता है.
topicName

string

इवेंट पब्लिश करने के लिए, पूरी तरह क्वालिफ़ाइड Google Cloud Pub/Sub API विषय का नाम. विषय का यह नाम, Cloud Pub/Sub में पहले से मौजूद होना चाहिए और आपने Gmail को "पब्लिश करें" की अनुमति पहले ही दे दी होगी किया जा सकता है. उदाहरण के लिए, "projects/my-project-identifier/topics/my-topic-name" (विषय का नाम रखने के लिए, Cloud Pub/Sub "v1" फ़ॉर्मैट का इस्तेमाल करके).

ध्यान दें कि "मेरा-प्रोजेक्ट-आइडेंटिफ़ायर" का हिस्सा आपके Google डेवलपर प्रोजेक्ट आईडी (जिसे देखने के इस अनुरोध को लागू करता है) से पूरी तरह मेल खाना चाहिए.

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

पुश नोटिफ़िकेशन स्मार्टवॉच का जवाब.

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

JSON के काेड में दिखाना 
{
  "historyId": string,
  "expiration": string
}
फ़ील्ड
historyId

string

मेलबॉक्स के वर्तमान इतिहास रिकॉर्ड का आईडी.
expiration

string (int64 format)

Gmail, मेलबॉक्स के अपडेट के लिए सूचनाएं भेजना कब बंद कर देगा (epoch मिलीसेकंड). स्मार्टवॉच को रिन्यू करने के लिए, इस समय से पहले watch पर फिर से कॉल करें.

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

इनमें से किसी एक 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

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

LabelFilterAction

labelIds सूची के फ़िल्टर करने के तरीके के बारे में बताया गया है.

Enums
include सिर्फ़ तय किए गए LabelId से जुड़े मैसेज में होने वाले बदलावों के लिए पुश नोटिफ़िकेशन पाएं.
exclude लेबल आईडी से जुड़े बदलाव को छोड़कर, मैसेज में किए गए सभी बदलावों के लिए पुश नोटिफ़िकेशन पाएं.