Subscriptions

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

इस संसाधन के लिए तरीका जानने के लिए, इस पेज के आखिर में देखें.

संसाधन के बारे में जानकारी

किसी कलेक्शन पर इवेंट की सदस्यता.

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
प्रॉपर्टी का नाम वैल्यू जानकारी ज़रूरी जानकारी
callbackUrl string वह यूआरएल जहां सूचनाएं डिलीवर होनी चाहिए (https:// से शुरू होना चाहिए). लिखा जा सकता है
collection string सदस्यता लेने के लिए संग्रह. ये वैल्यू इस्तेमाल की जा सकती हैं:
  • timeline - टाइमलाइन में किए गए बदलाव, जिनमें शामिल करना, उन्हें हटाना और अपडेट करना शामिल हैं.
  • locations - जगह की जानकारी अपडेट की गई.
  • settings - सेटिंग से जुड़े अपडेट.
 लिखा जा सकता है
id string सदस्यता का आईडी.
kind string संसाधन किस तरह का है. यह संख्या हमेशा mirror#subscription होती है.
notification nested object सूचनाओं के लिए कंटेनर ऑब्जेक्ट. Subscription रिसॉर्स में ऐसा नहीं होता.
notification.collection string सूचना जनरेट करने वाला कलेक्शन.
notification.itemId string उस आइटम का आईडी जिसकी मदद से सूचना जनरेट हुई.
notification.operation string सूचना जनरेट करने वाली कार्रवाई का टाइप.

मान्य वैल्यू ये हैं:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list सूचना को ट्रिगर करने वाले उपयोगकर्ता की कार्रवाइयों की सूची.
notification.userActions[].payload string कार्रवाई के लिए एक वैकल्पिक पेलोड.

, CUSTOM टाइप की कार्रवाइयां करने के लिए, चुने गए कस्टम मेन्यू आइटम का आईडी.
notification.userActions[].type string कार्रवाई किस तरह की है. इसका मान यह हो सकता है:
  • SHARE - उपयोगकर्ता ने आइटम शेयर किया है.
  • REPLY - उपयोगकर्ता ने आइटम का जवाब दिया है.
  • REPLY_ALL - उपयोगकर्ता ने सभी आइटम पाने वालों को जवाब दिया.
  • CUSTOM - उपयोगकर्ता ने टाइमलाइन आइटम पर, पसंद के मुताबिक बनाया गया मेन्यू आइटम चुना है.
  • DELETE - उपयोगकर्ता ने आइटम मिटा दिया है.
  • PIN - उपयोगकर्ता ने आइटम को पिन किया.
  • UNPIN - उपयोगकर्ता ने आइटम अनपिन किया.
  • LAUNCH - उपयोगकर्ता ने बोला गया निर्देश.
आने वाले समय में, इसमें और टाइप जोड़े जा सकते हैं. अलग-अलग तरह की उपयोगकर्ता कार्रवाइयों पर ध्यान नहीं दिया जाना चाहिए.
notification.userToken string सूचना के लिए सदस्यता लेने पर, सेवा देने वाली कंपनी का उपयोगकर्ता टोकन.
notification.verifyToken string सेवा की ओर से मिलने वाले सूचनाओं के लिए सदस्यता लेने पर मिलने वाला सीक्रेट टोकन.
operation[] list उन कार्रवाइयों की सूची जिनके लिए आपको सदस्यता लेनी होगी. खाली सूची से पता चलता है कि कलेक्शन में मौजूद सभी कार्रवाइयों की सदस्यता लेनी चाहिए. ये वैल्यू इस्तेमाल की जा सकती हैं:
  • UPDATE - आइटम अपडेट किया गया.
  • INSERT - एक नया आइटम शामिल किया गया.
  • DELETE - आइटम मिटा दिया गया है.
 लिखा जा सकता है
updated datetime आरएफ़सी 3339 के मुताबिक, इस सदस्यता में पिछली बार बदलाव किए जाने का समय.
userToken string सूचनाओं में सदस्य को एक अपारदर्शिता वाला टोकन भेजा गया, ताकि वह उपयोगकर्ता का आईडी तय कर सके. लिखा जा सकता है
verifyToken string सदस्यों को सूचनाओं में एक सीक्रेट टोकन भेजा गया, ताकि यह पुष्टि की जा सके कि सूचना Google ने जनरेट की है. लिखा जा सकता है

तरीके

मिटाएं
सदस्यता मिटाता है.
शामिल करें
एक नई सदस्यता बनाता है.
list
पुष्टि किए गए उपयोगकर्ता और सेवा के लिए सदस्यताओं की सूची लाता है.
अपडेट
मौजूदा सदस्यता को अपडेट करता है.