Google Classroom ऐड-ऑन अब आम तौर पर डेवलपर के लिए उपलब्ध हैं! ज़्यादा जानकारी के लिए, कृपया ऐड-ऑन दस्तावेज़ देखें.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

शिक्षकों और छात्र-छात्राओं की प्रोफ़ाइलें बनाना और उन्हें मैनेज करना
संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

Google Classroom में छात्र और शिक्षक की भूमिकाएं, किसी कोर्स में उपयोगकर्ता की भूमिका के बारे में बताती हैं. किसी उपयोगकर्ता को एक कोर्स में शिक्षक और दूसरे कोर्स में छात्र/छात्रा के तौर पर असाइन किया जा सकता है. "छात्र" या "शिक्षक" पद, किसी कोर्स में किसी उपयोगकर्ता के लिए अनुमतियों के एक सेट को दिखाता है.

छात्र/छात्राएं: Student रिसॉर्स, किसी ऐसे उपयोगकर्ता को दिखाता है जो किसी खास कोर्स में छात्र या छात्रा के तौर पर रजिस्टर है. छात्र-छात्राओं को कोर्स की जानकारी और उसमें शामिल शिक्षकों की जानकारी देखने की अनुमति होती है.
शिक्षक: Teacher रिसॉर्स, किसी खास कोर्स को पढ़ाने वाले उपयोगकर्ता के बारे में बताता है. शिक्षकों को कोर्स की जानकारी देखने और उसमें बदलाव करने की अनुमति होती है. साथ ही, वे शिक्षकों और छात्र-छात्राओं को देख सकते हैं और अतिरिक्त शिक्षकों और छात्र-छात्राओं को मैनेज कर सकते हैं. हर कोर्स का एक मुख्य शिक्षक या कोर्स का मालिक होता है. वह शिक्षक, कोर्स के मालिकाना हक के ट्रांसफ़र जैसी सेटिंग को मैनेज कर सकता है.

छात्र-छात्राओं और शिक्षकों की पहचान, उपयोगकर्ता के यूनीक आईडी या ईमेल पते से की जाती है. यह जानकारी, डायरेक्ट्री एपीआई से मिलती है. मौजूदा उपयोगकर्ता, "me" शॉर्टहैंड का इस्तेमाल करके अपने आईडी का रेफ़रंस भी दे सकता है.

Classroom API का इस्तेमाल करके, सीधे तौर पर मैनेजमेंट की अनुमतियां देना

Classroom API का इस्तेमाल करके, सीधे तौर पर कोर्स में उपयोगकर्ताओं को जोड़ने या हटाने पर, एडमिन, छात्र-छात्राओं, और शिक्षकों के पास अलग-अलग अनुमतियां होती हैं.

एडमिन

डोमेन एडमिन, न्योते के फ़्लो को बायपास करके, छात्र-छात्राओं और शिक्षकों को सीधे तौर पर किसी कोर्स में जोड़ सकते हैं. इसके लिए, ये शर्तें पूरी होनी चाहिए:

जो उपयोगकर्ता जोड़ा जा रहा है वह एडमिन के डोमेन का हिस्सा हो.
कोर्स का मुख्य शिक्षक या कोर्स का मालिक, एडमिन के डोमेन का हिस्सा हो.

एडमिन के डोमेन से बाहर के उपयोगकर्ताओं या कोर्स के लिए, ऐप्लिकेशन को invitations.create() तरीके से न्योता भेजकर, उपयोगकर्ता की सहमति लेनी होगी.

छात्र/छात्राएं

छात्र-छात्राएं किसी कोर्स में खुद को जोड़ सकते हैं. इसके लिए, उन्हें students.create() कोड डालना होगा और कोर्स का enrollmentCode बताना होगा. enrollmentCode, Course संसाधन में शामिल कोर्स का यूनीक आइडेंटिफ़ायर है. Classroom के वेब ऐप्लिकेशन में, enrollmentCode स्ट्रीम टैब और कोर्स की जानकारी वाले पेज पर उपलब्ध है.

शिक्षक

शिक्षक, उपयोगकर्ताओं को सीधे किसी कोर्स में नहीं जोड़ सकते. उन्हें छात्र-छात्राओं और दूसरे शिक्षकों को कोर्स में शामिल होने का न्योता भेजने के लिए, invitations.create() तरीके का इस्तेमाल करना होगा.

इस टेबल में बताया गया है कि Teacher और Student संसाधनों के लिए, create और delete तरीकों से अनुरोध करने की अनुमति किस उपयोगकर्ता को है.

	व्यवस्थापक	शिक्षक	छात्र/छात्रा
`CreateTeacher`	✔️	✖️	✖️
`DeleteTeacher`	✔️	✔️	✖️
`CreateStudent`	✔️	✖️	✔️ ¹
`DeleteStudent`	✔️	✔️	✔️ ²

¹ छात्र या छात्रा, सिर्फ़ खुद को कोर्स में जोड़ सकता है.

² छात्र या छात्रा, सिर्फ़ खुद को कोर्स से मिटा सकता है.

शिक्षकों को मैनेज करना

डोमेन एडमिन, अपने डोमेन में मौजूद शिक्षकों को सीधे teachers.create() की मदद से कोर्स में जोड़ सकते हैं. इसका उदाहरण यहां दिया गया है:

.NET

classroom/snippets/ClassroomSnippets/AddTeacher.cs

GitHub पर देखना

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

GitHub पर देखना

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

PHP

classroom/snippets/src/ClassroomAddTeacher.php

GitHub पर देखना

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

GitHub पर देखना

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 की ज़रूरत होती है.

.NET

classroom/snippets/ClassroomSnippets/AddStudent.cs

GitHub पर देखना

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

GitHub पर देखना

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

PHP

classroom/snippets/src/ClassroomAddStudent.php

GitHub पर देखना

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

GitHub पर देखना

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 डालें.

किसी उपयोगकर्ता की प्रोफ़ाइल वापस पाना

किसी उपयोगकर्ता की प्रोफ़ाइल, आईडी, और नाम वापस पाने के लिए, userProfiles.get() को कॉल करें. इसके लिए, अनुरोध करने वाले उपयोगकर्ता के आईडी, ईमेल पते या "मेरा" इस्तेमाल करें. emailAddress फ़ील्ड को वापस पाने के लिए, आपको classroom.profile.emails स्कोप शामिल करना होगा.

दिखाया गया id, Directory API उपयोगकर्ताओं के संसाधन से मिलता-जुलता है. इसमें studentId या teacherId शामिल होता है.

आगे बढ़ें

कोर्स के न्योते बनाना और उन्हें मैनेज करना