Puedes hacer referencia a cursos con un nombre diferente con un recurso de alias del curso. Los alias del curso son una asignación entre los identificadores de cursos de Google Classroom y los identificadores externos de cursos.
Te recomendamos que, cada vez que crees un curso a partir de un SIA o lo vincules a
un SIA, se use el CourseID del SIA como alias del curso. La API de Classroom te permite hacerlo directamente durante la creación del curso especificando el parámetro id
del curso como el alias. Si el alias ya existe, la creación del curso fallará y mostrará el error ALREADY_EXISTS (409)
. Esto evitará la creación de cursos duplicados si hay un error en el programa de sincronización.
Existen dos tipos de alias: para todo el dominio y para todo el proyecto.
- Los alias de todo el dominio usan el prefijo
d:
, y cualquier persona que use la API de Classroom puede verlos. - Los alias de todo el proyecto usan el prefijo
p:
y solo la aplicación (proyecto de Play Console) que los creó puede verlos y usarlos.
Los alias se pueden usar en cualquier parte de la API que espere un identificador de curso. Esto significa que, una vez que se registra un alias mediante la API, se puede usar para leer y modificar la información de los cursos y las listas.
Desde la perspectiva de la sincronización del SIA, esto significa que el identificador interno del SIA de un curso se puede registrar como un alias de todo el dominio para el curso. De esa manera, cualquier desarrollador que se integre con el SIA y Classroom podrá usar el identificador del SIA para interactuar con los datos de Classroom.
Por ejemplo, si asumimos que el nombre del SIA es school
y que el identificador interno
que usa el SIA para un curso en particular es math_101
, puedes crear un alias
como d:school_math_101
.
Cómo agregar un alias para un curso nuevo
A fin de agregar un alias para un curso nuevo, configura course.id
con el alias deseado cuando realices la solicitud courses.create()
.
Apps Script
Java
Python
Cómo agregar un alias para un curso existente
Para agregar el alias a un curso existente, puedes configurar alias
con el nombre de alias deseado y usar el método courses.aliases.create()
.
Apps Script
Java
Python
Recuperar alias del curso
Puedes recuperar los alias de un curso con el método courses.aliases.list()
, como se muestra en el siguiente ejemplo:
.NET
Java
Python