افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به اسناد افزونه ها مراجعه کنید.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

ایجاد و مدیریت معلمان و دانش آموزان

نقش‌های دانش‌آموز و معلم در Google Classroom نشان دهنده نقش کاربر در یک دوره هستند. یک کاربر می‌تواند در یک دوره به عنوان معلم و در دوره دیگر به عنوان دانش‌آموز منصوب شود. عنوان "دانش‌آموز" یا "معلم" نشان دهنده مجموعه‌ای از مجوزها برای یک کاربر خاص در یک دوره خاص است.

دانشجویان

یک منبع Student ، کاربری را نشان می‌دهد که به عنوان دانشجو ثبت‌نام کرده است.

در یک دوره خاص. دانشجویان مجاز به مشاهده جزئیات دوره و اساتید آن دوره هستند.

معلمان

منبع Teacher کاربری را نشان می‌دهد که یک دوره خاص را تدریس می‌کند. معلمان مجاز به مشاهده و تغییر جزئیات دوره، مشاهده معلمان و دانش‌آموزان و مدیریت معلمان و دانش‌آموزان اضافی هستند. هر دوره دارای یک معلم اصلی یا مالک دوره است که معلمی است که می‌تواند تنظیماتی مانند انتقال مالکیت دوره را مدیریت کند.

دانش‌آموزان و معلمان با شناسه منحصر به فرد یا آدرس ایمیل کاربر، که توسط API دایرکتوری برگردانده می‌شود، شناسایی می‌شوند. کاربر فعلی همچنین می‌تواند با استفاده از اختصار "me" به شناسه خود اشاره کند.

مجوزهای مدیریت مستقیم با استفاده از Classroom API

مدیران، دانش‌آموزان و معلمان هنگام اضافه کردن یا حذف مستقیم کاربران از دوره‌ها با استفاده از Classroom API، مجوزهای متفاوتی دارند.

مدیران

مدیران دامنه مجاز هستند در صورت برآورده شدن شرایط زیر، جریان دعوت را دور بزنند و مستقیماً دانش‌آموزان و معلمان را به یک دوره اضافه کنند:

کاربری که اضافه می‌شود بخشی از دامنه‌ی مدیر است.
معلم اصلی دوره یا صاحب دوره، بخشی از حوزه اختیارات مدیر است.

برای کاربران یا دوره‌های خارج از دامنه‌ی یک مدیر، برنامه‌ها باید با ارسال دعوت‌نامه با متد invitations.create رضایت کاربر را دریافت کنند.

دانشجویان

دانشجویان می‌توانند با فراخوانی students.create و مشخص کردن enrollmentCode دوره، خود را به آن اضافه کنند. enrollmentCode یک شناسه منحصر به فرد برای دوره است که در منبع Course resource) گنجانده شده است. در برنامه وب Classroom، enrollmentCode در تب stream و صفحه جزئیات دوره موجود است.

معلمان

معلمان نمی‌توانند مستقیماً کاربران را به یک دوره اضافه کنند و باید از متد invitations.create برای دعوت دانش‌آموزان و سایر معلمان به دوره استفاده کنند.

جدول زیر توضیح می‌دهد که کدام کاربر مجاز به ارسال درخواست به متدهای create و delete برای منابع Teacher و Student است.

	مدیر	معلم	دانشجو
`CreateTeacher`	✔️	✖️	✖️
`DeleteTeacher`	✔️	✔️	✖️
`CreateStudent`	✔️	✖️	✔️ ^۱
`DeleteStudent`	✔️	✔️	✔️ ^۲

^۱- هر دانشجو فقط می‌تواند در یک درس شرکت کند.

^۲- دانشجو فقط می‌تواند از یک درس انصراف دهد.

مدیریت معلمان

مدیران دامنه می‌توانند مستقیماً معلمان درون دامنه خود را با استفاده از teachers.create به دوره‌ها اضافه کنند، همانطور که در نمونه زیر نشان داده شده است:

دات نت

class/snippets/ClassroomSnippets/AddTeacher.cs

مشاهده در گیت‌هاب

using Google.Apis.Auth.OAuth2;
using Google.Apis.Classroom.v1;
using Google.Apis.Classroom.v1.Data;
using Google.Apis.Services;
using System;
using System.Net;
using Google;

namespace ClassroomSnippets
{
    // Class to demonstrate the use of Classroom Create Teacher API
    public class AddTeacher
    {
       /// <summary>
       /// Add teacher to the Course
       /// </summary>
       /// <param name="courseId"></param>
       /// <param name="teacherEmail"></param>
       /// <returns></returns>
        public static Teacher ClassroomAddTeacher( string courseId,
                 string teacherEmail)
         {
             try 
             {
                 /* Load pre-authorized user credentials from the environment.
                  TODO(developer) - See https://developers.google.com/identity for 
                  guides on implementing OAuth2 for your application. */
                 GoogleCredential credential = GoogleCredential.GetApplicationDefault()
                     .CreateScoped(ClassroomService.Scope.ClassroomRosters);

                 // Create Classroom API service.
                 var service = new ClassroomService(new BaseClientService.Initializer
                 {
                     HttpClientInitializer = credential,
                     ApplicationName = "Classroom API Snippet"
                 });

                 var teacher = new Teacher
                 {
                     UserId = teacherEmail
                 };
                 // Add the teacher to the course.
                 teacher = service.Courses.Teachers.Create(teacher, courseId).Execute();
                     Console.WriteLine(
                         "User '{0}' was added as a teacher to the course with ID '{1}'.\n",
                         teacher.Profile.Name.FullName, courseId);
                     return teacher;
             }
             catch (Exception e)
             {
                 // TODO(developer) - handle error appropriately
                 if (e is AggregateException)
                 {
                     Console.WriteLine("Credential Not found");
                 }
                 else if (e is GoogleApiException)
                 {
                     Console.WriteLine("Failed to Add the teacher. Error message: {0}", e.Message);
                 }
                 else
                 {
                     throw;
                 }
             }

             return null;
         }


    }

}

جاوا

کلاس/قطعه قطعه/src/main/java/AddTeacher.java

مشاهده در گیت‌هاب

import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.classroom.Classroom;
import com.google.api.services.classroom.ClassroomScopes;
import com.google.api.services.classroom.model.Teacher;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.Arrays;

/* Class to demonstrate the use of Classroom Add Teacher API */
public class AddTeacher {

  /* Scopes required by this API call. If modifying these scopes, delete your previously saved
  tokens/ folder. */
  static ArrayList<String> SCOPES =
      new ArrayList<>(Arrays.asList(ClassroomScopes.CLASSROOM_ROSTERS));

  /**
   * Add teacher to a specific course.
   *
   * @param courseId - Id of the course.
   * @param teacherEmail - Email address of the teacher.
   * @return newly created teacher
   * @throws IOException - if credentials file not found.
   * @throws GeneralSecurityException - if a new instance of NetHttpTransport was not created.
   */
  public static Teacher addTeacher(String courseId, String teacherEmail)
      throws GeneralSecurityException, IOException {

    // Create the classroom API client.
    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
    Classroom service =
        new Classroom.Builder(
                HTTP_TRANSPORT,
                GsonFactory.getDefaultInstance(),
                ClassroomCredentials.getCredentials(HTTP_TRANSPORT, SCOPES))
            .setApplicationName("Classroom samples")
            .build();

    Teacher teacher = new Teacher().setUserId(teacherEmail);
    try {
      // Add a teacher to a specified course
      teacher = service.courses().teachers().create(courseId, teacher).execute();
      // Prints the course id with the teacher name
      System.out.printf(
          "User '%s' was added as a teacher to the course with ID '%s'.\n",
          teacher.getProfile().getName().getFullName(), courseId);
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 409) {
        System.out.printf("User '%s' is already a member of this course.\n", teacherEmail);
      } else if (error.getCode() == 403) {
        System.out.println("The caller does not have permission.\n");
      } else {
        throw e;
      }
    }
    return teacher;
  }
}

پی اچ پی

کلاس/قطعه قطعه/src/ClassroomAddTeacher.php

مشاهده در گیت‌هاب

<?php
use Google\Client;
use Google\Service\Classroom;
use Google\Service\Classroom\Teacher;
use Google\service\Exception;

function addTeacher($courseId, $teacherEmail)
{
    /* Load pre-authorized user credentials from the environment.
    TODO (developer) - See https://developers.google.com/identity for
     guides on implementing OAuth2 for your application. */
    $client = new Client();
    $client->useApplicationDefaultCredentials();
    $client->addScope("https://www.googleapis.com/auth/classroom.profile.photos");
    $service = new Classroom($client);
    $teacher = new Teacher([
        'userId' => $teacherEmail
    ]);
    try {
        //  calling create teacher
        $teacher = $service->courses_teachers->create($courseId, $teacher);
        printf("User '%s' was added as a teacher to the course with ID '%s'.\n",
            $teacher->profile->name->fullName, $courseId);
    } catch (Exception $e) {
        if ($e->getCode() == 409) {
            printf("User '%s' is already a member of this course.\n", $teacherEmail);
        } else {
            throw $e;
        }
    }
    return $teacher;
}

پایتون

کلاس/قطعه قطعه/classroom_add_teacher.py

مشاهده در گیت‌هاب

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_add_teacher(course_id):
  """
  Adds a teacher to a course with specific course_id.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member
  service = build("classroom", "v1", credentials=creds)

  teacher_email = "gduser1@workspacesamples.dev"
  teacher = {"userId": teacher_email}

  try:
    teachers = service.courses().teachers()
    teacher = teachers.create(courseId=course_id, body=teacher).execute()
    print(
        "User %s was added as a teacher to the course with ID %s"
        % (teacher.get("profile").get("name").get("fullName"), course_id)
    )
  except HttpError as error:
    print('User "{%s}" is already a member of this course.' % teacher_email)
    return error
  return teachers


if __name__ == "__main__":
  # Put the course_id of course for which Teacher needs to be added.
  classroom_add_teacher(453686957652)

اساتید همکار می‌توانند با استفاده از متد teachers.delete اساتید دیگر را از یک دوره حذف کنند. این روش فقط استاد مشخص شده را از دوره حذف می‌کند و تاثیری بر انتساب او به دوره‌های دیگر یا پروفایل کاربری‌اش ندارد.

مدیریت صاحبان دوره

مدیران دامنه می‌توانند مالکیت دوره‌ها را بین اساتید منتقل کنند. برای جزئیات مهم به بخش به‌روزرسانی مالک دوره مراجعه کنید.

مدیریت دانش‌آموزان

مدیران دامنه می‌توانند مستقیماً با استفاده از متد students.create دانشجویان را در دامنه خود اضافه کنند. اگر دانشجویی مستقیماً خود را به یک دوره اضافه می‌کند، enrollmentCode الزامی است.

دات نت

class/snippets/ClassroomSnippets/AddStudent.cs

مشاهده در گیت‌هاب

using Google.Apis.Auth.OAuth2;
using Google.Apis.Classroom.v1;
using Google.Apis.Classroom.v1.Data;
using Google.Apis.Services;
using System;
using System.Net;
using Google;

namespace ClassroomSnippets
{
    // Class to demonstrate the use of Classroom Create Student API
    public class AddStudent
    {
        public static Student ClassroomAddStudent(string courseId, string enrollmentCode)
        {
            try
            {
                /* Load pre-authorized user credentials from the environment.
                 TODO(developer) - See https://developers.google.com/identity for 
                 guides on implementing OAuth2 for your application. */
                GoogleCredential credential = GoogleCredential.GetApplicationDefault()
                    .CreateScoped(ClassroomService.Scope.ClassroomRosters);
                var service = new ClassroomService(new BaseClientService.Initializer
                {
                    HttpClientInitializer = credential,
                    ApplicationName = "Classroom API .NET Quickstart"
                });

                var student = new Student
                {
                    UserId = "me"
                };

                var request = service.Courses.Students.Create(student, courseId);
                request.EnrollmentCode = enrollmentCode;
                student = request.Execute();
                Console.WriteLine(
                    "User '{0}' was enrolled  as a student in the course with ID '{1}'.\n",
                    student.Profile.Name.FullName, courseId);
            }
            catch (Exception e)
            {
                // TODO(developer) - handle error appropriately
                if (e is AggregateException)
                {
                    Console.WriteLine("Credential Not found");
                }
                else if (e is GoogleApiException)
                {
                    Console.WriteLine("Failed to Add the Student. Error message: {0}", e.Message);
                }
                else
                {
                    throw;
                }
            }

            return null;
        }
    }

}

جاوا

کلاس/قطعه قطعه کد/src/main/java/AddStudent.java

مشاهده در گیت‌هاب

import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.classroom.Classroom;
import com.google.api.services.classroom.ClassroomScopes;
import com.google.api.services.classroom.model.Student;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.Arrays;

/* Class to demonstrate the use of Classroom Add Student API */
public class AddStudent {

  /* Scopes required by this API call. If modifying these scopes, delete your previously saved
  tokens/ folder. */
  static ArrayList<String> SCOPES =
      new ArrayList<>(Arrays.asList(ClassroomScopes.CLASSROOM_ROSTERS));

  /**
   * Add a student in a specified course.
   *
   * @param courseId - Id of the course.
   * @param enrollmentCode - Code of the course to enroll.
   * @return newly added student
   * @throws IOException - if credentials file not found.
   * @throws GeneralSecurityException - if a new instance of NetHttpTransport was not created.
   */
  public static Student addStudent(String courseId, String enrollmentCode, String studentId)
      throws GeneralSecurityException, IOException {

    // Create the classroom API client.
    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
    Classroom service =
        new Classroom.Builder(
                HTTP_TRANSPORT,
                GsonFactory.getDefaultInstance(),
                ClassroomCredentials.getCredentials(HTTP_TRANSPORT, SCOPES))
            .setApplicationName("Classroom samples")
            .build();

    Student student = new Student().setUserId(studentId);
    try {
      // Enrolling a student to a specified course
      student =
          service
              .courses()
              .students()
              .create(courseId, student)
              .setEnrollmentCode(enrollmentCode)
              .execute();
      // Prints the course id with the Student name
      System.out.printf(
          "User '%s' was enrolled as a student in the course with ID '%s'.\n",
          student.getProfile().getName().getFullName(), courseId);
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 409) {
        System.out.println("You are already a member of this course.");
      } else if (error.getCode() == 403) {
        System.out.println("The caller does not have permission.\n");
      } else {
        throw e;
      }
    }
    return student;
  }
}

پی اچ پی

کلاس/قطعه قطعه کد/src/ClassroomAddStudent.php

مشاهده در گیت‌هاب

<?php
use Google\Client;
use Google\Service\Classroom;
use Google\Service\Classroom\Student;
use Google\Service\Exception;

function enrollAsStudent($courseId,$enrollmentCode)
{
    /* Load pre-authorized user credentials from the environment.
    TODO (developer) - See https://developers.google.com/identity for
     guides on implementing OAuth2 for your application. */
    $client = new Client();
    $client->useApplicationDefaultCredentials();
    $client->addScope("https://www.googleapis.com/auth/classroom.profile.emails");
    $service = new Classroom($client);
    $student = new Student([
        'userId' => 'me'
    ]);
    $params = [
        'enrollmentCode' => $enrollmentCode
    ];
    try {
        $student = $service->courses_students->create($courseId, $student, $params);
        printf("User '%s' was enrolled  as a student in the course with ID '%s'.\n",
            $student->profile->name->fullName, $courseId);
    } catch (Exception $e) {
        if ($e->getCode() == 409) {
            print "You are already a member of this course.\n";
        } else {
            throw $e;
        }
    }
    return $student;
}

پایتون

کلاس/قطعه کد/classroom_add_student.py

مشاهده در گیت‌هاب

import os

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

SCOPES = ["https://www.googleapis.com/auth/classroom.coursework.students"]


def classroom_add_student_new(course_id):
  """
  Adds a student to a course, the teacher has access to.
  The file token.json stores the user's access and refresh tokens, and is
  created automatically when the authorization flow completes for the first
  time.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity for
   guides on implementing OAuth2 for the application.
  """

  creds = None
  # The file token.json stores the user's access and refresh tokens, and is
  # created automatically when the authorization flow completes for the first
  # time.
  if os.path.exists("token.json"):
    creds = Credentials.from_authorized_user_file("token.json", SCOPES)
  # If there are no (valid) credentials available, let the user log in.
  if not creds or not creds.valid:
    if creds and creds.expired and creds.refresh_token:
      creds.refresh(Request())
    else:
      flow = InstalledAppFlow.from_client_secrets_file(
          "credentials.json", SCOPES
      )
      creds = flow.run_local_server(port=0)
    # Save the credentials for the next run
    with open("token.json", "w", encoding="utf8") as token:
      token.write(creds.to_json())

  enrollment_code = "abc-def"
  student = {"userId": "gduser1@workspacesamples.dev"}
  try:
    service = build("classroom", "v1", credentials=creds)
    student = (
        service.courses()
        .students()
        .create(
            courseId=course_id, enrollmentCode=enrollment_code, body=student
        )
        .execute()
    )
    print(
        '''User {%s} was enrolled as a student in
                   the course with ID "{%s}"'''
        % (student.get("profile").get("name").get("fullName"), course_id)
    )
    return student
  except HttpError as error:
    print(error)
    return error


if __name__ == "__main__":
  # Put the course_id of course for which student needs to be added.
  classroom_add_student_new(478800920837)

حذف یک دانشجو از یک دوره با استفاده از متد students.delete فقط او را از دوره مشخص شده حذف می‌کند و تاثیری بر ثبت نام او در دوره‌های دیگر یا پروفایل کاربری‌اش ندارد.

بازیابی دوره‌های کاربر

برای بازیابی لیستی از دوره‌های یک دانش‌آموز یا معلم، courses.list را فراخوانی کنید و studentId یا teacherId کاربر مربوطه را وارد کنید.

شما نمی‌توانید هم studentId و teacherId در یک درخواست courses.list() تنظیم کنید. برای بازیابی لیستی از دوره‌هایی که یک معلم و دانش‌آموز خاص در آنها ثبت‌نام کرده‌اند، برای هر کاربر درخواست‌های courses.list() جداگانه ارسال کنید. سپس، محل تلاقی دو مجموعه نتیجه را پیدا کنید.

بازیابی مشخصات کاربر

برای بازیابی پروفایل یک کاربر، شامل شناسه و نام، تابع userProfiles.get را با شناسه کاربر، ایمیل یا "me" برای کاربر درخواست‌کننده فراخوانی کنید. برای بازیابی فیلد emailAddress ، باید محدوده classroom.profile.emails را وارد کنید.

id برگردانده شده مربوط به منبع کاربران API دایرکتوری است که حاوی studentId یا teacherId منطبق است.

بعدی

ایجاد و مدیریت دعوت نامه های دوره، ایجاد و مدیریت دعوت نامه های دوره

ایجاد و مدیریت معلمان و دانش آموزان با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

مجوزهای مدیریت مستقیم با استفاده از Classroom API

مدیران

دانشجویان

معلمان

مدیریت معلمان

دات نت

جاوا

پی اچ پی

پایتون

مدیریت صاحبان دوره

مدیریت دانش‌آموزان

دات نت

جاوا

پی اچ پی

پایتون

بازیابی دوره‌های کاربر

بازیابی مشخصات کاربر

ایجاد و مدیریت معلمان و دانش آموزان