Puedes hacer referencia a los cursos con un nombre diferente mediante un alias de curso. Los alias de los cursos pueden servir como asignación entre los identificadores de cursos de Google Classroom y los identificadores de cursos externos. Por ejemplo, puedes establecer un alias de curso que coincida con el ID del curso de un sistema de información de estudiantes (SIE).
El alias del curso tiene dos formas: para todo el dominio y para todo el proyecto.
Los alias para todo el dominio usan el prefijo
d:
y cualquier persona que use la API de Classroom puede verlos. El espacio de nombres de dominio es útil para crear alias a los que todos los usuarios deben tener acceso, pero que no son específicos de ningún programa. Por ejemplo, las fichas alternativas de un curso, como MATH 127 y COMSCI 127, se deben crear en el espacio de nombres del dominio. Solo los administradores de dominios pueden crear alias en el espacio de nombres del dominio, pero todos los usuarios de un dominio pueden verlos.Los alias a nivel del proyecto usan un prefijo de
p:
y solo el proyecto de Google Cloud que los creó puede verlos y usarlos. El espacio de nombres del proyecto del desarrollador es útil para administrar alias específicos de una aplicación. Por ejemplo, una aplicación que usa identificadores alternativos para los cursos puede crear alias para asignar su identificador a los cursos de Classroom. Los alias creados en este espacio de nombres están vinculados a un proyecto de Google Cloud específico. Cualquier usuario de una aplicación puede crear y ver alias en el espacio de nombres del proyecto de desarrollador de esa aplicación.
Se puede usar un alias de curso en lugar del ID del curso de Classroom para cualquier extremo de la API de Classroom. Esto significa que el alias se puede usar para leer y modificar la información de los cursos y las listas.
Usa un alias para la sincronización con sistemas de información de estudiantes
El identificador interno del SIA para un curso se puede registrar como un alias para todo el dominio. De esta manera, cualquier desarrollador que realice integraciones con el SIE y Classroom puede usar el identificador del SIE para interactuar con los datos de Classroom.
Si creas un curso desde un SIE o lo vinculas a uno, se recomienda que se use el ID del curso del SIE como alias. Cuando creas un curso con el método courses.create()
, puedes especificar el alias en el campo id
de la solicitud. Si el alias ya existe, la creación del curso falla con un error 409 ALREADY_EXISTS
. Esto evita la creación de cursos duplicados si hay un problema en el programa de sincronización.
Por ejemplo, si suponemos que el nombre del SIE es school
y el identificador interno que usa el SIE para un curso en particular es math_101
, puedes crear un alias como d:school_math_101
.
Agrega un alias para un curso nuevo
Para agregar un alias para un curso nuevo, establece course.id
en un alias cuando realices la solicitud courses.create()
.
Apps Script
Java
Python
Agrega un alias para un curso existente
Para agregar el alias a un curso existente, puedes configurar el campo alias
y usar el método courses.aliases.create()
.
Apps Script
Java
Python
Cómo recuperar los alias de los cursos
Puedes recuperar los alias de un curso con el método courses.aliases.list()
, como se muestra en el siguiente ejemplo:
.NET
Java
Python