Method: userProfiles.get

نمایه کاربری را برمی گرداند.

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

  • اگر کاربر درخواست کننده اجازه دسترسی به این نمایه کاربر را نداشته باشد، اگر هیچ نمایه ای با شناسه درخواستی وجود نداشته باشد، یا برای خطاهای دسترسی ، PERMISSION_DENIED .

درخواست HTTP

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

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

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

پارامترها
user Id

string

شناسه نمایه برای بازگشت. شناسه می تواند یکی از موارد زیر باشد:

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

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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