List

Returns a list of aliases for a course

3 variables
3 variables

Returns a list of aliases for a course.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the course or for access errors.
  • NOT_FOUND if the course does not exist

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
  • View your Google Classroom classes

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

courseId STRING Required

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

pageToken STRING

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token

pageSize INTEGER

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results

Output

This building block provides 3 output parameters

  = Parameter name
  = Format

aliases[] OBJECT

Alternative identifier for a course.

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.

aliases[].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

nextPageToken STRING

Token identifying the next page of results to return. If empty, no further results are available