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 हो सकता है. मिटाया गया उपयोगकर्ता नहीं होना चाहिए. मिटाए गए उपयोगकर्ता के लिए, डायरेक्ट्री एपीआई में users.list को showDeleted=true के साथ कॉल करें. इसके बाद, मिले 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

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