Default request referring to version v1 of the Google Classroom API. This contains the host and root path used as a starting point for constructing service requests.

Represents the entirety of the methods and resources available for the Google Classroom API service.

Response when listing course aliases.

See: listCourseAliasesResponse smart constructor.

Creates a value of ListCourseAliasesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lcarNextPageToken
• lcarAliases

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

The course aliases.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

See: empty smart constructor.

Creates a value of Empty with the minimum fields required to make a request.

Global user permission description.

See: globalPermission smart constructor.

Creates a value of GlobalPermission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gpPermission

Permission value.

Response when listing invitations.

See: listInvitationsResponse smart constructor.

Creates a value of ListInvitationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lirNextPageToken
• lirInvitations

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

Invitations that match the list request.

An invitation to join a course.

See: invitation smart constructor.

Creates a value of Invitation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• iCourseId
• iUserId
• iRole
• iId

Identifier of the course to invite the user to.

Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.

Identifier assigned by Classroom. Read-only.

Teacher of a course.

See: teacher smart constructor.

Creates a value of Teacher with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tCourseId
• tProFile
• tUserId

Identifier of the course. Read-only.

Global user information for the teacher. Read-only.

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

Details of the user's name.

See: name smart constructor.

Creates a value of Name with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• nGivenName
• nFullName
• nFamilyName

The user's first name. Read-only.

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

The user's last name. Read-only.

Response when listing courses.

See: listCoursesResponse smart constructor.

Creates a value of ListCoursesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lcrNextPageToken
• lcrCourses

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

Courses that match the list request.

Global information for a user.

See: userProFile smart constructor.

Creates a value of UserProFile with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• upfPhotoURL
• upfName
• upfEmailAddress
• upfId
• upfPermissions

URL of user's profile photo. Read-only.

Name of the user. Read-only.

Email address of the user. Read-only.

Identifier of the user. Read-only.

Global permissions of the user. Read-only.

A Course in Classroom.

See: course smart constructor.

Creates a value of Course with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cCreationTime
• cRoom
• cCourseState
• cEnrollmentCode
• cUpdateTime
• cOwnerId
• cName
• cId
• cAlternateLink
• cDescription
• cDescriptionHeading
• cSection

Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only.

Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.

State of the course. If unspecified, the default state is `PROVISIONED`.

Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only.

Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only.

The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The 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 This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error.

Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.

Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error.

Absolute link to this course in the Classroom web UI. Read-only.

Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.

Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.

Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.

Response when listing students.

See: listStudentsResponse smart constructor.

Creates a value of ListStudentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lsrNextPageToken
• lsrStudents

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

Students who match the list request.

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.

See: courseAlias smart constructor.

Creates a value of CourseAlias with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• caAlias

Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.

Response when listing teachers.

See: listTeachersResponse smart constructor.

Creates a value of ListTeachersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltrNextPageToken
• ltrTeachers

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

Teachers who match the list request.

Student in a course.

See: student smart constructor.

Creates a value of Student with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sCourseId
• sProFile
• sUserId

Identifier of the course. Read-only.

Global user information for the student. Read-only.

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