রিপোর্ট এপিআই: সত্তা ব্যবহারের রিপোর্ট

এনটিটি ইউসেজ রিপোর্টটি আপনার অ্যাকাউন্টের ব্যবহারকারীদের দ্বারা ব্যবহৃত এনটিটিগুলোর সাথে সম্পর্কিত গুগল ওয়ার্কস্পেস পরিষেবা কার্যকলাপের তথ্য প্রদান করে। নির্দিষ্ট ব্যবহারের তথ্যের জন্য এই রিপোর্টগুলো কাস্টমাইজ এবং ফিল্টার করা যায়। গত ৩০ দিনের ডেটা উপলব্ধ থাকে।

আপনার গ্রাহক চুক্তি অনুসারে, সত্তাগুলির ব্যবহারের প্রতিবেদন শুধুমাত্র বৈধ উদ্দেশ্যে ব্যবহার করা যেতে পারে। এই প্রতিবেদনগুলি Google Workspace এবং Education-এর ক্ষেত্রেও প্রযোজ্য।

সমস্ত সত্তার ব্যবহারের কার্যকলাপ পুনরুদ্ধার করুন

এই API দ্বারা সমর্থিত একমাত্র এনটিটি টাইপ হলো Google+ কমিউনিটি। আপনার অ্যাকাউন্টে থাকা অ্যাপ এনটিটি সম্পর্কিত সমস্ত কার্যকলাপের একটি রিপোর্ট পেতে, নিম্নলিখিত GET HTTP অনুরোধটি ব্যবহার করুন এবং অথরাইজেশন ডকুমেন্টেশনে বর্ণিত অথরাইজেশন টোকেনটি অন্তর্ভুক্ত করুন। পাঠযোগ্যতার জন্য, নিম্নলিখিত উদাহরণটি লাইন রিটার্ন সহ ফরম্যাট করা হয়েছে:

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 । উপলব্ধ প্যারামিটারগুলো Entities Usage Parameters রেফারেন্সে নথিভুক্ত করা আছে। যদি কোনো প্যারামিটার নির্দিষ্ট না করা হয়, তবে সবগুলোই ফেরত দেওয়া হয়।

parameterFilters হলো ফলাফলের উপর প্রয়োগ করার জন্য ফিল্টারগুলোর একটি কমা-দ্বারা-বিভক্ত তালিকা। প্রতিটি ফিল্টার ` application:parameter_name[relational_operator]parameter_value এই বিন্যাসে থাকে। উদাহরণস্বরূপ, gplus:num_total_members>100 ফিল্টারটি শুধুমাত্র সেইসব ফলাফলকে অন্তর্ভুক্ত করার জন্য ফিল্টার করে, যেখানে gplus:num_total_members প্যারামিটারের মান ১০০-এর বেশি।

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 এর একটি রিপোর্ট প্রদান করে, যা ১০০-এর বেশি সদস্যবিশিষ্ট কমিউনিটিগুলো দ্বারা ফিল্টার করা থাকে। API রেসপন্সের একটি উদাহরণের জন্য, 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 HTTP অনুরোধটি ব্যবহার করুন এবং অনুমোদন ডকুমেন্টেশনে বর্ণিত অনুমোদন টোকেনটি অন্তর্ভুক্ত করুন। পাঠযোগ্যতার জন্য, নিম্নলিখিত উদাহরণটি লাইন রিটার্ন সহ ফরম্যাট করা হয়েছে।

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 প্রতিক্রিয়া

একটি সফল প্রতিক্রিয়া একটি HTTP 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": [],
}

• code : মেশিন-পঠনযোগ্য সতর্কীকরণ কোড
• message : মানুষের পাঠযোগ্য সতর্কবার্তা
• data : কী-ভ্যালু জোড়গুলোর তালিকা যা বিস্তারিত সতর্কীকরণ তথ্য প্রদান করে