CalendarList: watch

CalendarList के संसाधनों में हुए बदलावों पर नज़र रखें.

अनुरोध

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

POST https://www.googleapis.com/calendar/v3/users/me/calendarList/watch

पैरामीटर

पैरामीटर का नाम मान ब्यौरा

अनुमति देना

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है:

दायरा
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

ज़्यादा जानकारी के लिए, पुष्टि और अनुमति पेज देखें.

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

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर में डेटा दें:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
प्रॉपर्टी का नाम मान ब्यौरा नोट
id string यूयूआईडी या ऐसी ही कोई यूनीक स्ट्रिंग जो इस चैनल की पहचान करती है.
token string इस चैनल से भेजी गई हर सूचना के साथ, टारगेट पते पर डिलीवर की जाने वाली कोई भी स्ट्रिंग. ज़रूरी नहीं.
type string इस चैनल के लिए डिलीवरी का इस्तेमाल किया जाने वाला तरीका. मान्य वैल्यू "web_hook" (या "webhook") हैं. दोनों वैल्यू, ऐसे चैनल के बारे में बताती हैं जहां मैसेज डिलीवर करने के लिए एचटीटीपी अनुरोधों का इस्तेमाल किया जाता है.
address string वह ईमेल पता जहां इस चैनल की सूचनाएं भेजी जाती हैं.
params object डिलीवरी चैनल के व्यवहार को कंट्रोल करने वाले अन्य पैरामीटर. ज़रूरी नहीं.
params.ttl string सूचना चैनल के लिए, सेकंड में टीटीएल. डिफ़ॉल्ट रूप से, यह 6,04,800 सेकंड होता है.

जवाब

अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:

{
  "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 सूचना चैनल की समयसीमा खत्म होने की तारीख और समय, जो मिलीसेकंड में यूनिक्स टाइमस्टैंप के तौर पर दिखाया जाता है. ज़रूरी नहीं.