Method: users.watch

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
userId

string

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 डेवलपर प्रोजेक्ट आईडी से पूरी तरह मैच करना चाहिए. यह वह प्रोजेक्ट आईडी है जो स्मार्टवॉच के लिए अनुरोध करता है.

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

पुश नोटिफ़िकेशन की मदद से वीडियो देखने के लिए दिया गया जवाब.

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

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

string

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

string (int64 format)

जब Gmail, मेलबॉक्स अपडेट के लिए सूचनाएं भेजना बंद कर देगा (epoch Millis). स्मार्टवॉच को रिन्यू करने के लिए, इस समय से पहले 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

लेबल आईडी की सूची के लिए, फ़िल्टर करने का तरीका बताया गया.

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