Google Apps Adapter Record Fields Reference

Field

Read-Only

Description

id

Y

Identifier for this course assigned by Classroom (exclude on create)

name

N

Name of the course (required)

section

N

Section of the course

descriptionHeading

N

Heading for the description

description

N

Description

room

N

Room location. 

courseState

N

State of the course (ACTIVE|ARCHIVED|PROVISIONED|DECLINED) (default: PROVISIONED)

alias

N

Initial alias on creation, not readable and ignored on updates.

ownerId

Y

the Google Apps id of the owner of the course (required on create, but read-only after that)

enrollmentCode

Y

Enrollment code to use when joining this course

alternateLink

Y

indicates if the User's IP address is white listed

creationTime

Y

Creation timestamp

updateTime

Y

Update timestamp

Field

Read-Only

Description

alias

Y

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

Once assigned, an alias can be used in place of the id

Field

Read-Only

Description

courseId

Y

the id of the course

userId

Y

uniqueid of the Teacher/Student

profile

Y

User information of the Teacher/Student

profile.name

Y

Name of the user

profile.name.givenName

Y

The first name

profile.name.familyName

Y

The last name

profile.name.fullName

Y

The full name

profile.emailAddress

Y

The email address

profile.photoUrl

Y

The photo url

profile.permissions

Y

List of permissions

Field

Read-Only

Description

id

Y

the id of the invitation

userId

Y

uniqueid of the invited Teacher/Student

courseId

Y

the id of the course

role

Y

STUDENT | TEACHER