Method: userProfiles.guardians.list

فهرستی از نگهبانانی را برمی‌گرداند که کاربر درخواست‌کننده مجاز به مشاهده آن‌ها است، محدود به مواردی که با درخواست مطابقت دارند.

برای فهرست کردن سرپرستان هر دانش آموزی که کاربر درخواست کننده ممکن است سرپرستان آنها را مشاهده کند، از نویسه تحت اللفظی - برای شناسه دانشجویی استفاده کنید.

این روش کدهای خطای زیر را برمی گرداند:

  • PERMISSION_DENIED اگر studentId مشخص شده باشد، و کاربر درخواست کننده مجاز به مشاهده اطلاعات سرپرست آن دانش آموز نیست، اگر "-" به عنوان studentId مشخص شده باشد و کاربر مدیر دامنه نباشد، اگر سرپرستان برای دامنه مورد نظر فعال نشده باشند. ، اگر فیلتر invitedEmailAddress توسط کاربری که سرپرست دامنه نیست یا برای سایر خطاهای دسترسی تنظیم شده باشد.
  • اگر studentId مشخص شده باشد، INVALID_ARGUMENT ، اما قالب آن قابل شناسایی نیست (این یک آدرس ایمیل، نه یک studentId از API، و نه رشته تحت اللفظی me است). همچنین ممکن است در صورت ارائه pageToken نامعتبر برگردانده شود.
  • NOT_FOUND اگر studentId مشخص شده باشد و قالب آن قابل شناسایی باشد، اما Classroom هیچ سابقه ای از آن دانش آموز ندارد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.