रिपोर्ट API: इकाइयां उपयोग रिपोर्ट

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

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

सभी इकाइयों के इस्तेमाल से जुड़ी गतिविधियां फिर से पाएं

फ़िलहाल, इस API पर सिर्फ़ 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 पाने का तरीका जानने के लिए, एपीआई का रेफ़रंस देखें. दूसरे पैरामीटर के बारे में ऊपर बताया गया है. इनमें इकाई के इस्तेमाल से जुड़ी सभी गतिविधियां वापस पाएं सेक्शन देखें.

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

उदाहरण

नीचे दिए गए उदाहरण में, entityKey और कोट;1234" के साथ, 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: की/वैल्यू पेयर की सूची, जो चेतावनी से जुड़ी पूरी जानकारी देते हैं