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

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/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+ समुदायों पर रिपोर्ट लौटाता है.