सेटिंग के संसाधनों में हुए बदलावों की जानकारी देखें.
अनुरोध
एचटीटीपी अनुरोध
POST https://www.googleapis.com/calendar/v3/users/me/settings/watch
पैरामीटर
पैरामीटर का नाम | वैल्यू | ब्यौरा |
---|
अनुमति देना
इस अनुरोध के लिए, अनुमति देने के लिए, इनमें से कम से कम एक दायरे को शामिल करना ज़रूरी है:
स्कोप |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.settings.readonly |
ज़्यादा जानकारी के लिए, पुष्टि करना और अनुमति देना पेज देखें.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर के साथ डेटा दें:
{ "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 |
सूचना चैनल के खत्म होने की तारीख और समय, जिसे मिलीसेकंड में यूनिक्स टाइमस्टैंप के तौर पर दिखाया जाता है. ज़रूरी नहीं. |