Ödevleri yönetme

Classroom uygulaması üç tür yayın öğesini destekler: CourseWork, CourseWorkMaterials ve Announcements. Bu kılavuzda CourseWork öğesinin nasıl yönetileceği açıklanmaktadır ancak tüm akış öğelerinin API'leri benzerdir. Akış öğesi türleri ve aralarındaki farklar hakkında daha fazla bilgi edinmek için API kaynaklarına göz atın.

CourseWork kaynağı, belirli bir kurstaki öğrencilere atanan bir çalışma öğesini (son tarih veya maksimum puan gibi ek materyaller ve ayrıntılar dahil) temsil eder. CourseWork'nin dört alt türü vardır: Ödevler, test ödevleri, kısa yanıtlı sorular ve çoktan seçmeli sorular. Classroom API, bu alt türlerden üçünü destekler: ödevler, kısa yanıtlı sorular ve çoktan seçmeli sorular. Bu türler CourseWork.workType alanıyla temsil edilir.

CourseWork kaynağına ek olarak, tamamlanan çalışmaları StudentSubmission kaynağıyla da yönetebilirsiniz.

Ödev oluşturma

CourseWork, yalnızca kursun öğretmeni adına oluşturulabilir. Bir öğrenci veya kursta öğretmen olmayan bir alan yöneticisi adına CourseWork oluşturmaya çalışmak PERMISSION_DENIED hatasına neden olur. Classroom'daki farklı roller hakkında daha fazla bilgi edinmek için Kullanıcı türleri başlıklı makaleyi inceleyin.

courses.courseWork.create yöntemini kullanarak CourseWork oluştururken bağlantıları materials olarak ekleyebilirsiniz. Aşağıdaki örnek kodda bu işlem gösterilmektedir:

Java

classroom/snippets/src/main/java/CreateCourseWork.java
CourseWork courseWork = null;
try {
  // Create a link to add as a material on course work.
  Link articleLink =
      new Link()
          .setTitle("SR-71 Blackbird")
          .setUrl("https://www.lockheedmartin.com/en-us/news/features/history/blackbird.html");

  // Create a list of Materials to add to course work.
  List<Material> materials = Arrays.asList(new Material().setLink(articleLink));

  /* Create new CourseWork object with the material attached.
  Set workType to `ASSIGNMENT`. Possible values of workType can be found here:
  https://developers.google.com/classroom/reference/rest/v1/CourseWorkType
  Set state to `PUBLISHED`. Possible values of state can be found here:
  https://developers.google.com/classroom/reference/rest/v1/courses.courseWork#courseworkstate */
  CourseWork content =
      new CourseWork()
          .setTitle("Supersonic aviation")
          .setDescription(
              "Read about how the SR-71 Blackbird, the world’s fastest and "
                  + "highest-flying manned aircraft, was built.")
          .setMaterials(materials)
          .setWorkType("ASSIGNMENT")
          .setState("PUBLISHED");

  courseWork = service.courses().courseWork().create(courseId, content).execute();

  /* Prints the created courseWork. */
  System.out.printf("CourseWork created: %s\n", courseWork.getTitle());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The courseId does not exist: %s.\n", courseId);
  } else {
    throw e;
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return courseWork;

Python

classroom/snippets/classroom_create_coursework.py
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_create_coursework(course_id):
  """
  Creates the coursework 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()
  # pylint: disable=maybe-no-member

  try:
    service = build("classroom", "v1", credentials=creds)
    coursework = {
        "title": "Ant colonies",
        "description": """Read the article about ant colonies
                              and complete the quiz.""",
        "materials": [
            {"link": {"url": "http://example.com/ant-colonies"}},
            {"link": {"url": "http://example.com/ant-quiz"}},
        ],
        "workType": "ASSIGNMENT",
        "state": "PUBLISHED",
    }
    coursework = (
        service.courses()
        .courseWork()
        .create(courseId=course_id, body=coursework)
        .execute()
    )
    print(f"Assignment created with ID {coursework.get('id')}")
    return coursework

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


if __name__ == "__main__":
  # Put the course_id of course whose coursework needs to be created,
  # the user has access to.
  classroom_create_coursework(453686957652)

title ve workType alanları zorunludur. Diğer tüm alanlar isteğe bağlıdır. state belirtilmezse CourseWork taslak durumunda oluşturulur.

Bağlı materyalleri CourseWork'a dahil etmek için belirtilen bir hedef url ile Kaynak bağla öğesini kullanın. Classroom, title ve küçük resim URL'sini (thumbnailUrl) otomatik olarak getirir. Classroom API, Google Drive ve YouTube materyallerini de doğal olarak destekler. Bu materyaller, benzer şekilde bir DriveFile kaynağı veya YouTubeVideo kaynağı ile dahil edilebilir.

Teslim tarihini belirtmek için dueDate ve dueTime alanlarını ilgili UTC saatine ayarlayın. Son tarih gelecekte olmalıdır.

CourseWork yanıtı, diğer API isteklerinde atamaya referans vermek için kullanılabilecek, sunucuya atanan bir tanımlayıcı içerir.

CourseWork'u alma

İlgili dersin öğrencileri ve öğretmenleri adına CourseWork değerini alabilirsiniz. Ayrıca, kursta öğretmen olmasalar bile alan yöneticileri adına CourseWork alabilirsiniz. Belirli bir CourseWork almak için courses.courseWork.get kullanın. Tüm CourseWork öğelerini (isteğe bağlı olarak bazı ölçütlerle eşleşen) almak için courses.courseWork.list öğesini kullanın.

Gerekli kapsam, istek gönderen kullanıcının kurstaki rolüne bağlıdır. Kullanıcı öğrenciyse aşağıdaki kapsamlardan birini kullanın:

  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me

Kullanıcı bir öğretmen veya alan yöneticisiyse aşağıdaki kapsamlardan birini kullanın:

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students

CourseWork almak için izin sahibi olmak, materyallere veya materyal meta verilerine erişim izni olduğu anlamına gelmez. Bu durum, derse üye olmayan yöneticilerin ekteki Drive dosyasının başlığını göremeyeceği anlamına gelir.

Öğrenci yanıtlarını yönetme

StudentSubmission kaynağı, bir öğrenci tarafından CourseWork için yapılan çalışmaları temsil eder. Kaynak, çalışma durumu ve not gibi çalışmayla ilgili meta verileri içerir. Yeni bir CourseWork oluşturulduğunda her öğrenci için StudentSubmission gizli olarak oluşturulur.

Aşağıdaki bölümlerde, öğrenci yanıtlarını yöneten yaygın işlemler açıklanmaktadır.

Öğrenci yanıtlarını alma

Öğrenciler kendi gönderimlerini, öğretmenler kurslarındaki tüm öğrencilerin gönderimlerini, alan yöneticileri ise alanlarındaki tüm öğrencilerin gönderimlerini alabilir. Her StudentSubmission için bir tanımlayıcı atanır. Tanımlayıcıyı biliyorsanız gönderimi almak için courses.courseWork.studentSubmissions.get kullanın.

Aşağıdaki örnekte gösterildiği gibi, bazı ölçütlere uyan tüm StudentSubmission kaynaklarını almak için courses.courseWork.studentSubmissions.list yöntemini kullanın:

Java

classroom/snippets/src/main/java/ListSubmissions.java
List<StudentSubmission> studentSubmissions = new ArrayList<>();
String pageToken = null;

try {
  do {
    ListStudentSubmissionsResponse response =
        service
            .courses()
            .courseWork()
            .studentSubmissions()
            .list(courseId, courseWorkId)
            .setPageToken(pageToken)
            .execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getStudentSubmissions() != null) {
      studentSubmissions.addAll(response.getStudentSubmissions());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (studentSubmissions.isEmpty()) {
    System.out.println("No student submission found.");
  } else {
    for (StudentSubmission submission : studentSubmissions) {
      System.out.printf(
          "Student id (%s), student submission id (%s)\n",
          submission.getUserId(), submission.getId());
    }
  }
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf(
        "The courseId (%s) or courseWorkId (%s) does not exist.\n", courseId, courseWorkId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return studentSubmissions;

Python

classroom/snippets/classroom_list_submissions.py
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_list_submissions(course_id, coursework_id):
  """
  Creates the courses 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()
  # pylint: disable=maybe-no-member
  submissions = []
  page_token = None

  try:
    service = build("classroom", "v1", credentials=creds)
    while True:
      coursework = service.courses().courseWork()
      response = (
          coursework.studentSubmissions()
          .list(
              pageToken=page_token,
              courseId=course_id,
              courseWorkId=coursework_id,
              pageSize=10,
          )
          .execute()
      )
      submissions.extend(response.get("studentSubmissions", []))
      page_token = response.get("nextPageToken", None)
      if not page_token:
        break

    if not submissions:
      print("No student submissions found.")

    print("Student Submissions:")
    for submission in submissions:
      print(
          "Submitted at:"
          f"{(submission.get('id'), submission.get('creationTime'))}"
      )

  except HttpError as error:
    print(f"An error occurred: {error}")
    submissions = None
  return submissions


if __name__ == "__main__":
  # Put the course_id and coursework_id of course whose list needs to be
  # submitted.
  classroom_list_submissions(453686957652, 466086979658)

Aşağıdaki örnekte gösterildiği gibi userId parametresini belirterek belirli bir öğrenciye ait StudentSubmission kaynaklarını alın:

Java

classroom/snippets/src/main/java/ListStudentSubmissions.java
List<StudentSubmission> studentSubmissions = new ArrayList<>();
String pageToken = null;

try {
  do {
    // Set the userId as a query parameter on the request.
    ListStudentSubmissionsResponse response =
        service
            .courses()
            .courseWork()
            .studentSubmissions()
            .list(courseId, courseWorkId)
            .setPageToken(pageToken)
            .set("userId", userId)
            .execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getStudentSubmissions() != null) {
      studentSubmissions.addAll(response.getStudentSubmissions());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (studentSubmissions.isEmpty()) {
    System.out.println("No student submission found.");
  } else {
    for (StudentSubmission submission : studentSubmissions) {
      System.out.printf("Student submission: %s.\n", submission.getId());
    }
  }

Python

classroom/snippets/classroom_list_student_submissions.py
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_list_student_submissions(course_id, coursework_id, user_id):
  """
  Creates the courses 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()
  # pylint: disable=maybe-no-member
  submissions = []
  page_token = None

  try:
    service = build("classroom", "v1", credentials=creds)
    while True:
      coursework = service.courses().courseWork()
      response = (
          coursework.studentSubmissions()
          .list(
              pageToken=page_token,
              courseId=course_id,
              courseWorkId=coursework_id,
              userId=user_id,
          )
          .execute()
      )
      submissions.extend(response.get("studentSubmissions", []))
      page_token = response.get("nextPageToken", None)
      if not page_token:
        break

    if not submissions:
      print("No student submissions found.")

    print("Student Submissions:")
    for submission in submissions:
      print(
          "Submitted at:"
          f"{(submission.get('id'), submission.get('creationTime'))}"
      )

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


if __name__ == "__main__":
  # Put the course_id, coursework_id and user_id of course whose list needs
  # to be submitted.
  classroom_list_student_submissions(453686957652, 466086979658, "me")

Öğrenciler, Student kaynağında gösterildiği gibi benzersiz kimlik veya e-posta adresiyle tanımlanır. Mevcut kullanıcı, "me" kısaltmasını kullanarak kendi kimliğine de atıfta bulunabilir.

Bir kurstaki tüm ödevler için öğrenci gönderimlerini de alabilirsiniz. Bunu yapmak için aşağıdaki örnekte gösterildiği gibi courseWorkId olarak "-" değişmez değerini kullanın:

Java

service.courses().courseWork().studentSubmissions()
    .list(courseId, "-")
    .set("userId", userId)
    .execute();

Python

service.courses().courseWork().studentSubmissions().list(
    courseId=<course ID or alias>,
    courseWorkId='-',
    userId=<user ID>).execute()

Gerekli kapsam, istek yapan kullanıcının kurstaki rolüne bağlıdır. Kullanıcı bir öğretmen veya alan yöneticisiyse aşağıdaki kapsamı kullanın:

  • https://www.googleapis.com/auth/classroom.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students

Kullanıcı öğrenciyse aşağıdaki kapsamı kullanın:

  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me

StudentSubmission alma izniniz olması, eklerine veya ek meta verilerine erişim izniniz olduğu anlamına gelmez. Bu durum, derse üye olmayan yöneticilerin ekteki Drive dosyasının başlığını göremeyeceği anlamına gelir.

Öğrenci yanıtlarına ek ekleme

Link, DriveFile veya YouTubeVideo kaynağı ekleyerek öğrenci gönderimlerine bağlantı ekleyebilirsiniz. Bu işlem, aşağıdaki örnekte gösterildiği gibi courses.courseWork.studentSubmissions.modifyAttachments ile yapılır:

Java

classroom/snippets/src/main/java/ModifyAttachmentsStudentSubmission.java
StudentSubmission studentSubmission = null;
try {
  // Create ModifyAttachmentRequest object that includes a new attachment with a link.
  Link link = new Link().setUrl("https://en.wikipedia.org/wiki/Irrational_number");
  Attachment attachment = new Attachment().setLink(link);
  ModifyAttachmentsRequest modifyAttachmentsRequest =
      new ModifyAttachmentsRequest().setAddAttachments(Arrays.asList(attachment));

  // The modified studentSubmission object is returned with the new attachment added to it.
  studentSubmission =
      service
          .courses()
          .courseWork()
          .studentSubmissions()
          .modifyAttachments(courseId, courseWorkId, id, modifyAttachmentsRequest)
          .execute();

  /* Prints the modified student submission. */
  System.out.printf(
      "Modified student submission attachments: '%s'.\n",
      studentSubmission.getAssignmentSubmission().getAttachments());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf(
        "The courseId (%s), courseWorkId (%s), or studentSubmissionId (%s) does "
            + "not exist.\n",
        courseId, courseWorkId, id);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return studentSubmission;

Python

classroom/snippets/classroom_add_attachment.py
def classroom_add_attachment(course_id, coursework_id, submission_id):
  """
  Adds attachment 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
  request = {
      "addAttachments": [
          {"link": {"url": "http://example.com/quiz-results"}},
          {"link": {"url": "http://example.com/quiz-reading"}},
      ]
  }

  try:
    service = build("classroom", "v1", credentials=creds)
    while True:
      coursework = service.courses().courseWork()
      coursework.studentSubmissions().modifyAttachments(
          courseId=course_id,
          courseWorkId=coursework_id,
          id=submission_id,
          body=request,
      ).execute()

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


if __name__ == "__main__":
  # Put the course_id, coursework_id and submission_id of course in which
  # attachment needs to be added.
  classroom_add_attachment("course_id", "coursework_id", "me")

Link eki, hedef url tarafından tanımlanır; Classroom, title ve küçük resim (thumbnailUrl) dosyalarını otomatik olarak getirir. StudentSubmissions'a eklenebilecek materyaller hakkında bilgi edinmek için Material bölümüne bakın.

StudentSubmission yalnızca kurs öğretmeni veya sahibi olan öğrenci tarafından değiştirilebilir. Yalnızca StudentSubmission öğesinin CourseWorkType değeri ASSIGNMENT ise Materials öğesini ekleyebilirsiniz.

Gerekli kapsam, istek yapan kullanıcının kurstaki rolüne bağlıdır. Kullanıcı bir öğretmense aşağıdaki kapsamı kullanın:

  • https://www.googleapis.com/auth/classroom.coursework.students

Kullanıcı öğrenciyse aşağıdaki kapsamı kullanın:

  • https://www.googleapis.com/auth/classroom.coursework.me