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 - उपयोगकर्ता ने बोलकर निर्देश दिया है.
आने वाले समय में, इसमें और टाइप जोड़े जा सकते हैं. बिना पहचान वाले टाइप के User Actions को अनदेखा करना चाहिए.
notification.userToken string सूचनाएं पाने के लिए सदस्यता लेते समय, सेवा से मिला उपयोगकर्ता टोकन.
notification.verifyToken string सूचना पाने के लिए सदस्यता लेने पर, सेवा देने वाली कंपनी से मिला सीक्रेट पुष्टि टोकन.
operation[] list उन कार्रवाइयों की सूची जिनकी सदस्यता होनी चाहिए. खाली सूची का मतलब है कि कलेक्शन की सभी कार्रवाइयों की सदस्यता होनी चाहिए. स्वीकृत मान हैं:
  • UPDATE - आइटम अपडेट कर दिया गया है.
  • INSERT - नया आइटम शामिल किया गया.
  • DELETE - आइटम को मिटा दिया गया है.
 लिखा जा सकता है
updated datetime वह समय जब इस सदस्यता में पिछली बार बदलाव किया गया था. यह आरएफ़सी 3339 के मुताबिक फ़ॉर्मैट किया गया था.
userToken string सदस्य को सूचनाओं के तौर पर भेजा गया एक ओपेक टोकन, ताकि यह उपयोगकर्ता के आईडी की पहचान कर सके. लिखा जा सकता है
verifyToken string सदस्य को सूचनाओं के तौर पर एक सीक्रेट टोकन भेजा जाता है. इससे यह पुष्टि की जा सकती है कि सूचना, Google ने जनरेट की है. लिखा जा सकता है

तरीके

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