Method: userUsageReport.get

यह रिपोर्ट, खाते का इस्तेमाल करने वाले उपयोगकर्ताओं के ग्रुप के लिए, प्रॉपर्टी और आंकड़ों का कलेक्शन इकट्ठा करती है. ज़्यादा जानकारी के लिए, इस्तेमाल करने से जुड़ी रिपोर्ट की गाइड देखें. उपयोगकर्ता रिपोर्ट के पैरामीटर के बारे में ज़्यादा जानकारी पाने के लिए, उपयोगकर्ता के इस्तेमाल के पैरामीटर वाली रेफ़रंस गाइड देखें.

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

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
userKey or all

string

उस प्रोफ़ाइल आईडी या उपयोगकर्ता ईमेल के बारे में बताता है जिसके लिए डेटा फ़िल्टर किया जाना चाहिए. यह all सभी जानकारी के लिए हो सकता है. इसके अलावा, यह उपयोगकर्ता के यूनीक Google Workspace प्रोफ़ाइल आईडी या उसके मुख्य ईमेल पते के लिए, userKey हो सकता है. उपयोगकर्ता की जानकारी को मिटाया नहीं जाना चाहिए. किसी मिटाए गए उपयोगकर्ता के लिए, showDeleted=true के साथ डायरेक्ट्री एपीआई में users.list को कॉल करें और फिर दिखाए गए ID को userKey के तौर पर इस्तेमाल करें.
date

string

यूटीसी-8:00 (पैसिफ़िक स्टैंडर्ड समय) के हिसाब से, इस्तेमाल की तारीख दिखती है. टाइमस्टैंप, ISO 8601 फ़ॉर्मैट में होना चाहिए, yyyy-mm-dd.

क्वेरी पैरामीटर

पैरामीटर
customerId

string

ग्राहक का यूनीक आईडी, जिससे डेटा वापस पाया जा सकता है.
filters

string

filters क्वेरी स्ट्रिंग, ऐप्लिकेशन के इवेंट पैरामीटर की कॉमा-सेपरेटेड लिस्ट होती है. इसमें रिलेशनल ऑपरेटर से पैरामीटर की वैल्यू में बदलाव किया जाता है. filters क्वेरी स्ट्रिंग में उस ऐप्लिकेशन का नाम शामिल होता है जिसका इस्तेमाल, रिपोर्ट में दिखाया जाता है. उपयोगकर्ताओं की इस्तेमाल की रिपोर्ट में, accounts, docs, और gmail ऐप्लिकेशन की वैल्यू शामिल होती हैं.

फ़िल्टर, [application name]:[parameter name][relational operator][parameter value],... फ़ॉर्मैट में होते हैं.

इस उदाहरण में, <> 'बराबर नहीं' के ऑपरेटर को अनुरोध की क्वेरी स्ट्रिंग (%3C%3E) में यूआरएल से कोड किया गया है: 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

मिलते-जुलते ऑपरेटर ये शामिल हैं:

  • == - 'इसके बराबर'.
  • <> - 'इसके बराबर नहीं'. यह यूआरएल के लिए कोड किया गया (%3C%3E) है.
  • < - 'इससे कम'. यह यूआरएल के लिए कोड किया गया (%3C) है.
  • <= - 'इससे कम या इसके बराबर'. यह यूआरएल के लिए कोड किया गया (%3C=) है.
  • > - 'इससे ज़्यादा'. यह यूआरएल के लिए कोड किया गया (%3E) है.
  • >= - 'इससे ज़्यादा या इसके बराबर'. यह यूआरएल के लिए कोड किया गया (%3E=) है.
maxResults

integer (uint32 format)

इससे तय होता है कि जवाब के हर पेज पर कितने गतिविधि रिकॉर्ड दिखाई दें. उदाहरण के लिए, अगर अनुरोध maxResults=1 सेट करता है और रिपोर्ट में दो गतिविधियां होती हैं, तो रिपोर्ट में दो पेज होते हैं. रिस्पॉन्स की nextPageToken प्रॉपर्टी में, दूसरे पेज का टोकन है.
maxResults क्वेरी स्ट्रिंग ज़रूरी नहीं है.
orgUnitId

string

रिपोर्ट करने के लिए संगठन की इकाई का आईडी. उपयोगकर्ता गतिविधि सिर्फ़ उन उपयोगकर्ताओं को दिखाई जाएगी जो संगठन की किसी खास इकाई से जुड़े हों.

pageToken

string

अगला पेज तय करने के लिए टोकन. इस रिपोर्ट में एक से ज़्यादा पेजों वाली रिपोर्ट के तौर पर, nextPageToken प्रॉपर्टी मौजूद होती है. रिपोर्ट के अगले पेज पर जाने के लिए आपके फ़ॉलो-ऑन अनुरोध में, pageToken क्वेरी स्ट्रिंग में nextPageToken वैल्यू डालें.
parameters

string

parameters क्वेरी स्ट्रिंग, इवेंट पैरामीटर की कॉमा-सेपरेटेड लिस्ट होती है. यह रिपोर्ट के नतीजों को बेहतर बनाती है. पैरामीटर किसी खास ऐप्लिकेशन से जुड़ा होता है. ग्राहक उपयोग रिपोर्ट की ऐप्लिकेशन वैल्यू में accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet और sites शामिल हैं.
parameters क्वेरी स्ट्रिंग, app_name1:param_name1, app_name2:param_name2 के CSV फ़ॉर्म में है.

groupIdFilter

string

कॉमा लगाकर अलग किए गए ग्रुप आईडी (धुंधला) जिन पर उपयोगकर्ता गतिविधियां फ़िल्टर की जाती हैं. इसका मतलब है कि सिर्फ़ उन उपयोगकर्ताओं की गतिविधियों को शामिल किया जाएगा जो यहां बताए गए ग्रुप आईडी में से कम से कम एक का हिस्सा हैं. फ़ॉर्मैट: "id:abc123,id:xyz456"

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में UsageReports का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.