Method: userProfiles.guardians.get

یک قیم خاص را برمی گرداند.

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

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

درخواست HTTP

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

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

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

پارامترها
studentId

string

دانش آموزی که سرپرست او درخواست می شود. یکی از موارد زیر:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد
guardianId

string

فیلد id از یک Guardian .

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه از Guardian است.

محدوده مجوز

به یکی از حوزه های 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

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