Используют ли ваши пользователи Класс с Google Meet? Ознакомьтесь с кратким руководством по скрипту приложений, в котором рассказывается, как проверить посещаемость учащихся на курсах Google Meet .

Управление классной работой

В Классе есть пять типов Занятий: Задания, Тестовые задания, Вопросы (краткий ответ и множественный выбор) и Материалы. API Classroom в настоящее время позволяет разработчикам читать и писать три из этих типов: Задания, Вопросы и Материалы.

Чтобы получить доступ к этой функции, вы можете использовать ресурс CourseWork , который представляет собой задание или вопрос, назначенные учащимся определенного курса, включая любые дополнительные материалы и сведения, такие как срок выполнения или максимальный балл.

В дополнение к ресурсу CourseWork вы можете управлять выполненными заданиями с помощью ресурса StudentSubmission . В следующих разделах они описаны более подробно.

Создание заданий

Задания могут быть созданы только от имени преподавателя (преподавателей) курса, и попытка создать задания в курсе от имени учащегося приведет к ошибке 403 PERMISSION_DENIED . Аналогично, администраторы домена также не могут создавать задания для курсов, которые они не преподают, и попытка сделать это через API также приведет к ошибке 403 PERMISSION_DENIED .

При создании заданий вы можете прикреплять ссылки в качестве materials , как показано в примере кода ниже:

питон

класс/фрагменты/classroom_create_coursework.py
from __future__ import print_function

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)

Результат включает назначенный сервером идентификатор, который можно использовать для ссылки на назначение в других запросах API.

Чтобы включить связанные материалы в задание, созданное с помощью Classroom API, используйте ресурс Link , указав целевой URL. Класс автоматически извлекает название и миниатюру. Classroom API также изначально поддерживает материалы с Диска и YouTube, которые можно аналогичным образом включать в ресурсы DriveFile или YouTubeVideo .

Чтобы указать дату выполнения, задайте в полях dueDate и dueTime соответствующее время в формате UTC. Срок должен быть в будущем.

Получить задания и вопросы

Вы можете получить задания и вопросы для студентов и преподавателей соответствующего курса или администратора домена. Чтобы получить конкретное задание или вопрос, используйте курсы.courseWork.get. Чтобы получить все задания или вопросы (необязательно соответствующие некоторым критериям), используйте курсы.courseWork.list.

Требуемый объем зависит от роли запрашивающего пользователя в курсе. Если пользователь является учащимся, используйте одну из следующих областей:

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

Если пользователь является учителем или администратором домена, используйте одну из следующих областей:

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

Наличие разрешения на получение задания или вопроса не означает разрешения на доступ к материалам или метаданным материалов. На практике это означает, что администратор может не видеть название вложенного файла на Диске, если он не является участником курса. Если вы хотите разрешить администраторам доступ к файлам пользователей, см. руководство по делегированию домена .

Управление ответами учащихся

Ресурс StudentSubmission представляет проделанную работу и оценку учащегося за задание или вопрос. Ресурс StudentSubmission неявно создается для каждого учащегося при создании нового вопроса или задания.

В следующих разделах объясняются общие действия, которые управляют ответами учащихся.

Получить ответы учащихся

Учащиеся могут получить свои собственные отправленные материалы, преподаватели могут получить отправленные материалы для всех учащихся своих курсов, а администраторы домена могут получить все отправленные материалы для всех учащихся в своем домене. Каждой заявке студента присваивается идентификатор; если вы знаете идентификатор, используйте курсы.courseWork.studentSubmissions.get, чтобы получить его.

Используйте курсы.courseWork.studentSubmissions.list, чтобы получить StudentSubmission , соответствующие некоторым критериям, как показано в следующем примере:

питон

класс/фрагменты/classroom_list_submissions.py
from __future__ import print_function

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

Получите отправленные материалы, принадлежащие конкретному учащемуся, указав параметр userId, как показано в следующем примере:

питон

класс/фрагменты/classroom_list_student_submissions.py
from __future__ import print_function

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

Учащиеся идентифицируются по уникальному идентификатору или адресу электронной почты пользователя, возвращаемому Google Admin SDK. Текущий пользователь также может ссылаться на свой собственный идентификатор, используя сокращение "me" .

Также возможно получить студенческие работы для всех заданий в рамках курса. Для этого используйте литерал "-" в качестве courseWorkId, как показано в следующем примере:

питон

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

Требуемый объем зависит от роли запрашивающего пользователя в курсе. Используйте следующую область, если пользователь является учителем или администратором домена:

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

Используйте следующую область, если пользователь является студентом:

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

Наличие разрешения на получение материалов учащихся не означает наличия разрешений на доступ к вложениям или метаданным вложений. На практике это означает, что администратор может не видеть название вложенного файла на Диске, если он не является участником курса. Если вы хотите разрешить администраторам доступ к файлам пользователей, см. руководство по делегированию домена .

Добавление вложений к ответу учащегося

Вы можете прикрепить ссылки к работе учащегося, прикрепив ресурс Link, DriveFile или YouTubeVideo. Это делается с помощьюcourses.courseWork.studentSubmissions.modifyAttachments, как показано в следующем примере:

питон

класс/фрагменты/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")

Вложение ссылки определяется целевым URL-адресом; Класс автоматически получит заголовок и уменьшенное изображение. Вы можете узнать о других материалах на соответствующих справочных страницах.

Материалы могут быть созданы преподавателем курса или учащимся, которому принадлежит соответствующая студенческая работа, но только для студенческих работ со значением courseWorkType , равным "ASSIGNMENT" .

Требуемый объем зависит от роли запрашивающего пользователя в курсе. Используйте следующую область, если пользователь является учителем:

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

Используйте следующую область, если пользователь является студентом:

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

Управление состоянием ответа учащегося

Ответ учащегося может быть отменен, сдан или возвращен. Поле состояния в StudentSubmission указывает текущее состояние. Чтобы изменить состояние, вызовите один из следующих методов:

Все эти методы принимают пустое тело. Пример:

питон

service.courses().courseWork().studentSubmission().turnIn(
    courseId=<course ID or alias>,
    courseWorkId=<courseWork ID>,
    id=<studentSubmission ID>,
    body={}).execute()

Только учащийся, которому принадлежит StudentSubmission , может сдать или вернуть его. Востребована может быть только поданная подача. Преподаватели курса могут возвращать только StudentSubmission , который находится в сданном состоянии.

Ответы учащихся

Ресурс StudentSubmission имеет два поля для хранения оценок: assignedGrade — это оценка, сообщаемая учащимся, и draftGrade — это предварительная оценка, видимая только преподавателям. Эти поля обновляются с помощью courses.courseWork.studentSubmissions.patch с маской поля, содержащей соответствующие поля, как показано в следующем примере.

питон

studentSubmission = {
  'assignedGrade': 99,
  'draftGrade': 80
}
service.courses().courseWork().studentSubmissions().patch(
    courseId=<course ID or alias>,
    courseWorkId=<courseWork ID>,
    id=<studentSubmission ID>,
    updateMask='assignedGrade,draftGrade',
    body=studentSubmission).execute()

При работе с пользовательским интерфейсом Класса учителя не могут выставлять оценки, пока они не сохранят предварительную оценку. Выставленная оценка может быть возвращена ученику. Приложения должны эмулировать это поведение. Ваше приложение может оценивать задание учащегося одним из двух способов:

  • Назначьте только draftGrade . Это полезно, например, чтобы позволить учителю вручную просматривать оценки перед их окончанием. Учащиеся не могут видеть черновые оценки.

  • Назначьте как draftGrade , так assignedGrade , чтобы полностью оценить задание.