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

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

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

LabelFilterAction

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

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