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

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

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

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

اضافه کردن مستقیم

مدیران دامنه مجاز به دور زدن جریان دعوت و افزودن مستقیم کاربران در دامنه خود به عنوان معلم یا دانش آموز به دوره های آموزشی در دامنه خود هستند. در صورتی که صاحب دوره در دامنه مدیریت باشد، یک دوره در دامنه ادمین در نظر گرفته می شود. برای کاربران یا دوره‌های خارج از دامنه یک مدیر دامنه تأیید شده، برنامه‌ها باید رضایت کاربر را با ارسال دعوتنامه با متد invitations.create() دریافت کنند.

معلمان را اضافه یا حذف کنید

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

classroom/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;
         
}


   
}

}
classroom/snippets/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;
 
}
}
classroom/snippets/src/ClassroomAddTeacher.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/snippets/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)

اگر معلم‌های دیگری را از طرف یک معلم تأیید شده اضافه می‌کنید، باید از متد invitations.create() استفاده کنید.

شما می توانید معلمان اضافی را از یک دوره با متد teachers.delete() حذف کنید. این فقط معلم مشخص شده را از دوره حذف می کند و بر تکلیف آنها به دوره های دیگر یا نمایه کاربری آنها تأثیری ندارد.

ثبت نام یا حذف دانش آموزان

همانطور که در نمونه زیر نشان داده شده است، مدیران دامنه می توانند مستقیماً با متد students.create() دانش آموزان را در دامنه خود اضافه کنند:

classroom/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;
       
}
   
}

}
classroom/snippets/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;
 
}
}
classroom/snippets/src/ClassroomAddStudent.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/snippets/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)

اگر از طرف یک معلم تأیید شده دانش آموزان را اضافه می کنید، باید از متد invitations.create() استفاده کنید.

می توانید با متد students.delete() یک دانش آموز را از یک دوره حذف کنید. این فقط دانش آموز مشخص شده را از دوره حذف می کند و تأثیری بر ثبت نام وی در سایر دوره ها یا پروفایل کاربری آنها ندارد.

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

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

بازیابی نمایه یک کاربر

برای بازیابی نمایه خلاصه شده، از جمله شناسه و نام، برای کاربر، با شناسه کاربر، ایمیل یا "me" برای کاربر درخواست کننده، با userProfiles.get() تماس بگیرید.

برای بازیابی فیلد emailAddress ، باید محدوده classroom.profile.emails را وارد کنید.

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

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

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