কোর্স উপনাম পরিচালনা করুন

আপনি একটি কোর্স উপনাম সম্পদের সাথে একটি ভিন্ন নামে কোর্স উল্লেখ করতে পারেন। কোর্স উপনাম হল Google ক্লাসরুম কোর্স শনাক্তকারী এবং বহিরাগত কোর্স শনাক্তকারীর মধ্যে একটি ম্যাপিং।

আমরা সুপারিশ করি যে আপনি যখনই একটি SIS থেকে একটি কোর্স তৈরি করেন বা একটি কোর্সকে একটি SIS-এর সাথে লিঙ্ক করেন, SIS-এর কোর্সআইডিটি কোর্স উপনাম হিসাবে ব্যবহার করা হয়। ক্লাসরুম API আপনাকে কোর্সের id প্যারামিটারকে উপনাম হিসাবে উল্লেখ করে সরাসরি কোর্স তৈরিতে এটি করতে দেয়। যদি উপনামটি ইতিমধ্যেই বিদ্যমান থাকে তবে একটি ALREADY_EXISTS (409) ত্রুটির সাথে কোর্স তৈরি ব্যর্থ হবে৷ সিঙ্ক প্রোগ্রামে কোনো বাগ থাকলে এটি ডুপ্লিকেট কোর্স তৈরি করা প্রতিরোধ করবে।

উপনাম দুটি স্বাদে আসে: ডোমেন-ওয়াইড এবং প্রোজেক্ট-ওয়াইড।

• ডোমেন-ব্যাপী উপনামগুলি d: এর একটি উপসর্গ ব্যবহার করে এবং যে কেউ Classroom API ব্যবহার করে দেখতে পারে।
• প্রকল্প-ব্যাপী উপনামগুলি p: এর একটি উপসর্গ ব্যবহার করে এবং শুধুমাত্র সেই অ্যাপ্লিকেশন (ডেভেলপার কনসোল প্রকল্প) দ্বারা দেখা এবং ব্যবহার করা যেতে পারে যা তাদের তৈরি করেছে৷

উপনামগুলি API-এর যে কোনও জায়গায় ব্যবহার করা যেতে পারে যা একটি কোর্স শনাক্তকারীর প্রত্যাশা করে। এর মানে হল যে একবার API ব্যবহার করে একটি উপনাম নিবন্ধিত হয়, সেই উপনামটি পাঠ্যক্রম এবং রোস্টার তথ্য পড়তে এবং সংশোধন করতে ব্যবহার করা যেতে পারে।

SIS সিঙ্ক্রোনাইজেশনের দৃষ্টিকোণ থেকে, এর মানে হল যে কোনও কোর্সের জন্য SIS অভ্যন্তরীণ শনাক্তকারীকে কোর্সের জন্য ডোমেন-ওয়াইড উপনাম হিসাবে নিবন্ধিত করা যেতে পারে। এইভাবে যেকোন ডেভেলপার যারা SIS এবং Classroom উভয়ের সাথে একীভূত হয় তারা ক্লাসরুম ডেটার সাথে ইন্টারঅ্যাক্ট করার জন্য SIS আইডেন্টিফায়ার ব্যবহার করতে পারে।

উদাহরণস্বরূপ, যদি আমরা ধরে নিই যে SIS এর নামটি হল school এবং SIS দ্বারা একটি নির্দিষ্ট কোর্সের জন্য ব্যবহৃত অভ্যন্তরীণ শনাক্তকারী হল math_101 , আপনি d:school_math_101 হিসাবে একটি উপনাম তৈরি করতে পারেন।

একটি নতুন কোর্সের জন্য একটি উপনাম যোগ করুন

একটি নতুন কোর্সের জন্য একটি উপনাম যোগ করতে, courses.create() অনুরোধ করার সময় পছন্দসই উপনামে course.id সেট করুন।

অ্যাপস স্ক্রিপ্ট

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

জাভা

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;

পাইথন

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() পদ্ধতি ব্যবহার করতে পারেন।

অ্যাপস স্ক্রিপ্ট

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

জাভা

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;

পাইথন

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() পদ্ধতি ব্যবহার করে একটি কোর্সের উপনাম পুনরুদ্ধার করতে পারেন, যেমনটি নিম্নলিখিত নমুনায় দেখানো হয়েছে:

.নেট

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

জাভা

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;

পাইথন

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")