Create

Creates an alias for a course

2 variables
1 variables

Creates an alias for a course.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors.
  • NOT_FOUND if the course does not exist.
  • ALREADY_EXISTS if the alias already exists.
  • FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias)

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage your Google Classroom classes

Input

This building block consumes 2 input parameters

  = Parameter name
  = Format

courseId STRING Required

Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias

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

Output

This building block provides 1 output parameters

  = Parameter name
  = Format

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