List

Returns a list of teachers of this course that the requester is permitted to view

3 variables
14 variables

Returns a list of teachers of this course that the requester is permitted to view.

This method returns the following error codes:

  • NOT_FOUND if the course does not exist.
  • PERMISSION_DENIED for access errors

Authorization

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

  • View the email addresses of people in your classes
  • View the profile photos of people in your classes
  • Manage your Google Classroom class rosters
  • View your Google Classroom class rosters

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

courseId STRING Required

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 means no maximum.

The server may return fewer than the specified number of results

Output

This building block provides 14 output parameters

  = Parameter name
  = Format

teachers[] OBJECT

Teacher of a course

teachers[].userId STRING

Identifier of the user.

When specified as a parameter of a request, this identifier can be one of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user

teachers[].courseId STRING

Identifier of the course.

Read-only

teachers[].profile OBJECT

Global information for a user

teachers[].profile.emailAddress STRING

Email address of the user.

Read-only

teachers[].profile.photoUrl STRING

URL of user's profile photo.

Read-only

teachers[].profile.permissions[] OBJECT

Global user permission description

teachers[].profile.name OBJECT

Details of the user's name

teachers[].profile.name.givenName STRING

The user's first name.

Read-only

teachers[].profile.name.familyName STRING

The user's last name.

Read-only

teachers[].profile.name.fullName STRING

The user's full name formed by concatenating the first and last name values.

Read-only

teachers[].profile.id STRING

Identifier of the user.

Read-only

teachers[].profile.verifiedTeacher BOOLEAN

Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false.

Read-only

nextPageToken STRING

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