An alias uniquely identifies a course. It must be unique within one of the following scopes:
domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom.
project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.
JSON representation
{"alias": string}
Fields
alias
string
Alias string. The format of the string indicates the desired alias scoping.
d:<name> indicates a domain-scoped alias. Example: d:math_101
p:<name> indicates a project-scoped alias. Example: p:abc123
This field has a maximum length of 256 characters.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-03 UTC."],[[["A CourseAlias is an alternative, unique identifier for a course, offering flexibility for domain and project-level scoping."],["Aliases can be domain-scoped (visible within the creator's domain) or project-scoped (visible to the creating project)."],["Domain-scoped aliases are typically used for external course identifiers, while project-scoped aliases are useful for application-specific identifiers or ensuring data integrity."],["You can manage CourseAliases using the provided methods to create, delete, and list them for a specific course."]]],[]]
