कोर्स के दूसरे नाम मैनेज करना

कोर्स के उपनाम का इस्तेमाल करके, कोर्स को किसी दूसरे नाम से रेफ़र किया जा सकता है. कोर्स के दूसरे नाम, Google Classroom के कोर्स आइडेंटिफ़ायर और बाहरी कोर्स आइडेंटिफ़ायर के बीच मैपिंग के तौर पर काम कर सकते हैं. उदाहरण के लिए, छात्र-छात्राओं की जानकारी का रिकॉर्ड रखने वाले सिस्टम (एसआईएस) के कोर्स आईडी से मैच करने के लिए, कोर्स का कोई दूसरा नाम सेट किया जा सकता है.

कोर्स के उपनाम के दो फ़ॉर्म होते हैं: डोमेन-वाइड और प्रोजेक्ट-वाइड.

• डोमेन के लिए इस्तेमाल होने वाले उपनाम, d: प्रीफ़िक्स का इस्तेमाल करते हैं. इन्हें Classroom API का इस्तेमाल करने वाला कोई भी व्यक्ति देख सकता है. डोमेन नेमस्पेस, ऐसे उपनाम बनाने के लिए मददगार होता है जिनका ऐक्सेस सभी उपयोगकर्ताओं को चाहिए, लेकिन जो किसी एक प्रोग्राम के लिए खास नहीं होते. उदाहरण के लिए, किसी कोर्स के लिए वैकल्पिक लिस्टिंग, जैसे कि MATH 127 और COMSCI 127, डोमेन नेमस्पेस में बनाई जानी चाहिए. डोमेन नेमस्पेस में उपनाम सिर्फ़ डोमेन एडमिन बना सकते हैं. हालांकि, ये उपनाम डोमेन के सभी उपयोगकर्ताओं को दिखते हैं.

• पूरे प्रोजेक्ट के लिए उपनाम, p: के प्रीफ़िक्स का इस्तेमाल करते हैं. इन्हें सिर्फ़ वह Google Cloud प्रोजेक्ट देख सकता है और इस्तेमाल कर सकता है जिसने इन्हें बनाया है. डेवलपर प्रोजेक्ट नेमस्पेस, किसी ऐप्लिकेशन के लिए खासतौर पर अलीएस मैनेज करने के लिए मददगार होता है. उदाहरण के लिए, कोई ऐसा ऐप्लिकेशन जो कोर्स के लिए अन्य आइडेंटिफ़ायर का इस्तेमाल करता है, अपने आइडेंटिफ़ायर को Classroom के कोर्स से मैप करने के लिए, दूसरे नाम बना सकता है. इस नेमस्पेस में बनाए गए किसी भी उपनाम को किसी खास Google Cloud प्रोजेक्ट से जोड़ा जा सकता है. किसी ऐप्लिकेशन का कोई भी उपयोगकर्ता, उस ऐप्लिकेशन के डेवलपर प्रोजेक्ट के नेमस्पेस में उपनाम बना सकता है और उन्हें देख सकता है.

Classroom API के किसी भी एंडपॉइंट के लिए, Classroom क्लास के आईडी के बजाय क्लास के उपनाम का इस्तेमाल किया जा सकता है. इसका मतलब है कि कोर्स और रोस्टर की जानकारी को पढ़ने और उनमें बदलाव करने के लिए, उपनाम का इस्तेमाल किया जा सकता है.

छात्र-छात्राओं की जानकारी का रिकॉर्ड रखने वाले सिस्टम के साथ सिंक करने के लिए, किसी दूसरे नाम का इस्तेमाल करना

किसी कोर्स के लिए, एसआईएस का इंटरनल आइडेंटिफ़ायर, डोमेन के लिए अन्य डोमेन नेम के तौर पर रजिस्टर किया जा सकता है. इस तरह, एसआईएस और Classroom, दोनों के साथ इंटिग्रेट करने वाला कोई भी डेवलपर, Classroom के डेटा के साथ इंटरैक्ट करने के लिए एसआईएस आइडेंटिफ़ायर का इस्तेमाल कर सकता है.

अगर किसी एसआईएस से कोर्स बनाया जाता है या किसी कोर्स को एसआईएस से लिंक किया जाता है, तो हमारा सुझाव है कि एसआईएस के कोर्स आईडी का इस्तेमाल कोर्स के उपनाम के तौर पर किया जाए. courses.create() तरीके का इस्तेमाल करके कोर्स बनाते समय, अनुरोध के id फ़ील्ड में उपनाम डाला जा सकता है. अगर उपनाम पहले से मौजूद है, तो कोर्स बनाने की प्रोसेस पूरी नहीं हो पाती और 409 ALREADY_EXISTS गड़बड़ी का मैसेज दिखता है. इससे, सिंक प्रोग्राम में कोई समस्या होने पर, डुप्लीकेट कोर्स बनने से रोका जा सकता है.

उदाहरण के लिए, मान लें कि एसआईएस का नाम school है और किसी खास कोर्स के लिए एसआईएस का इस्तेमाल किया जाने वाला इंटरनल आइडेंटिफ़ायर math_101 है. ऐसे में, d:school_math_101 के तौर पर कोई दूसरा नाम बनाया जा सकता है.

नए कोर्स के लिए कोई उपनाम जोड़ना

किसी नए कोर्स के लिए कोई दूसरा नाम जोड़ने के लिए, courses.create() अनुरोध करते समय course.id को किसी दूसरे नाम पर सेट करें.

Apps Script

classroom/snippets/createAlias.gs

GitHub पर देखना

/**
 * Creates Course with an alias specified
 */
function createAlias() {
  let course = {
    id: 'p:bio_101',
    name: '10th Grade Biology',
    section: 'Period 2',
    descriptionHeading: 'Welcome to 10th Grade Biology',
    description: 'We\'ll be learning about the structure of living creatures from a combination ' +
      'of textbooks, guest lectures, and lab work. Expect to be excited!',
    room: '301',
    ownerId: 'me',
    courseState: 'PROVISIONED'
  };
  try {
    // Create the course using course details.
    course = Classroom.Courses.create(course);
    console.log('Course created: %s (%s)', course.name, course.id);
  } catch (err) {
    // TODO (developer) - Handle Courses.create() exception
    console.log('Failed to create course %s with an error %s', course.name, err.message);
  }
}

Java

classroom/snippets/src/main/java/CreateCourseWithAlias.java

GitHub पर देखना

Course course = null;

/* Create a new Course with the alias set as the id field. Project-wide aliases use a prefix
of "p:" and can only be seen and used by the application that created them. */
Course content =
    new Course()
        .setId("p:history_4_2022")
        .setName("9th Grade History")
        .setSection("Period 4")
        .setDescriptionHeading("Welcome to 9th Grade History.")
        .setOwnerId("me")
        .setCourseState("PROVISIONED");

try {
  course = service.courses().create(content).execute();
  // Prints the new created course id and name
  System.out.printf("Course created: %s (%s)\n", course.getName(), course.getId());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 409) {
    System.out.printf("The course alias already exists: %s.\n", content.getId());
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return course;

Python

classroom/snippets/classroom_add_alias_new.py

GitHub पर देखना

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


def classroom_add_alias_new():
  """
  Creates a course with alias specification the user 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.
  """
  # pylint: disable=maybe-no-member
  creds = None
  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())

  alias = "d:school_physics_333"
  course = {
      "id": alias,
      "name": "English",
      "section": "Period 2",
      "description": "Course Description",
      "room": "301",
      "ownerId": "me",
  }
  try:
    print("-------------")
    service = build("classroom", "v1", credentials=creds)
    course = service.courses().create(body=course).execute()
    print("====================================")

  except HttpError as error:
    print(f"An error occurred: {error}")
  return course


if __name__ == "__main__":
  # pylint: disable=too-many-arguments
  # Put the course_id of course whose alias needs to be created.
  classroom_add_alias_new()

किसी मौजूदा कोर्स के लिए कोई दूसरा नाम जोड़ना

किसी मौजूदा कोर्स में दूसरा नाम जोड़ने के लिए, alias फ़ील्ड को सेट करें और courses.aliases.create() तरीके का इस्तेमाल करें.

Apps Script

classroom/snippets/addAlias.gs

GitHub पर देखना

/**
 * Updates the section and room of Google Classroom.
 * @param {string} course_id
 * @see https://developers.google.com/classroom/reference/rest/v1/courses.aliases/create
 */
function addAlias(course_id) {
  const alias = {
    'alias': 'p:bio_101'
  };
  try {
    const course_alias = Classroom.Courses.Aliases.create(resource=alias, courseId=course_id);
    console.log('%s successfully added as an alias!', course_alias.alias);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Request to add alias %s failed with error %s.', alias.alias, err.message);
  }
}

Java

classroom/snippets/src/main/java/AddAliasToCourse.java

GitHub पर देखना

/* Create a new CourseAlias object with a project-wide alias. Project-wide aliases use a prefix
of "p:" and can only be seen and used by the application that created them. */
CourseAlias content = new CourseAlias().setAlias("p:biology_10");
CourseAlias courseAlias = null;

try {
  courseAlias = service.courses().aliases().create(courseId, content).execute();
  System.out.printf("Course alias created: %s \n", courseAlias.getAlias());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 409) {
    System.out.printf("The course alias already exists: %s.\n", content);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return courseAlias;

Python

classroom/snippets/classroom_add_alias_existing.py

GitHub पर देखना

def classroom_add_alias_existing(course_id):
  """
  Adds alias to existing 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)
  alias = "d:school_math_101"
  course_alias = {"alias": alias}
  try:
    course_alias = (
        service.courses()
        .aliases()
        .create(courseId=course_id, body=course_alias)
        .execute()
    )
    return course_alias
  except HttpError as error:
    print(f"An error occurred: {error}")
    print("Alias Creation Failed")
  return course_alias


if __name__ == "__main__":
  # Put the course_id of course whose alias needs to be added.
  classroom_add_alias_existing(456058313539)

कोर्स के उपनाम वापस पाना

किसी कोर्स के लिए, courses.aliases.list() तरीके का इस्तेमाल करके, दूसरे नामों को वापस पाया जा सकता है. इस बारे में यहां दिए गए सैंपल में बताया गया है:

.NET

classroom/snippets/ClassroomSnippets/ListCourseAliases.cs

GitHub पर देखना

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

namespace ClassroomSnippets
{
    // Class to demonstrate the use of Classroom List Alias API
    public class ListCourseAliases
    {
        /// <summary>
        /// Retrieve the aliases for a course.
        /// </summary>
        /// <param name="courseId">Id of the course.</param>
        /// <returns>list of course aliases, null otherwise.</returns>
        public static List<CourseAlias> ClassroomListAliases(string courseId)
        {
            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.ClassroomCourses);

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

                string pageToken = null;
                var courseAliases = new List<CourseAlias>();

                do
                {
                    // List of aliases of specified course
                    var request = service.Courses.Aliases.List(courseId);
                    request.PageSize = 100;
                    request.PageToken = pageToken;
                    var response = request.Execute();
                    courseAliases.AddRange(response.Aliases);
                    pageToken = response.NextPageToken;
                } while (pageToken != null);

                if (courseAliases.Count == 0)
                {
                    Console.WriteLine("No aliases found.");
                }
                else
                {
                    Console.WriteLine("Aliases:");
                    foreach (var courseAlias in courseAliases)
                    {
                        Console.WriteLine(courseAlias.Alias);
                    }
                }
                return courseAliases;
            }
            catch (Exception e)
            {
                // TODO(developer) - handle error appropriately
                if (e is AggregateException)
                {
                    Console.WriteLine("Credential Not found");
                }
                else if (e is GoogleApiException)
                {
                    Console.WriteLine("Course does not exist.");
                }

                else
                {
                    throw;
                }
            }
            return null;
        }
    }
}

Java

classroom/snippets/src/main/java/ListCourseAliases.java

GitHub पर देखना

String pageToken = null;
List<CourseAlias> courseAliases = new ArrayList<>();

try {
  // List of aliases of specified course
  do {
    ListCourseAliasesResponse response =
        service
            .courses()
            .aliases()
            .list(courseId)
            .setPageSize(100)
            .setPageToken(pageToken)
            .execute();
    courseAliases.addAll(response.getAliases());
    pageToken = response.getNextPageToken();
  } while (pageToken != null);

  if (courseAliases.isEmpty()) {
    System.out.println("No aliases found.");
  } else {
    System.out.println("Aliases:");
    for (CourseAlias courseAlias : courseAliases) {
      System.out.println(courseAlias.getAlias());
    }
  }
} catch (GoogleJsonResponseException e) {
  // TODO(developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.err.println("Course does not exist.\n");
  } else {
    throw e;
  }
}
return courseAliases;

Python

classroom/snippets/classroom_list_course_aliases.py

GitHub पर देखना

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


def classroom_list_course_aliases(course_id):
  """
  Prints the list of the aliases of a specified course the user has access to.
  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()
  try:
    service = build("classroom", "v1", credentials=creds)
    course_aliases = []
    page_token = None

    while True:
      response = (
          service.courses()
          .aliases()
          .list(pageToken=page_token, courseId=course_id)
          .execute()
      )
      course_aliases.extend(response.get("aliases", []))
      page_token = response.get("nextPageToken", None)
      if not page_token:
        break

    if not course_aliases:
      print("No course aliases found.")

    print("Course aliases:")
    for course_alias in course_aliases:
      print(f"{course_alias.get('alias')}")
    return course_aliases
  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  classroom_list_course_aliases("course_id")