रिपोर्ट एपीआई एक RESTful API है. इसका इस्तेमाल अपने उपयोगकर्ताओं की Google Workspace गतिविधियों के बारे में जानकारी ऐक्सेस करने के लिए किया जा सकता है. रिपोर्ट एपीआई, एडमिन SDK API का हिस्सा है.
रिपोर्ट एपीआई, दो तरह की रिपोर्ट देता है:
- गतिविधि रिपोर्ट, जो किसी खास ऐप्लिकेशन या सेवा, जैसे कि Google Drive या Admin console के इवेंट की रिपोर्ट करती हैं.
- इस्तेमाल की रिपोर्ट, जिनमें उपयोगकर्ताओं की वजह से होने वाले फ़ाइल फ़ोल्डर के इवेंट की सूची होती है.
- ग्राहक के इस्तेमाल की रिपोर्ट, आपके डोमेन के सभी उपयोगकर्ताओं के लिए इवेंट की सूची बनाती है.
- उपयोगकर्ता के इस्तेमाल की रिपोर्ट, उपयोगकर्ताओं के हिसाब से व्यवस्थित किए गए इवेंट की सूची बनाती हैं.
नीचे, रिपोर्ट एपीआई में इस्तेमाल किए जाने वाले सामान्य शब्दों की सूची दी गई है:
- गतिविधि की रिपोर्ट
गतिविधि रिपोर्ट में, Google Workspace के किसी खास ऐप्लिकेशन या सेवा में गतिविधियों की जानकारी शामिल होती है. गतिविधि रिपोर्ट में तारीख, समय, उपयोगकर्ता, और गतिविधि का प्रकार शामिल होता है. एपीआई के रेफ़रंस में, गतिविधि की रिपोर्ट और उनमें शामिल जानकारी की पूरी सूची होती है. यहां ऐप्लिकेशन या सेवा से जुड़ी, गतिविधि की कुछ रिपोर्ट के उदाहरण दिए गए हैं:
- एडमिन की गतिविधि वाली रिपोर्ट में, एडमिन कंसोल का इस्तेमाल करने वाले एडमिन की गतिविधियां दिखती हैं. उदाहरण के लिए, आपको उन सभी चीज़ों की सूची मिल सकती है जिनमें एडमिन ने Admin console का इस्तेमाल करके उपयोगकर्ता का नाम बदला है.
- Google Drive में सेव की गई गतिविधि की रिपोर्ट में बताया जाता है कि आपके डोमेन के उपयोगकर्ता, Drive में मौजूद अपने दस्तावेज़ों में किस तरह के बदलाव कर सकते हैं और उन्हें कैसे देख सकते हैं. उदाहरण के लिए, आपको Drive पर किसी खास उपयोगकर्ता की गतिविधि की सूची मिल सकती है.
- लॉगिन गतिविधि रिपोर्ट इस बारे में जानकारी देती हैं कि आपके खाते के उपयोगकर्ता अपने खातों में कब लॉग इन और आउट करते हैं. उदाहरण के लिए, आपको किसी खास समयावधि में अपने डोमेन के लिए सभी लॉगिन की रिपोर्ट मिल सकती है.
- मोबाइल गतिविधि रिपोर्ट Google मोबाइल प्रबंधन की ओर से प्रबंधित मोबाइल डिवाइस का उपयोग करके गतिविधियां दिखाती हैं. उदाहरण के लिए, उपयोगकर्ता जब कोई नया डिवाइस रजिस्टर करते हैं, तब आपको इसकी सूचना मिल सकती है.
- OAuth टोकन से जुड़ी गतिविधि रिपोर्ट में इवेंट तब शामिल किए जाते हैं, जब आपके उपयोगकर्ताओं ने तीसरे पक्ष की वेबसाइटों और ऐप्लिकेशन को इस्तेमाल किए गए अनुमति टोकन दिए या निरस्त किए हों. किसी उपयोगकर्ता के Google Workspace डेटा को ऐक्सेस करने वाले तीसरे पक्ष के सभी सदस्यों की सूची देखने के लिए, रिपोर्ट एपीआई का इस्तेमाल किया जा सकता है.
- इस्तेमाल की रिपोर्ट
इस्तेमाल करने की रिपोर्ट से, आपके डोमेन में होने वाले Google Workspace इवेंट के बारे में जानकारी मिलती है. एपीआई का इस्तेमाल करके, उपयोगकर्ताओं की खास जानकारी का अनुरोध किया जा सकता है.
- ग्राहक उपयोग रिपोर्ट आपके खाते में विस्तृत ऐप्लिकेशन और सेवा गतिविधियों की सूची बनाती हैं. यह इस्तेमाल की जानकारी को ऐप्लिकेशन के टाइप के हिसाब से व्यवस्थित किया जाता है. साथ ही, इसमें उस ऐप्लिकेशन से जुड़ी खास जानकारी शामिल होती है.
- उपयोगकर्ताओं के इस्तेमाल की रिपोर्ट आपके खाते के उपयोगकर्ताओं की गतिविधियां दिखाती हैं. इन रिपोर्ट को उपयोग की विशिष्ट जानकारी के लिए कस्टमाइज़ और फ़िल्टर किया जा सकता है. इस तरह के इस्तेमाल के बारे में जानकारी को ऐप्लिकेशन के टाइप के हिसाब से व्यवस्थित किया जाता है. साथ ही, इसमें ऐप्लिकेशन से जुड़ी खास जानकारी शामिल होती है.
- इकाइयों की उपयोग रिपोर्ट Currents ऐप्लिकेशन में आपके खाते के उपयोगकर्ताओं की ओर से उपयोग की जाने वाली इकाइयों से संबंधित गतिविधियों को सूचीबद्ध करता है.
- सूचनाएं
- रिपोर्ट एपीआई से आपको सूचनाएं मिलती हैं. इन इवेंट की मदद से, इवेंट के बारे में जानकारी देखी जा सकती है, जैसे कि संसाधनों में बदलाव. जब आप कोई संसाधन देख रहे होते हैं और वह संसाधन बदल जाता है, तो रिपोर्ट एपीआई आपको एक सूचना भेजता है. रिपोर्ट एपीआई सेट अप करने और उससे सूचनाएं पाने के बारे में ज़्यादा जानकारी के लिए, पुश नोटिफ़िकेशन पाने से जुड़ी गाइड देखें.
अगले चरण
'रिपोर्ट एपीआई' के बारे में जानने और उसे काम करने लायक बनाने के लिए, क्विकस्टार्ट का इस्तेमाल करें. इन्हें बाएं नेविगेशन बार में प्रोग्रामिंग भाषा के हिसाब से दिखाया जाता है. आप अपना खाता सेट अप करने के बारे में सामान्य जानकारी पढ़ने के लिए भी इस सेक्शन में आगे बढ़ सकते हैं.
रिपोर्ट एपीआई का इस्तेमाल करने के लिए, अपना खाता सेट अप करने और एडमिन बनने के लिए, ज़रूरी शर्तें अपनाएं. साथ ही, आप एक प्रोजेक्ट बनाएंगी और उसे Google API (एपीआई) कंसोल का इस्तेमाल करके रजिस्टर करेंगे. साथ ही, आप 'रिपोर्ट एपीआई' सेवा को भी चालू कर देंगे.
ऑथराइज़ेशन सेक्शन में, Google Workspace के ऐप्लिकेशन और सेवाओं से उपयोगकर्ता का डेटा पाने के लिए, OAuth 2.0 ऐक्सेस टोकन के इस्तेमाल का तरीका बताया गया है.
किसी खास तरह के संसाधन या तरीके की जानकारी पाने के लिए, एपीआई का रेफ़रंस देखें.
ज़्यादा जानकारी के लिए, एडमिन SDK का एपीआई समस्या को ट्रैक करने वाला टूल, Google Workspace डेवलपर का ब्लॉग, और Google Workspace एडमिन सहायता केंद्र देखें.