您可以使用课程别名以其他名称引用课程。课程别名可用作 Google 课堂课程标识符与外部课程标识符之间的映射。例如,您可以设置课程别名,使其与学生信息系统 (SIS) 中的课程 ID 相匹配。
课程别名有两种形式:网域级别名和项目级别名。
网域级别别名使用
d:
作为前缀,任何使用 Classroom API 的用户都可以看到。网域命名空间非常适合创建所有用户都需要访问但不特定于任何一项计划的别名。例如,课程的其他列表(例如 MATH 127 和 COMSCI 127)应在域名命名空间中创建。只有网域管理员可以创建网域命名空间中的别名,但网域中的所有用户都可以看到这些别名。项目级别别名使用
p:
作为前缀,并且只有创建它们的 Google Cloud 项目才能看到和使用它们。开发者项目命名空间非常适合管理特定于应用的别名。例如,如果应用使用课程的备用标识符,则可以创建别名,以将其标识符映射到 Google 课堂课程。在此命名空间中创建的别名会与特定 Google Cloud 项目相关联。应用的任何用户都可以在该应用的开发者项目的命名空间中创建和查看别名。
您可以使用课程别名来代替任何 Google 课堂 API 端点的 Google 课堂课程 ID。这意味着,该别名可用于读取和修改课程和名单信息。
使用别名与学生信息系统同步
课程的学生信息系统内部标识符可以注册为课程的域名级别别名。这样一来,任何同时与学生信息系统和 Google 课堂集成的开发者都可以使用学生信息系统标识符与 Google 课堂数据进行交互。
如果您通过学生信息系统 (SIS) 创建课程或将课程关联到 SIS,建议您使用 SIS 的课程 ID 作为课程别名。使用 courses.create()
方法创建课程时,您可以在请求的 id
字段中指定别名。如果别名已存在,课程创建会因 409 ALREADY_EXISTS
错误而失败。这样可以防止在同步计划中出现问题时创建重复课程。
例如,假设学生信息系统 (SIS) 的名称为 school
,并且 SIS 为特定课程使用的内部标识符为 math_101
,您可以创建别名 d:school_math_101
。
为新课程添加别名
如需为新课程添加别名,请在发出 courses.create()
请求时将 course.id
设置为别名。
Apps 脚本
Java
Python
为现有课程添加别名
如需为现有课程添加别名,您可以设置 alias
字段并使用 courses.aliases.create()
方法。
Apps 脚本
Java
Python
检索课程别名
您可以使用 courses.aliases.list()
方法检索课程的别名,如以下示例所示:
.NET
Java
Python