Method: entityUsageReports.get

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

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

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

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

पाथ पैरामीटर

पैरामीटर
entityType

enum (EntityType)

रिपोर्ट में शामिल इकाई का टाइप दिखाता है.
entityKey

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