এই পৃষ্ঠাটি Google Classroom API-তে অনুরোধগুলি কীভাবে কাজ করে তার একটি উচ্চ-স্তরের ওভারভিউ বর্ণনা করে। লক্ষ্য হল এমন পাঠকদের সাহায্য করা যারা ইতিমধ্যে রিসোর্স-ভিত্তিক ডিজাইন বা Google Workspace API-এর সাথে পরিচিত নন।
নির্দিষ্ট কোড নমুনার জন্য, সংশ্লিষ্ট API নির্দেশিকাগুলি দেখুন, উদাহরণস্বরূপ কোর্স তৈরি করুন এবং পরিচালনা করুন বা কোর্সওয়ার্ক তৈরি করুন এবং পরিচালনা করুন ।
সম্পদ-ভিত্তিক নকশা
API কাঠামোতে উল্লিখিত হিসাবে, Classroom API সম্পদ-ভিত্তিক নকশার ধরণ অনুসরণ করে। বেশিরভাগ সংস্থানগুলিতে সম্পদের উদাহরণ তৈরি করা, পড়া, আপডেট করা এবং মুছে ফেলার মতো স্ট্যান্ডার্ড অপারেশনের পদ্ধতি রয়েছে।
উদাহরণস্বরূপ, API ব্যবহার করে একটি ক্লাসরুম Course create() , patch() , get() , list() , এবং delete() সম্ভব।
তৈরি করুন
একটি নতুন সংস্থান তৈরি করতে, যেমন একটি Course , সংশ্লিষ্ট সংস্থানের জন্য create() পদ্ধতিতে কল করুন।
Create() কলের জন্য সর্বদা ইনপুট হিসাবে সংশ্লিষ্ট সংস্থানের প্রাথমিক, সমালোচনামূলক বিবরণ প্রয়োজন। উদাহরণস্বরূপ, একটি Course তৈরি করতে, Course রিসোর্সে create() পদ্ধতিতে কল করুন এবং room মত ঐচ্ছিক তথ্য সহ অনুরোধে name ও description উল্লেখ করুন।
সাবরিসোর্সের জন্য (কখনও কখনও চাইল্ড রিসোর্স বলা হয়), প্যারেন্ট রিসোর্সের জন্য আইডেন্টিফায়ারও প্রয়োজন। উদাহরণস্বরূপ, একটি Course মধ্যে একটি CourseWork তৈরি করার সময়, CourseWork কোন Course অন্তর্গত তা নির্ধারণ করতে Course id প্রয়োজন।
Create() পদ্ধতি এপিআই কল রেসপন্সে সদ্য তৈরি রিসোর্সের একটি উদাহরণ প্রদান করে। রিটার্ন করা রিসোর্সে সাধারণত কোনো অতিরিক্ত, সার্ভার-জেনারেটেড ফিল্ড থাকে, যেমন রিসোর্স id বা creationTime ।
প্যাচ
বিদ্যমান সংস্থানগুলি সংশোধন করতে, সংশ্লিষ্ট সংস্থানে patch() পদ্ধতি (যাকে কখনও কখনও update() বলা হয়) কল করুন। patch() পদ্ধতিটি create() করতে প্রায় অভিন্ন, দুটি মূল পার্থক্য সহ; patch() পদ্ধতিতে কল করার সময় আপনাকে অবশ্যই নির্দিষ্ট করতে হবে:
- রিসোর্সের
idপরিবর্তন করতে হবে। - রিসোর্সের কোন ক্ষেত্র আপডেট করা হবে তা নির্ধারণ করতে একটি
updateMaskনামে পরিচিত ক্ষেত্রগুলির একটি তালিকা। এটি ঐচ্ছিক ক্ষেত্রে যেখানে ক্ষেত্রগুলির একটি ডিফল্ট সেট আছে বা ক্ষেত্রগুলি অনুমান করা হয়েছে৷
Patch() পদ্ধতিগুলি API কল প্রতিক্রিয়াতে আপডেট হওয়া সংস্থানের সম্পূর্ণ উদাহরণ প্রদান করে, সমস্ত পরিবর্তন সম্পূর্ণ করে।
পান এবং তালিকা
সম্পদ পুনরুদ্ধার করার জন্য দুটি পদ্ধতি আছে: get() এবং list() ।
get() পদ্ধতি কিছু শনাক্তকারী দ্বারা একটি নির্দিষ্ট সংস্থান পুনরুদ্ধার করে। উদাহরণস্বরূপ, id বা alias উপর ভিত্তি করে একটি Course আনা। get() কল সরাসরি সম্পূর্ণ রিসোর্স ফেরত দেয়।
list() পদ্ধতিটি পৃথক রিসোর্স শনাক্তকারীর প্রয়োজন ছাড়াই একক অনুরোধে একই ধরণের একাধিক সংস্থান পুনরুদ্ধার করে। প্রায়শই list() অপারেশন কিছু প্যারেন্ট রিসোর্সের সমস্ত সাবরিসোর্স পায়, উদাহরণস্বরূপ, একটি Course মধ্যে সমস্ত CourseWork পুনরুদ্ধার করা। এটি একাধিক get() কল করার তুলনায় অনুরোধগুলি হ্রাস করার জন্য উপযোগী এবং বিশেষ করে মূল্যবান যখন আপনি আপনার পছন্দের সংস্থানগুলির id জানেন না।
সাধারণত, list() পদ্ধতিতে কিছু সর্বোচ্চ পরিমাণ রিসোর্স থাকে যা একটি কলে ফেরত দেওয়া যায় এবং কলের সাথে একটি pageSize মান অন্তর্ভুক্ত করে নিম্ন সীমা কনফিগার করা যেতে পারে। যে ক্ষেত্রে সীমার চেয়ে বেশি সংস্থান রয়েছে, list() পদ্ধতিটি পৃষ্ঠা সংখ্যাকে সমর্থন করে; প্রত্যাবর্তিত ফলাফলের প্রতিটি "পৃষ্ঠা" একটি pageToken প্রদান করে, যা পরবর্তী ব্যাচের সম্পদ আনতে পরবর্তী list() কলে অন্তর্ভুক্ত করা যেতে পারে।
মুছে দিন
delete() পদ্ধতি একটি রিসোর্স আইডেন্টিফায়ার গ্রহণ করে, যেমন id , এবং সংশ্লিষ্ট রিসোর্স মুছে দেয়। যদি delete() সফল হয়, একটি খালি প্রতিক্রিয়া ফেরত দেওয়া হয়।
অন্যান্য অপারেশন
ক্লাসরুম এপিআই-এর সাথে সম্ভব সমস্ত ক্রিয়াকলাপগুলি উপরে উল্লিখিত স্ট্যান্ডার্ড ক্রিয়াকলাপগুলির সাথে অর্জন করা যায় না, উদাহরণস্বরূপ, একটি CourseWork সংস্থানের নিয়োগকারীদের সংশোধন করা৷ এই ক্ষেত্রে, কাস্টম পদ্ধতি উপলব্ধ, যেমন modifyAssignees পদ্ধতি। এই পদ্ধতিগুলির আচরণটি পছন্দসই এবং আপনার পৃথকভাবে তাদের জন্য ডকুমেন্টেশনের সাথে পরামর্শ করা উচিত।