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 के साथ Directory API में users.list को कॉल करें. इसके बाद, userKey के तौर पर, दिखाए गए ID का इस्तेमाल करें.
date

string

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

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

पैरामीटर
customerId

string

उस ग्राहक का यूनीक आईडी जिसका डेटा आपको चाहिए.
filters

string

filters क्वेरी स्ट्रिंग, किसी ऐप्लिकेशन के इवेंट पैरामीटर की सूची होती है. इसमें पैरामीटर की वैल्यू को रिलेशनल ऑपरेटर से मैनिप्युलेट किया जाता है. इस सूची में, पैरामीटर को कॉमा लगाकर अलग किया जाता है. filters क्वेरी स्ट्रिंग में उस ऐप्लिकेशन का नाम शामिल होता है जिसका इस्तेमाल रिपोर्ट में दिखाया जाता है. उपयोगकर्ताओं के ऐप्लिकेशन के इस्तेमाल की रिपोर्ट के लिए, ऐप्लिकेशन की वैल्यू में accounts, chat, 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, chat, 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

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