Method: courses.courseWork.getAddOnContext

Получает метаданные для надстроек Класса в контексте определенного сообщения.

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

Этот метод возвращает следующие коды ошибок:

  • PERMISSION_DENIED для ошибок доступа .
  • INVALID_ARGUMENT если запрос имеет неверный формат.
  • NOT_FOUND если один из идентифицированных ресурсов не существует.

HTTP-запрос

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
courseId

string

Необходимый. Идентификатор курса.

itemId

string

Идентификатор Announcement , CourseWork или CourseWorkMaterial , к которому прикреплено вложение. Это поле является обязательным, но не помечено как таковое при переходе с postId.

Параметры запроса

Параметры
addOnToken

string

Необязательный. Токен, авторизующий запрос.

Токен передается в качестве параметра запроса, когда пользователь перенаправляется из Класса на URL-адрес надстройки.

Токен авторизации необходим, если не выполняется ни одно из следующих условий:

  • Дополнение имеет вложения к сообщению.
  • Проект разработчика, выдающий запрос, — это тот же проект, в котором было создано сообщение.
attachmentId

string

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

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр AddOnContext .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

Дополнительную информацию см. в руководстве по авторизации .