पुश नोटिफ़िकेशन

इस दस्तावेज़ में, पुश नोटिफ़िकेशन का इस्तेमाल करने का तरीका बताया गया है. पुश नोटिफ़िकेशन से, संसाधन में बदलाव होने पर आपके ऐप्लिकेशन को सूचना मिलती है.

खास जानकारी

Admin SDK API, पुश नोटिफ़िकेशन की सुविधा देता है. इससे संसाधनों में हुए बदलावों पर नज़र रखी जा सकती है. इस सुविधा का इस्तेमाल करके, अपने ऐप्लिकेशन की परफ़ॉर्मेंस को बेहतर बनाया जा सकता है. इससे आपको यह पता लगाने के लिए, पोलिंग संसाधनों से जुड़ी अतिरिक्त नेटवर्क और कंप्यूट लागत को कम करने में मदद मिलती है कि उनमें बदलाव हुआ है या नहीं. जब भी मॉनिटर की जा रही किसी संसाधन में बदलाव होता है, तब Admin SDK API आपके ऐप्लिकेशन को इसकी सूचना देता है.

पुश नोटिफ़िकेशन का इस्तेमाल करने के लिए, आपको ये दो काम करने होंगे:

अपना रिसीविंग यूआरएल या "वेबबुक" कॉलबैक रिसीवर सेट अप करें.
यह एक एचटीटीपीएस सर्वर है. यह एपीआई सूचना वाले उन मैसेज को मैनेज करता है जो किसी संसाधन में बदलाव होने पर ट्रिगर होते हैं.
आपको जिस भी संसाधन एंडपॉइंट पर नज़र रखनी है उसके लिए, एक (सूचना चैनल) सेट अप करें.
चैनल, सूचना वाले मैसेज के लिए राउटिंग की जानकारी देता है. चैनल सेटअप करने के दौरान, आपको उस यूआरएल की पहचान करनी होगी जहां आपको सूचनाएं चाहिए. जब भी किसी चैनल के संसाधन में बदलाव होता है, तब Admin SDK API, उस यूआरएल पर सूचना वाला मैसेज POSTअनुरोध के तौर पर भेजता है.

फ़िलहाल, Admin SDK API की मदद से, गतिविधियों के संसाधन में हुए बदलावों की सूचनाएं पाई जा सकती हैं.

सूचना के चैनल बनाना

पुश नोटिफ़िकेशन पाने का अनुरोध करने के लिए, आपको उस हर संसाधन के लिए एक सूचना चैनल सेट अप करना होगा जिसे आपको मॉनिटर करना है. सूचना चैनल सेट अप करने के बाद, Admin SDK API आपके ऐप्लिकेशन को सूचना देता है. यह सूचना तब मिलती है, जब निगरानी की जा रही किसी संसाधन में बदलाव होता है.

स्मार्टवॉच से अनुरोध करना

Admin SDK API के हर ऐसे संसाधन के लिए, watch तरीका उपलब्ध होता है जिसे मॉनिटर किया जा सकता है. यह तरीका, इस तरह के यूआरआई पर उपलब्ध होता है:

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

किसी संसाधन में हुए बदलावों के बारे में सूचनाएं पाने के लिए, सूचना चैनल सेट अप करने के लिए, संसाधन के लिए watch तरीके को POST अनुरोध भेजें.

हर सूचना चैनल, किसी उपयोगकर्ता और किसी संसाधन (या संसाधनों के सेट) से जुड़ा होता है. watch अनुरोध तब तक पूरा नहीं होगा, जब तक मौजूदा उपयोगकर्ता या सेवा खाते के पास इस संसाधन का मालिकाना हक नहीं है या उसे ऐक्सेस करने की अनुमति नहीं है.

उदाहरण

गतिविधियों के संसाधन के लिए, वीडियो देखने के सभी अनुरोध इस सामान्य फ़ॉर्म में होते हैं:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/userKey or all/applications/applicationName/watch
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myFilesChannelDest",
  "payload": true,
  "expiration": 3600
}

अनुरोध के मुख्य हिस्से में ये प्रॉपर्टी होती हैं:

id: यह यूयूआईडी या इसी तरह की कोई यूनीक स्ट्रिंग होती है, जिससे इस चैनल की पहचान होती है.
type: डिलीवरी के तरीके का टाइप. इस फ़ील्ड की वैल्यू web_hook होनी चाहिए.
address: वह यूआरएल जहां सूचनाएं भेजी जाती हैं.
token: यह एक मनमानी स्ट्रिंग है. इसे हर सूचना के साथ टारगेट पते पर भेजा जाता है. इसका मकसद यह पुष्टि करना है कि सूचना किसी भरोसेमंद सोर्स से आई है.
payload: यह एक बूलियन फ़्लैग है. इससे पता चलता है कि पेलोड को सूचना में शामिल किया जाना चाहिए या नहीं.
expiration: सूचना चैनल के लिए, टाइम-टू-लाइव (सेकंड में).

userKey, applicationName, eventName, और filters पैरामीटर का इस्तेमाल करके, सिर्फ़ कुछ इवेंट, उपयोगकर्ताओं या ऐप्लिकेशन के लिए सूचनाएं पाई जा सकती हैं.

ध्यान दें: यहां दिए गए उदाहरणों में, अनुरोध के मुख्य हिस्से को शामिल नहीं किया गया है, ताकि जानकारी साफ़ तौर पर समझाई जा सके.

एडमिन की सभी गतिविधियों पर नज़र रखें:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin/watch

सभी दस्तावेज़ों से जुड़ी गतिविधियों पर नज़र रखें:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/docs/watch

किसी उपयोगकर्ता की एडमिन गतिविधि पर नज़र रखने के लिए:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/liz@example.com/applications/admin/watch

किसी खास इवेंट पर नज़र रखें. जैसे, किसी उपयोगकर्ता का पासवर्ड बदलना:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin/watch?eventName=CHANGE_PASSWORD

किसी दस्तावेज़ में हुए बदलावों को ट्रैक करने के लिए:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/docs/watch?eventName=EDIT&filters==doc_id=123456abcdef

ज़रूरी प्रॉपर्टी

हर watch अनुरोध के साथ, आपको ये फ़ील्ड देने होंगे:

id प्रॉपर्टी स्ट्रिंग, जो आपके प्रोजेक्ट में इस नए सूचना चैनल की पहचान करती है. हमारा सुझाव है कि आप यूनिवर्सली यूनीक आइडेंटिफ़ायर (UUID) या इसी तरह की कोई यूनीक स्ट्रिंग इस्तेमाल करें. ज़्यादा से ज़्यादा 64 वर्ण इस्तेमाल किए जा सकते हैं.

आपने जो आईडी वैल्यू सेट की है वह आपको इस चैनल के लिए मिलने वाले हर सूचना मैसेज के X-Goog-Channel-Id एचटीटीपी हेडर में वापस दिखती है.
type प्रॉपर्टी स्ट्रिंग, web_hook वैल्यू पर सेट है.
address प्रॉपर्टी स्ट्रिंग को उस यूआरएल पर सेट किया जाता है जो इस सूचना चैनल के लिए सूचनाएं सुनता है और उनका जवाब देता है. यह आपका वेबहुक कॉलबैक यूआरएल है. इसमें एचटीटीपीएस का इस्तेमाल होना चाहिए.

ध्यान दें कि Admin SDK API, इस एचटीटीपीएस पते पर सूचनाएं सिर्फ़ तब भेज सकता है, जब आपके वेब सर्वर पर मान्य एसएसएल सर्टिफ़िकेट इंस्टॉल किया गया हो. अमान्य सर्टिफ़िकेट में ये शामिल हैं:
- खुद हस्ताक्षर किए हुए सर्टिफ़िकेट.
- किसी गैर-भरोसेमंद सोर्स के हस्ताक्षर किए हुए सर्टिफ़िकेट.
- वे सर्टिफ़िकेट जो निरस्त कर दिए गए हैं.
- ऐसे सर्टिफ़िकेट जिनका विषय, टारगेट किए गए होस्टनेम से मेल नहीं खाता.

ज़रूरी नहीं है कि ये प्रॉपर्टी मौजूद हों

watch अनुरोध के साथ, इन वैकल्पिक फ़ील्ड की जानकारी भी दी जा सकती है:

token प्रॉपर्टी, जो चैनल टोकन के तौर पर इस्तेमाल करने के लिए आर्बिट्ररी स्ट्रिंग वैल्यू तय करती है. सूचना चैनल टोकन का इस्तेमाल कई कामों के लिए किया जा सकता है. उदाहरण के लिए, इस टोकन का इस्तेमाल यह पुष्टि करने के लिए किया जा सकता है कि हर इनकमिंग मैसेज, आपके ऐप्लिकेशन से बनाए गए चैनल के लिए है. इससे यह पक्का किया जा सकता है कि सूचना को स्पूफ़ नहीं किया जा रहा है. इसके अलावा, इस टोकन का इस्तेमाल, चैनल के मकसद के आधार पर मैसेज को आपके ऐप्लिकेशन में सही जगह पर भेजने के लिए भी किया जा सकता है. ज़्यादा से ज़्यादा वर्ण: 256 वर्ण.
यह टोकन, हर सूचना मैसेज में X-Goog-Channel-Token एचटीटीपी हेडर में शामिल होता है. यह मैसेज, आपका ऐप्लिकेशन इस चैनल के लिए पाता है.

अगर सूचना चैनल टोकन का इस्तेमाल किया जाता है, तो हमारा सुझाव है कि आप:
- एक्सटेंसिबल एन्कोडिंग फ़ॉर्मैट का इस्तेमाल करें. जैसे, यूआरएल क्वेरी पैरामीटर. उदाहरण: forwardTo=hr&createdBy=mobile
- इसमें OAuth टोकन जैसे संवेदनशील डेटा को शामिल न करें.
ध्यान दें: अगर आपको बहुत ज़्यादा संवेदनशील डेटा भेजना है, तो पक्का करें कि टोकन में जोड़ने से पहले उसे एन्क्रिप्ट किया गया हो.
expiration प्रॉपर्टी स्ट्रिंग को Unix टाइमस्टैंप पर सेट किया जाता है. यह टाइमस्टैंप, उस तारीख और समय के लिए होता है जब आपको Admin SDK API को इस सूचना चैनल के लिए मैसेज भेजना बंद करना है. यह टाइमस्टैंप मिलीसेकंड में होता है.

अगर किसी चैनल की समयसीमा खत्म होने वाली है, तो उसे X-Goog-Channel-Expiration एचटीटीपी हेडर की वैल्यू के तौर पर शामिल किया जाता है. यह वैल्यू, हर सूचना वाले मैसेज में होती है. यह मैसेज, आपके ऐप्लिकेशन को इस चैनल के लिए मिलता है. इस वैल्यू को, आसानी से पढ़े जा सकने वाले फ़ॉर्मैट में दिखाया जाता है.

ध्यान दें: Admin SDK API के लिए, ज़्यादा से ज़्यादा समयसीमा 21,600 सेकंड है. अगर आपने अपने अनुरोध में expiration प्रॉपर्टी सेट नहीं की है, तो मौजूदा समय के 21,600 सेकंड बाद, कुकी की समयसीमा खत्म होने का डिफ़ॉल्ट समय सेट हो जाएगा.

अनुरोध के बारे में ज़्यादा जानकारी के लिए, एपीआई रेफ़रंस में Activities संसाधन के लिए watch तरीका देखें.

जवाब देखना

अगर watch अनुरोध से सूचना चैनल बन जाता है, तो यह एचटीटीपी 200 OK स्टेटस कोड दिखाता है.

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

{
  "kind": "api#channel",
  "id": "reportsApiId",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName",
  "token": "target=myApp-myFilesChannelDest",
  "expiration": 3600
}

आपने अनुरोध में जो प्रॉपर्टी भेजी हैं उनके अलावा, जवाब में मिली जानकारी में resourceId और resourceUri भी शामिल हैं. इनसे यह पता चलता है कि इस सूचना चैनल पर कौनसे संसाधन पर नज़र रखी जा रही है.

ध्यान दें: resourceId प्रॉपर्टी, संसाधन के लिए एक स्टेबल आइडेंटिफ़ायर है. यह वर्शन पर निर्भर नहीं करता. resourceUri प्रॉपर्टी, मौजूदा एपीआई वर्शन के हिसाब से देखे गए संसाधन का कैननिकल यूआरआई है. इसलिए, यह वर्शन के हिसाब से अलग-अलग होती है.

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

रिस्पॉन्स के बारे में ज़्यादा जानकारी के लिए, एपीआई रेफ़रंस में Activities संसाधन के लिए watch तरीका देखें.

मैसेज सिंक करना

किसी संसाधन पर नज़र रखने के लिए सूचना चैनल बनाने के बाद, Admin SDK API एक sync मैसेज भेजता है. इससे पता चलता है कि सूचनाएं भेजी जा रही हैं. इन मैसेज के लिए, X-Goog-Resource-State एचटीटीपी हेडर की वैल्यू sync है. नेटवर्क टाइमिंग से जुड़ी समस्याओं की वजह से, ऐसा हो सकता है कि आपको sync मैसेज, watch तरीके के जवाब से पहले ही मिल जाए.

sync सूचना को अनदेखा किया जा सकता है. हालांकि, इसका इस्तेमाल भी किया जा सकता है. उदाहरण के लिए, अगर आपको चैनल नहीं रखना है, तो X-Goog-Channel-ID और X-Goog-Resource-ID वैल्यू का इस्तेमाल करके, सूचनाएं पाना बंद किया जा सकता है. इसके अलावा, sync सूचना का इस्तेमाल करके, कुछ इवेंट के लिए तैयारी की जा सकती है.

एडमिन SDK API, आपके यूआरएल पर sync मैसेज भेजता है. इसका फ़ॉर्मैट यहां दिया गया है.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

सिंक किए गए मैसेज में हमेशा X-Goog-Message-Number एचटीटीपी हेडर की वैल्यू 1 होती है. इस चैनल के लिए, इसके बाद आने वाली हर सूचना में एक ऐसा मैसेज नंबर होता है जो पिछली सूचना के मैसेज नंबर से बड़ा होता है. हालांकि, मैसेज नंबर क्रम से नहीं होंगे.

सूचना के चैनलों को रिन्यू करना

सूचना चैनल की समयसीमा खत्म होने का समय हो सकता है. इसकी वैल्यू, आपके अनुरोध या Admin SDK API की किसी आंतरिक सीमा या डिफ़ॉल्ट वैल्यू से तय होती है. इनमें से ज़्यादा पाबंदी वाली वैल्यू का इस्तेमाल किया जाता है. अगर चैनल की सदस्यता की समयसीमा खत्म होने वाली है, तो उसकी जानकारी watch तरीके से मिली जानकारी में शामिल की जाती है. यह जानकारी यूनिक्स टाइमस्टैंप (मिलीसेकंड में) के तौर पर शामिल की जाती है. इसके अलावा, हर सूचना वाले मैसेज में समयसीमा खत्म होने की तारीख और समय (इंसान के पढ़ने लायक फ़ॉर्मैट में) शामिल होता है. आपका ऐप्लिकेशन, इस चैनल के लिए X-Goog-Channel-Expiration एचटीटीपी हेडर में यह मैसेज पाता है.

फ़िलहाल, सूचना चैनल को अपने-आप रिन्यू करने का कोई तरीका उपलब्ध नहीं है. जब किसी चैनल की समयसीमा खत्म होने वाली हो, तो आपको उसे नए चैनल से बदलना होगा. इसके लिए, watch तरीके को कॉल करें. हमेशा की तरह, आपको नए चैनल की id प्रॉपर्टी के लिए एक यूनीक वैल्यू का इस्तेमाल करना होगा. ध्यान दें कि ऐसा हो सकता है कि एक ही संसाधन के लिए, सूचना पाने के दोनों चैनल कुछ समय के लिए चालू रहें.

सूचनाएं पाएं

जब भी मॉनिटर की जा रही किसी संसाधन में बदलाव होता है, तब आपके ऐप्लिकेशन को बदलाव के बारे में बताने वाला सूचना मैसेज मिलता है. Admin SDK API, इन मैसेज को एचटीटीपीएस POST अनुरोधों के तौर पर भेजता है. ये अनुरोध, उस यूआरएल पर भेजे जाते हैं जिसे आपने इस सूचना चैनल के लिए address प्रॉपर्टी के तौर पर सेट किया है.

ध्यान दें: सूचनाएं भेजने के लिए किए गए एचटीटीपीएस अनुरोधों में, APIs-Google उपयोगकर्ता एजेंट के तौर पर शामिल होता है. साथ ही, ये अनुरोध robots.txt के निर्देशों का पालन करते हैं. इस बारे में APIs Google User Agent में बताया गया है.

सूचना वाले मैसेज के फ़ॉर्मैट को समझना

सूचना वाले सभी मैसेज में, एचटीटीपी हेडर का एक सेट शामिल होता है. इसमें X-Goog- प्रीफ़िक्स होते हैं. कुछ तरह की सूचनाओं में मैसेज का मुख्य हिस्सा भी शामिल हो सकता है.

हेडर

Admin SDK API से आपके सूचना पाने वाले यूआरएल पर पोस्ट किए गए सूचना वाले मैसेज में, ये एचटीटीपी हेडर शामिल होते हैं:

हेडर	ब्यौरा
हमेशा मौजूद
`X-Goog-Channel-ID`	यूयूआईडी या अन्य यूनीक स्ट्रिंग, जिसका इस्तेमाल आपने इस सूचना चैनल की पहचान करने के लिए किया है.
`X-Goog-Message-Number`	पूर्णांक, जो इस सूचना चैनल के लिए इस मैसेज की पहचान करता है. `sync` मैसेज के लिए, वैल्यू हमेशा `1` होती है. चैनल पर मौजूद हर मैसेज के लिए, मैसेज की संख्या बढ़ती है. हालांकि, यह क्रम से नहीं होती.
`X-Goog-Resource-ID`	यह एक अपारदर्शी वैल्यू है, जो देखे जा रहे संसाधन की पहचान करती है. यह आईडी, एपीआई के सभी वर्शन में एक जैसा रहता है.
`X-Goog-Resource-State`	संसाधन की नई स्थिति, जिसकी वजह से सूचना ट्रिगर हुई. संभावित वैल्यू: `sync` या इवेंट का नाम.
`X-Goog-Resource-URI`	यह एपीआई के वर्शन के हिसाब से, मॉनिटर किए जा रहे संसाधन के लिए आइडेंटिफ़ायर होता है.
कभी-कभी मौजूद होता है
`X-Goog-Channel-Expiration`	सूचना चैनल के खत्म होने की तारीख और समय. इसे ऐसे फ़ॉर्मैट में दिखाया जाता है जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. यह सिर्फ़ तब मौजूद होता है, जब इसे तय किया गया हो.
`X-Goog-Channel-Token`	आपके ऐप्लिकेशन ने सूचना चैनल का यह टोकन सेट किया था. इसका इस्तेमाल सूचना के सोर्स की पुष्टि करने के लिए किया जा सकता है. यह सिर्फ़ तब मौजूद होता है, जब इसे तय किया गया हो.

गतिविधियों के लिए सूचना वाले मैसेज के अनुरोध के मुख्य हिस्से में यह जानकारी शामिल होती है:

प्रॉपर्टी	ब्यौरा
`kind`	इससे यह पता चलता है कि यह एक गतिविधि संसाधन है. वैल्यू: तय की गई स्ट्रिंग "`admin#reports#activity`".
`id`	गतिविधि के रिकॉर्ड का यूनीक आइडेंटिफ़ायर.
`id.time`	गतिविधि होने का समय. वैल्यू, आईएसओ 8601 तारीख और समय के फ़ॉर्मैट में है. समय, पूरी तारीख के साथ घंटे, मिनट, और सेकंड के बारे में बताता है. यह YYYY-MM-DDThh:mm:ssTZD फ़ॉर्मैट में होता है. उदाहरण के लिए, 2010-04-05T17:30:04+01:00.
`id.uniqueQualifier`	अगर कई इवेंट का समय एक जैसा है, तो यूनीक क्वालिफ़ायर.
`id.applicationName`	उस ऐप्लिकेशन का नाम जिससे इवेंट जुड़ा है. इन वैल्यू का इस्तेमाल किया जा सकता है: admin calendar drive groups groups_enterprise login मोबाइल saml टोकन user_accounts
`id.customerId`	Google Workspace खाते के लिए यूनीक आइडेंटिफ़ायर.
`actor`	कार्रवाई करने वाला उपयोगकर्ता.
`actor.callerType`	रिपोर्ट में दी गई गतिविधि को करने वाले लेखक का टाइप. एपीआई के इस वर्शन में, `callerType` वह `USER` या OAuth 2LO इकाई का अनुरोध है जिसने रिपोर्ट में दी गई कार्रवाई की है .
`actor.email`	उस उपयोगकर्ता का मुख्य ईमेल पता जिसकी गतिविधियों की रिपोर्ट की जा रही है.
`actor.profileId`	उपयोगकर्ता की यूनीक Google Workspace प्रोफ़ाइल का आईडी.
`ownerDomain`	Admin console या Docs ऐप्लिकेशन के दस्तावेज़ के मालिक का डोमेन. यह वह डोमेन है जिस पर रिपोर्ट के इवेंट का असर पड़ा है.
`ipAddress`	कार्रवाई करने वाले व्यक्ति का आईपी पता. यह Google Workspace में लॉग इन करते समय उपयोगकर्ता का इंटरनेट प्रोटोकॉल (आईपी) पता होता है. यह उपयोगकर्ता की मौजूदा जगह की जानकारी दिखा सकता है या नहीं भी दिखा सकता है. उदाहरण के लिए, आईपी पता उपयोगकर्ता के प्रॉक्सी सर्वर का पता या वर्चुअल प्राइवेट नेटवर्क (वीपीएन) का पता हो सकता है. यह एपीआई IPv4 और IPv6 के साथ काम करता है.
`events[]`	रिपोर्ट में गतिविधि वाले इवेंट.
`events[].type`	इवेंट का टाइप. एडमिन जिस Google Workspace सेवा या सुविधा में बदलाव करता है उसकी पहचान `type` प्रॉपर्टी में की जाती है. यह प्रॉपर्टी, `eventName` प्रॉपर्टी का इस्तेमाल करके किसी इवेंट की पहचान करती है.
`events[].name`	इवेंट का नाम. यह एपीआई से रिपोर्ट की गई गतिविधि का नाम है. हर `eventName`, Google Workspace की किसी सेवा या सुविधा से जुड़ा होता है. एपीआई, इन्हें अलग-अलग तरह के इवेंट में व्यवस्थित करता है. सामान्य तौर पर, `eventName` अनुरोध के पैरामीटर के लिए: अगर कोई `eventName` नहीं दिया गया है, तो रिपोर्ट में `eventName` के सभी संभावित उदाहरण दिखते हैं. `eventName` का अनुरोध करने पर, एपीआई से मिले जवाब में वे सभी गतिविधियां दिखती हैं जिनमें वह `eventName` शामिल होता है. ऐसा हो सकता है कि दिखाई गई गतिविधियों में, अनुरोध की गई प्रॉपर्टी के अलावा अन्य `eventName` प्रॉपर्टी भी मौजूद हों.
`events[].parameters[]`	अलग-अलग ऐप्लिकेशन के लिए पैरामीटर वैल्यू पेयर.
`events[].parameters[].name`	पैरामीटर का नाम.
`events[].parameters[].value`	पैरामीटर की स्ट्रिंग वैल्यू.
`events[].parameters[].intValue`	पैरामीटर की पूर्णांक वैल्यू.
`events[].parameters[].boolValue`	पैरामीटर की बूलियन वैल्यू.

उदाहरण

गतिविधि संसाधन के इवेंट के लिए सूचना वाले मैसेज, इस सामान्य फ़ॉर्म में होते हैं:

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName
X-Goog-Resource-State:  eventName
X-Goog-Message-Number: 10

{
  "kind": "admin#reports#activity",
  "id": {
    "time": datetime,
    "uniqueQualifier": long,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "callerType": string,
    "email": string,
    "profileId": long
  },
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "name": string,
          "value": string,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

एडमिन की गतिविधि वाले इवेंट का उदाहरण:

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 596
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?alt=json
X-Goog-Resource-State:  CREATE_USER
X-Goog-Message-Number: 23

{
  "kind": "admin#reports#activity",
  "id": {
    "time": "2013-09-10T18:23:35.808Z",
    "uniqueQualifier": "-0987654321",
    "applicationName": "admin",
    "customerId": "ABCD012345"
  },
  "actor": {
    "callerType": "USER",
    "email": "admin@example.com",
    "profileId": "0123456789987654321"
  },
  "ownerDomain": "apps-reporting.example.com",
  "ipAddress": "192.0.2.0",
  "events": [
    {
      "type": "USER_SETTINGS",
      "name": "CREATE_USER",
      "parameters": [
        {
          "name": "USER_EMAIL",
          "value": "liz@example.com"
        }
      ]
    }
  ]
}

सूचनाओं का उत्तर दें

सफल होने का स्टेटस दिखाने के लिए, इनमें से कोई भी स्टेटस कोड दिखाया जा सकता है: 200, 201, 202, 204 या 102.

अगर आपकी सेवा, Google की API क्लाइंट लाइब्रेरी का इस्तेमाल करती है और 500,502, 503 या 504 दिखाती है, तो Admin SDK API, एक्सपोनेंशियल बैकऑफ़ के साथ फिर से कोशिश करता है. वापसी के हर दूसरे स्टेटस कोड को मैसेज डिलीवर न होने की समस्या माना जाता है.

Admin SDK API के सूचना इवेंट समझना

इस सेक्शन में, Admin SDK API के साथ पुश नोटिफ़िकेशन का इस्तेमाल करने पर मिलने वाले सूचना मैसेज के बारे में जानकारी दी गई है.

Reports API की पुश नोटिफ़िकेशन में दो तरह के मैसेज होते हैं: सिंक मैसेज और इवेंट की सूचनाएं. मैसेज टाइप की जानकारी, X-Goog-Resource-State एचटीटीपी हेडर में दी जाती है. इवेंट की सूचनाओं के लिए उपलब्ध वैल्यू, activities.list तरीके के लिए उपलब्ध वैल्यू के जैसी ही होती हैं. हर ऐप्लिकेशन के यूनीक इवेंट होते हैं:

सूचनाएं पाने की सुविधा बंद करें

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

https://www.googleapis.com/admin/reports_v1/channels/stop

इस तरीके के लिए, आपको कम से कम चैनल की id और resourceId प्रॉपर्टी देनी होंगी. यहां दिए गए उदाहरण में, इन प्रॉपर्टी को दिखाया गया है. ध्यान दें कि अगर Admin SDK API में कई तरह के ऐसे संसाधन हैं जिनमें watch तरीके हैं, तो सिर्फ़ एक stop तरीका होता है.

चैनल को सिर्फ़ वे उपयोगकर्ता बंद कर सकते हैं जिनके पास इसकी अनुमति है. खास तौर पर:

अगर चैनल को किसी सामान्य उपयोगकर्ता खाते से बनाया गया था, तो उसे सिर्फ़ वही उपयोगकर्ता बंद कर सकता है जिसने उसे बनाया था. साथ ही, वह उपयोगकर्ता उसी क्लाइंट से होना चाहिए जिसकी पहचान OAuth 2.0 क्लाइंट आईडी से की गई है. यह आईडी, ऑथराइज़ेशन टोकन से मिलता है.
अगर चैनल को किसी सेवा खाते से बनाया गया है, तो उसी क्लाइंट का कोई भी उपयोगकर्ता चैनल को बंद कर सकता है.

यहां दिए गए कोड सैंपल में, सूचनाएं पाने की सुविधा बंद करने का तरीका बताया गया है:

POST https://www.googleapis.com/admin/reports_v1/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}

विशेष विचार-योग्य तथ्य

पुश नोटिफ़िकेशन का इस्तेमाल करते समय, इन बातों का ध्यान रखें:

सूचनाएं 100% भरोसेमंद नहीं होती हैं. सामान्य तौर पर काम करने की स्थितियों में, कुछ मैसेज डिलीवर नहीं हो पाते हैं. यह पक्का करें कि ये मैसेज ठीक से हैंडल किए जाएं, ताकि पुश मैसेज न मिलने पर भी ऐप्लिकेशन सिंक हो जाए.

ऐसा हो सकता है कि सूचनाएं, इवेंट के क्रम में न मिलें.