इवेंट संसाधनों में होने वाले बदलावों के लिए देखें.
अनुरोध
एचटीटीपी अनुरोध
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
पैरामीटर
पैरामीटर का नाम | मान | ब्यौरा |
---|---|---|
पाथ पैरामीटर | ||
calendarId |
string |
कैलेंडर आइडेंटिफ़ायर. कैलेंडर आईडी वापस पाने के लिए, calendarList.list तरीके को कॉल करें. अगर आपको उस उपयोगकर्ता का मुख्य कैलेंडर ऐक्सेस करना है जिसने फ़िलहाल लॉग इन किया हुआ है, तो "primary " का इस्तेमाल करें कीवर्ड.
|
वैकल्पिक क्वेरी पैरामीटर | ||
eventTypes |
string |
इवेंट के तौर पर देखे जाने वाले संसाधन. ज़रूरी नहीं. अलग-अलग तरह के संसाधनों को देखने के लिए, इस पैरामीटर को कई बार दोहराया जा सकता है. अगर यह नीति सेट नहीं है, तो सभी तरह के इवेंट दिखाता है.
ये वैल्यू स्वीकार की जाती हैं:
|
अनुमति देना
यह अनुरोध, इनमें से कम से कम एक दायरे के साथ अनुमति देने की अनुमति देता है:
दायरा |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
ज़्यादा जानकारी के लिए, पुष्टि करने और अनुमति देने से जुड़ा पेज देखें.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर के साथ डेटा उपलब्ध कराएं:
{ "id": string, "token": string, "type": string, "address": string, "params": { "ttl": string } }
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
id |
string |
यूयूआईडी या मिलती-जुलती यूनीक स्ट्रिंग, जिससे इस चैनल की पहचान होती है. | |
token |
string |
टारगेट पते पर डिलीवर की गई एक आर्बिट्रेरी स्ट्रिंग, जिसमें इस चैनल पर भेजी गई हर सूचना शामिल होती है. ज़रूरी नहीं. | |
type |
string |
इस चैनल के लिए इस्तेमाल किए गए डिलीवरी के तरीके का टाइप. मान्य वैल्यू "web_hook " हैं (या "webhook "). दोनों वैल्यू उस चैनल के बारे में बताती हैं जहां मैसेज डिलीवर करने के लिए Http अनुरोधों का इस्तेमाल किया जाता है. |
|
address |
string |
वह पता जहां इस चैनल के लिए सूचनाएं भेजी जाती हैं. | |
params |
object |
डिलीवरी चैनल के काम करने के तरीके को कंट्रोल करने वाले अन्य पैरामीटर. ज़रूरी नहीं. | |
params.ttl |
string |
सूचना चैनल के लिए लाइव होने का समय सेकंड में. यह डिफ़ॉल्ट रूप से 604800 सेकंड का होता है. |
जवाब
सही तरीके से काम करने पर, यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स का मुख्य हिस्सा दिखाता है:
{ "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long }
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
kind |
string |
इसकी पहचान सूचना के एक चैनल के तौर पर करती है, जिसका इस्तेमाल किसी संसाधन में हुए बदलावों को देखने के लिए किया जाता है. यह चैनल "api#channel " है. |
|
id |
string |
यूयूआईडी या मिलती-जुलती यूनीक स्ट्रिंग, जिससे इस चैनल की पहचान होती है. | |
resourceId |
string |
एक ओपेक आईडी, जो इस चैनल पर देखे जा रहे संसाधन की पहचान करता है. यह अलग-अलग एपीआई वर्शन में ठीक से काम करता है. | |
resourceUri |
string |
देखे गए संसाधन के लिए किसी वर्शन की खास पहचान करने वाला. | |
token |
string |
टारगेट पते पर डिलीवर की गई एक आर्बिट्रेरी स्ट्रिंग, जिसमें इस चैनल पर भेजी गई हर सूचना शामिल होती है. ज़रूरी नहीं. | |
expiration |
long |
सूचना चैनल के खत्म होने की तारीख और समय, जिसे यूनिक्स टाइमस्टैंप के तौर पर मिलीसेकंड में दिखाया जाता है. ज़रूरी नहीं. |