Method: entityUsageReports.get

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
entityType

enum (EntityType)

यह बताता है कि रिपोर्ट किस तरह की है.
entityKey or all

string

डेटा को फ़िल्टर करने के लिए, ऑब्जेक्ट की कुंजी दिखाता है. इस स्ट्रिंग में सभी उपयोगकर्ताओं की गतिविधि से जुड़े इवेंट या किसी खास ऐप्लिकेशन के लिए कोई दूसरी वैल्यू पाने के लिए, all वैल्यू ली जा सकती है. किसी entityType के लिए, entityKey पाने का तरीका जानने के लिए, इकाई के इस्तेमाल के पैरामीटर की रेफ़रंस गाइड देखें.
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/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

रिलेशनल ऑपरेटर में ये शामिल हैं:

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

integer (uint32 format)

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

string

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

string

parameters क्वेरी स्ट्रिंग, कॉमा लगाकर अलग की गई इवेंट पैरामीटर की सूची है, जो किसी रिपोर्ट के नतीजों को बेहतर बनाती है. पैरामीटर किसी खास ऐप्लिकेशन से जुड़ा होता है. इकाइयों के इस्तेमाल की रिपोर्ट के लिए, ऐप्लिकेशन की वैल्यू सिर्फ़ gplus हैं.
parameter क्वेरी स्ट्रिंग, [app_name1:param_name1], [app_name2:param_name2]... के CSV फ़ॉर्मैट में होती है.

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

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

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

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

अनुमति देने के दायरे

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

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

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

EntityType

Enums
gplus_communities Google+ बिरादरी पर रिपोर्ट देता है.