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" के विषय के नाम के फ़ॉर्मैट का इस्तेमाल करके).

ध्यान दें कि "my-project-identifier" हिस्सा, आपके Google डेवलपर प्रोजेक्ट आईडी से पूरी तरह मेल खाना चाहिए. यह वह आईडी होता है जिससे स्मार्टवॉच के लिए अनुरोध किया जा रहा है.

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

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

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

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

string

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

string (int64 format)

Gmail, मेलबॉक्स के अपडेट (एपिक मिलीसेकंड) के लिए सूचनाएं कब भेजना बंद कर देगा. स्मार्टवॉच की सदस्यता रिन्यू करने के लिए, इस समय से पहले 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 सिर्फ़ उन मैसेज में हुए बदलावों के लिए पुश नोटिफ़िकेशन पाएं जिनमें दिए गए labelIds शामिल हैं.
exclude मैसेज में किए गए सभी बदलावों के लिए पुश नोटिफ़िकेशन पाएं. हालांकि, इनमें उन बदलावों के लिए सूचनाएं नहीं मिलेंगी जिनमें दिए गए labelIds शामिल हैं.