Method: userProfiles.guardians.list

অভিভাবকদের একটি তালিকা প্রদান করে যা অনুরোধকারী ব্যবহারকারীকে দেখার অনুমতি দেওয়া হয়েছে, অনুরোধের সাথে মেলে তাদের জন্য সীমাবদ্ধ।

যে কোনো শিক্ষার্থীর জন্য অভিভাবকদের তালিকা করতে অনুরোধকারী ব্যবহারকারী অভিভাবকদের দেখতে পারেন, আক্ষরিক অক্ষর ব্যবহার করুন - ছাত্র আইডির জন্য।

এই পদ্ধতি নিম্নলিখিত ত্রুটি কোড প্রদান করে:

  • PERMISSION_DENIED যদি একটি studentId নির্দিষ্ট করা থাকে, এবং অনুরোধকারী ব্যবহারকারীকে সেই ছাত্রের অভিভাবকের তথ্য দেখার অনুমতি দেওয়া হয় না, যদি "-" studentId হিসাবে নির্দিষ্ট করা হয় এবং ব্যবহারকারী ডোমেন প্রশাসক না হয়, যদি অভিভাবকরা প্রশ্নে থাকা ডোমেনের জন্য সক্ষম না হয় , যদি invitedEmailAddress ফিল্টারটি এমন একজন ব্যবহারকারী দ্বারা সেট করা হয় যিনি একজন ডোমেন প্রশাসক নন, বা অন্যান্য অ্যাক্সেস ত্রুটির জন্য।
  • INVALID_ARGUMENT যদি একটি studentId নির্দিষ্ট করা থাকে, কিন্তু এর বিন্যাসটি স্বীকৃত হতে পারে না (এটি একটি ইমেল ঠিকানা নয়, না API থেকে একটি studentId , বা আক্ষরিক স্ট্রিং me )। একটি অবৈধ pageToken প্রদান করা হলে ফেরত দেওয়া হতে পারে।
  • NOT_FOUND যদি একটি studentId নির্দিষ্ট করা হয়, এবং এর বিন্যাস স্বীকৃত হতে পারে, কিন্তু Classroom সেই ছাত্রের কোনো রেকর্ড নেই।

HTTP অনুরোধ

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

URL gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করে।

পাথ প্যারামিটার

পরামিতি
studentId

string

যে শিক্ষার্থীর সাথে অভিভাবক লিঙ্ক করেছেন তার দ্বারা ফলাফল ফিল্টার করুন। শনাক্তকারী নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:

  • ব্যবহারকারীর জন্য সংখ্যাসূচক শনাক্তকারী
  • ব্যবহারকারীর ইমেল ঠিকানা
  • স্ট্রিং আক্ষরিক "me" , অনুরোধকারী ব্যবহারকারীকে নির্দেশ করে
  • স্ট্রিং আক্ষরিক "-" , নির্দেশ করে যে ফলাফলগুলি সমস্ত ছাত্রদের জন্য ফেরত দেওয়া উচিত যা অনুরোধকারী ব্যবহারকারীর দেখার অ্যাক্সেস রয়েছে৷

ক্যোয়ারী প্যারামিটার

পরামিতি
invitedEmailAddress

string

যে ইমেল ঠিকানায় আসল আমন্ত্রণ পাঠানো হয়েছিল তার ফলাফলগুলি ফিল্টার করুন, যার ফলে এই অভিভাবক লিঙ্ক। এই ফিল্টারটি শুধুমাত্র ডোমেইন অ্যাডমিনিস্ট্রেটরদের দ্বারা ব্যবহার করা যেতে পারে।

pageToken

string

nextPageToken মান একটি পূর্ববর্তী list কল থেকে ফিরে এসেছে, এটি নির্দেশ করে যে ফলাফলের পরবর্তী পৃষ্ঠাটি ফেরত দেওয়া উচিত।

list অনুরোধটি অন্যথায় এই টোকেনটির ফলে অনুরূপ হতে হবে।

pageSize

integer

ফেরত দিতে আইটেম সর্বোচ্চ সংখ্যা. শূন্য বা অনির্দিষ্ট নির্দেশ করে যে সার্ভার সর্বোচ্চ বরাদ্দ করতে পারে।

সার্ভার নির্দিষ্ট সংখ্যক ফলাফলের চেয়ে কম ফেরত দিতে পারে।

শরীরের অনুরোধ

অনুরোধের বডি খালি হতে হবে।

প্রতিক্রিয়া শরীর

অভিভাবকদের তালিকা করার সময় প্রতিক্রিয়া।

সফল হলে, প্রতিক্রিয়া বডিতে নিম্নলিখিত কাঠামোর সাথে ডেটা থাকে:

JSON প্রতিনিধিত্ব 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
ক্ষেত্র
guardians[]

object ( Guardian )

ফলাফলের এই পৃষ্ঠার অভিভাবকরা অনুরোধে উল্লেখিত মানদণ্ড পূরণ করেছে।

nextPageToken

string

টোকেন চিহ্নিত করে ফলাফলের পরবর্তী পৃষ্ঠায় ফিরতে হবে। খালি থাকলে, আর কোন ফলাফল পাওয়া যায় না।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

আরও তথ্যের জন্য, অনুমোদন নির্দেশিকা দেখুন।