Method: courses.announcements.getAddOnContext

فراداده‌های افزونه‌های Classroom را در زمینه یک پست خاص دریافت می‌کند.

برای حفظ یکپارچگی داده ها و مدل مجوزهای خود، یک افزونه باید این را فراخوانی کند تا پارامترهای پرس و جو و نقش کاربر درخواست کننده را هر زمان که افزونه در iframe باز می شود، تأیید کند.

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

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

درخواست HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{itemId}/addOnContext

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

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

پارامترها
courseId

string

مورد نیاز. شناسه دوره

itemId

string

شناسه Announcement ، CourseWork ، یا CourseWorkMaterial که پیوست تحت آن پیوست شده است. این فیلد الزامی است، اما زمانی که ما از postId مهاجرت می کنیم، به این صورت علامت گذاری نمی شود.

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

پارامترها
addOnToken

string

اختیاری. رمزی که درخواست را تأیید می کند.

هنگامی که کاربر از Classroom به URL افزونه هدایت می شود، این رمز به عنوان یک پارامتر پرس و جو ارسال می شود.

زمانی که هیچ یک از موارد زیر صحیح نباشد، کد مجوز لازم است:

  • این افزونه دارای پیوست هایی در پست است.
  • پروژه توسعه دهنده ای که درخواست را صادر می کند، همان پروژه ای است که پست را ایجاد کرده است.
attachmentId

string

اختیاری. شناسه پیوست. این فیلد برای همه درخواست‌ها الزامی است، به جز زمانی که کاربر در iframe کشف پیوست باشد.

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

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