REST Resource: courses.aliases
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: CourseAlias
Autre identifiant d'un cours.
Un alias identifie de manière unique un cours. Il doit être unique dans l'un des champs d'application suivants:
domaine: un alias de domaine est visible par tous les utilisateurs du domaine de l'auteur de l'alias et ne peut être créé que par un administrateur de domaine. Un alias de portée de domaine est souvent utilisé lorsqu'un cours dispose d'un identifiant externe à Classroom.
project: un alias de portée projet est visible par toute requête d'une application utilisant l'ID de projet de la Developer Console qui a créé l'alias. Il peut être créé par n'importe quel projet. Un alias de portée projet est souvent utilisé lorsqu'une application dispose d'identifiants alternatifs. Une valeur aléatoire peut également être utilisée pour éviter les cours en double en cas d'échec de la transmission, car une nouvelle tentative de requête renvoie ALREADY_EXISTS si une précédente a réussi.
| Représentation JSON |
{
"alias": string
} |
| Champs |
alias |
string
Chaîne d'alias. Le format de la chaîne indique le champ d'application souhaité de l'alias.
d:<name> indique un alias de portée de domaine. Exemple : d:math_101p:<name> indique un alias de portée projet. Exemple : p:abc123 Ce champ ne doit pas comporter plus de 256 caractères.
|
Méthodes |
|
|
Crée un alias pour un cours. |
|
|
Supprime un alias d'un cours. |
|
|
Renvoie la liste des alias d'un cours. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# REST Resource: courses.aliases\n\n- [Resource: CourseAlias](#CourseAlias)\n - [JSON representation](#CourseAlias.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CourseAlias\n---------------------\n\nAlternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the following scopes:\n\n- 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.\n\n- 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.\n\n| JSON representation |\n|-----------------------------|\n| ``` { \"alias\": string } ``` |\n\n| Fields ||\n|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `alias` | `string` Alias string. The format of the string indicates the desired alias scoping. - `d:\u003cname\u003e` indicates a domain-scoped alias. Example: `d:math_101` - `p:\u003cname\u003e` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------|-----------------------------------------|\n| ### [create](/workspace/classroom/reference/rest/v1/courses.aliases/create) | Creates an alias for a course. |\n| ### [delete](/workspace/classroom/reference/rest/v1/courses.aliases/delete) | Deletes an alias of a course. |\n| ### [list](/workspace/classroom/reference/rest/v1/courses.aliases/list) | Returns a list of aliases for a course. |"]]
