این سند حاوی اطلاعات مجوز و احراز هویت مخصوص Google Classroom API است. قبل از خواندن این سند، حتماً اطلاعات عمومی احراز هویت و مجوز Google Workspace را در اطلاعات مربوط به احراز هویت و مجوز مطالعه کنید.
OAuth 2.0 را برای مجوز پیکربندی کنید
صفحه رضایت OAuth را پیکربندی کنید و دامنه ها را انتخاب کنید تا مشخص کنید چه اطلاعاتی برای کاربران و بازبینان برنامه نمایش داده می شود و برنامه خود را ثبت کنید تا بتوانید بعداً آن را منتشر کنید.
محدوده‌های API Classroom
برای تعریف سطح دسترسی اعطا شده به برنامه خود، باید محدوده های مجوز را شناسایی و اعلام کنید. محدوده مجوز یک رشته URI OAuth 2.0 است که حاوی نام برنامه Google Workspace، نوع داده‌هایی است که به آن دسترسی دارد و سطح دسترسی. Scopes درخواست‌های برنامه شما برای کار با داده‌های Google Workspace، از جمله داده‌های حساب Google کاربران است.
هنگامی که برنامه شما نصب می شود، از کاربر خواسته می شود تا محدوده های مورد استفاده برنامه را تأیید کند. به طور کلی، شما باید محدودترین محدوده ممکن را انتخاب کنید و از درخواست دامنه هایی که برنامه شما به آن نیاز ندارد اجتناب کنید. کاربران با سهولت بیشتری به محدوده‌های محدود و به وضوح توضیح داده شده دسترسی می‌دهند.
Classroom API از حوزه های زیر پشتیبانی می کند:
| محدوده ها | معنی |
|---|---|
https://www.googleapis.com/auth/classroom.announcements | اعلان‌ها را در Google Classroom مشاهده و مدیریت کنید. |
https://www.googleapis.com/auth/classroom.announcements.readonly | مشاهده اطلاعیه ها در Google Classroom. |
https://www.googleapis.com/auth/classroom.courses | کلاس‌های Google Classroom خود را مشاهده، ویرایش، ایجاد و برای همیشه حذف کنید. |
https://www.googleapis.com/auth/classroom.courses.readonly | کلاس‌های Google Classroom خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.coursework.me | موارد درسی شامل تکالیف، سؤالات و نمرات را ببینید، ایجاد و ویرایش کنید. |
https://www.googleapis.com/auth/classroom.coursework.me.readonly | دروس و نمرات خود را در Google Classroom مشاهده کنید. |
https://www.googleapis.com/auth/classroom.coursework.students | کار درسی و نمرات دانش‌آموزان را در کلاس‌های Google Classroom که تدریس می‌کنید مدیریت کنید و تکالیف درسی و نمرات کلاس‌هایی را که مدیریت می‌کنید مشاهده کنید. |
https://www.googleapis.com/auth/classroom.coursework.students.readonly | کار درسی و نمرات دانش‌آموزان را در کلاس‌های Google Classroom که تدریس می‌کنید یا مدیریت می‌کنید، مشاهده کنید. |
https://www.googleapis.com/auth/classroom.courseworkmaterials | مطالب کلاس را در Google Classroom مشاهده، ویرایش و ایجاد کنید. |
https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly | همه مطالب کلاسی را برای کلاس‌های Google Classroom خود مشاهده کنید. |
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly | سرپرستان Google Classroom خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.guardianlinks.students | سرپرستان دانش‌آموزان را در کلاس‌های Google Classroom خود مشاهده و مدیریت کنید. |
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly | سرپرستان دانش‌آموزان را در کلاس‌های Google Classroom خود مشاهده کنید. |
https://www.googleapis.com/auth/classroom.profile.emails | آدرس ایمیل افراد در کلاس های خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.profile.photos | عکس های پروفایل افراد در کلاس های خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.push-notifications | اعلان‌هایی درباره داده‌های Google Classroom خود دریافت کنید. |
https://www.googleapis.com/auth/classroom.rosters | فهرست‌های کلاس Google Classroom خود را مدیریت کنید. |
https://www.googleapis.com/auth/classroom.rosters.readonly | فهرست‌های کلاس Google Classroom خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.student-submissions.me.readonly | دروس و نمرات خود را در Google Classroom مشاهده کنید. |
https://www.googleapis.com/auth/classroom.student-submissions.students.readonly | کار درسی و نمرات دانش‌آموزان را در کلاس‌های Google Classroom که تدریس می‌کنید یا مدیریت می‌کنید، مشاهده کنید. |
https://www.googleapis.com/auth/classroom.topics | مشاهده، ایجاد و ویرایش موضوعات در Google Classroom. |
https://www.googleapis.com/auth/classroom.topics.readonly | مشاهده موضوعات در Google Classroom. |
این سند حاوی اطلاعات مجوز و احراز هویت مخصوص Google Classroom API است. قبل از خواندن این سند، حتماً اطلاعات عمومی احراز هویت و مجوز Google Workspace را در اطلاعات مربوط به احراز هویت و مجوز مطالعه کنید.
OAuth 2.0 را برای مجوز پیکربندی کنید
صفحه رضایت OAuth را پیکربندی کنید و دامنه ها را انتخاب کنید تا مشخص کنید چه اطلاعاتی برای کاربران و بازبینان برنامه نمایش داده می شود و برنامه خود را ثبت کنید تا بتوانید بعداً آن را منتشر کنید.
محدوده‌های API Classroom
برای تعریف سطح دسترسی اعطا شده به برنامه خود، باید محدوده های مجوز را شناسایی و اعلام کنید. محدوده مجوز یک رشته URI OAuth 2.0 است که حاوی نام برنامه Google Workspace، نوع داده‌هایی است که به آن دسترسی دارد و سطح دسترسی. Scopes درخواست‌های برنامه شما برای کار با داده‌های Google Workspace، از جمله داده‌های حساب Google کاربران است.
هنگامی که برنامه شما نصب می شود، از کاربر خواسته می شود تا محدوده های مورد استفاده برنامه را تأیید کند. به طور کلی، شما باید محدودترین محدوده ممکن را انتخاب کنید و از درخواست دامنه هایی که برنامه شما به آن نیاز ندارد اجتناب کنید. کاربران با سهولت بیشتری به محدوده‌های محدود و به وضوح توضیح داده شده دسترسی می‌دهند.
Classroom API از حوزه های زیر پشتیبانی می کند:
| محدوده ها | معنی |
|---|---|
https://www.googleapis.com/auth/classroom.announcements | اعلان‌ها را در Google Classroom مشاهده و مدیریت کنید. |
https://www.googleapis.com/auth/classroom.announcements.readonly | مشاهده اطلاعیه ها در Google Classroom. |
https://www.googleapis.com/auth/classroom.courses | کلاس‌های Google Classroom خود را مشاهده، ویرایش، ایجاد و برای همیشه حذف کنید. |
https://www.googleapis.com/auth/classroom.courses.readonly | کلاس‌های Google Classroom خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.coursework.me | موارد درسی شامل تکالیف، سؤالات و نمرات را ببینید، ایجاد و ویرایش کنید. |
https://www.googleapis.com/auth/classroom.coursework.me.readonly | دروس و نمرات خود را در Google Classroom مشاهده کنید. |
https://www.googleapis.com/auth/classroom.coursework.students | کار درسی و نمرات دانش‌آموزان را در کلاس‌های Google Classroom که تدریس می‌کنید مدیریت کنید و تکالیف درسی و نمرات کلاس‌هایی را که مدیریت می‌کنید مشاهده کنید. |
https://www.googleapis.com/auth/classroom.coursework.students.readonly | کار درسی و نمرات دانش‌آموزان را در کلاس‌های Google Classroom که تدریس می‌کنید یا مدیریت می‌کنید، مشاهده کنید. |
https://www.googleapis.com/auth/classroom.courseworkmaterials | مطالب کلاس را در Google Classroom مشاهده، ویرایش و ایجاد کنید. |
https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly | همه مطالب کلاسی را برای کلاس‌های Google Classroom خود مشاهده کنید. |
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly | سرپرستان Google Classroom خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.guardianlinks.students | سرپرستان دانش‌آموزان را در کلاس‌های Google Classroom خود مشاهده و مدیریت کنید. |
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly | سرپرستان دانش‌آموزان را در کلاس‌های Google Classroom خود مشاهده کنید. |
https://www.googleapis.com/auth/classroom.profile.emails | آدرس ایمیل افراد در کلاس های خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.profile.photos | عکس های پروفایل افراد در کلاس های خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.push-notifications | اعلان‌هایی درباره داده‌های Google Classroom خود دریافت کنید. |
https://www.googleapis.com/auth/classroom.rosters | فهرست‌های کلاس Google Classroom خود را مدیریت کنید. |
https://www.googleapis.com/auth/classroom.rosters.readonly | فهرست‌های کلاس Google Classroom خود را مشاهده کنید. |
https://www.googleapis.com/auth/classroom.student-submissions.me.readonly | دروس و نمرات خود را در Google Classroom مشاهده کنید. |
https://www.googleapis.com/auth/classroom.student-submissions.students.readonly | کار درسی و نمرات دانش‌آموزان را در کلاس‌های Google Classroom که تدریس می‌کنید یا مدیریت می‌کنید، مشاهده کنید. |
https://www.googleapis.com/auth/classroom.topics | مشاهده، ایجاد و ویرایش موضوعات در Google Classroom. |
https://www.googleapis.com/auth/classroom.topics.readonly | مشاهده موضوعات در Google Classroom. |