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

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

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

नीचे दिए गए उदाहरण में community_name की रिपोर्ट दी गई है और हर gplus_communities इकाई के लिए, 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 पाने का तरीका जानना है, तो इस बारे में जानकारी पाएं दिलचस्पी है. अन्य पैरामीटर, ऊपर सभी इकाइयों के इस्तेमाल से जुड़ी गतिविधियां वापस पाना.

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

उदाहरण

नीचे दिए गए उदाहरण में, ऐसी gplus_community इकाई की इकाई रिपोर्ट दी गई है जिसका entityKey "1234".

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: की-वैल्यू पेयर की सूची, जो चेतावनी की पूरी जानकारी देती है