Package classroom

import "google.golang.org/api/classroom/v1"
...
ctx := context.Background()
classroomService, err := classroom.NewService(ctx)

classroomService, err := classroom.NewService(ctx, option.WithScopes(classroom.ClassroomTopicsReadonlyScope))

classroomService, err := classroom.NewService(ctx, option.WithAPIKey("AIza..."))

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
classroomService, err := classroom.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Constants

OAuth2 scopes used by this API.

const (
    // View and manage announcements in Google Classroom
    ClassroomAnnouncementsScope = "https://www.googleapis.com/auth/classroom.announcements"

    // View announcements in Google Classroom
    ClassroomAnnouncementsReadonlyScope = "https://www.googleapis.com/auth/classroom.announcements.readonly"

    // See, edit, create, and permanently delete your Google Classroom classes
    ClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses"

    // View your Google Classroom classes
    ClassroomCoursesReadonlyScope = "https://www.googleapis.com/auth/classroom.courses.readonly"

    // See, create and edit coursework items including assignments, questions, and
    // grades
    ClassroomCourseworkMeScope = "https://www.googleapis.com/auth/classroom.coursework.me"

    // View your course work and grades in Google Classroom
    ClassroomCourseworkMeReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.me.readonly"

    // Manage course work and grades for students in the Google Classroom classes
    // you teach and view the course work and grades for classes you administer
    ClassroomCourseworkStudentsScope = "https://www.googleapis.com/auth/classroom.coursework.students"

    // View course work and grades for students in the Google Classroom classes you
    // teach or administer
    ClassroomCourseworkStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.students.readonly"

    // See, edit, and create classwork materials in Google Classroom
    ClassroomCourseworkmaterialsScope = "https://www.googleapis.com/auth/classroom.courseworkmaterials"

    // See all classwork materials for your Google Classroom classes
    ClassroomCourseworkmaterialsReadonlyScope = "https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly"

    // View your Google Classroom guardians
    ClassroomGuardianlinksMeReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"

    // View and manage guardians for students in your Google Classroom classes
    ClassroomGuardianlinksStudentsScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students"

    // View guardians for students in your Google Classroom classes
    ClassroomGuardianlinksStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"

    // View the email addresses of people in your classes
    ClassroomProfileEmailsScope = "https://www.googleapis.com/auth/classroom.profile.emails"

    // View the profile photos of people in your classes
    ClassroomProfilePhotosScope = "https://www.googleapis.com/auth/classroom.profile.photos"

    // Receive notifications about your Google Classroom data
    ClassroomPushNotificationsScope = "https://www.googleapis.com/auth/classroom.push-notifications"

    // Manage your Google Classroom class rosters
    ClassroomRostersScope = "https://www.googleapis.com/auth/classroom.rosters"

    // View your Google Classroom class rosters
    ClassroomRostersReadonlyScope = "https://www.googleapis.com/auth/classroom.rosters.readonly"

    // View your course work and grades in Google Classroom
    ClassroomStudentSubmissionsMeReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"

    // View course work and grades for students in the Google Classroom classes you
    // teach or administer
    ClassroomStudentSubmissionsStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"

    // See, create, and edit topics in Google Classroom
    ClassroomTopicsScope = "https://www.googleapis.com/auth/classroom.topics"

    // View topics in Google Classroom
    ClassroomTopicsReadonlyScope = "https://www.googleapis.com/auth/classroom.topics.readonly"
)

type Announcement ¶

Announcement: Announcement created by a teacher for students of the course

type Announcement struct {
    // AlternateLink: Absolute link to this announcement in the Classroom web UI.
    // This is only populated if `state` is `PUBLISHED`. Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // AssigneeMode: Assignee mode of the announcement. If unspecified, the default
    // value is `ALL_STUDENTS`.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
    //   "ALL_STUDENTS" - All students can see the item. This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // CreationTime: Timestamp when this announcement was created. Read-only.
    CreationTime string `json:"creationTime,omitempty"`
    // CreatorUserId: Identifier for the user that created the announcement.
    // Read-only.
    CreatorUserId string `json:"creatorUserId,omitempty"`
    // Id: Classroom-assigned identifier of this announcement, unique per course.
    // Read-only.
    Id string `json:"id,omitempty"`
    // IndividualStudentsOptions: Identifiers of students with access to the
    // announcement. This field is set only if `assigneeMode` is
    // `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then
    // only students specified in this field can see the announcement.
    IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`
    // Materials: Additional materials. Announcements must have no more than 20
    // material items.
    Materials []*Material `json:"materials,omitempty"`
    // ScheduledTime: Optional timestamp when this announcement is scheduled to be
    // published.
    ScheduledTime string `json:"scheduledTime,omitempty"`
    // State: Status of this announcement. If unspecified, the default state is
    // `DRAFT`.
    //
    // Possible values:
    //   "ANNOUNCEMENT_STATE_UNSPECIFIED" - No state specified. This is never
    // returned.
    //   "PUBLISHED" - Status for announcement that has been published. This is the
    // default state.
    //   "DRAFT" - Status for an announcement that is not yet published.
    // Announcement in this state is visible only to course teachers and domain
    // administrators.
    //   "DELETED" - Status for announcement that was published but is now deleted.
    // Announcement in this state is visible only to course teachers and domain
    // administrators. Announcement in this state is deleted after some time.
    State string `json:"state,omitempty"`
    // Text: Description of this announcement. The text must be a valid UTF-8
    // string containing no more than 30,000 characters.
    Text string `json:"text,omitempty"`
    // UpdateTime: Timestamp of the most recent change to this announcement.
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Announcement) MarshalJSON ¶

func (s *Announcement) MarshalJSON() ([]byte, error)

type Assignment ¶

Assignment: Additional details for assignments.

type Assignment struct {
    // StudentWorkFolder: Drive folder where attachments from student submissions
    // are placed. This is only populated for course teachers and administrators.
    StudentWorkFolder *DriveFolder `json:"studentWorkFolder,omitempty"`
    // ForceSendFields is a list of field names (e.g. "StudentWorkFolder") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "StudentWorkFolder") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Assignment) MarshalJSON ¶

func (s *Assignment) MarshalJSON() ([]byte, error)

type AssignmentSubmission ¶

AssignmentSubmission: Student work for an assignment.

type AssignmentSubmission struct {
    // Attachments: Attachments added by the student. Drive files that correspond
    // to materials with a share mode of STUDENT_COPY may not exist yet if the
    // student has not accessed the assignment in Classroom. Some attachment
    // metadata is only populated if the requesting user has permission to access
    // it. Identifier and alternate_link fields are always available, but others
    // (for example, title) may not be.
    Attachments []*Attachment `json:"attachments,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Attachments") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Attachments") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AssignmentSubmission) MarshalJSON ¶

func (s *AssignmentSubmission) MarshalJSON() ([]byte, error)

type Attachment ¶

Attachment: Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.

type Attachment struct {
    // DriveFile: Google Drive file attachment.
    DriveFile *DriveFile `json:"driveFile,omitempty"`
    // Form: Google Forms attachment.
    Form *Form `json:"form,omitempty"`
    // Link: Link attachment.
    Link *Link `json:"link,omitempty"`
    // YouTubeVideo: Youtube video attachment.
    YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DriveFile") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Attachment) MarshalJSON ¶

func (s *Attachment) MarshalJSON() ([]byte, error)

type CloudPubsubTopic ¶

CloudPubsubTopic: A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.

type CloudPubsubTopic struct {
    // TopicName: The `name` field of a Cloud Pub/Sub Topic
    // (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
    TopicName string `json:"topicName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "TopicName") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "TopicName") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CloudPubsubTopic) MarshalJSON ¶

func (s *CloudPubsubTopic) MarshalJSON() ([]byte, error)

type Course ¶

Course: A Course in Classroom.

type Course struct {
    // AlternateLink: Absolute link to this course in the Classroom web UI.
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // CalendarId: The Calendar ID for a calendar that all course members can see,
    // to which Classroom adds events for course work and announcements in the
    // course. The Calendar for a course is created asynchronously when the course
    // is set to `CourseState.ACTIVE` for the first time (at creation time or when
    // it is updated to `ACTIVE` through the UI or the API). The Calendar ID will
    // not be populated until the creation process is completed. Read-only.
    CalendarId string `json:"calendarId,omitempty"`
    // CourseGroupEmail: The email address of a Google group containing all members
    // of the course. This group does not accept email and can only be used for
    // permissions. Read-only.
    CourseGroupEmail string `json:"courseGroupEmail,omitempty"`
    // CourseMaterialSets: Sets of materials that appear on the "about" page of
    // this course. Read-only.
    CourseMaterialSets []*CourseMaterialSet `json:"courseMaterialSets,omitempty"`
    // CourseState: State of the course. If unspecified, the default state is
    // `PROVISIONED`.
    //
    // Possible values:
    //   "COURSE_STATE_UNSPECIFIED" - No course state. No returned Course message
    // will use this value.
    //   "ACTIVE" - The course is active.
    //   "ARCHIVED" - The course has been archived. You cannot modify it except to
    // change it to a different state.
    //   "PROVISIONED" - The course has been created, but not yet activated. It is
    // accessible by the primary teacher and domain administrators, who may modify
    // it or change it to the `ACTIVE` or `DECLINED` states. A course may only be
    // changed to `PROVISIONED` if it is in the `DECLINED` state.
    //   "DECLINED" - The course has been created, but declined. It is accessible
    // by the course owner and domain administrators, though it will not be
    // displayed in the web UI. You cannot modify the course except to change it to
    // the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is
    // in the `PROVISIONED` state.
    //   "SUSPENDED" - The course has been suspended. You cannot modify the course,
    // and only the user identified by the `owner_id` can view the course. A course
    // may be placed in this state if it potentially violates the Terms of Service.
    CourseState string `json:"courseState,omitempty"`
    // CreationTime: Creation time of the course. Specifying this field in a course
    // update mask results in an error. Read-only.
    CreationTime string `json:"creationTime,omitempty"`
    // Description: 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.
    Description string `json:"description,omitempty"`
    // DescriptionHeading: 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.
    DescriptionHeading string `json:"descriptionHeading,omitempty"`
    // EnrollmentCode: Enrollment code to use when joining this course. Specifying
    // this field in a course update mask results in an error. Read-only.
    EnrollmentCode string `json:"enrollmentCode,omitempty"`
    // GradebookSettings: The gradebook settings that specify how a student's
    // overall grade for the course will be calculated and who it will be displayed
    // to. Read-only
    GradebookSettings *GradebookSettings `json:"gradebookSettings,omitempty"`
    // GuardiansEnabled: Whether or not guardian notifications are enabled for this
    // course. Read-only.
    GuardiansEnabled bool `json:"guardiansEnabled,omitempty"`
    // Id: 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 results in an error.
    Id string `json:"id,omitempty"`
    // Name: 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.
    Name string `json:"name,omitempty"`
    // OwnerId: 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. Admins can also
    // specify this field in a patch course request to transfer ownership. In other
    // contexts, it is read-only.
    OwnerId string `json:"ownerId,omitempty"`
    // Room: Optional room location. For example, "301". If set, this field must be
    // a valid UTF-8 string and no longer than 650 characters.
    Room string `json:"room,omitempty"`
    // Section: 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.
    Section string `json:"section,omitempty"`
    // TeacherFolder: Information about a Drive Folder that is shared with all
    // teachers of the course. This field will only be set for teachers of the
    // course and domain administrators. Read-only.
    TeacherFolder *DriveFolder `json:"teacherFolder,omitempty"`
    // TeacherGroupEmail: The email address of a Google group containing all
    // teachers of the course. This group does not accept email and can only be
    // used for permissions. Read-only.
    TeacherGroupEmail string `json:"teacherGroupEmail,omitempty"`
    // UpdateTime: Time of the most recent update to this course. Specifying this
    // field in a course update mask results in an error. Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Course) MarshalJSON ¶

func (s *Course) MarshalJSON() ([]byte, error)

type CourseAlias ¶

CourseAlias: 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.

type CourseAlias struct {
    // Alias: 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.
    Alias string `json:"alias,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Alias") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Alias") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseAlias) MarshalJSON ¶

func (s *CourseAlias) MarshalJSON() ([]byte, error)

type CourseMaterial ¶

CourseMaterial: A material attached to a course as part of a material set.

type CourseMaterial struct {
    // DriveFile: Google Drive file attachment.
    DriveFile *DriveFile `json:"driveFile,omitempty"`
    // Form: Google Forms attachment.
    Form *Form `json:"form,omitempty"`
    // Link: Link atatchment.
    Link *Link `json:"link,omitempty"`
    // YouTubeVideo: Youtube video attachment.
    YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DriveFile") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseMaterial) MarshalJSON ¶

func (s *CourseMaterial) MarshalJSON() ([]byte, error)

type CourseMaterialSet ¶

CourseMaterialSet: A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.

type CourseMaterialSet struct {
    // Materials: Materials attached to this set.
    Materials []*CourseMaterial `json:"materials,omitempty"`
    // Title: Title for this set.
    Title string `json:"title,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Materials") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Materials") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseMaterialSet) MarshalJSON ¶

func (s *CourseMaterialSet) MarshalJSON() ([]byte, error)

type CourseRosterChangesInfo ¶

CourseRosterChangesInfo: Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.

type CourseRosterChangesInfo struct {
    // CourseId: The `course_id` of the course to subscribe to roster changes for.
    CourseId string `json:"courseId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseRosterChangesInfo) MarshalJSON ¶

func (s *CourseRosterChangesInfo) MarshalJSON() ([]byte, error)

type CourseWork ¶

CourseWork: Course work created by a teacher for students of the course.

type CourseWork struct {
    // AlternateLink: Absolute link to this course work in the Classroom web UI.
    // This is only populated if `state` is `PUBLISHED`. Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // AssigneeMode: Assignee mode of the coursework. If unspecified, the default
    // value is `ALL_STUDENTS`.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
    //   "ALL_STUDENTS" - All students can see the item. This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`
    // Assignment: Assignment details. This is populated only when `work_type` is
    // `ASSIGNMENT`. Read-only.
    Assignment *Assignment `json:"assignment,omitempty"`
    // AssociatedWithDeveloper: Whether this course work item is associated with
    // the Developer Console project making the request. See CreateCourseWork for
    // more details. Read-only.
    AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // CreationTime: Timestamp when this course work was created. Read-only.
    CreationTime string `json:"creationTime,omitempty"`
    // CreatorUserId: Identifier for the user that created the coursework.
    // Read-only.
    CreatorUserId string `json:"creatorUserId,omitempty"`
    // Description: Optional description of this course work. If set, the
    // description must be a valid UTF-8 string containing no more than 30,000
    // characters.
    Description string `json:"description,omitempty"`
    // DueDate: Optional date, in UTC, that submissions for this course work are
    // due. This must be specified if `due_time` is specified.
    DueDate *Date `json:"dueDate,omitempty"`
    // DueTime: Optional time of day, in UTC, that submissions for this course work
    // are due. This must be specified if `due_date` is specified.
    DueTime *TimeOfDay `json:"dueTime,omitempty"`
    // GradeCategory: The category that this coursework's grade contributes to.
    // Present only when a category has been chosen for the coursework. May be used
    // in calculating the overall grade. Read-only.
    GradeCategory *GradeCategory `json:"gradeCategory,omitempty"`
    // Id: Classroom-assigned identifier of this course work, unique per course.
    // Read-only.
    Id string `json:"id,omitempty"`
    // IndividualStudentsOptions: Identifiers of students with access to the
    // coursework. This field is set only if `assigneeMode` is
    // `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then
    // only students specified in this field are assigned the coursework.
    IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`
    // Materials: Additional materials. CourseWork must have no more than 20
    // material items.
    Materials []*Material `json:"materials,omitempty"`
    // MaxPoints: Maximum grade for this course work. If zero or unspecified, this
    // assignment is considered ungraded. This must be a non-negative integer
    // value.
    MaxPoints float64 `json:"maxPoints,omitempty"`
    // MultipleChoiceQuestion: Multiple choice question details. For read
    // operations, this field is populated only when `work_type` is
    // `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be
    // specified when creating course work with a `work_type` of
    // `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
    MultipleChoiceQuestion *MultipleChoiceQuestion `json:"multipleChoiceQuestion,omitempty"`
    // ScheduledTime: Optional timestamp when this course work is scheduled to be
    // published.
    ScheduledTime string `json:"scheduledTime,omitempty"`
    // State: Status of this course work. If unspecified, the default state is
    // `DRAFT`.
    //
    // Possible values:
    //   "COURSE_WORK_STATE_UNSPECIFIED" - No state specified. This is never
    // returned.
    //   "PUBLISHED" - Status for work that has been published. This is the default
    // state.
    //   "DRAFT" - Status for work that is not yet published. Work in this state is
    // visible only to course teachers and domain administrators.
    //   "DELETED" - Status for work that was published but is now deleted. Work in
    // this state is visible only to course teachers and domain administrators.
    // Work in this state is deleted after some time.
    State string `json:"state,omitempty"`
    // SubmissionModificationMode: Setting to determine when students are allowed
    // to modify submissions. If unspecified, the default value is
    // `MODIFIABLE_UNTIL_TURNED_IN`.
    //
    // Possible values:
    //   "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" - No modification mode
    // specified. This is never returned.
    //   "MODIFIABLE_UNTIL_TURNED_IN" - Submissions can be modified before being
    // turned in.
    //   "MODIFIABLE" - Submissions can be modified at any time.
    SubmissionModificationMode string `json:"submissionModificationMode,omitempty"`
    // Title: Title of this course work. The title must be a valid UTF-8 string
    // containing between 1 and 3000 characters.
    Title string `json:"title,omitempty"`
    // TopicId: Identifier for the topic that this coursework is associated with.
    // Must match an existing topic in the course.
    TopicId string `json:"topicId,omitempty"`
    // UpdateTime: Timestamp of the most recent change to this course work.
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`
    // WorkType: Type of this course work. The type is set when the course work is
    // created and cannot be changed.
    //
    // Possible values:
    //   "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is never
    // returned.
    //   "ASSIGNMENT" - An assignment.
    //   "SHORT_ANSWER_QUESTION" - A short answer question.
    //   "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
    WorkType string `json:"workType,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseWork) MarshalJSON ¶

func (s *CourseWork) MarshalJSON() ([]byte, error)

func (*CourseWork) UnmarshalJSON ¶

func (s *CourseWork) UnmarshalJSON(data []byte) error

type CourseWorkChangesInfo ¶

CourseWorkChangesInfo: Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.

type CourseWorkChangesInfo struct {
    // CourseId: The `course_id` of the course to subscribe to work changes for.
    CourseId string `json:"courseId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseWorkChangesInfo) MarshalJSON ¶

func (s *CourseWorkChangesInfo) MarshalJSON() ([]byte, error)

type CourseWorkMaterial ¶

CourseWorkMaterial: Course work material created by a teacher for students of the course

type CourseWorkMaterial struct {
    // AlternateLink: Absolute link to this course work material in the Classroom
    // web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // AssigneeMode: Assignee mode of the course work material. If unspecified, the
    // default value is `ALL_STUDENTS`.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
    //   "ALL_STUDENTS" - All students can see the item. This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // CreationTime: Timestamp when this course work material was created.
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`
    // CreatorUserId: Identifier for the user that created the course work
    // material. Read-only.
    CreatorUserId string `json:"creatorUserId,omitempty"`
    // Description: Optional description of this course work material. The text
    // must be a valid UTF-8 string containing no more than 30,000 characters.
    Description string `json:"description,omitempty"`
    // Id: Classroom-assigned identifier of this course work material, unique per
    // course. Read-only.
    Id string `json:"id,omitempty"`
    // IndividualStudentsOptions: Identifiers of students with access to the course
    // work material. This field is set only if `assigneeMode` is
    // `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then
    // only students specified in this field can see the course work material.
    IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`
    // Materials: Additional materials. A course work material must have no more
    // than 20 material items.
    Materials []*Material `json:"materials,omitempty"`
    // ScheduledTime: Optional timestamp when this course work material is
    // scheduled to be published.
    ScheduledTime string `json:"scheduledTime,omitempty"`
    // State: Status of this course work material. If unspecified, the default
    // state is `DRAFT`.
    //
    // Possible values:
    //   "COURSEWORK_MATERIAL_STATE_UNSPECIFIED" - No state specified. This is
    // never returned.
    //   "PUBLISHED" - Status for course work material that has been published.
    // This is the default state.
    //   "DRAFT" - Status for a course work material that is not yet published.
    // Course work material in this state is visible only to course teachers and
    // domain administrators.
    //   "DELETED" - Status for course work material that was published but is now
    // deleted. Course work material in this state is visible only to course
    // teachers and domain administrators. Course work material in this state is
    // deleted after some time.
    State string `json:"state,omitempty"`
    // Title: Title of this course work material. The title must be a valid UTF-8
    // string containing between 1 and 3000 characters.
    Title string `json:"title,omitempty"`
    // TopicId: Identifier for the topic that this course work material is
    // associated with. Must match an existing topic in the course.
    TopicId string `json:"topicId,omitempty"`
    // UpdateTime: Timestamp of the most recent change to this course work
    // material. Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CourseWorkMaterial) MarshalJSON ¶

func (s *CourseWorkMaterial) MarshalJSON() ([]byte, error)

type CoursesAliasesCreateCall ¶

type CoursesAliasesCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAliasesCreateCall) Context ¶

func (c *CoursesAliasesCreateCall) Context(ctx context.Context) *CoursesAliasesCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesAliasesCreateCall) Do ¶

func (c *CoursesAliasesCreateCall) Do(opts ...googleapi.CallOption) (*CourseAlias, error)

Do executes the "classroom.courses.aliases.create" call. Any non-2xx status code is an error. Response headers are in either *CourseAlias.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAliasesCreateCall) Fields ¶

func (c *CoursesAliasesCreateCall) Fields(s ...googleapi.Field) *CoursesAliasesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAliasesCreateCall) Header ¶

func (c *CoursesAliasesCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesAliasesDeleteCall ¶

type CoursesAliasesDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAliasesDeleteCall) Context ¶

func (c *CoursesAliasesDeleteCall) Context(ctx context.Context) *CoursesAliasesDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesAliasesDeleteCall) Do ¶

func (c *CoursesAliasesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.aliases.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAliasesDeleteCall) Fields ¶

func (c *CoursesAliasesDeleteCall) Fields(s ...googleapi.Field) *CoursesAliasesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAliasesDeleteCall) Header ¶

func (c *CoursesAliasesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesAliasesListCall ¶

type CoursesAliasesListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAliasesListCall) Context ¶

func (c *CoursesAliasesListCall) Context(ctx context.Context) *CoursesAliasesListCall

Context sets the context to be used in this call's Do method.

func (*CoursesAliasesListCall) Do ¶

func (c *CoursesAliasesListCall) Do(opts ...googleapi.CallOption) (*ListCourseAliasesResponse, error)

Do executes the "classroom.courses.aliases.list" call. Any non-2xx status code is an error. Response headers are in either *ListCourseAliasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAliasesListCall) Fields ¶

func (c *CoursesAliasesListCall) Fields(s ...googleapi.Field) *CoursesAliasesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAliasesListCall) Header ¶

func (c *CoursesAliasesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesAliasesListCall) IfNoneMatch ¶

func (c *CoursesAliasesListCall) IfNoneMatch(entityTag string) *CoursesAliasesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesAliasesListCall) PageSize ¶

func (c *CoursesAliasesListCall) PageSize(pageSize int64) *CoursesAliasesListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesAliasesListCall) PageToken ¶

func (c *CoursesAliasesListCall) PageToken(pageToken string) *CoursesAliasesListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesAliasesListCall) Pages ¶

func (c *CoursesAliasesListCall) Pages(ctx context.Context, f func(*ListCourseAliasesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesAliasesService ¶

type CoursesAliasesService struct {
    // contains filtered or unexported fields
}

func NewCoursesAliasesService ¶

func NewCoursesAliasesService(s *Service) *CoursesAliasesService

func (*CoursesAliasesService) Create ¶

func (r *CoursesAliasesService) Create(courseId string, coursealias *CourseAlias) *CoursesAliasesCreateCall

Create: 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).

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

func (*CoursesAliasesService) Delete ¶

func (r *CoursesAliasesService) Delete(courseId string, aliasid string) *CoursesAliasesDeleteCall

Delete: Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `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 delete a domain-scoped alias).

• alias: Alias to delete. This may not be the Classroom-assigned identifier.
• courseId: Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.

func (*CoursesAliasesService) List ¶

func (r *CoursesAliasesService) List(courseId string) *CoursesAliasesListCall

List: 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.

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

type CoursesAnnouncementsCreateCall ¶

type CoursesAnnouncementsCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAnnouncementsCreateCall) Context ¶

func (c *CoursesAnnouncementsCreateCall) Context(ctx context.Context) *CoursesAnnouncementsCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesAnnouncementsCreateCall) Do ¶

func (c *CoursesAnnouncementsCreateCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.create" call. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsCreateCall) Fields ¶

func (c *CoursesAnnouncementsCreateCall) Fields(s ...googleapi.Field) *CoursesAnnouncementsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAnnouncementsCreateCall) Header ¶

func (c *CoursesAnnouncementsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesAnnouncementsDeleteCall ¶

type CoursesAnnouncementsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAnnouncementsDeleteCall) Context ¶

func (c *CoursesAnnouncementsDeleteCall) Context(ctx context.Context) *CoursesAnnouncementsDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesAnnouncementsDeleteCall) Do ¶

func (c *CoursesAnnouncementsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.announcements.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsDeleteCall) Fields ¶

func (c *CoursesAnnouncementsDeleteCall) Fields(s ...googleapi.Field) *CoursesAnnouncementsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAnnouncementsDeleteCall) Header ¶

func (c *CoursesAnnouncementsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesAnnouncementsGetCall ¶

type CoursesAnnouncementsGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAnnouncementsGetCall) Context ¶

func (c *CoursesAnnouncementsGetCall) Context(ctx context.Context) *CoursesAnnouncementsGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesAnnouncementsGetCall) Do ¶

func (c *CoursesAnnouncementsGetCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.get" call. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsGetCall) Fields ¶

func (c *CoursesAnnouncementsGetCall) Fields(s ...googleapi.Field) *CoursesAnnouncementsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAnnouncementsGetCall) Header ¶

func (c *CoursesAnnouncementsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesAnnouncementsGetCall) IfNoneMatch ¶

func (c *CoursesAnnouncementsGetCall) IfNoneMatch(entityTag string) *CoursesAnnouncementsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesAnnouncementsListCall ¶

type CoursesAnnouncementsListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAnnouncementsListCall) AnnouncementStates ¶

func (c *CoursesAnnouncementsListCall) AnnouncementStates(announcementStates ...string) *CoursesAnnouncementsListCall

AnnouncementStates sets the optional parameter "announcementStates": Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.

Possible values:

"ANNOUNCEMENT_STATE_UNSPECIFIED" - No state specified. This is never

returned.

"PUBLISHED" - Status for announcement that has been published. This is the

default state.

"DRAFT" - Status for an announcement that is not yet published.

Announcement in this state is visible only to course teachers and domain administrators.

"DELETED" - Status for announcement that was published but is now deleted.

Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time.

func (*CoursesAnnouncementsListCall) Context ¶

func (c *CoursesAnnouncementsListCall) Context(ctx context.Context) *CoursesAnnouncementsListCall

Context sets the context to be used in this call's Do method.

func (*CoursesAnnouncementsListCall) Do ¶

func (c *CoursesAnnouncementsListCall) Do(opts ...googleapi.CallOption) (*ListAnnouncementsResponse, error)

Do executes the "classroom.courses.announcements.list" call. Any non-2xx status code is an error. Response headers are in either *ListAnnouncementsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsListCall) Fields ¶

func (c *CoursesAnnouncementsListCall) Fields(s ...googleapi.Field) *CoursesAnnouncementsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAnnouncementsListCall) Header ¶

func (c *CoursesAnnouncementsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesAnnouncementsListCall) IfNoneMatch ¶

func (c *CoursesAnnouncementsListCall) IfNoneMatch(entityTag string) *CoursesAnnouncementsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesAnnouncementsListCall) OrderBy ¶

func (c *CoursesAnnouncementsListCall) OrderBy(orderBy string) *CoursesAnnouncementsListCall

OrderBy sets the optional parameter "orderBy": Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`

func (*CoursesAnnouncementsListCall) PageSize ¶

func (c *CoursesAnnouncementsListCall) PageSize(pageSize int64) *CoursesAnnouncementsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesAnnouncementsListCall) PageToken ¶

func (c *CoursesAnnouncementsListCall) PageToken(pageToken string) *CoursesAnnouncementsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesAnnouncementsListCall) Pages ¶

func (c *CoursesAnnouncementsListCall) Pages(ctx context.Context, f func(*ListAnnouncementsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesAnnouncementsModifyAssigneesCall ¶

type CoursesAnnouncementsModifyAssigneesCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAnnouncementsModifyAssigneesCall) Context ¶

func (c *CoursesAnnouncementsModifyAssigneesCall) Context(ctx context.Context) *CoursesAnnouncementsModifyAssigneesCall

Context sets the context to be used in this call's Do method.

func (*CoursesAnnouncementsModifyAssigneesCall) Do ¶

func (c *CoursesAnnouncementsModifyAssigneesCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.modifyAssignees" call. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsModifyAssigneesCall) Fields ¶

func (c *CoursesAnnouncementsModifyAssigneesCall) Fields(s ...googleapi.Field) *CoursesAnnouncementsModifyAssigneesCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAnnouncementsModifyAssigneesCall) Header ¶

func (c *CoursesAnnouncementsModifyAssigneesCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesAnnouncementsPatchCall ¶

type CoursesAnnouncementsPatchCall struct {
    // contains filtered or unexported fields
}

func (*CoursesAnnouncementsPatchCall) Context ¶

func (c *CoursesAnnouncementsPatchCall) Context(ctx context.Context) *CoursesAnnouncementsPatchCall

Context sets the context to be used in this call's Do method.

func (*CoursesAnnouncementsPatchCall) Do ¶

func (c *CoursesAnnouncementsPatchCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.patch" call. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsPatchCall) Fields ¶

func (c *CoursesAnnouncementsPatchCall) Fields(s ...googleapi.Field) *CoursesAnnouncementsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesAnnouncementsPatchCall) Header ¶

func (c *CoursesAnnouncementsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesAnnouncementsPatchCall) UpdateMask ¶

func (c *CoursesAnnouncementsPatchCall) UpdateMask(updateMask string) *CoursesAnnouncementsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`

type CoursesAnnouncementsService ¶

type CoursesAnnouncementsService struct {
    // contains filtered or unexported fields
}

func NewCoursesAnnouncementsService ¶

func NewCoursesAnnouncementsService(s *Service) *CoursesAnnouncementsService

func (*CoursesAnnouncementsService) Create ¶

func (r *CoursesAnnouncementsService) Create(courseId string, announcement *Announcement) *CoursesAnnouncementsCreateCall

Create: Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible

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

func (*CoursesAnnouncementsService) Delete ¶

func (r *CoursesAnnouncementsService) Delete(courseId string, id string) *CoursesAnnouncementsDeleteCall

Delete: Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.

func (*CoursesAnnouncementsService) Get ¶

func (r *CoursesAnnouncementsService) Get(courseId string, id string) *CoursesAnnouncementsGetCall

Get: Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the announcement.

func (*CoursesAnnouncementsService) List ¶

func (r *CoursesAnnouncementsService) List(courseId string) *CoursesAnnouncementsListCall

List: Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

func (*CoursesAnnouncementsService) ModifyAssignees ¶

func (r *CoursesAnnouncementsService) ModifyAssignees(courseId string, id string, modifyannouncementassigneesrequest *ModifyAnnouncementAssigneesRequest) *CoursesAnnouncementsModifyAssigneesCall

ModifyAssignees: Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the announcement.

func (*CoursesAnnouncementsService) Patch ¶

func (r *CoursesAnnouncementsService) Patch(courseId string, id string, announcement *Announcement) *CoursesAnnouncementsPatchCall

Patch: Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the announcement.

type CoursesCourseWorkCreateCall ¶

type CoursesCourseWorkCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkCreateCall) Context ¶

func (c *CoursesCourseWorkCreateCall) Context(ctx context.Context) *CoursesCourseWorkCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkCreateCall) Do ¶

func (c *CoursesCourseWorkCreateCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.create" call. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkCreateCall) Fields ¶

func (c *CoursesCourseWorkCreateCall) Fields(s ...googleapi.Field) *CoursesCourseWorkCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkCreateCall) Header ¶

func (c *CoursesCourseWorkCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkDeleteCall ¶

type CoursesCourseWorkDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkDeleteCall) Context ¶

func (c *CoursesCourseWorkDeleteCall) Context(ctx context.Context) *CoursesCourseWorkDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkDeleteCall) Do ¶

func (c *CoursesCourseWorkDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkDeleteCall) Fields ¶

func (c *CoursesCourseWorkDeleteCall) Fields(s ...googleapi.Field) *CoursesCourseWorkDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkDeleteCall) Header ¶

func (c *CoursesCourseWorkDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkGetCall ¶

type CoursesCourseWorkGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkGetCall) Context ¶

func (c *CoursesCourseWorkGetCall) Context(ctx context.Context) *CoursesCourseWorkGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkGetCall) Do ¶

func (c *CoursesCourseWorkGetCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.get" call. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkGetCall) Fields ¶

func (c *CoursesCourseWorkGetCall) Fields(s ...googleapi.Field) *CoursesCourseWorkGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkGetCall) Header ¶

func (c *CoursesCourseWorkGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkGetCall) IfNoneMatch ¶

func (c *CoursesCourseWorkGetCall) IfNoneMatch(entityTag string) *CoursesCourseWorkGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesCourseWorkListCall ¶

type CoursesCourseWorkListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkListCall) Context ¶

func (c *CoursesCourseWorkListCall) Context(ctx context.Context) *CoursesCourseWorkListCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkListCall) CourseWorkStates ¶

func (c *CoursesCourseWorkListCall) CourseWorkStates(courseWorkStates ...string) *CoursesCourseWorkListCall

CourseWorkStates sets the optional parameter "courseWorkStates": Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.

Possible values:

"COURSE_WORK_STATE_UNSPECIFIED" - No state specified. This is never

returned.

"PUBLISHED" - Status for work that has been published. This is the default

state.

"DRAFT" - Status for work that is not yet published. Work in this state is

visible only to course teachers and domain administrators.

"DELETED" - Status for work that was published but is now deleted. Work in

this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time.

func (*CoursesCourseWorkListCall) Do ¶

func (c *CoursesCourseWorkListCall) Do(opts ...googleapi.CallOption) (*ListCourseWorkResponse, error)

Do executes the "classroom.courses.courseWork.list" call. Any non-2xx status code is an error. Response headers are in either *ListCourseWorkResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkListCall) Fields ¶

func (c *CoursesCourseWorkListCall) Fields(s ...googleapi.Field) *CoursesCourseWorkListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkListCall) Header ¶

func (c *CoursesCourseWorkListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkListCall) IfNoneMatch ¶

func (c *CoursesCourseWorkListCall) IfNoneMatch(entityTag string) *CoursesCourseWorkListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesCourseWorkListCall) OrderBy ¶

func (c *CoursesCourseWorkListCall) OrderBy(orderBy string) *CoursesCourseWorkListCall

OrderBy sets the optional parameter "orderBy": Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`

func (*CoursesCourseWorkListCall) PageSize ¶

func (c *CoursesCourseWorkListCall) PageSize(pageSize int64) *CoursesCourseWorkListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesCourseWorkListCall) PageToken ¶

func (c *CoursesCourseWorkListCall) PageToken(pageToken string) *CoursesCourseWorkListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesCourseWorkListCall) Pages ¶

func (c *CoursesCourseWorkListCall) Pages(ctx context.Context, f func(*ListCourseWorkResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesCourseWorkMaterialsCreateCall ¶

type CoursesCourseWorkMaterialsCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkMaterialsCreateCall) Context ¶

func (c *CoursesCourseWorkMaterialsCreateCall) Context(ctx context.Context) *CoursesCourseWorkMaterialsCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkMaterialsCreateCall) Do ¶

func (c *CoursesCourseWorkMaterialsCreateCall) Do(opts ...googleapi.CallOption) (*CourseWorkMaterial, error)

Do executes the "classroom.courses.courseWorkMaterials.create" call. Any non-2xx status code is an error. Response headers are in either *CourseWorkMaterial.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsCreateCall) Fields ¶

func (c *CoursesCourseWorkMaterialsCreateCall) Fields(s ...googleapi.Field) *CoursesCourseWorkMaterialsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkMaterialsCreateCall) Header ¶

func (c *CoursesCourseWorkMaterialsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkMaterialsDeleteCall ¶

type CoursesCourseWorkMaterialsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkMaterialsDeleteCall) Context ¶

func (c *CoursesCourseWorkMaterialsDeleteCall) Context(ctx context.Context) *CoursesCourseWorkMaterialsDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkMaterialsDeleteCall) Do ¶

func (c *CoursesCourseWorkMaterialsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWorkMaterials.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsDeleteCall) Fields ¶

func (c *CoursesCourseWorkMaterialsDeleteCall) Fields(s ...googleapi.Field) *CoursesCourseWorkMaterialsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkMaterialsDeleteCall) Header ¶

func (c *CoursesCourseWorkMaterialsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkMaterialsGetCall ¶

type CoursesCourseWorkMaterialsGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkMaterialsGetCall) Context ¶

func (c *CoursesCourseWorkMaterialsGetCall) Context(ctx context.Context) *CoursesCourseWorkMaterialsGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkMaterialsGetCall) Do ¶

func (c *CoursesCourseWorkMaterialsGetCall) Do(opts ...googleapi.CallOption) (*CourseWorkMaterial, error)

Do executes the "classroom.courses.courseWorkMaterials.get" call. Any non-2xx status code is an error. Response headers are in either *CourseWorkMaterial.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsGetCall) Fields ¶

func (c *CoursesCourseWorkMaterialsGetCall) Fields(s ...googleapi.Field) *CoursesCourseWorkMaterialsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkMaterialsGetCall) Header ¶

func (c *CoursesCourseWorkMaterialsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkMaterialsGetCall) IfNoneMatch ¶

func (c *CoursesCourseWorkMaterialsGetCall) IfNoneMatch(entityTag string) *CoursesCourseWorkMaterialsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesCourseWorkMaterialsListCall ¶

type CoursesCourseWorkMaterialsListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkMaterialsListCall) Context ¶

func (c *CoursesCourseWorkMaterialsListCall) Context(ctx context.Context) *CoursesCourseWorkMaterialsListCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkMaterialsListCall) CourseWorkMaterialStates ¶

func (c *CoursesCourseWorkMaterialsListCall) CourseWorkMaterialStates(courseWorkMaterialStates ...string) *CoursesCourseWorkMaterialsListCall

CourseWorkMaterialStates sets the optional parameter "courseWorkMaterialStates": Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.

Possible values:

"COURSEWORK_MATERIAL_STATE_UNSPECIFIED" - No state specified. This is

never returned.

"PUBLISHED" - Status for course work material that has been published.

This is the default state.

"DRAFT" - Status for a course work material that is not yet published.

Course work material in this state is visible only to course teachers and domain administrators.

"DELETED" - Status for course work material that was published but is now

deleted. Course work material in this state is visible only to course teachers and domain administrators. Course work material in this state is deleted after some time.

func (*CoursesCourseWorkMaterialsListCall) Do ¶

func (c *CoursesCourseWorkMaterialsListCall) Do(opts ...googleapi.CallOption) (*ListCourseWorkMaterialResponse, error)

Do executes the "classroom.courses.courseWorkMaterials.list" call. Any non-2xx status code is an error. Response headers are in either *ListCourseWorkMaterialResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsListCall) Fields ¶

func (c *CoursesCourseWorkMaterialsListCall) Fields(s ...googleapi.Field) *CoursesCourseWorkMaterialsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkMaterialsListCall) Header ¶

func (c *CoursesCourseWorkMaterialsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkMaterialsListCall) IfNoneMatch ¶

func (c *CoursesCourseWorkMaterialsListCall) IfNoneMatch(entityTag string) *CoursesCourseWorkMaterialsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesCourseWorkMaterialsListCall) MaterialDriveId ¶

func (c *CoursesCourseWorkMaterialsListCall) MaterialDriveId(materialDriveId string) *CoursesCourseWorkMaterialsListCall

MaterialDriveId sets the optional parameter "materialDriveId": Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `material_link` is also specified, course work material must have materials matching both filters.

func (*CoursesCourseWorkMaterialsListCall) MaterialLink ¶

func (c *CoursesCourseWorkMaterialsListCall) MaterialLink(materialLink string) *CoursesCourseWorkMaterialsListCall

MaterialLink sets the optional parameter "materialLink": Optional filtering for course work material with at least one link material whose URL partially matches the provided string.

func (*CoursesCourseWorkMaterialsListCall) OrderBy ¶

func (c *CoursesCourseWorkMaterialsListCall) OrderBy(orderBy string) *CoursesCourseWorkMaterialsListCall

OrderBy sets the optional parameter "orderBy": Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`

func (*CoursesCourseWorkMaterialsListCall) PageSize ¶

func (c *CoursesCourseWorkMaterialsListCall) PageSize(pageSize int64) *CoursesCourseWorkMaterialsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesCourseWorkMaterialsListCall) PageToken ¶

func (c *CoursesCourseWorkMaterialsListCall) PageToken(pageToken string) *CoursesCourseWorkMaterialsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesCourseWorkMaterialsListCall) Pages ¶

func (c *CoursesCourseWorkMaterialsListCall) Pages(ctx context.Context, f func(*ListCourseWorkMaterialResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesCourseWorkMaterialsPatchCall ¶

type CoursesCourseWorkMaterialsPatchCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkMaterialsPatchCall) Context ¶

func (c *CoursesCourseWorkMaterialsPatchCall) Context(ctx context.Context) *CoursesCourseWorkMaterialsPatchCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkMaterialsPatchCall) Do ¶

func (c *CoursesCourseWorkMaterialsPatchCall) Do(opts ...googleapi.CallOption) (*CourseWorkMaterial, error)

Do executes the "classroom.courses.courseWorkMaterials.patch" call. Any non-2xx status code is an error. Response headers are in either *CourseWorkMaterial.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsPatchCall) Fields ¶

func (c *CoursesCourseWorkMaterialsPatchCall) Fields(s ...googleapi.Field) *CoursesCourseWorkMaterialsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkMaterialsPatchCall) Header ¶

func (c *CoursesCourseWorkMaterialsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkMaterialsPatchCall) UpdateMask ¶

func (c *CoursesCourseWorkMaterialsPatchCall) UpdateMask(updateMask string) *CoursesCourseWorkMaterialsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id`

type CoursesCourseWorkMaterialsService ¶

type CoursesCourseWorkMaterialsService struct {
    // contains filtered or unexported fields
}

func NewCoursesCourseWorkMaterialsService ¶

func NewCoursesCourseWorkMaterialsService(s *Service) *CoursesCourseWorkMaterialsService

func (*CoursesCourseWorkMaterialsService) Create ¶

func (r *CoursesCourseWorkMaterialsService) Create(courseId string, courseworkmaterial *CourseWorkMaterial) *CoursesCourseWorkMaterialsCreateCall

Create: Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible

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

func (*CoursesCourseWorkMaterialsService) Delete ¶

func (r *CoursesCourseWorkMaterialsService) Delete(courseId string, id string) *CoursesCourseWorkMaterialsDeleteCall

Delete: Deletes a course work material. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.

func (*CoursesCourseWorkMaterialsService) Get ¶

func (r *CoursesCourseWorkMaterialsService) Get(courseId string, id string) *CoursesCourseWorkMaterialsGetCall

Get: Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the course work material.

func (*CoursesCourseWorkMaterialsService) List ¶

func (r *CoursesCourseWorkMaterialsService) List(courseId string) *CoursesCourseWorkMaterialsListCall

List: Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

func (*CoursesCourseWorkMaterialsService) Patch ¶

func (r *CoursesCourseWorkMaterialsService) Patch(courseId string, id string, courseworkmaterial *CourseWorkMaterial) *CoursesCourseWorkMaterialsPatchCall

Patch: Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the course work material.

type CoursesCourseWorkModifyAssigneesCall ¶

type CoursesCourseWorkModifyAssigneesCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkModifyAssigneesCall) Context ¶

func (c *CoursesCourseWorkModifyAssigneesCall) Context(ctx context.Context) *CoursesCourseWorkModifyAssigneesCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkModifyAssigneesCall) Do ¶

func (c *CoursesCourseWorkModifyAssigneesCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.modifyAssignees" call. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkModifyAssigneesCall) Fields ¶

func (c *CoursesCourseWorkModifyAssigneesCall) Fields(s ...googleapi.Field) *CoursesCourseWorkModifyAssigneesCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkModifyAssigneesCall) Header ¶

func (c *CoursesCourseWorkModifyAssigneesCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkPatchCall ¶

type CoursesCourseWorkPatchCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkPatchCall) Context ¶

func (c *CoursesCourseWorkPatchCall) Context(ctx context.Context) *CoursesCourseWorkPatchCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkPatchCall) Do ¶

func (c *CoursesCourseWorkPatchCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.patch" call. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkPatchCall) Fields ¶

func (c *CoursesCourseWorkPatchCall) Fields(s ...googleapi.Field) *CoursesCourseWorkPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkPatchCall) Header ¶

func (c *CoursesCourseWorkPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkPatchCall) UpdateMask ¶

func (c *CoursesCourseWorkPatchCall) UpdateMask(updateMask string) *CoursesCourseWorkPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`

type CoursesCourseWorkService ¶

type CoursesCourseWorkService struct {
    StudentSubmissions *CoursesCourseWorkStudentSubmissionsService
    // contains filtered or unexported fields
}

func NewCoursesCourseWorkService ¶

func NewCoursesCourseWorkService(s *Service) *CoursesCourseWorkService

func (*CoursesCourseWorkService) Create ¶

func (r *CoursesCourseWorkService) Create(courseId string, coursework *CourseWork) *CoursesCourseWorkCreateCall

Create: Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible

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

func (*CoursesCourseWorkService) Delete ¶

func (r *CoursesCourseWorkService) Delete(courseId string, id string) *CoursesCourseWorkDeleteCall

Delete: Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.

func (*CoursesCourseWorkService) Get ¶

func (r *CoursesCourseWorkService) Get(courseId string, id string) *CoursesCourseWorkGetCall

Get: Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the course work.

func (*CoursesCourseWorkService) List ¶

func (r *CoursesCourseWorkService) List(courseId string) *CoursesCourseWorkListCall

List: Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

func (*CoursesCourseWorkService) ModifyAssignees ¶

func (r *CoursesCourseWorkService) ModifyAssignees(courseId string, id string, modifycourseworkassigneesrequest *ModifyCourseWorkAssigneesRequest) *CoursesCourseWorkModifyAssigneesCall

ModifyAssignees: Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the coursework.

func (*CoursesCourseWorkService) Patch ¶

func (r *CoursesCourseWorkService) Patch(courseId string, id string, coursework *CourseWork) *CoursesCourseWorkPatchCall

Patch: Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the course work.

type CoursesCourseWorkStudentSubmissionsGetCall ¶

type CoursesCourseWorkStudentSubmissionsGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsGetCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsGetCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Do(opts ...googleapi.CallOption) (*StudentSubmission, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.get" call. Any non-2xx status code is an error. Response headers are in either *StudentSubmission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsGetCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsGetCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkStudentSubmissionsGetCall) IfNoneMatch ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) IfNoneMatch(entityTag string) *CoursesCourseWorkStudentSubmissionsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesCourseWorkStudentSubmissionsListCall ¶

type CoursesCourseWorkStudentSubmissionsListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsListCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsListCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsListCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Do(opts ...googleapi.CallOption) (*ListStudentSubmissionsResponse, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.list" call. Any non-2xx status code is an error. Response headers are in either *ListStudentSubmissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsListCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsListCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkStudentSubmissionsListCall) IfNoneMatch ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) IfNoneMatch(entityTag string) *CoursesCourseWorkStudentSubmissionsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesCourseWorkStudentSubmissionsListCall) Late ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Late(late string) *CoursesCourseWorkStudentSubmissionsListCall

Late sets the optional parameter "late": Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.

Possible values:

"LATE_VALUES_UNSPECIFIED" - No restriction on submission late values

specified.

"LATE_ONLY" - Return StudentSubmissions where late is true.
"NOT_LATE_ONLY" - Return StudentSubmissions where late is false.

func (*CoursesCourseWorkStudentSubmissionsListCall) PageSize ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) PageSize(pageSize int64) *CoursesCourseWorkStudentSubmissionsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesCourseWorkStudentSubmissionsListCall) PageToken ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) PageToken(pageToken string) *CoursesCourseWorkStudentSubmissionsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesCourseWorkStudentSubmissionsListCall) Pages ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Pages(ctx context.Context, f func(*ListStudentSubmissionsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*CoursesCourseWorkStudentSubmissionsListCall) States ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) States(states ...string) *CoursesCourseWorkStudentSubmissionsListCall

States sets the optional parameter "states": Requested submission states. If specified, returned student submissions match one of the specified submission states.

Possible values:

"SUBMISSION_STATE_UNSPECIFIED" - No state specified. This should never be

returned.

"NEW" - The student has never accessed this submission. Attachments are

not returned and timestamps is not set.

"CREATED" - Has been created.
"TURNED_IN" - Has been turned in to the teacher.
"RETURNED" - Has been returned to the student.
"RECLAIMED_BY_STUDENT" - Student chose to "unsubmit" the assignment.

func (*CoursesCourseWorkStudentSubmissionsListCall) UserId ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) UserId(userId string) *CoursesCourseWorkStudentSubmissionsListCall

UserId sets the optional parameter "userId": Optional argument to restrict returned student work to those owned by the student with the specified identifier. 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

type CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall ¶

type CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Do(opts ...googleapi.CallOption) (*StudentSubmission, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.modifyAttachments" call. Any non-2xx status code is an error. Response headers are in either *StudentSubmission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkStudentSubmissionsPatchCall ¶

type CoursesCourseWorkStudentSubmissionsPatchCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsPatchCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Do(opts ...googleapi.CallOption) (*StudentSubmission, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.patch" call. Any non-2xx status code is an error. Response headers are in either *StudentSubmission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) UpdateMask ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) UpdateMask(updateMask string) *CoursesCourseWorkStudentSubmissionsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`

type CoursesCourseWorkStudentSubmissionsReclaimCall ¶

type CoursesCourseWorkStudentSubmissionsReclaimCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsReclaimCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.reclaim" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsReclaimCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkStudentSubmissionsReturnCall ¶

type CoursesCourseWorkStudentSubmissionsReturnCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsReturnCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.return" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsReturnCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCourseWorkStudentSubmissionsService ¶

type CoursesCourseWorkStudentSubmissionsService struct {
    // contains filtered or unexported fields
}

func NewCoursesCourseWorkStudentSubmissionsService ¶

func NewCoursesCourseWorkStudentSubmissionsService(s *Service) *CoursesCourseWorkStudentSubmissionsService

func (*CoursesCourseWorkStudentSubmissionsService) Get ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Get(courseId string, courseWorkId string, id string) *CoursesCourseWorkStudentSubmissionsGetCall

Get: Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the course work.
• id: Identifier of the student submission.

func (*CoursesCourseWorkStudentSubmissionsService) List ¶

func (r *CoursesCourseWorkStudentSubmissionsService) List(courseId string, courseWorkId string) *CoursesCourseWorkStudentSubmissionsListCall

List: Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the student work to request. This may be set to the string literal "-" to request student work for all course work in the specified course.

func (*CoursesCourseWorkStudentSubmissionsService) ModifyAttachments ¶

func (r *CoursesCourseWorkStudentSubmissionsService) ModifyAttachments(courseId string, courseWorkId string, id string, modifyattachmentsrequest *ModifyAttachmentsRequest) *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall

ModifyAttachments: Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the course work.
• id: Identifier of the student submission.

func (*CoursesCourseWorkStudentSubmissionsService) Patch ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Patch(courseId string, courseWorkId string, id string, studentsubmission *StudentSubmission) *CoursesCourseWorkStudentSubmissionsPatchCall

Patch: Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the course work.
• id: Identifier of the student submission.

func (*CoursesCourseWorkStudentSubmissionsService) Reclaim ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Reclaim(courseId string, courseWorkId string, id string, reclaimstudentsubmissionrequest *ReclaimStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsReclaimCall

Reclaim: Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the course work.
• id: Identifier of the student submission.

func (*CoursesCourseWorkStudentSubmissionsService) Return ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Return(courseId string, courseWorkId string, id string, returnstudentsubmissionrequest *ReturnStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsReturnCall

Return: Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the course work.
• id: Identifier of the student submission.

func (*CoursesCourseWorkStudentSubmissionsService) TurnIn ¶

func (r *CoursesCourseWorkStudentSubmissionsService) TurnIn(courseId string, courseWorkId string, id string, turninstudentsubmissionrequest *TurnInStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsTurnInCall

TurnIn: Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the OAuth client ID (https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• courseWorkId: Identifier of the course work.
• id: Identifier of the student submission.

type CoursesCourseWorkStudentSubmissionsTurnInCall ¶

type CoursesCourseWorkStudentSubmissionsTurnInCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Context ¶

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsTurnInCall

Context sets the context to be used in this call's Do method.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Do ¶

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.turnIn" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Fields ¶

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Fields(s ...googleapi.Field) *CoursesCourseWorkStudentSubmissionsTurnInCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Header ¶

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesCreateCall ¶

type CoursesCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesCreateCall) Context ¶

func (c *CoursesCreateCall) Context(ctx context.Context) *CoursesCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesCreateCall) Do ¶

func (c *CoursesCreateCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.create" call. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCreateCall) Fields ¶

func (c *CoursesCreateCall) Fields(s ...googleapi.Field) *CoursesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesCreateCall) Header ¶

func (c *CoursesCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesDeleteCall ¶

type CoursesDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesDeleteCall) Context ¶

func (c *CoursesDeleteCall) Context(ctx context.Context) *CoursesDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesDeleteCall) Do ¶

func (c *CoursesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesDeleteCall) Fields ¶

func (c *CoursesDeleteCall) Fields(s ...googleapi.Field) *CoursesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesDeleteCall) Header ¶

func (c *CoursesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesGetCall ¶

type CoursesGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesGetCall) Context ¶

func (c *CoursesGetCall) Context(ctx context.Context) *CoursesGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesGetCall) Do ¶

func (c *CoursesGetCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.get" call. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesGetCall) Fields ¶

func (c *CoursesGetCall) Fields(s ...googleapi.Field) *CoursesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesGetCall) Header ¶

func (c *CoursesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesGetCall) IfNoneMatch ¶

func (c *CoursesGetCall) IfNoneMatch(entityTag string) *CoursesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesListCall ¶

type CoursesListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesListCall) Context ¶

func (c *CoursesListCall) Context(ctx context.Context) *CoursesListCall

Context sets the context to be used in this call's Do method.

func (*CoursesListCall) CourseStates ¶

func (c *CoursesListCall) CourseStates(courseStates ...string) *CoursesListCall

CourseStates sets the optional parameter "courseStates": Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

Possible values:

"COURSE_STATE_UNSPECIFIED" - No course state. No returned Course message

will use this value.

"ACTIVE" - The course is active.
"ARCHIVED" - The course has been archived. You cannot modify it except to

change it to a different state.

"PROVISIONED" - The course has been created, but not yet activated. It is

accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.

"DECLINED" - The course has been created, but declined. It is accessible

by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.

"SUSPENDED" - The course has been suspended. You cannot modify the course,

and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service.

func (*CoursesListCall) Do ¶

func (c *CoursesListCall) Do(opts ...googleapi.CallOption) (*ListCoursesResponse, error)

Do executes the "classroom.courses.list" call. Any non-2xx status code is an error. Response headers are in either *ListCoursesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesListCall) Fields ¶

func (c *CoursesListCall) Fields(s ...googleapi.Field) *CoursesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesListCall) Header ¶

func (c *CoursesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesListCall) IfNoneMatch ¶

func (c *CoursesListCall) IfNoneMatch(entityTag string) *CoursesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesListCall) PageSize ¶

func (c *CoursesListCall) PageSize(pageSize int64) *CoursesListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesListCall) PageToken ¶

func (c *CoursesListCall) PageToken(pageToken string) *CoursesListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesListCall) Pages ¶

func (c *CoursesListCall) Pages(ctx context.Context, f func(*ListCoursesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*CoursesListCall) StudentId ¶

func (c *CoursesListCall) StudentId(studentId string) *CoursesListCall

StudentId sets the optional parameter "studentId": Restricts returned courses to those having a student with the specified identifier. 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

func (*CoursesListCall) TeacherId ¶

func (c *CoursesListCall) TeacherId(teacherId string) *CoursesListCall

TeacherId sets the optional parameter "teacherId": Restricts returned courses to those having a teacher with the specified identifier. 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

type CoursesPatchCall ¶

type CoursesPatchCall struct {
    // contains filtered or unexported fields
}

func (*CoursesPatchCall) Context ¶

func (c *CoursesPatchCall) Context(ctx context.Context) *CoursesPatchCall

Context sets the context to be used in this call's Do method.

func (*CoursesPatchCall) Do ¶

func (c *CoursesPatchCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.patch" call. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesPatchCall) Fields ¶

func (c *CoursesPatchCall) Fields(s ...googleapi.Field) *CoursesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesPatchCall) Header ¶

func (c *CoursesPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesPatchCall) UpdateMask ¶

func (c *CoursesPatchCall) UpdateMask(updateMask string) *CoursesPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`

type CoursesService ¶

type CoursesService struct {
    Aliases *CoursesAliasesService

    Announcements *CoursesAnnouncementsService

    CourseWork *CoursesCourseWorkService

    CourseWorkMaterials *CoursesCourseWorkMaterialsService

    Students *CoursesStudentsService

    Teachers *CoursesTeachersService

    Topics *CoursesTopicsService
    // contains filtered or unexported fields
}

func NewCoursesService ¶

func NewCoursesService(s *Service) *CoursesService

func (*CoursesService) Create ¶

func (r *CoursesService) Create(course *Course) *CoursesCreateCall

Create: Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.

func (*CoursesService) Delete ¶

func (r *CoursesService) Delete(id string) *CoursesDeleteCall

Delete: Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

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

func (*CoursesService) Get ¶

func (r *CoursesService) Get(id string) *CoursesGetCall

Get: Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

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

func (*CoursesService) List ¶

func (r *CoursesService) List() *CoursesListCall

List: Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

func (*CoursesService) Patch ¶

func (r *CoursesService) Patch(id string, course *Course) *CoursesPatchCall

Patch: Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * InactiveCourseOwner * IneligibleOwner

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

func (*CoursesService) Update ¶

func (r *CoursesService) Update(id string, course *Course) *CoursesUpdateCall

Update: Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

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

type CoursesStudentsCreateCall ¶

type CoursesStudentsCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesStudentsCreateCall) Context ¶

func (c *CoursesStudentsCreateCall) Context(ctx context.Context) *CoursesStudentsCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesStudentsCreateCall) Do ¶

func (c *CoursesStudentsCreateCall) Do(opts ...googleapi.CallOption) (*Student, error)

Do executes the "classroom.courses.students.create" call. Any non-2xx status code is an error. Response headers are in either *Student.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsCreateCall) EnrollmentCode ¶

func (c *CoursesStudentsCreateCall) EnrollmentCode(enrollmentCode string) *CoursesStudentsCreateCall

EnrollmentCode sets the optional parameter "enrollmentCode": Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.

func (*CoursesStudentsCreateCall) Fields ¶

func (c *CoursesStudentsCreateCall) Fields(s ...googleapi.Field) *CoursesStudentsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesStudentsCreateCall) Header ¶

func (c *CoursesStudentsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesStudentsDeleteCall ¶

type CoursesStudentsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesStudentsDeleteCall) Context ¶

func (c *CoursesStudentsDeleteCall) Context(ctx context.Context) *CoursesStudentsDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesStudentsDeleteCall) Do ¶

func (c *CoursesStudentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.students.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsDeleteCall) Fields ¶

func (c *CoursesStudentsDeleteCall) Fields(s ...googleapi.Field) *CoursesStudentsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesStudentsDeleteCall) Header ¶

func (c *CoursesStudentsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesStudentsGetCall ¶

type CoursesStudentsGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesStudentsGetCall) Context ¶

func (c *CoursesStudentsGetCall) Context(ctx context.Context) *CoursesStudentsGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesStudentsGetCall) Do ¶

func (c *CoursesStudentsGetCall) Do(opts ...googleapi.CallOption) (*Student, error)

Do executes the "classroom.courses.students.get" call. Any non-2xx status code is an error. Response headers are in either *Student.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsGetCall) Fields ¶

func (c *CoursesStudentsGetCall) Fields(s ...googleapi.Field) *CoursesStudentsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesStudentsGetCall) Header ¶

func (c *CoursesStudentsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesStudentsGetCall) IfNoneMatch ¶

func (c *CoursesStudentsGetCall) IfNoneMatch(entityTag string) *CoursesStudentsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesStudentsListCall ¶

type CoursesStudentsListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesStudentsListCall) Context ¶

func (c *CoursesStudentsListCall) Context(ctx context.Context) *CoursesStudentsListCall

Context sets the context to be used in this call's Do method.

func (*CoursesStudentsListCall) Do ¶

func (c *CoursesStudentsListCall) Do(opts ...googleapi.CallOption) (*ListStudentsResponse, error)

Do executes the "classroom.courses.students.list" call. Any non-2xx status code is an error. Response headers are in either *ListStudentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsListCall) Fields ¶

func (c *CoursesStudentsListCall) Fields(s ...googleapi.Field) *CoursesStudentsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesStudentsListCall) Header ¶

func (c *CoursesStudentsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesStudentsListCall) IfNoneMatch ¶

func (c *CoursesStudentsListCall) IfNoneMatch(entityTag string) *CoursesStudentsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesStudentsListCall) PageSize ¶

func (c *CoursesStudentsListCall) PageSize(pageSize int64) *CoursesStudentsListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.

func (*CoursesStudentsListCall) PageToken ¶

func (c *CoursesStudentsListCall) PageToken(pageToken string) *CoursesStudentsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesStudentsListCall) Pages ¶

func (c *CoursesStudentsListCall) Pages(ctx context.Context, f func(*ListStudentsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesStudentsService ¶

type CoursesStudentsService struct {
    // contains filtered or unexported fields
}

func NewCoursesStudentsService ¶

func NewCoursesStudentsService(s *Service) *CoursesStudentsService

func (*CoursesStudentsService) Create ¶

func (r *CoursesStudentsService) Create(courseId string, student *Student) *CoursesStudentsCreateCall

Create: Adds a user as a student of a course. Domain administrators are permitted to directly add (https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.

• courseId: Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.

func (*CoursesStudentsService) Delete ¶

func (r *CoursesStudentsService) Delete(courseId string, userId string) *CoursesStudentsDeleteCall

Delete: Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• userId: Identifier of the student to delete. 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.

func (*CoursesStudentsService) Get ¶

func (r *CoursesStudentsService) Get(courseId string, userId string) *CoursesStudentsGetCall

Get: Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• userId: Identifier of the student to return. 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.

func (*CoursesStudentsService) List ¶

func (r *CoursesStudentsService) List(courseId string) *CoursesStudentsListCall

List: Returns a list of students 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.

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

type CoursesTeachersCreateCall ¶

type CoursesTeachersCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTeachersCreateCall) Context ¶

func (c *CoursesTeachersCreateCall) Context(ctx context.Context) *CoursesTeachersCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesTeachersCreateCall) Do ¶

func (c *CoursesTeachersCreateCall) Do(opts ...googleapi.CallOption) (*Teacher, error)

Do executes the "classroom.courses.teachers.create" call. Any non-2xx status code is an error. Response headers are in either *Teacher.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersCreateCall) Fields ¶

func (c *CoursesTeachersCreateCall) Fields(s ...googleapi.Field) *CoursesTeachersCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTeachersCreateCall) Header ¶

func (c *CoursesTeachersCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesTeachersDeleteCall ¶

type CoursesTeachersDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTeachersDeleteCall) Context ¶

func (c *CoursesTeachersDeleteCall) Context(ctx context.Context) *CoursesTeachersDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesTeachersDeleteCall) Do ¶

func (c *CoursesTeachersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.teachers.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersDeleteCall) Fields ¶

func (c *CoursesTeachersDeleteCall) Fields(s ...googleapi.Field) *CoursesTeachersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTeachersDeleteCall) Header ¶

func (c *CoursesTeachersDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesTeachersGetCall ¶

type CoursesTeachersGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTeachersGetCall) Context ¶

func (c *CoursesTeachersGetCall) Context(ctx context.Context) *CoursesTeachersGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesTeachersGetCall) Do ¶

func (c *CoursesTeachersGetCall) Do(opts ...googleapi.CallOption) (*Teacher, error)

Do executes the "classroom.courses.teachers.get" call. Any non-2xx status code is an error. Response headers are in either *Teacher.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersGetCall) Fields ¶

func (c *CoursesTeachersGetCall) Fields(s ...googleapi.Field) *CoursesTeachersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTeachersGetCall) Header ¶

func (c *CoursesTeachersGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesTeachersGetCall) IfNoneMatch ¶

func (c *CoursesTeachersGetCall) IfNoneMatch(entityTag string) *CoursesTeachersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesTeachersListCall ¶

type CoursesTeachersListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTeachersListCall) Context ¶

func (c *CoursesTeachersListCall) Context(ctx context.Context) *CoursesTeachersListCall

Context sets the context to be used in this call's Do method.

func (*CoursesTeachersListCall) Do ¶

func (c *CoursesTeachersListCall) Do(opts ...googleapi.CallOption) (*ListTeachersResponse, error)

Do executes the "classroom.courses.teachers.list" call. Any non-2xx status code is an error. Response headers are in either *ListTeachersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersListCall) Fields ¶

func (c *CoursesTeachersListCall) Fields(s ...googleapi.Field) *CoursesTeachersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTeachersListCall) Header ¶

func (c *CoursesTeachersListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesTeachersListCall) IfNoneMatch ¶

func (c *CoursesTeachersListCall) IfNoneMatch(entityTag string) *CoursesTeachersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesTeachersListCall) PageSize ¶

func (c *CoursesTeachersListCall) PageSize(pageSize int64) *CoursesTeachersListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.

func (*CoursesTeachersListCall) PageToken ¶

func (c *CoursesTeachersListCall) PageToken(pageToken string) *CoursesTeachersListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesTeachersListCall) Pages ¶

func (c *CoursesTeachersListCall) Pages(ctx context.Context, f func(*ListTeachersResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesTeachersService ¶

type CoursesTeachersService struct {
    // contains filtered or unexported fields
}

func NewCoursesTeachersService ¶

func NewCoursesTeachersService(s *Service) *CoursesTeachersService

func (*CoursesTeachersService) Create ¶

func (r *CoursesTeachersService) Create(courseId string, teacher *Teacher) *CoursesTeachersCreateCall

Create: Creates a teacher of a course. Domain administrators are permitted to directly add (https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

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

func (*CoursesTeachersService) Delete ¶

func (r *CoursesTeachersService) Delete(courseId string, userId string) *CoursesTeachersDeleteCall

Delete: Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• userId: Identifier of the teacher to delete. 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.

func (*CoursesTeachersService) Get ¶

func (r *CoursesTeachersService) Get(courseId string, userId string) *CoursesTeachersGetCall

Get: Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• userId: Identifier of the teacher to return. 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.

func (*CoursesTeachersService) List ¶

func (r *CoursesTeachersService) List(courseId string) *CoursesTeachersListCall

List: 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.

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

type CoursesTopicsCreateCall ¶

type CoursesTopicsCreateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTopicsCreateCall) Context ¶

func (c *CoursesTopicsCreateCall) Context(ctx context.Context) *CoursesTopicsCreateCall

Context sets the context to be used in this call's Do method.

func (*CoursesTopicsCreateCall) Do ¶

func (c *CoursesTopicsCreateCall) Do(opts ...googleapi.CallOption) (*Topic, error)

Do executes the "classroom.courses.topics.create" call. Any non-2xx status code is an error. Response headers are in either *Topic.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsCreateCall) Fields ¶

func (c *CoursesTopicsCreateCall) Fields(s ...googleapi.Field) *CoursesTopicsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTopicsCreateCall) Header ¶

func (c *CoursesTopicsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesTopicsDeleteCall ¶

type CoursesTopicsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTopicsDeleteCall) Context ¶

func (c *CoursesTopicsDeleteCall) Context(ctx context.Context) *CoursesTopicsDeleteCall

Context sets the context to be used in this call's Do method.

func (*CoursesTopicsDeleteCall) Do ¶

func (c *CoursesTopicsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.topics.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsDeleteCall) Fields ¶

func (c *CoursesTopicsDeleteCall) Fields(s ...googleapi.Field) *CoursesTopicsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTopicsDeleteCall) Header ¶

func (c *CoursesTopicsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type CoursesTopicsGetCall ¶

type CoursesTopicsGetCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTopicsGetCall) Context ¶

func (c *CoursesTopicsGetCall) Context(ctx context.Context) *CoursesTopicsGetCall

Context sets the context to be used in this call's Do method.

func (*CoursesTopicsGetCall) Do ¶

func (c *CoursesTopicsGetCall) Do(opts ...googleapi.CallOption) (*Topic, error)

Do executes the "classroom.courses.topics.get" call. Any non-2xx status code is an error. Response headers are in either *Topic.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsGetCall) Fields ¶

func (c *CoursesTopicsGetCall) Fields(s ...googleapi.Field) *CoursesTopicsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTopicsGetCall) Header ¶

func (c *CoursesTopicsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesTopicsGetCall) IfNoneMatch ¶

func (c *CoursesTopicsGetCall) IfNoneMatch(entityTag string) *CoursesTopicsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type CoursesTopicsListCall ¶

type CoursesTopicsListCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTopicsListCall) Context ¶

func (c *CoursesTopicsListCall) Context(ctx context.Context) *CoursesTopicsListCall

Context sets the context to be used in this call's Do method.

func (*CoursesTopicsListCall) Do ¶

func (c *CoursesTopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicResponse, error)

Do executes the "classroom.courses.topics.list" call. Any non-2xx status code is an error. Response headers are in either *ListTopicResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsListCall) Fields ¶

func (c *CoursesTopicsListCall) Fields(s ...googleapi.Field) *CoursesTopicsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTopicsListCall) Header ¶

func (c *CoursesTopicsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesTopicsListCall) IfNoneMatch ¶

func (c *CoursesTopicsListCall) IfNoneMatch(entityTag string) *CoursesTopicsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*CoursesTopicsListCall) PageSize ¶

func (c *CoursesTopicsListCall) PageSize(pageSize int64) *CoursesTopicsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*CoursesTopicsListCall) PageToken ¶

func (c *CoursesTopicsListCall) PageToken(pageToken string) *CoursesTopicsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*CoursesTopicsListCall) Pages ¶

func (c *CoursesTopicsListCall) Pages(ctx context.Context, f func(*ListTopicResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesTopicsPatchCall ¶

type CoursesTopicsPatchCall struct {
    // contains filtered or unexported fields
}

func (*CoursesTopicsPatchCall) Context ¶

func (c *CoursesTopicsPatchCall) Context(ctx context.Context) *CoursesTopicsPatchCall

Context sets the context to be used in this call's Do method.

func (*CoursesTopicsPatchCall) Do ¶

func (c *CoursesTopicsPatchCall) Do(opts ...googleapi.CallOption) (*Topic, error)

Do executes the "classroom.courses.topics.patch" call. Any non-2xx status code is an error. Response headers are in either *Topic.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsPatchCall) Fields ¶

func (c *CoursesTopicsPatchCall) Fields(s ...googleapi.Field) *CoursesTopicsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesTopicsPatchCall) Header ¶

func (c *CoursesTopicsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*CoursesTopicsPatchCall) UpdateMask ¶

func (c *CoursesTopicsPatchCall) UpdateMask(updateMask string) *CoursesTopicsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name`

type CoursesTopicsService ¶

type CoursesTopicsService struct {
    // contains filtered or unexported fields
}

func NewCoursesTopicsService ¶

func NewCoursesTopicsService(s *Service) *CoursesTopicsService

func (*CoursesTopicsService) Create ¶

func (r *CoursesTopicsService) Create(courseId string, topic *Topic) *CoursesTopicsCreateCall

Create: Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

func (*CoursesTopicsService) Delete ¶

func (r *CoursesTopicsService) Delete(courseId string, id string) *CoursesTopicsDeleteCall

Delete: Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the topic to delete.

func (*CoursesTopicsService) Get ¶

func (r *CoursesTopicsService) Get(courseId string, id string) *CoursesTopicsGetCall

Get: Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.

- courseId: Identifier of the course. - id: Identifier of the topic.

func (*CoursesTopicsService) List ¶

func (r *CoursesTopicsService) List(courseId string) *CoursesTopicsListCall

List: Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

func (*CoursesTopicsService) Patch ¶

func (r *CoursesTopicsService) Patch(courseId string, id string, topic *Topic) *CoursesTopicsPatchCall

Patch: Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist

• courseId: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
• id: Identifier of the topic.

type CoursesUpdateCall ¶

type CoursesUpdateCall struct {
    // contains filtered or unexported fields
}

func (*CoursesUpdateCall) Context ¶

func (c *CoursesUpdateCall) Context(ctx context.Context) *CoursesUpdateCall

Context sets the context to be used in this call's Do method.

func (*CoursesUpdateCall) Do ¶

func (c *CoursesUpdateCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.update" call. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesUpdateCall) Fields ¶

func (c *CoursesUpdateCall) Fields(s ...googleapi.Field) *CoursesUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*CoursesUpdateCall) Header ¶

func (c *CoursesUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type Date ¶

Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

type Date struct {
    // Day: Day of a month. Must be from 1 to 31 and valid for the year and month,
    // or 0 to specify a year by itself or a year and month where the day isn't
    // significant.
    Day int64 `json:"day,omitempty"`
    // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without
    // a month and day.
    Month int64 `json:"month,omitempty"`
    // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
    // without a year.
    Year int64 `json:"year,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Day") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Day") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Date) MarshalJSON ¶

func (s *Date) MarshalJSON() ([]byte, error)

type DriveFile ¶

DriveFile: Representation of a Google Drive file.

type DriveFile struct {
    // AlternateLink: URL that can be used to access the Drive item. Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // Id: Drive API resource ID.
    Id string `json:"id,omitempty"`
    // ThumbnailUrl: URL of a thumbnail image of the Drive item. Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`
    // Title: Title of the Drive item. Read-only.
    Title string `json:"title,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DriveFile) MarshalJSON ¶

func (s *DriveFile) MarshalJSON() ([]byte, error)

type DriveFolder ¶

DriveFolder: Representation of a Google Drive folder.

type DriveFolder struct {
    // AlternateLink: URL that can be used to access the Drive folder. Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // Id: Drive API resource ID.
    Id string `json:"id,omitempty"`
    // Title: Title of the Drive folder. Read-only.
    Title string `json:"title,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DriveFolder) MarshalJSON ¶

func (s *DriveFolder) MarshalJSON() ([]byte, error)

type Empty ¶

Empty: 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); }

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
}

type Feed ¶

Feed: A class of notifications that an application can register to receive. For example: "all roster changes for a domain".

type Feed struct {
    // CourseRosterChangesInfo: Information about a `Feed` with a `feed_type` of
    // `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is
    // `COURSE_ROSTER_CHANGES`.
    CourseRosterChangesInfo *CourseRosterChangesInfo `json:"courseRosterChangesInfo,omitempty"`
    // CourseWorkChangesInfo: Information about a `Feed` with a `feed_type` of
    // `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is
    // `COURSE_WORK_CHANGES`.
    CourseWorkChangesInfo *CourseWorkChangesInfo `json:"courseWorkChangesInfo,omitempty"`
    // FeedType: The type of feed.
    //
    // Possible values:
    //   "FEED_TYPE_UNSPECIFIED" - Should never be returned or provided.
    //   "DOMAIN_ROSTER_CHANGES" - All roster changes for a particular domain.
    // Notifications will be generated whenever a user joins or leaves a course. No
    // notifications will be generated when an invitation is created or deleted,
    // but notifications will be generated when a user joins a course by accepting
    // an invitation.
    //   "COURSE_ROSTER_CHANGES" - All roster changes for a particular course.
    // Notifications will be generated whenever a user joins or leaves a course. No
    // notifications will be generated when an invitation is created or deleted,
    // but notifications will be generated when a user joins a course by accepting
    // an invitation.
    //   "COURSE_WORK_CHANGES" - All course work activity for a particular course.
    // Notifications will be generated when a CourseWork or StudentSubmission
    // object is created or modified. No notification will be generated when a
    // StudentSubmission object is created in connection with the creation or
    // modification of its parent CourseWork object (but a notification will be
    // generated for that CourseWork object's creation or modification).
    FeedType string `json:"feedType,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CourseRosterChangesInfo") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseRosterChangesInfo") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Feed) MarshalJSON ¶

func (s *Feed) MarshalJSON() ([]byte, error)

type Form ¶

Form: Google Forms item.

type Form struct {
    // FormUrl: URL of the form.
    FormUrl string `json:"formUrl,omitempty"`
    // ResponseUrl: URL of the form responses document. Only set if responses have
    // been recorded and only when the requesting user is an editor of the form.
    // Read-only.
    ResponseUrl string `json:"responseUrl,omitempty"`
    // ThumbnailUrl: URL of a thumbnail image of the Form. Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`
    // Title: Title of the Form. Read-only.
    Title string `json:"title,omitempty"`
    // ForceSendFields is a list of field names (e.g. "FormUrl") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "FormUrl") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Form) MarshalJSON ¶

func (s *Form) MarshalJSON() ([]byte, error)

type GlobalPermission ¶

GlobalPermission: Global user permission description.

type GlobalPermission struct {
    // Permission: Permission value.
    //
    // Possible values:
    //   "PERMISSION_UNSPECIFIED" - No permission is specified. This is not
    // returned and is not a valid value.
    //   "CREATE_COURSE" - User is permitted to create a course.
    Permission string `json:"permission,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Permission") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Permission") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GlobalPermission) MarshalJSON ¶

func (s *GlobalPermission) MarshalJSON() ([]byte, error)

type GradeCategory ¶

GradeCategory: Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the help center article (https://support.google.com/edu/classroom/answer/9184995) for details.

type GradeCategory struct {
    // DefaultGradeDenominator: Default value of denominator. Only applicable when
    // grade calculation type is TOTAL_POINTS.
    DefaultGradeDenominator int64 `json:"defaultGradeDenominator,omitempty"`
    // Id: ID of the grade category.
    Id string `json:"id,omitempty"`
    // Name: Name of the grade category.
    Name string `json:"name,omitempty"`
    // Weight: The weight of the category average as part of overall average. A
    // weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two
    // digits should always be zero since we use two decimal precision. Only
    // applicable when grade calculation type is WEIGHTED_CATEGORIES.
    Weight int64 `json:"weight,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DefaultGradeDenominator") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DefaultGradeDenominator") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GradeCategory) MarshalJSON ¶

func (s *GradeCategory) MarshalJSON() ([]byte, error)

type GradeHistory ¶

GradeHistory: The history of each grade on this submission.

type GradeHistory struct {
    // ActorUserId: The teacher who made the grade change.
    ActorUserId string `json:"actorUserId,omitempty"`
    // GradeChangeType: The type of grade change at this time in the submission
    // grade history.
    //
    // Possible values:
    //   "UNKNOWN_GRADE_CHANGE_TYPE" - No grade change type specified. This should
    // never be returned.
    //   "DRAFT_GRADE_POINTS_EARNED_CHANGE" - A change in the numerator of the
    // draft grade.
    //   "ASSIGNED_GRADE_POINTS_EARNED_CHANGE" - A change in the numerator of the
    // assigned grade.
    //   "MAX_POINTS_CHANGE" - A change in the denominator of the grade.
    GradeChangeType string `json:"gradeChangeType,omitempty"`
    // GradeTimestamp: When the grade of the submission was changed.
    GradeTimestamp string `json:"gradeTimestamp,omitempty"`
    // MaxPoints: The denominator of the grade at this time in the submission grade
    // history.
    MaxPoints float64 `json:"maxPoints,omitempty"`
    // PointsEarned: The numerator of the grade at this time in the submission
    // grade history.
    PointsEarned float64 `json:"pointsEarned,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ActorUserId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ActorUserId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GradeHistory) MarshalJSON ¶

func (s *GradeHistory) MarshalJSON() ([]byte, error)

func (*GradeHistory) UnmarshalJSON ¶

func (s *GradeHistory) UnmarshalJSON(data []byte) error

type GradebookSettings ¶

GradebookSettings: The gradebook settings for a course. See the help center article (https://support.google.com/edu/classroom/answer/9184995) for details.

type GradebookSettings struct {
    // CalculationType: Indicates how the overall grade is calculated.
    //
    // Possible values:
    //   "CALCULATION_TYPE_UNSPECIFIED" - No method specified. This is never
    // returned.
    //   "TOTAL_POINTS" - Overall grade is the sum of grades divided by the sum of
    // total points regardless of category.
    //   "WEIGHTED_CATEGORIES" - Overall grade is the weighted average by category.
    CalculationType string `json:"calculationType,omitempty"`
    // DisplaySetting: Indicates who can see the overall grade..
    //
    // Possible values:
    //   "DISPLAY_SETTING_UNSPECIFIED" - No setting specified. This is never
    // returned.
    //   "SHOW_OVERALL_GRADE" - Shows overall grade in the gradebook and student
    // profile to both teachers and students.
    //   "HIDE_OVERALL_GRADE" - Does not show overall grade in the gradebook or
    // student profile.
    //   "SHOW_TEACHERS_ONLY" - Shows the overall grade to teachers in the
    // gradebook and student profile. Hides from students in their student profile.
    DisplaySetting string `json:"displaySetting,omitempty"`
    // GradeCategories: Grade categories that are available for coursework in the
    // course.
    GradeCategories []*GradeCategory `json:"gradeCategories,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CalculationType") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CalculationType") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GradebookSettings) MarshalJSON ¶

func (s *GradebookSettings) MarshalJSON() ([]byte, error)

type Guardian ¶

Guardian: Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

type Guardian struct {
    // GuardianId: Identifier for the guardian.
    GuardianId string `json:"guardianId,omitempty"`
    // GuardianProfile: User profile for the guardian.
    GuardianProfile *UserProfile `json:"guardianProfile,omitempty"`
    // InvitedEmailAddress: The email address to which the initial guardian
    // invitation was sent. This field is only visible to domain administrators.
    InvitedEmailAddress string `json:"invitedEmailAddress,omitempty"`
    // StudentId: Identifier for the student to whom the guardian relationship
    // applies.
    StudentId string `json:"studentId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "GuardianId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "GuardianId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Guardian) MarshalJSON ¶

func (s *Guardian) MarshalJSON() ([]byte, error)

type GuardianInvitation ¶

GuardianInvitation: An invitation to become the guardian of a specified user, sent to a specified email address.

type GuardianInvitation struct {
    // CreationTime: The time that this invitation was created. Read-only.
    CreationTime string `json:"creationTime,omitempty"`
    // InvitationId: Unique identifier for this invitation. Read-only.
    InvitationId string `json:"invitationId,omitempty"`
    // InvitedEmailAddress: Email address that the invitation was sent to. This
    // field is only visible to domain administrators.
    InvitedEmailAddress string `json:"invitedEmailAddress,omitempty"`
    // State: The state that this invitation is in.
    //
    // Possible values:
    //   "GUARDIAN_INVITATION_STATE_UNSPECIFIED" - Should never be returned.
    //   "PENDING" - The invitation is active and awaiting a response.
    //   "COMPLETE" - The invitation is no longer active. It may have been
    // accepted, declined, withdrawn or it may have expired.
    State string `json:"state,omitempty"`
    // StudentId: ID of the student (in standard format)
    StudentId string `json:"studentId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CreationTime") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CreationTime") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GuardianInvitation) MarshalJSON ¶

func (s *GuardianInvitation) MarshalJSON() ([]byte, error)

type IndividualStudentsOptions ¶

IndividualStudentsOptions: Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.

type IndividualStudentsOptions struct {
    // StudentIds: Identifiers for the students that have access to the
    // coursework/announcement.
    StudentIds []string `json:"studentIds,omitempty"`
    // ForceSendFields is a list of field names (e.g. "StudentIds") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "StudentIds") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*IndividualStudentsOptions) MarshalJSON ¶

func (s *IndividualStudentsOptions) MarshalJSON() ([]byte, error)

type Invitation ¶

Invitation: An invitation to join a course.

type Invitation struct {
    // CourseId: Identifier of the course to invite the user to.
    CourseId string `json:"courseId,omitempty"`
    // Id: Identifier assigned by Classroom. Read-only.
    Id string `json:"id,omitempty"`
    // Role: Role to invite the user to have. Must not be
    // `COURSE_ROLE_UNSPECIFIED`.
    //
    // Possible values:
    //   "COURSE_ROLE_UNSPECIFIED" - No course role.
    //   "STUDENT" - Student in the course.
    //   "TEACHER" - Teacher of the course.
    //   "OWNER" - Owner of the course.
    Role string `json:"role,omitempty"`
    // UserId: 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
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Invitation) MarshalJSON ¶

func (s *Invitation) MarshalJSON() ([]byte, error)

type InvitationsAcceptCall ¶

type InvitationsAcceptCall struct {
    // contains filtered or unexported fields
}

func (*InvitationsAcceptCall) Context ¶

func (c *InvitationsAcceptCall) Context(ctx context.Context) *InvitationsAcceptCall

Context sets the context to be used in this call's Do method.

func (*InvitationsAcceptCall) Do ¶

func (c *InvitationsAcceptCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.invitations.accept" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsAcceptCall) Fields ¶

func (c *InvitationsAcceptCall) Fields(s ...googleapi.Field) *InvitationsAcceptCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InvitationsAcceptCall) Header ¶

func (c *InvitationsAcceptCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InvitationsCreateCall ¶

type InvitationsCreateCall struct {
    // contains filtered or unexported fields
}

func (*InvitationsCreateCall) Context ¶

func (c *InvitationsCreateCall) Context(ctx context.Context) *InvitationsCreateCall

Context sets the context to be used in this call's Do method.

func (*InvitationsCreateCall) Do ¶

func (c *InvitationsCreateCall) Do(opts ...googleapi.CallOption) (*Invitation, error)

Do executes the "classroom.invitations.create" call. Any non-2xx status code is an error. Response headers are in either *Invitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsCreateCall) Fields ¶

func (c *InvitationsCreateCall) Fields(s ...googleapi.Field) *InvitationsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InvitationsCreateCall) Header ¶

func (c *InvitationsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InvitationsDeleteCall ¶

type InvitationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*InvitationsDeleteCall) Context ¶

func (c *InvitationsDeleteCall) Context(ctx context.Context) *InvitationsDeleteCall

Context sets the context to be used in this call's Do method.

func (*InvitationsDeleteCall) Do ¶

func (c *InvitationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.invitations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsDeleteCall) Fields ¶

func (c *InvitationsDeleteCall) Fields(s ...googleapi.Field) *InvitationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InvitationsDeleteCall) Header ¶

func (c *InvitationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InvitationsGetCall ¶

type InvitationsGetCall struct {
    // contains filtered or unexported fields
}

func (*InvitationsGetCall) Context ¶

func (c *InvitationsGetCall) Context(ctx context.Context) *InvitationsGetCall

Context sets the context to be used in this call's Do method.

func (*InvitationsGetCall) Do ¶

func (c *InvitationsGetCall) Do(opts ...googleapi.CallOption) (*Invitation, error)

Do executes the "classroom.invitations.get" call. Any non-2xx status code is an error. Response headers are in either *Invitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsGetCall) Fields ¶

func (c *InvitationsGetCall) Fields(s ...googleapi.Field) *InvitationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InvitationsGetCall) Header ¶

func (c *InvitationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*InvitationsGetCall) IfNoneMatch ¶

func (c *InvitationsGetCall) IfNoneMatch(entityTag string) *InvitationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type InvitationsListCall ¶

type InvitationsListCall struct {
    // contains filtered or unexported fields
}

func (*InvitationsListCall) Context ¶

func (c *InvitationsListCall) Context(ctx context.Context) *InvitationsListCall

Context sets the context to be used in this call's Do method.

func (*InvitationsListCall) CourseId ¶

func (c *InvitationsListCall) CourseId(courseId string) *InvitationsListCall

CourseId sets the optional parameter "courseId": Restricts returned invitations to those for a course with the specified identifier.

func (*InvitationsListCall) Do ¶

func (c *InvitationsListCall) Do(opts ...googleapi.CallOption) (*ListInvitationsResponse, error)

Do executes the "classroom.invitations.list" call. Any non-2xx status code is an error. Response headers are in either *ListInvitationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsListCall) Fields ¶

func (c *InvitationsListCall) Fields(s ...googleapi.Field) *InvitationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InvitationsListCall) Header ¶

func (c *InvitationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*InvitationsListCall) IfNoneMatch ¶

func (c *InvitationsListCall) IfNoneMatch(entityTag string) *InvitationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*InvitationsListCall) PageSize ¶

func (c *InvitationsListCall) PageSize(pageSize int64) *InvitationsListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.

func (*InvitationsListCall) PageToken ¶

func (c *InvitationsListCall) PageToken(pageToken string) *InvitationsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*InvitationsListCall) Pages ¶

func (c *InvitationsListCall) Pages(ctx context.Context, f func(*ListInvitationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*InvitationsListCall) UserId ¶

func (c *InvitationsListCall) UserId(userId string) *InvitationsListCall

UserId sets the optional parameter "userId": Restricts returned invitations to those for a specific user. 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

type InvitationsService ¶

type InvitationsService struct {
    // contains filtered or unexported fields
}

func NewInvitationsService ¶

func NewInvitationsService(s *Service) *InvitationsService

func (*InvitationsService) Accept ¶

func (r *InvitationsService) Accept(id string) *InvitationsAcceptCall

Accept: Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

- id: Identifier of the invitation to accept.

func (*InvitationsService) Create ¶

func (r *InvitationsService) Create(invitation *Invitation) *InvitationsCreateCall

Create: Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION`: * if the requested user's account is disabled. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

func (*InvitationsService) Delete ¶

func (r *InvitationsService) Delete(id string) *InvitationsDeleteCall

Delete: Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

- id: Identifier of the invitation to delete.

func (*InvitationsService) Get ¶

func (r *InvitationsService) Get(id string) *InvitationsGetCall

Get: Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

- id: Identifier of the invitation to return.

func (*InvitationsService) List ¶

func (r *InvitationsService) List() *InvitationsListCall

List: Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

type Link ¶

Link: URL item.

type Link struct {
    // ThumbnailUrl: URL of a thumbnail image of the target URL. Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`
    // Title: Title of the target of the URL. Read-only.
    Title string `json:"title,omitempty"`
    // Url: URL to link to. This must be a valid UTF-8 string containing between 1
    // and 2024 characters.
    Url string `json:"url,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ThumbnailUrl") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ThumbnailUrl") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Link) MarshalJSON ¶

func (s *Link) MarshalJSON() ([]byte, error)

type ListAnnouncementsResponse ¶

ListAnnouncementsResponse: Response when listing course work.

type ListAnnouncementsResponse struct {
    // Announcements: Announcement items that match the request.
    Announcements []*Announcement `json:"announcements,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Announcements") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Announcements") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListAnnouncementsResponse) MarshalJSON ¶

func (s *ListAnnouncementsResponse) MarshalJSON() ([]byte, error)

type ListCourseAliasesResponse ¶

ListCourseAliasesResponse: Response when listing course aliases.

type ListCourseAliasesResponse struct {
    // Aliases: The course aliases.
    Aliases []*CourseAlias `json:"aliases,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Aliases") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Aliases") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListCourseAliasesResponse) MarshalJSON ¶

func (s *ListCourseAliasesResponse) MarshalJSON() ([]byte, error)

type ListCourseWorkMaterialResponse ¶

ListCourseWorkMaterialResponse: Response when listing course work material.

type ListCourseWorkMaterialResponse struct {
    // CourseWorkMaterial: Course work material items that match the request.
    CourseWorkMaterial []*CourseWorkMaterial `json:"courseWorkMaterial,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CourseWorkMaterial") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseWorkMaterial") to include
    // in API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListCourseWorkMaterialResponse) MarshalJSON ¶

func (s *ListCourseWorkMaterialResponse) MarshalJSON() ([]byte, error)

type ListCourseWorkResponse ¶

ListCourseWorkResponse: Response when listing course work.

type ListCourseWorkResponse struct {
    // CourseWork: Course work items that match the request.
    CourseWork []*CourseWork `json:"courseWork,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CourseWork") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseWork") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListCourseWorkResponse) MarshalJSON ¶

func (s *ListCourseWorkResponse) MarshalJSON() ([]byte, error)

type ListCoursesResponse ¶

ListCoursesResponse: Response when listing courses.

type ListCoursesResponse struct {
    // Courses: Courses that match the list request.
    Courses []*Course `json:"courses,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Courses") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Courses") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListCoursesResponse) MarshalJSON ¶

func (s *ListCoursesResponse) MarshalJSON() ([]byte, error)

type ListGuardianInvitationsResponse ¶

ListGuardianInvitationsResponse: Response when listing guardian invitations.

type ListGuardianInvitationsResponse struct {
    // GuardianInvitations: Guardian invitations that matched the list request.
    GuardianInvitations []*GuardianInvitation `json:"guardianInvitations,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "GuardianInvitations") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "GuardianInvitations") to include
    // in API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListGuardianInvitationsResponse) MarshalJSON ¶

func (s *ListGuardianInvitationsResponse) MarshalJSON() ([]byte, error)

type ListGuardiansResponse ¶

ListGuardiansResponse: Response when listing guardians.

type ListGuardiansResponse struct {
    // Guardians: Guardians on this page of results that met the criteria specified
    // in the request.
    Guardians []*Guardian `json:"guardians,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Guardians") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Guardians") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListGuardiansResponse) MarshalJSON ¶

func (s *ListGuardiansResponse) MarshalJSON() ([]byte, error)

type ListInvitationsResponse ¶

ListInvitationsResponse: Response when listing invitations.

type ListInvitationsResponse struct {
    // Invitations: Invitations that match the list request.
    Invitations []*Invitation `json:"invitations,omitempty"`
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Invitations") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Invitations") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListInvitationsResponse) MarshalJSON ¶

func (s *ListInvitationsResponse) MarshalJSON() ([]byte, error)

type ListStudentSubmissionsResponse ¶

ListStudentSubmissionsResponse: Response when listing student submissions.

type ListStudentSubmissionsResponse struct {
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // StudentSubmissions: Student work that matches the request.
    StudentSubmissions []*StudentSubmission `json:"studentSubmissions,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListStudentSubmissionsResponse) MarshalJSON ¶

func (s *ListStudentSubmissionsResponse) MarshalJSON() ([]byte, error)

type ListStudentsResponse ¶

ListStudentsResponse: Response when listing students.

type ListStudentsResponse struct {
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Students: Students who match the list request.
    Students []*Student `json:"students,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListStudentsResponse) MarshalJSON ¶

func (s *ListStudentsResponse) MarshalJSON() ([]byte, error)

type ListTeachersResponse ¶

ListTeachersResponse: Response when listing teachers.

type ListTeachersResponse struct {
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Teachers: Teachers who match the list request.
    Teachers []*Teacher `json:"teachers,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListTeachersResponse) MarshalJSON ¶

func (s *ListTeachersResponse) MarshalJSON() ([]byte, error)

type ListTopicResponse ¶

ListTopicResponse: Response when listing topics.

type ListTopicResponse struct {
    // NextPageToken: Token identifying the next page of results to return. If
    // empty, no further results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Topic: Topic items that match the request.
    Topic []*Topic `json:"topic,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListTopicResponse) MarshalJSON ¶

func (s *ListTopicResponse) MarshalJSON() ([]byte, error)

type Material ¶

Material: Material attached to course work. When creating attachments, setting the `form` field is not supported.

type Material struct {
    // DriveFile: Google Drive file material.
    DriveFile *SharedDriveFile `json:"driveFile,omitempty"`
    // Form: Google Forms material.
    Form *Form `json:"form,omitempty"`
    // Link: Link material. On creation, this is upgraded to a more appropriate
    // type if possible, and this is reflected in the response.
    Link *Link `json:"link,omitempty"`
    // YoutubeVideo: YouTube video material.
    YoutubeVideo *YouTubeVideo `json:"youtubeVideo,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DriveFile") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Material) MarshalJSON ¶

func (s *Material) MarshalJSON() ([]byte, error)

type ModifyAnnouncementAssigneesRequest ¶

ModifyAnnouncementAssigneesRequest: Request to modify assignee mode and options of an announcement.

type ModifyAnnouncementAssigneesRequest struct {
    // AssigneeMode: Mode of the announcement describing whether it is accessible
    // by all students or specified individual students.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
    //   "ALL_STUDENTS" - All students can see the item. This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`
    // ModifyIndividualStudentsOptions: Set which students can view or cannot view
    // the announcement. Must be specified only when `assigneeMode` is
    // `INDIVIDUAL_STUDENTS`.
    ModifyIndividualStudentsOptions *ModifyIndividualStudentsOptions `json:"modifyIndividualStudentsOptions,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AssigneeMode") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AssigneeMode") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ModifyAnnouncementAssigneesRequest) MarshalJSON ¶

func (s *ModifyAnnouncementAssigneesRequest) MarshalJSON() ([]byte, error)

type ModifyAttachmentsRequest ¶

ModifyAttachmentsRequest: Request to modify the attachments of a student submission.

type ModifyAttachmentsRequest struct {
    // AddAttachments: Attachments to add. A student submission may not have more
    // than 20 attachments. Form attachments are not supported.
    AddAttachments []*Attachment `json:"addAttachments,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AddAttachments") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AddAttachments") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ModifyAttachmentsRequest) MarshalJSON ¶

func (s *ModifyAttachmentsRequest) MarshalJSON() ([]byte, error)

type ModifyCourseWorkAssigneesRequest ¶

ModifyCourseWorkAssigneesRequest: Request to modify assignee mode and options of a coursework.

type ModifyCourseWorkAssigneesRequest struct {
    // AssigneeMode: Mode of the coursework describing whether it will be assigned
    // to all students or specified individual students.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
    //   "ALL_STUDENTS" - All students can see the item. This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`
    // ModifyIndividualStudentsOptions: Set which students are assigned or not
    // assigned to the coursework. Must be specified only when `assigneeMode` is
    // `INDIVIDUAL_STUDENTS`.
    ModifyIndividualStudentsOptions *ModifyIndividualStudentsOptions `json:"modifyIndividualStudentsOptions,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AssigneeMode") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AssigneeMode") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ModifyCourseWorkAssigneesRequest) MarshalJSON ¶

func (s *ModifyCourseWorkAssigneesRequest) MarshalJSON() ([]byte, error)

type ModifyIndividualStudentsOptions ¶

ModifyIndividualStudentsOptions: Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.

type ModifyIndividualStudentsOptions struct {
    // AddStudentIds: IDs of students to be added as having access to this
    // coursework/announcement.
    AddStudentIds []string `json:"addStudentIds,omitempty"`
    // RemoveStudentIds: IDs of students to be removed from having access to this
    // coursework/announcement.
    RemoveStudentIds []string `json:"removeStudentIds,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AddStudentIds") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AddStudentIds") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ModifyIndividualStudentsOptions) MarshalJSON ¶

func (s *ModifyIndividualStudentsOptions) MarshalJSON() ([]byte, error)

type MultipleChoiceQuestion ¶

MultipleChoiceQuestion: Additional details for multiple-choice questions.

type MultipleChoiceQuestion struct {
    // Choices: Possible choices.
    Choices []string `json:"choices,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Choices") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Choices") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MultipleChoiceQuestion) MarshalJSON ¶

func (s *MultipleChoiceQuestion) MarshalJSON() ([]byte, error)

type MultipleChoiceSubmission ¶

MultipleChoiceSubmission: Student work for a multiple-choice question.

type MultipleChoiceSubmission struct {
    // Answer: Student's select choice.
    Answer string `json:"answer,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Answer") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Answer") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MultipleChoiceSubmission) MarshalJSON ¶

func (s *MultipleChoiceSubmission) MarshalJSON() ([]byte, error)

type Name ¶

Name: Details of the user's name.

type Name struct {
    // FamilyName: The user's last name. Read-only.
    FamilyName string `json:"familyName,omitempty"`
    // FullName: The user's full name formed by concatenating the first and last
    // name values. Read-only.
    FullName string `json:"fullName,omitempty"`
    // GivenName: The user's first name. Read-only.
    GivenName string `json:"givenName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "FamilyName") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "FamilyName") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Name) MarshalJSON ¶

func (s *Name) MarshalJSON() ([]byte, error)

type ReclaimStudentSubmissionRequest ¶

ReclaimStudentSubmissionRequest: Request to reclaim a student submission.

type ReclaimStudentSubmissionRequest struct {
}

type Registration ¶

Registration: An instruction to Classroom to send notifications from the `feed` to the provided destination.

type Registration struct {
    // CloudPubsubTopic: The Cloud Pub/Sub topic that notifications are to be sent
    // to.
    CloudPubsubTopic *CloudPubsubTopic `json:"cloudPubsubTopic,omitempty"`
    // ExpiryTime: The time until which the `Registration` is effective. This is a
    // read-only field assigned by the server.
    ExpiryTime string `json:"expiryTime,omitempty"`
    // Feed: Specification for the class of notifications that Classroom should
    // deliver to the destination.
    Feed *Feed `json:"feed,omitempty"`
    // RegistrationId: A server-generated unique identifier for this
    // `Registration`. Read-only.
    RegistrationId string `json:"registrationId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CloudPubsubTopic") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CloudPubsubTopic") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Registration) MarshalJSON ¶

func (s *Registration) MarshalJSON() ([]byte, error)

type RegistrationsCreateCall ¶

type RegistrationsCreateCall struct {
    // contains filtered or unexported fields
}

func (*RegistrationsCreateCall) Context ¶

func (c *RegistrationsCreateCall) Context(ctx context.Context) *RegistrationsCreateCall

Context sets the context to be used in this call's Do method.

func (*RegistrationsCreateCall) Do ¶

func (c *RegistrationsCreateCall) Do(opts ...googleapi.CallOption) (*Registration, error)

Do executes the "classroom.registrations.create" call. Any non-2xx status code is an error. Response headers are in either *Registration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RegistrationsCreateCall) Fields ¶

func (c *RegistrationsCreateCall) Fields(s ...googleapi.Field) *RegistrationsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*RegistrationsCreateCall) Header ¶

func (c *RegistrationsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type RegistrationsDeleteCall ¶

type RegistrationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*RegistrationsDeleteCall) Context ¶

func (c *RegistrationsDeleteCall) Context(ctx context.Context) *RegistrationsDeleteCall

Context sets the context to be used in this call's Do method.

func (*RegistrationsDeleteCall) Do ¶

func (c *RegistrationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.registrations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RegistrationsDeleteCall) Fields ¶

func (c *RegistrationsDeleteCall) Fields(s ...googleapi.Field) *RegistrationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*RegistrationsDeleteCall) Header ¶

func (c *RegistrationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type RegistrationsService ¶

type RegistrationsService struct {
    // contains filtered or unexported fields
}

func NewRegistrationsService ¶

func NewRegistrationsService(s *Service) *RegistrationsService

func (*RegistrationsService) Create ¶

func (r *RegistrationsService) Create(registration *Registration) *RegistrationsCreateCall

Create: Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.

func (*RegistrationsService) Delete ¶

func (r *RegistrationsService) Delete(registrationId string) *RegistrationsDeleteCall

Delete: Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.

- registrationId: The `registration_id` of the `Registration` to be deleted.

type ReturnStudentSubmissionRequest ¶

ReturnStudentSubmissionRequest: Request to return a student submission.

type ReturnStudentSubmissionRequest struct {
}

type Service ¶

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Courses *CoursesService

    Invitations *InvitationsService

    Registrations *RegistrationsService

    UserProfiles *UserProfilesService
    // contains filtered or unexported fields
}

func New ¶

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService ¶

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SharedDriveFile ¶

SharedDriveFile: Drive file that is used as material for course work.

type SharedDriveFile struct {
    // DriveFile: Drive file details.
    DriveFile *DriveFile `json:"driveFile,omitempty"`
    // ShareMode: Mechanism by which students access the Drive item.
    //
    // Possible values:
    //   "UNKNOWN_SHARE_MODE" - No sharing mode specified. This should never be
    // returned.
    //   "VIEW" - Students can view the shared file.
    //   "EDIT" - Students can edit the shared file.
    //   "STUDENT_COPY" - Students have a personal copy of the shared file.
    ShareMode string `json:"shareMode,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DriveFile") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*SharedDriveFile) MarshalJSON ¶

func (s *SharedDriveFile) MarshalJSON() ([]byte, error)

type ShortAnswerSubmission ¶

ShortAnswerSubmission: Student work for a short answer question.

type ShortAnswerSubmission struct {
    // Answer: Student response to a short-answer question.
    Answer string `json:"answer,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Answer") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Answer") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ShortAnswerSubmission) MarshalJSON ¶

func (s *ShortAnswerSubmission) MarshalJSON() ([]byte, error)

type StateHistory ¶

StateHistory: The history of each state this submission has been in.

type StateHistory struct {
    // ActorUserId: The teacher or student who made the change.
    ActorUserId string `json:"actorUserId,omitempty"`
    // State: The workflow pipeline stage.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - No state specified. This should never be returned.
    //   "CREATED" - The Submission has been created.
    //   "TURNED_IN" - The student has turned in an assigned document, which may or
    // may not be a template.
    //   "RETURNED" - The teacher has returned the assigned document to the
    // student.
    //   "RECLAIMED_BY_STUDENT" - The student turned in the assigned document, and
    // then chose to "unsubmit" the assignment, giving the student control again as
    // the owner.
    //   "STUDENT_EDITED_AFTER_TURN_IN" - The student edited their submission after
    // turning it in. Currently, only used by Questions, when the student edits
    // their answer.
    State string `json:"state,omitempty"`
    // StateTimestamp: When the submission entered this state.
    StateTimestamp string `json:"stateTimestamp,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ActorUserId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ActorUserId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*StateHistory) MarshalJSON ¶

func (s *StateHistory) MarshalJSON() ([]byte, error)

type Student ¶

Student: Student in a course.

type Student struct {
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // Profile: Global user information for the student. Read-only.
    Profile *UserProfile `json:"profile,omitempty"`
    // StudentWorkFolder: Information about a Drive Folder for this student's work
    // in this course. Only visible to the student and domain administrators.
    // Read-only.
    StudentWorkFolder *DriveFolder `json:"studentWorkFolder,omitempty"`
    // UserId: 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
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Student) MarshalJSON ¶

func (s *Student) MarshalJSON() ([]byte, error)

type StudentSubmission ¶

StudentSubmission: Student submission for course work. `StudentSubmission` items are generated when a `CourseWork` item is created. Student submissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.

type StudentSubmission struct {
    // AlternateLink: Absolute link to the submission in the Classroom web UI.
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`
    // AssignedGrade: Optional grade. If unset, no grade was set. This value must
    // be non-negative. Decimal (that is, non-integer) values are allowed, but are
    // rounded to two decimal places. This may be modified only by course teachers.
    AssignedGrade float64 `json:"assignedGrade,omitempty"`
    // AssignmentSubmission: Submission content when course_work_type is
    // ASSIGNMENT. Students can modify this content using ModifyAttachments.
    AssignmentSubmission *AssignmentSubmission `json:"assignmentSubmission,omitempty"`
    // AssociatedWithDeveloper: Whether this student submission is associated with
    // the Developer Console project making the request. See CreateCourseWork for
    // more details. Read-only.
    AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // CourseWorkId: Identifier for the course work this corresponds to. Read-only.
    CourseWorkId string `json:"courseWorkId,omitempty"`
    // CourseWorkType: Type of course work this submission is for. Read-only.
    //
    // Possible values:
    //   "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is never
    // returned.
    //   "ASSIGNMENT" - An assignment.
    //   "SHORT_ANSWER_QUESTION" - A short answer question.
    //   "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
    CourseWorkType string `json:"courseWorkType,omitempty"`
    // CreationTime: Creation time of this submission. This may be unset if the
    // student has not accessed this item. Read-only.
    CreationTime string `json:"creationTime,omitempty"`
    // DraftGrade: Optional pending grade. If unset, no grade was set. This value
    // must be non-negative. Decimal (that is, non-integer) values are allowed, but
    // are rounded to two decimal places. This is only visible to and modifiable by
    // course teachers.
    DraftGrade float64 `json:"draftGrade,omitempty"`
    // Id: Classroom-assigned Identifier for the student submission. This is unique
    // among submissions for the relevant course work. Read-only.
    Id string `json:"id,omitempty"`
    // Late: Whether this submission is late. Read-only.
    Late bool `json:"late,omitempty"`
    // MultipleChoiceSubmission: Submission content when course_work_type is
    // MULTIPLE_CHOICE_QUESTION.
    MultipleChoiceSubmission *MultipleChoiceSubmission `json:"multipleChoiceSubmission,omitempty"`
    // ShortAnswerSubmission: Submission content when course_work_type is
    // SHORT_ANSWER_QUESTION.
    ShortAnswerSubmission *ShortAnswerSubmission `json:"shortAnswerSubmission,omitempty"`
    // State: State of this submission. Read-only.
    //
    // Possible values:
    //   "SUBMISSION_STATE_UNSPECIFIED" - No state specified. This should never be
    // returned.
    //   "NEW" - The student has never accessed this submission. Attachments are
    // not returned and timestamps is not set.
    //   "CREATED" - Has been created.
    //   "TURNED_IN" - Has been turned in to the teacher.
    //   "RETURNED" - Has been returned to the student.
    //   "RECLAIMED_BY_STUDENT" - Student chose to "unsubmit" the assignment.
    State string `json:"state,omitempty"`
    // SubmissionHistory: The history of the submission (includes state and grade
    // histories). Read-only.
    SubmissionHistory []*SubmissionHistory `json:"submissionHistory,omitempty"`
    // UpdateTime: Last update time of this submission. This may be unset if the
    // student has not accessed this item. Read-only.
    UpdateTime string `json:"updateTime,omitempty"`
    // UserId: Identifier for the student that owns this submission. Read-only.
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AlternateLink") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*StudentSubmission) MarshalJSON ¶

func (s *StudentSubmission) MarshalJSON() ([]byte, error)

func (*StudentSubmission) UnmarshalJSON ¶

func (s *StudentSubmission) UnmarshalJSON(data []byte) error

type SubmissionHistory ¶

SubmissionHistory: The history of the submission. This currently includes state and grade histories.

type SubmissionHistory struct {
    // GradeHistory: The grade history information of the submission, if present.
    GradeHistory *GradeHistory `json:"gradeHistory,omitempty"`
    // StateHistory: The state history information of the submission, if present.
    StateHistory *StateHistory `json:"stateHistory,omitempty"`
    // ForceSendFields is a list of field names (e.g. "GradeHistory") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "GradeHistory") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*SubmissionHistory) MarshalJSON ¶

func (s *SubmissionHistory) MarshalJSON() ([]byte, error)

type Teacher ¶

Teacher: Teacher of a course.

type Teacher struct {
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // Profile: Global user information for the teacher. Read-only.
    Profile *UserProfile `json:"profile,omitempty"`
    // UserId: 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
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Teacher) MarshalJSON ¶

func (s *Teacher) MarshalJSON() ([]byte, error)

type TimeOfDay ¶

TimeOfDay: Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

type TimeOfDay struct {
    // Hours: Hours of day in 24 hour format. Should be from 0 to 23. An API may
    // choose to allow the value "24:00:00" for scenarios like business closing
    // time.
    Hours int64 `json:"hours,omitempty"`
    // Minutes: Minutes of hour of day. Must be from 0 to 59.
    Minutes int64 `json:"minutes,omitempty"`
    // Nanos: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    Nanos int64 `json:"nanos,omitempty"`
    // Seconds: Seconds of minutes of the time. Must normally be from 0 to 59. An
    // API may allow the value 60 if it allows leap-seconds.
    Seconds int64 `json:"seconds,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Hours") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Hours") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*TimeOfDay) MarshalJSON ¶

func (s *TimeOfDay) MarshalJSON() ([]byte, error)

type Topic ¶

Topic: Topic created by a teacher for the course

type Topic struct {
    // CourseId: Identifier of the course. Read-only.
    CourseId string `json:"courseId,omitempty"`
    // Name: The name of the topic, generated by the user. Leading and trailing
    // whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are
    // collapsed into one inside the name. The result must be a non-empty string.
    // Topic names are case sensitive, and must be no longer than 100 characters.
    Name string `json:"name,omitempty"`
    // TopicId: Unique identifier for the topic. Read-only.
    TopicId string `json:"topicId,omitempty"`
    // UpdateTime: The time the topic was last updated by the system. Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CourseId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Topic) MarshalJSON ¶

func (s *Topic) MarshalJSON() ([]byte, error)

type TurnInStudentSubmissionRequest ¶

TurnInStudentSubmissionRequest: Request to turn in a student submission.

type TurnInStudentSubmissionRequest struct {
}

type UserProfile ¶

UserProfile: Global information for a user.

type UserProfile struct {
    // EmailAddress: Email address of the user. Must request
    // `https://www.googleapis.com/auth/classroom.profile.emails` scope for this
    // field to be populated in a response body. Read-only.
    EmailAddress string `json:"emailAddress,omitempty"`
    // Id: Identifier of the user. Read-only.
    Id string `json:"id,omitempty"`
    // Name: Name of the user. Read-only.
    Name *Name `json:"name,omitempty"`
    // Permissions: Global permissions of the user. Read-only.
    Permissions []*GlobalPermission `json:"permissions,omitempty"`
    // PhotoUrl: URL of user's profile photo. Must request
    // `https://www.googleapis.com/auth/classroom.profile.photos` scope for this
    // field to be populated in a response body. Read-only.
    PhotoUrl string `json:"photoUrl,omitempty"`
    // VerifiedTeacher: Represents whether a Google Workspace for Education user's
    // domain administrator has explicitly verified them as being a teacher. This
    // field is always false if the user is not a member of a Google Workspace for
    // Education domain. Read-only
    VerifiedTeacher bool `json:"verifiedTeacher,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "EmailAddress") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "EmailAddress") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*UserProfile) MarshalJSON ¶

func (s *UserProfile) MarshalJSON() ([]byte, error)

type UserProfilesGetCall ¶

type UserProfilesGetCall struct {
    // contains filtered or unexported fields
}

func (*UserProfilesGetCall) Context ¶

func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall

Context sets the context to be used in this call's Do method.

func (*UserProfilesGetCall) Do ¶

func (c *UserProfilesGetCall) Do(opts ...googleapi.CallOption) (*UserProfile, error)

Do executes the "classroom.userProfiles.get" call. Any non-2xx status code is an error. Response headers are in either *UserProfile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGetCall) Fields ¶

func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UserProfilesGetCall) Header ¶

func (c *UserProfilesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UserProfilesGetCall) IfNoneMatch ¶

func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UserProfilesGuardianInvitationsCreateCall ¶

type UserProfilesGuardianInvitationsCreateCall struct {
    // contains filtered or unexported fields
}

func (*UserProfilesGuardianInvitationsCreateCall) Context ¶

func (c *UserProfilesGuardianInvitationsCreateCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsCreateCall

Context sets the context to be used in this call's Do method.

func (*UserProfilesGuardianInvitationsCreateCall) Do ¶

func (c *UserProfilesGuardianInvitationsCreateCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

Do executes the "classroom.userProfiles.guardianInvitations.create" call. Any non-2xx status code is an error. Response headers are in either *GuardianInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsCreateCall) Fields ¶

func (c *UserProfilesGuardianInvitationsCreateCall) Fields(s ...googleapi.Field) *UserProfilesGuardianInvitationsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UserProfilesGuardianInvitationsCreateCall) Header ¶

func (c *UserProfilesGuardianInvitationsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UserProfilesGuardianInvitationsGetCall ¶

type UserProfilesGuardianInvitationsGetCall struct {
    // contains filtered or unexported fields
}

func (*UserProfilesGuardianInvitationsGetCall) Context ¶

func (c *UserProfilesGuardianInvitationsGetCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsGetCall

Context sets the context to be used in this call's Do method.

func (*UserProfilesGuardianInvitationsGetCall) Do ¶

func (c *UserProfilesGuardianInvitationsGetCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

Do executes the "classroom.userProfiles.guardianInvitations.get" call. Any non-2xx status code is an error. Response headers are in either *GuardianInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsGetCall) Fields ¶

func (c *UserProfilesGuardianInvitationsGetCall) Fields(s ...googleapi.Field) *UserProfilesGuardianInvitationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UserProfilesGuardianInvitationsGetCall) Header ¶

func (c *UserProfilesGuardianInvitationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UserProfilesGuardianInvitationsGetCall) IfNoneMatch ¶

func (c *UserProfilesGuardianInvitationsGetCall) IfNoneMatch(entityTag string) *UserProfilesGuardianInvitationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UserProfilesGuardianInvitationsListCall ¶

type UserProfilesGuardianInvitationsListCall struct {
    // contains filtered or unexported fields
}

func (*UserProfilesGuardianInvitationsListCall) Context ¶

func (c *UserProfilesGuardianInvitationsListCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsListCall

Context sets the context to be used in this call's Do method.

func (*UserProfilesGuardianInvitationsListCall) Do ¶

func (c *UserProfilesGuardianInvitationsListCall) Do(opts ...googleapi.CallOption) (*ListGuardianInvitationsResponse, error)

Do executes the "classroom.userProfiles.guardianInvitations.list" call. Any non-2xx status code is an error. Response headers are in either *ListGuardianInvitationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsListCall) Fields ¶

func (c *UserProfilesGuardianInvitationsListCall) Fields(s ...googleapi.Field) *UserProfilesGuardianInvitationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UserProfilesGuardianInvitationsListCall) Header ¶

func (c *UserProfilesGuardianInvitationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UserProfilesGuardianInvitationsListCall) IfNoneMatch ¶

func (c *UserProfilesGuardianInvitationsListCall) IfNoneMatch(entityTag string) *UserProfilesGuardianInvitationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UserProfilesGuardianInvitationsListCall) InvitedEmailAddress ¶

func (c *UserProfilesGuardianInvitationsListCall) InvitedEmailAddress(invitedEmailAddress string) *UserProfilesGuardianInvitationsListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress": If specified, only results with the specified `invited_email_address` are returned.

func (*UserProfilesGuardianInvitationsListCall) PageSize ¶

func (c *UserProfilesGuardianInvitationsListCall) PageSize(pageSize int64) *UserProfilesGuardianInvitationsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*UserProfilesGuardianInvitationsListCall) PageToken ¶

func (c *UserProfilesGuardianInvitationsListCall) PageToken(pageToken string) *UserProfilesGuardianInvitationsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*UserProfilesGuardianInvitationsListCall) Pages ¶

func (c *UserProfilesGuardianInvitationsListCall) Pages(ctx context.Context, f func(*ListGuardianInvitationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*UserProfilesGuardianInvitationsListCall) States ¶

func (c *UserProfilesGuardianInvitationsListCall) States(states ...string) *UserProfilesGuardianInvitationsListCall

States sets the optional parameter "states": If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.

Possible values:

"GUARDIAN_INVITATION_STATE_UNSPECIFIED" - Should never be returned.
"PENDING" - The invitation is active and awaiting a response.
"COMPLETE" - The invitation is no longer active. It may have been

accepted, declined, withdrawn or it may have expired.

type UserProfilesGuardianInvitationsPatchCall ¶

type UserProfilesGuardianInvitationsPatchCall struct {
    // contains filtered or unexported fields
}

func (*UserProfilesGuardianInvitationsPatchCall) Context ¶

func (c *UserProfilesGuardianInvitationsPatchCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsPatchCall

Context sets the context to be used in this call's Do method.

func (*UserProfilesGuardianInvitationsPatchCall) Do ¶

func (c *UserProfilesGuardianInvitationsPatchCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

Do executes the "classroom.userProfiles.guardianInvitations.patch" call. Any non-2xx status code is an error. Response headers are in either *GuardianInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsPatchCall) Fields ¶

func (c *UserProfilesGuardianInvitationsPatchCall) Fields(s ...googleapi.Field) *UserProfilesGuardianInvitationsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UserProfilesGuardianInvitationsPatchCall) Header ¶

func (c *UserProfilesGuardianInvitationsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UserProfilesGuardianInvitationsPatchCall) UpdateMask ¶

func (c *UserProfilesGuardianInvitationsPatchCall) UpdateMask(updateMask string) *UserProfilesGuardianInvitationsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`

type UserProfilesGuardianInvitationsService ¶

type UserProfilesGuardianInvitationsService struct {
    // contains filtered or unexported fields
}

func NewUserProfilesGuardianInvitationsService ¶

func NewUserProfilesGuardianInvitationsService(s *Service) *UserProfilesGuardianInvitationsService

func (*UserProfilesGuardianInvitationsService) Create ¶

func (r *UserProfilesGuardianInvitationsService) Create(studentId string, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsCreateCall

Create: Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.

- studentId: ID of the student (in standard format).

func (*UserProfilesGuardianInvitationsService) Get ¶

func (r *UserProfilesGuardianInvitationsService) Get(studentId string, invitationId string) *UserProfilesGuardianInvitationsGetCall

Get: Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.

• invitationId: The `id` field of the `GuardianInvitation` being requested.
• studentId: The ID of the student whose guardian invitation is being requested.

func (*UserProfilesGuardianInvitationsService) List ¶

func (r *UserProfilesGuardianInvitationsService) List(studentId string) *UserProfilesGuardianInvitationsListCall

List: Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

• studentId: The ID of the student whose guardian invitations are to be returned. 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 * the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.

func (*UserProfilesGuardianInvitationsService) Patch ¶

func (r *UserProfilesGuardianInvitationsService) Patch(studentId string, invitationId string, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsPatchCall

Patch: Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.

• invitationId: The `id` field of the `GuardianInvitation` to be modified.
• studentId: The ID of the student whose guardian invitation is to be modified.

type UserProfilesGuardiansDeleteCall ¶

type UserProfilesGuardiansDeleteCall struct {
    // contains filtered or unexported fields
}

func (*UserProfilesGuardiansDeleteCall) Context ¶

func (c *UserProfilesGuardiansDeleteCall) Context(ctx context.Context) *UserProfilesGuardiansDeleteCall

Context sets the context to be used in this call's Do method.

func (*UserProfilesGuardiansDeleteCall) Do ¶

func (c *UserProfilesGuardiansDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)