Method: courses.patch

Actualiza uno o más campos en un curso.

Este método devuelve los siguientes códigos de error:

  • PERMISSION_DENIED si el usuario solicitante no tiene permiso para modificar el curso solicitado o por errores de acceso
  • NOT_FOUND si no existe ningún curso con el ID solicitado
  • INVALID_ARGUMENT si se especifican campos no válidos en la máscara de actualización o si no se proporciona ninguna máscara de actualización
  • FAILED_PRECONDITION para los siguientes errores de solicitud:
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner
    • CourseTitleCannotContainUrl

Solicitud HTTP

PATCH https://classroom.googleapis.com/v1/courses/{id}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
id

string

Es el identificador del curso que se actualizará. Este identificador puede ser el que asigna Classroom o un alias.

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Máscara que identifica qué campos del curso se deben actualizar. Este campo es obligatorio para realizar una actualización. La actualización fallará si se especifican campos no válidos. Los siguientes campos son válidos:

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

Nota: Los parches de ownerId se consideran efectivos de inmediato, pero, en la práctica, la transferencia de propiedad de todos los recursos afectados puede tardar un tiempo en completarse.

Cuando se configura en un parámetro de consulta, este campo se debe especificar como

updateMask=<field1>,<field2>,...

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Course.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Course.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/classroom.courses

Para obtener más información, consulta la Guía de autorización.