จัดการครูและนักเรียน

นักเรียนและครูคือการจับคู่ที่เฉพาะเจาะจงระหว่างโปรไฟล์ผู้ใช้และหลักสูตร ซึ่งแสดงถึงบทบาทของผู้ใช้ในหลักสูตร การกําหนดทิศทางให้กับนักเรียนและครูไม่ได้เป็นแบบทั่วโลก กล่าวคือ ผู้ใช้คนหนึ่งได้รับการมอบหมายให้เป็นครูสําหรับหลักสูตรหนึ่งและนักเรียนอีกหลักสูตรหนึ่ง การระบุสถานะเป็น "นักเรียน" หรือ "ครู" หมายถึงชุดของสิทธิ์สําหรับผู้ใช้คนใดคนหนึ่งในหลักสูตรหนึ่ง

นักเรียน/นักศึกษา
แหล่งข้อมูลสําหรับนักเรียนคือผู้ใช้ที่ลงทะเบียนเป็นนักเรียน/นักศึกษาในหลักสูตรที่เฉพาะเจาะจง นักเรียนดูรายละเอียดของหลักสูตรและครูของหลักสูตรนั้นได้
ครู
แหล่งข้อมูลของครูแสดงถึงผู้ใช้ที่สอนหลักสูตรเฉพาะ ครูได้รับอนุญาตให้ดูและเปลี่ยนรายละเอียดหลักสูตร ดูครูและนักเรียน รวมทั้งจัดการครูและนักเรียนเพิ่มเติม

ระบบจะระบุนักเรียนและครูด้วยรหัสที่ไม่ซ้ํากันหรืออีเมลของผู้ใช้ตามที่ Google Admin SDK แสดงผล ผู้ใช้ปัจจุบันอาจอ้างอิงรหัสของตนเองได้โดยใช้วิดีโอสั้นของ "me"

การเพิ่มโดยตรง

ผู้ดูแลระบบโดเมนสามารถข้ามขั้นตอนการเชิญและเพิ่มผู้ใช้ภายในโดเมนได้โดยตรงในฐานะครูหรือนักเรียนไปยังหลักสูตรภายในโดเมนของตน ระบบจะถือว่าหลักสูตรอยู่ในโดเมนของผู้ดูแลระบบหากเจ้าของหลักสูตรอยู่ในโดเมนของผู้ดูแลระบบ สําหรับผู้ใช้หรือหลักสูตรนอกโดเมนของผู้ดูแลระบบโดเมนที่ผ่านการตรวจสอบสิทธิ์ แอปพลิเคชันต้องได้รับความยินยอมจากผู้ใช้ด้วยการส่งคําเชิญด้วยเมธอด invitations.create()

เพิ่มหรือนําครูออก

ผู้ดูแลระบบโดเมนจะเพิ่มครูภายในโดเมนไปยังหลักสูตรได้โดยตรงโดยใช้ teachers.create() ดังที่แสดงในตัวอย่างต่อไปนี้

.NET

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


    }

}

Java

Classroom/snippets/src/main/java/AddTeacher.java
import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
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 com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Collections;

/* Class to demonstrate the use of Classroom Add Teacher API */
public class AddTeacher {
  /**
   * 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.
   */
  public static Teacher addTeacher(String courseId, String teacherEmail)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Collections.singleton(ClassroomScopes.CLASSROOM_ROSTERS));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the classroom API client
    Classroom service = new Classroom.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .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;
  }
}

PHP

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

Python

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() ดังที่แสดงในตัวอย่างต่อไปนี้

.NET

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

}

Java

Classroom/snippets/src/main/java/AddStudent.java
import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
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 com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Collections;

/* Class to demonstrate the use of Classroom Add Student API */
public class AddStudent {
  /**
   * 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.
   */
  public static Student addStudent(String courseId, String enrollmentCode)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Collections.singleton(ClassroomScopes.CLASSROOM_ROSTERS));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the classroom API client
    Classroom service = new Classroom.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Classroom samples")
        .build();

    Student student = new Student().setUserId("gduser1@workspacesamples.dev");
    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;
  }
}

PHP

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

Python

Classroom/snippets/classroom_add_student.py
from __future__ import print_function

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 ของผู้ใช้รายนั้นๆ

เรียกข้อมูลโปรไฟล์ของผู้ใช้

หากต้องการเรียกข้อมูลโปรไฟล์ฉบับย่อ รวมถึงรหัสและชื่อของผู้ใช้ ให้เรียกใช้ userProfiles.get() ด้วยรหัส อีเมล หรือ "ฉัน" ของผู้ใช้ที่ต้องการ

หากต้องการเรียกข้อมูลช่อง emailAddress คุณต้องใส่ขอบเขต classroom.profile.emails

รหัสที่แสดงผลจะสอดคล้องกับทรัพยากรผู้ใช้ Directory API ที่มี studentId หรือ teacherId ที่ตรงกัน

โอนการเป็นเจ้าของหลักสูตร

ผู้ดูแลระบบโดเมนจะโอนการเป็นเจ้าของหลักสูตรระหว่างครูภายในโดเมนได้ โดยเรียกใช้วิธีต่อไปนี้

  1. ขั้นแรก ให้โทรหา teachers.create() เพื่อเพิ่มครูเข้ากับหลักสูตร หากยังไม่ได้เป็นครูร่วมสอน

  2. จากนั้นเรียก courses.patch() และระบุอีเมลครูร่วมสอนหรือรหัสผู้ใช้ในช่อง ownerId ของออบเจ็กต์คําขอเพื่ออัปเดตเจ้าของหลักสูตร