Reports API: इकाइयों के इस्तेमाल की रिपोर्ट

इकाइयों के इस्तेमाल की रिपोर्ट में, Google Workspace की सेवा से जुड़ी उन इकाइयों के बारे में जानकारी दी जाती है जिनका इस्तेमाल आपके खाते के उपयोगकर्ता करते हैं. इन रिपोर्ट को इस्तेमाल से जुड़ी खास जानकारी के हिसाब से फ़िल्टर और पसंद के मुताबिक बनाया जा सकता है. पिछले 30 दिनों का डेटा उपलब्ध है.

आपके ग्राहक समझौते के मुताबिक, इकाइयों के इस्तेमाल की रिपोर्ट का इस्तेमाल, सिर्फ़ कानूनी मकसद के लिए किया जा सकता है. ये रिपोर्ट Google Workspace और Education पर भी लागू होती हैं.

सभी इकाइयों की इस्तेमाल की गतिविधियां वापस पाएं

फ़िलहाल, इस एपीआई के साथ सिर्फ़ Google+ समुदाय काम करते हैं. अपने खाते की ऐप्लिकेशन इकाइयों से जुड़ी सभी गतिविधियों की रिपोर्ट फिर से पाने के लिए, यहां दिए गए GET एचटीटीपी अनुरोध का इस्तेमाल करें. साथ ही, अनुमति के दस्तावेज़ में बताए गए ऑथराइज़ेशन टोकन को शामिल करें. टेक्स्ट को आसानी से पढ़ा जा सके, इसके लिए नीचे दिए गए उदाहरण को लाइन रिटर्न के साथ फ़ॉर्मैट किया गया है:

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

date वैल्यू, इस्तेमाल किए जाने की तारीख होती है और टाइमस्टैंप, ISO 8601 फ़ॉर्मैट, yyyy-mm-dd में होता है. हमारा सुझाव है कि इसके लिए, आप अपने खाते के टाइम ज़ोन का इस्तेमाल करें. क्वेरी स्ट्रिंग पैरामीटर और रिस्पॉन्स प्रॉपर्टी के बारे में ज़्यादा जानकारी के लिए, एपीआई का रेफ़रंस देखें. इकाइयों के इस्तेमाल से जुड़ी रिपोर्ट के पैरामीटर के बारे में जानकारी पाने के लिए, इकाइयों के इस्तेमाल के पैरामीटर का रेफ़रंस देखें.

applicationParameters, कॉमा लगाकर अलग किए गए उन पैरामीटर की सूची है जिन्हें आपको वापस पाना है. हर पैरामीटर को application:parameter_name के तौर पर फ़ॉर्मैट किया जाता है. उदाहरण के लिए, gplus:community_name. उपलब्ध पैरामीटर इकाइयों के इस्तेमाल के पैरामीटर के रेफ़रंस में दिए गए हैं. अगर कोई पैरामीटर तय नहीं किया गया है, तो सभी पैरामीटर दिखाए जाते हैं.

parameterFilters, फ़िल्टर की ऐसी सूची है जिसे नतीजों पर लागू करने के लिए कॉमा लगाकर अलग किया जाता है. हर फ़िल्टर को application:parameter_name[relational_operator]parameter_value के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, फ़िल्टर gplus:num_total_members>100 नतीजों को फ़िल्टर करके सिर्फ़ ऐसे नतीजे दिखाता है जिनके gplus:num_total_members पैरामीटर की वैल्यू 100 से ज़्यादा हो.

एक बार फ़ेच करने पर, maxResults नतीजे ज़्यादा से ज़्यादा संख्या में दिखाए जा सकते हैं. अगर नतीजों की कुल संख्या इससे ज़्यादा है, तो जवाब में काट-छांट की जाएगी और nextPageToken शामिल किया जाएगा. ज़्यादा जानने के लिए, JSON रिस्पॉन्स का उदाहरण देखें.

उदाहरण

इस उदाहरण में, एक ऐसी रिपोर्ट दी गई है जिसमें gplus_communities इकाइयों के सभी पैरामीटर शामिल हैं.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11

इस उदाहरण में, सभी gplus_communities इकाइयों के लिए community_name पैरामीटर वाली रिपोर्ट दी गई है.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name

इस उदाहरण में, हर gplus_communities इकाई के लिए community_name और num_total_members की रिपोर्ट दी गई है. इसे 100 से ज़्यादा सदस्यों वाली कम्यूनिटी के हिसाब से फ़िल्टर किया गया है. एपीआई से मिले रिस्पॉन्स के उदाहरण के लिए, JSON रिस्पॉन्स का उदाहरण देखें.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11
?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100

किसी खास इकाई की रिपोर्ट वापस पाना

किसी खास इकाई की रिपोर्ट फिर से पाने के लिए, नीचे दिए गए GET एचटीटीपी अनुरोध का इस्तेमाल करें. साथ ही, अनुमति के दस्तावेज़ में बताया गया ऑथराइज़ेशन टोकन शामिल करें. टेक्स्ट को आसानी से पढ़ा जा सके, इसके लिए नीचे दिए गए उदाहरण को लाइन रिटर्न के साथ फ़ॉर्मैट किया गया है.

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

entityKey एक इकाई आइडेंटिफ़ायर है, जो खास तौर पर उस ऐप्लिकेशन के लिए होता है जहां इकाई मौजूद है. अपनी पसंद की इकाई के लिए, entityKey को पाने का तरीका जानने के लिए, एपीआई का रेफ़रंस देखें. अन्य पैरामीटर को ऊपर, इस्तेमाल की गई सभी इकाइयों को वापस पाएं में दिया गया है.

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

उदाहरण

यहां दिए गए उदाहरण में, "1234" entityKey वाली gplus_community इकाई की इकाई रिपोर्ट के बारे में बताया गया है.

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

इस्तेमाल की रिपोर्ट का उदाहरण JSON

सही जवाब एचटीटीपी 200 स्टेटस कोड दिखाता है. रिस्पॉन्स में स्टेटस कोड के साथ-साथ एक रिपोर्ट भी दिखती है. जवाब के कुछ पैरामीटर को हटा दिया गया है, ताकि वे आसानी से पढ़े जा सकें.

इकाइयों की रिपोर्ट के लिए, JSON रिस्पॉन्स का उदाहरण

{
 "kind": "reports#usageReports",
 "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
 "usageReports": [
 {
   "kind": "admin#reports#usageReport",
   "date": "2017-12-11",
   "entity": {
    "type": "OBJECT",
    "customerId": "C03az79cb",
    "objectType": "GPLUS_COMMUNITY",
    "objectId": "1234",
   },
   "parameters": [
    {
      "name": "gplus:community_name",
      "stringValue": "My Community"
    },
    {
     "name": "gplus:num_total_members",
     "intValue": 37
    },
    {
     "name": "gplus:num_7day_active_members",
     "intValue": 12
    },
    {
     "name": "gplus:num_30day_active_members",
     "intValue": 17
    },
   ]
  }
 ]
}

चेतावनियों वाली इकाइयों की रिपोर्ट के लिए, JSON रिस्पॉन्स का उदाहरण

अगर अनुरोध पूरा नहीं किया जा सकता, तो हो सकता है कि जवाब के तौर पर एक या उससे ज़्यादा चेतावनियां मिलें. इस उदाहरण में, अनुरोध के समय रिपोर्ट उपलब्ध नहीं होती.
{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": "PARTIAL_DATA_AVAILABLE"
      "message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
      "data": [
        {
          "key": "date"
          "value": "2017-12-11"
        }
      ]
    }
  ],
 "usageReports": [],
}
warnings कलेक्शन में हर एंट्री में ये पैरामीटर होते हैं:
  • code: मशीन से पढ़ा जा सकने वाला चेतावनी कोड
  • message: चेतावनी वाला ऐसा मैसेज जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है
  • data: चेतावनी की पूरी जानकारी देने वाले की-वैल्यू पेयर की सूची