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

UTC-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

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.