classroom

package

v0.257.0Latest Latest

This package is not in the latest version of its module.

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:7

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/googleapis/google-api-go-client

Documentation ¶

Overview¶

Package classroom provides access to the Google Classroom API.

For product documentation, see:https://developers.google.com/workspace/classroom/

Library status¶

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client¶

Usage example:

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

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options¶

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

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

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

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

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index¶

Constants¶

View Source

const (// See and update its own attachments to posts in Google ClassroomClassroomAddonsStudentScope = "https://www.googleapis.com/auth/classroom.addons.student"// See, create, and update its own attachments to posts in classes you teach in// Google ClassroomClassroomAddonsTeacherScope = "https://www.googleapis.com/auth/classroom.addons.teacher"// View and manage announcements in Google ClassroomClassroomAnnouncementsScope = "https://www.googleapis.com/auth/classroom.announcements"// View announcements in Google ClassroomClassroomAnnouncementsReadonlyScope = "https://www.googleapis.com/auth/classroom.announcements.readonly"// See, edit, create, and permanently delete your Google Classroom classesClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses"// View your Google Classroom classesClassroomCoursesReadonlyScope = "https://www.googleapis.com/auth/classroom.courses.readonly"// See, create and edit coursework items including assignments, questions, and// gradesClassroomCourseworkMeScope = "https://www.googleapis.com/auth/classroom.coursework.me"// View your course work and grades in Google ClassroomClassroomCourseworkMeReadonlyScope = "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 administerClassroomCourseworkStudentsScope = "https://www.googleapis.com/auth/classroom.coursework.students"// View course work and grades for students in the Google Classroom classes you// teach or administerClassroomCourseworkStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.students.readonly"// See, edit, and create classwork materials in Google ClassroomClassroomCourseworkmaterialsScope = "https://www.googleapis.com/auth/classroom.courseworkmaterials"// See all classwork materials for your Google Classroom classesClassroomCourseworkmaterialsReadonlyScope = "https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly"// View your Google Classroom guardiansClassroomGuardianlinksMeReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"// View and manage guardians for students in your Google Classroom classesClassroomGuardianlinksStudentsScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students"// View guardians for students in your Google Classroom classesClassroomGuardianlinksStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"// View the email addresses of people in your classesClassroomProfileEmailsScope = "https://www.googleapis.com/auth/classroom.profile.emails"// View the profile photos of people in your classesClassroomProfilePhotosScope = "https://www.googleapis.com/auth/classroom.profile.photos"// Receive notifications about your Google Classroom dataClassroomPushNotificationsScope = "https://www.googleapis.com/auth/classroom.push-notifications"// Manage your Google Classroom class rostersClassroomRostersScope = "https://www.googleapis.com/auth/classroom.rosters"// View your Google Classroom class rostersClassroomRostersReadonlyScope = "https://www.googleapis.com/auth/classroom.rosters.readonly"// View your course work and grades in Google ClassroomClassroomStudentSubmissionsMeReadonlyScope = "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 administerClassroomStudentSubmissionsStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"// See, create, and edit topics in Google ClassroomClassroomTopicsScope = "https://www.googleapis.com/auth/classroom.topics"// View topics in Google ClassroomClassroomTopicsReadonlyScope = "https://www.googleapis.com/auth/classroom.topics.readonly")

OAuth2 scopes used by this API.

Variables¶

This section is empty.

Functions¶

This section is empty.

Types¶

typeAddOnAttachment ¶added inv0.186.0

type AddOnAttachment struct {// CopyHistory: Output only. Identifiers of attachments that were previous// copies of this attachment. If the attachment was previously copied by virtue// of its parent post being copied, this enumerates the identifiers of// attachments that were its previous copies in ascending chronological order// of copy.CopyHistory []*CopyHistory `json:"copyHistory,omitempty"`// CourseId: Immutable. Identifier of the course.CourseIdstring `json:"courseId,omitempty"`// DueDate: Date, in UTC, that work on this attachment is due. This must be// specified if `due_time` is specified.DueDate *Date `json:"dueDate,omitempty"`// DueTime: Time of day, in UTC, that work on this attachment is due. This must// be specified if `due_date` is specified.DueTime *TimeOfDay `json:"dueTime,omitempty"`// Id: Immutable. Classroom-assigned identifier for this attachment, unique per// post.Idstring `json:"id,omitempty"`// ItemId: Immutable. Identifier of the `Announcement`, `CourseWork`, or// `CourseWorkMaterial` under which the attachment is attached. Unique per// course.ItemIdstring `json:"itemId,omitempty"`// MaxPoints: Maximum grade for this attachment. Can only be set if// `studentWorkReviewUri` is set. Set to a non-zero value to indicate that the// attachment supports grade passback. If set, this must be a non-negative// integer value. When set to zero, the attachment will not support grade// passback.MaxPointsfloat64 `json:"maxPoints,omitempty"`// PostId: Immutable. Deprecated, use `item_id` instead.PostIdstring `json:"postId,omitempty"`// StudentViewUri: Required. URI to show the student view of the attachment.// The URI will be opened in an iframe with the `courseId`, `itemId`,// `itemType`, and `attachmentId` query parameters set.StudentViewUri *EmbedUri `json:"studentViewUri,omitempty"`// StudentWorkReviewUri: URI for the teacher to see student work on the// attachment, if applicable. The URI will be opened in an iframe with the// `courseId`, `itemId`, `itemType`, `attachmentId`, and `submissionId` query// parameters set. This is the same `submissionId` returned in the// `AddOnContext.studentContext`// (//devsite.google.com/classroom/reference/rest/v1/AddOnContext#StudentContext// ) field when a student views the attachment. If the URI is omitted or// removed, `max_points` will also be discarded.StudentWorkReviewUri *EmbedUri `json:"studentWorkReviewUri,omitempty"`// TeacherViewUri: Required. URI to show the teacher view of the attachment.// The URI will be opened in an iframe with the `courseId`, `itemId`,// `itemType`, and `attachmentId` query parameters set.TeacherViewUri *EmbedUri `json:"teacherViewUri,omitempty"`// Title: Required. Title of this attachment. The title must be between 1 and// 1000 characters.Titlestring `json:"title,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CopyHistory") 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. "CopyHistory") 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:"-"`}

AddOnAttachment: An add-on attachment on a post.

func (AddOnAttachment)MarshalJSON ¶added inv0.186.0

func (sAddOnAttachment) MarshalJSON() ([]byte,error)

func (*AddOnAttachment)UnmarshalJSON ¶added inv0.186.0

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

typeAddOnAttachmentStudentSubmission ¶added inv0.186.0

type AddOnAttachmentStudentSubmission struct {// PointsEarned: Student grade on this attachment. If unset, no grade was set.PointsEarnedfloat64 `json:"pointsEarned,omitempty"`// PostSubmissionState: Submission state of add-on attachment's parent post// (i.e. assignment).//// 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.PostSubmissionStatestring `json:"postSubmissionState,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "PointsEarned") 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. "PointsEarned") 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:"-"`}

AddOnAttachmentStudentSubmission: Payload for grade update requests.

func (AddOnAttachmentStudentSubmission)MarshalJSON ¶added inv0.186.0

func (sAddOnAttachmentStudentSubmission) MarshalJSON() ([]byte,error)

func (*AddOnAttachmentStudentSubmission)UnmarshalJSON ¶added inv0.186.0

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

typeAddOnContext ¶added inv0.186.0

type AddOnContext struct {// CourseId: Immutable. Identifier of the course.CourseIdstring `json:"courseId,omitempty"`// ItemId: Immutable. Identifier of the `Announcement`, `CourseWork`, or// `CourseWorkMaterial` under which the attachment is attached.ItemIdstring `json:"itemId,omitempty"`// PostId: Immutable. Deprecated, use `item_id` instead.PostIdstring `json:"postId,omitempty"`// StudentContext: Add-on context corresponding to the requesting user's role// as a student. Its presence implies that the requesting user is a student in// the course.StudentContext *StudentContext `json:"studentContext,omitempty"`// SupportsStudentWork: Optional. Whether the post allows the teacher to see// student work and passback grades.SupportsStudentWorkbool `json:"supportsStudentWork,omitempty"`// TeacherContext: Add-on context corresponding to the requesting user's role// as a teacher. Its presence implies that the requesting user is a teacher in// the course.TeacherContext *TeacherContext `json:"teacherContext,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:"-"`}

AddOnContext: Attachment-relevant metadata for Classroom add-ons in thecontext of a specific post.

func (AddOnContext)MarshalJSON ¶added inv0.186.0

func (sAddOnContext) MarshalJSON() ([]byte,error)

typeAnnouncement ¶

type Announcement struct {// AlternateLink: Absolute link to this announcement in the Classroom web UI.// This is only populated if `state` is `PUBLISHED`. Read-only.AlternateLinkstring `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.AssigneeModestring `json:"assigneeMode,omitempty"`// CourseId: Identifier of the course. Read-only.CourseIdstring `json:"courseId,omitempty"`// CreationTime: Timestamp when this announcement was created. Read-only.CreationTimestring `json:"creationTime,omitempty"`// CreatorUserId: Identifier for the user that created the announcement.// Read-only.CreatorUserIdstring `json:"creatorUserId,omitempty"`// Id: Classroom-assigned identifier of this announcement, unique per course.// Read-only.Idstring `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.ScheduledTimestring `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.Statestring `json:"state,omitempty"`// Text: Description of this announcement. The text must be a valid UTF-8// string containing no more than 30,000 characters.Textstring `json:"text,omitempty"`// UpdateTime: Timestamp of the most recent change to this announcement.// Read-only.UpdateTimestring `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:"-"`}

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

func (Announcement)MarshalJSON ¶

func (sAnnouncement) MarshalJSON() ([]byte,error)

typeAssignment ¶

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:"-"`}

Assignment: Additional details for assignments.

func (Assignment)MarshalJSON ¶

func (sAssignment) MarshalJSON() ([]byte,error)

typeAssignmentSubmission ¶

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:"-"`}

AssignmentSubmission: Student work for an assignment.

func (AssignmentSubmission)MarshalJSON ¶

func (sAssignmentSubmission) MarshalJSON() ([]byte,error)

typeAttachment ¶

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:"-"`}

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

func (Attachment)MarshalJSON ¶

func (sAttachment) MarshalJSON() ([]byte,error)

typeCloudPubsubTopic ¶

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).TopicNamestring `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:"-"`}

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

func (CloudPubsubTopic)MarshalJSON ¶

func (sCloudPubsubTopic) MarshalJSON() ([]byte,error)

typeCopyHistory ¶added inv0.186.0

type CopyHistory struct {// AttachmentId: Immutable. Identifier of the attachment.AttachmentIdstring `json:"attachmentId,omitempty"`// CourseId: Immutable. Identifier of the course.CourseIdstring `json:"courseId,omitempty"`// ItemId: Immutable. Identifier of the `Announcement`, `CourseWork`, or// `CourseWorkMaterial` under which the attachment is attached.ItemIdstring `json:"itemId,omitempty"`// PostId: Immutable. Deprecated, use `item_id` instead.PostIdstring `json:"postId,omitempty"`// ForceSendFields is a list of field names (e.g. "AttachmentId") 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. "AttachmentId") 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:"-"`}

CopyHistory: Identifier of a previous copy of a given attachment.

func (CopyHistory)MarshalJSON ¶added inv0.186.0

func (sCopyHistory) MarshalJSON() ([]byte,error)

typeCourse ¶

type Course struct {// AlternateLink: Absolute link to this course in the Classroom web UI.// Read-only.AlternateLinkstring `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.CalendarIdstring `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.CourseGroupEmailstring `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.CourseStatestring `json:"courseState,omitempty"`// CreationTime: Creation time of the course. Specifying this field in a course// update mask results in an error. Read-only.CreationTimestring `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.Descriptionstring `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.DescriptionHeadingstring `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.EnrollmentCodestring `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.GuardiansEnabledbool `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.Idstring `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.Namestring `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.OwnerIdstring `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.Roomstring `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.Sectionstring `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.TeacherGroupEmailstring `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.UpdateTimestring `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:"-"`}

Course: A Course in Classroom.

func (Course)MarshalJSON ¶

func (sCourse) MarshalJSON() ([]byte,error)

typeCourseAlias ¶

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.Aliasstring `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:"-"`}

CourseAlias: Alternative identifier for a course. An alias uniquelyidentifies a course. It must be unique within one of the following scopes: *domain: A domain-scoped alias is visible to all users within the aliascreator's domain and can be created only by a domain admin. A domain-scopedalias is often used when a course has an identifier external to Classroom. *project: A project-scoped alias is visible to any request from anapplication using the Developer Console project ID that created the aliasand can be created by any project. A project-scoped alias is often used whenan application has alternative identifiers. A random value can also be usedto avoid duplicate courses in the event of transmission failures, asretrying a request will return `ALREADY_EXISTS` if a previous one hassucceeded.

func (CourseAlias)MarshalJSON ¶

func (sCourseAlias) MarshalJSON() ([]byte,error)

typeCourseMaterial ¶

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:"-"`}

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

func (CourseMaterial)MarshalJSON ¶

func (sCourseMaterial) MarshalJSON() ([]byte,error)

typeCourseMaterialSet ¶

type CourseMaterialSet struct {// Materials: Materials attached to this set.Materials []*CourseMaterial `json:"materials,omitempty"`// Title: Title for this set.Titlestring `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:"-"`}

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

func (CourseMaterialSet)MarshalJSON ¶

func (sCourseMaterialSet) MarshalJSON() ([]byte,error)

typeCourseRosterChangesInfo ¶

type CourseRosterChangesInfo struct {// CourseId: The `course_id` of the course to subscribe to roster changes for.CourseIdstring `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:"-"`}

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

func (CourseRosterChangesInfo)MarshalJSON ¶

func (sCourseRosterChangesInfo) MarshalJSON() ([]byte,error)

typeCourseWork ¶

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.AlternateLinkstring `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.AssigneeModestring `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.AssociatedWithDeveloperbool `json:"associatedWithDeveloper,omitempty"`// CourseId: Identifier of the course. Read-only.CourseIdstring `json:"courseId,omitempty"`// CreationTime: Timestamp when this course work was created. Read-only.CreationTimestring `json:"creationTime,omitempty"`// CreatorUserId: Identifier for the user that created the coursework.// Read-only.CreatorUserIdstring `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.Descriptionstring `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"`// GradingPeriodId: Identifier of the grading period associated with the// coursework. * At creation, if unspecified, the grading period ID will be set// based on the `dueDate` (or `scheduledTime` if no `dueDate` is set). * To// indicate no association to any grading period, set this field to an empty// string (""). * If specified, it must match an existing grading period ID in// the course.GradingPeriodIdstring `json:"gradingPeriodId,omitempty"`// Id: Classroom-assigned identifier of this course work, unique per course.// Read-only.Idstring `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.MaxPointsfloat64 `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.ScheduledTimestring `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.Statestring `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.SubmissionModificationModestring `json:"submissionModificationMode,omitempty"`// Title: Title of this course work. The title must be a valid UTF-8 string// containing between 1 and 3000 characters.Titlestring `json:"title,omitempty"`// TopicId: Identifier for the topic that this coursework is associated with.// Must match an existing topic in the course.TopicIdstring `json:"topicId,omitempty"`// UpdateTime: Timestamp of the most recent change to this course work.// Read-only.UpdateTimestring `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.WorkTypestring `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:"-"`}

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

func (CourseWork)MarshalJSON ¶

func (sCourseWork) MarshalJSON() ([]byte,error)

func (*CourseWork)UnmarshalJSON ¶

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

typeCourseWorkChangesInfo ¶

type CourseWorkChangesInfo struct {// CourseId: The `course_id` of the course to subscribe to work changes for.CourseIdstring `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:"-"`}

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

func (CourseWorkChangesInfo)MarshalJSON ¶

func (sCourseWorkChangesInfo) MarshalJSON() ([]byte,error)

typeCourseWorkMaterial ¶added inv0.33.0

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.AlternateLinkstring `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.AssigneeModestring `json:"assigneeMode,omitempty"`// CourseId: Identifier of the course. Read-only.CourseIdstring `json:"courseId,omitempty"`// CreationTime: Timestamp when this course work material was created.// Read-only.CreationTimestring `json:"creationTime,omitempty"`// CreatorUserId: Identifier for the user that created the course work// material. Read-only.CreatorUserIdstring `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.Descriptionstring `json:"description,omitempty"`// Id: Classroom-assigned identifier of this course work material, unique per// course. Read-only.Idstring `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.ScheduledTimestring `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.Statestring `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.Titlestring `json:"title,omitempty"`// TopicId: Identifier for the topic that this course work material is// associated with. Must match an existing topic in the course.TopicIdstring `json:"topicId,omitempty"`// UpdateTime: Timestamp of the most recent change to this course work// material. Read-only.UpdateTimestring `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:"-"`}

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

func (CourseWorkMaterial)MarshalJSON ¶added inv0.33.0

func (sCourseWorkMaterial) MarshalJSON() ([]byte,error)

typeCoursesAliasesCreateCall ¶

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

func (*CoursesAliasesCreateCall)Context ¶

func (c *CoursesAliasesCreateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAliasesCreateCall)Header ¶

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

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

typeCoursesAliasesDeleteCall ¶

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

func (*CoursesAliasesDeleteCall)Context ¶

func (c *CoursesAliasesDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAliasesDeleteCall)Header ¶

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

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

typeCoursesAliasesListCall ¶

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

func (*CoursesAliasesListCall)Context ¶

func (c *CoursesAliasesListCall) Context(ctxcontext.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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CoursesAliasesListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAliasesListCall)Header ¶

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

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

func (*CoursesAliasesListCall)IfNoneMatch ¶

func (c *CoursesAliasesListCall) IfNoneMatch(entityTagstring) *CoursesAliasesListCall

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

func (*CoursesAliasesListCall)PageSize ¶

func (c *CoursesAliasesListCall) PageSize(pageSizeint64) *CoursesAliasesListCall

PageSize sets the optional parameter "pageSize": Maximum number of items toreturn. 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(pageTokenstring) *CoursesAliasesListCall

PageToken sets the optional parameter "pageToken": nextPageToken valuereturned from a previous list call, indicating that the subsequent page ofresults should be returned. The list request must be otherwise identical tothe one that resulted in this token.

func (*CoursesAliasesListCall)Pages ¶

func (c *CoursesAliasesListCall) Pages(ctxcontext.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.

typeCoursesAliasesService ¶

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

funcNewCoursesAliasesService ¶

func NewCoursesAliasesService(s *Service) *CoursesAliasesService

func (*CoursesAliasesService)Create ¶

func (r *CoursesAliasesService) Create(courseIdstring, coursealias *CourseAlias) *CoursesAliasesCreateCall

Create: Creates an alias for a course. This method returns the followingerror codes: * `PERMISSION_DENIED` if the requesting user is not permittedto create the alias or for access errors. * `NOT_FOUND` if the course doesnot exist. * `ALREADY_EXISTS` if the alias already exists. *`FAILED_PRECONDITION` if the alias requested does not make sense for therequesting user or course (for example, if a user not in a domain attemptsto access a domain-scoped alias).

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

func (*CoursesAliasesService)Delete ¶

func (r *CoursesAliasesService) Delete(courseIdstring, aliasidstring) *CoursesAliasesDeleteCall

Delete: Deletes an alias of a course. This method returns the followingerror codes: * `PERMISSION_DENIED` if the requesting user is not permittedto remove the alias or for access errors. * `NOT_FOUND` if the alias doesnot exist. * `FAILED_PRECONDITION` if the alias requested does not makesense for the requesting user or course (for example, if a user not in adomain 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. Thisidentifier can be either the Classroom-assigned identifier or an alias.

func (*CoursesAliasesService)List ¶

func (r *CoursesAliasesService) List(courseIdstring) *CoursesAliasesListCall

List: Returns a list of aliases for a course. This method returns thefollowing error codes: * `PERMISSION_DENIED` if the requesting user is notpermitted to access the course or for access errors. * `NOT_FOUND` if thecourse does not exist.

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

typeCoursesAnnouncementsAddOnAttachmentsCreateCall ¶added inv0.186.0

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

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)AddOnToken ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsCreateCall) AddOnToken(addOnTokenstring) *CoursesAnnouncementsAddOnAttachmentsCreateCall

AddOnToken sets the optional parameter "addOnToken": Token that authorizesthe request. The token is passed as a query parameter when the user isredirected from Classroom to the add-on's URL. This authorization token isrequired for in-Classroom attachment creation but optional for partner-firstattachment creation. Returns an error if not provided for partner-firstattachment creation and the developer projects that created the attachmentand its parent stream item do not match.

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Context ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsCreateCall) Context(ctxcontext.Context) *CoursesAnnouncementsAddOnAttachmentsCreateCall

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

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Do ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsCreateCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Header ¶added inv0.186.0

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

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

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)PostId ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsCreateCall) PostId(postIdstring) *CoursesAnnouncementsAddOnAttachmentsCreateCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesAnnouncementsAddOnAttachmentsDeleteCall ¶added inv0.186.0

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

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Context ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsDeleteCall) Context(ctxcontext.Context) *CoursesAnnouncementsAddOnAttachmentsDeleteCall

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

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Do ¶added inv0.186.0

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

Do executes the "classroom.courses.announcements.addOnAttachments.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Header ¶added inv0.186.0

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

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

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)PostId ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsDeleteCall) PostId(postIdstring) *CoursesAnnouncementsAddOnAttachmentsDeleteCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesAnnouncementsAddOnAttachmentsGetCall ¶added inv0.186.0

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

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Context ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsGetCall) Context(ctxcontext.Context) *CoursesAnnouncementsAddOnAttachmentsGetCall

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

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Do ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Header ¶added inv0.186.0

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

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

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsGetCall) IfNoneMatch(entityTagstring) *CoursesAnnouncementsAddOnAttachmentsGetCall

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)PostId ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsGetCall) PostId(postIdstring) *CoursesAnnouncementsAddOnAttachmentsGetCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesAnnouncementsAddOnAttachmentsListCall ¶added inv0.186.0

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

func (*CoursesAnnouncementsAddOnAttachmentsListCall)Context ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) Context(ctxcontext.Context) *CoursesAnnouncementsAddOnAttachmentsListCall

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

func (*CoursesAnnouncementsAddOnAttachmentsListCall)Do ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAddOnAttachmentsResponse,error)

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

func (*CoursesAnnouncementsAddOnAttachmentsListCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsAddOnAttachmentsListCall)Header ¶added inv0.186.0

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

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

func (*CoursesAnnouncementsAddOnAttachmentsListCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) IfNoneMatch(entityTagstring) *CoursesAnnouncementsAddOnAttachmentsListCall

func (*CoursesAnnouncementsAddOnAttachmentsListCall)PageSize ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) PageSize(pageSizeint64) *CoursesAnnouncementsAddOnAttachmentsListCall

PageSize sets the optional parameter "pageSize": The maximum number ofattachments to return. The service may return fewer than this value. Ifunspecified, at most 20 attachments will be returned. The maximum value is20; values above 20 will be coerced to 20.

func (*CoursesAnnouncementsAddOnAttachmentsListCall)PageToken ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) PageToken(pageTokenstring) *CoursesAnnouncementsAddOnAttachmentsListCall

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListAddOnAttachments` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListAddOnAttachments` must match the call that provided the page token.

func (*CoursesAnnouncementsAddOnAttachmentsListCall)Pages ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) Pages(ctxcontext.Context, f func(*ListAddOnAttachmentsResponse)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 (*CoursesAnnouncementsAddOnAttachmentsListCall)PostId ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsListCall) PostId(postIdstring) *CoursesAnnouncementsAddOnAttachmentsListCall

PostId sets the optional parameter "postId": Identifier of the post underthe course whose attachments to enumerate. Deprecated, use `item_id`instead.

typeCoursesAnnouncementsAddOnAttachmentsPatchCall ¶added inv0.186.0

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

func (*CoursesAnnouncementsAddOnAttachmentsPatchCall)Context ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsPatchCall) Context(ctxcontext.Context) *CoursesAnnouncementsAddOnAttachmentsPatchCall

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

func (*CoursesAnnouncementsAddOnAttachmentsPatchCall)Do ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsPatchCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesAnnouncementsAddOnAttachmentsPatchCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsAddOnAttachmentsPatchCall)Header ¶added inv0.186.0

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

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

func (*CoursesAnnouncementsAddOnAttachmentsPatchCall)PostId ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsPatchCall) PostId(postIdstring) *CoursesAnnouncementsAddOnAttachmentsPatchCall

PostId sets the optional parameter "postId": Required. Identifier of thepost under which the attachment is attached.

func (*CoursesAnnouncementsAddOnAttachmentsPatchCall)UpdateMask ¶added inv0.186.0

func (c *CoursesAnnouncementsAddOnAttachmentsPatchCall) UpdateMask(updateMaskstring) *CoursesAnnouncementsAddOnAttachmentsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Mask thatidentifies which fields on the attachment to update. The update fails ifinvalid fields are specified. If a field supports empty values, it can becleared by specifying it in the update mask and not in the `AddOnAttachment`object. If a field that does not support empty values is included in theupdate mask and not set in the `AddOnAttachment` object, an`INVALID_ARGUMENT` error is returned. The following fields may be specifiedby teachers: * `title` * `teacher_view_uri` * `student_view_uri` *`student_work_review_uri` * `due_date` * `due_time` * `max_points`

typeCoursesAnnouncementsAddOnAttachmentsService ¶added inv0.186.0

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

funcNewCoursesAnnouncementsAddOnAttachmentsService ¶added inv0.186.0

func NewCoursesAnnouncementsAddOnAttachmentsService(s *Service) *CoursesAnnouncementsAddOnAttachmentsService

func (*CoursesAnnouncementsAddOnAttachmentsService)Create ¶added inv0.186.0

func (r *CoursesAnnouncementsAddOnAttachmentsService) Create(courseIdstring, itemIdstring, addonattachment *AddOnAttachment) *CoursesAnnouncementsAddOnAttachmentsCreateCall

Create: Creates an add-on attachment under a post. Requires the add-on tohave permission to create new attachments on the post. This method returnsthe following error codes: * `PERMISSION_DENIED` for access errors. *`INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of theidentified resources does not exist.

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which to create the attachment. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesAnnouncementsAddOnAttachmentsService)Delete ¶added inv0.186.0

func (r *CoursesAnnouncementsAddOnAttachmentsService) Delete(courseIdstring, itemIdstring, attachmentIdstring) *CoursesAnnouncementsAddOnAttachmentsDeleteCall

Delete: Deletes an add-on attachment. Requires the add-on to have been theoriginal creator of the attachment. This method returns the following errorcodes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if therequest is malformed. * `NOT_FOUND` if one of the identified resources doesnot exist.

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesAnnouncementsAddOnAttachmentsService)Get ¶added inv0.186.0

func (r *CoursesAnnouncementsAddOnAttachmentsService) Get(courseIdstring, itemIdstring, attachmentIdstring) *CoursesAnnouncementsAddOnAttachmentsGetCall

Get: Returns an add-on attachment. Requires the add-on requesting theattachment to be the original creator of the attachment. This method returnsthe following error codes: * `PERMISSION_DENIED` for access errors. *`INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of theidentified resources does not exist.

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesAnnouncementsAddOnAttachmentsService)List ¶added inv0.186.0

func (r *CoursesAnnouncementsAddOnAttachmentsService) List(courseIdstring, itemIdstring) *CoursesAnnouncementsAddOnAttachmentsListCall

List: Returns all attachments created by an add-on under the post. Requiresthe add-on to have active attachments on the post or have permission tocreate new attachments on the post. This method returns the following errorcodes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if therequest is malformed. * `NOT_FOUND` if one of the identified resources doesnot exist.

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` whose attachments should be enumerated. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesAnnouncementsAddOnAttachmentsService)Patch ¶added inv0.186.0

func (r *CoursesAnnouncementsAddOnAttachmentsService) Patch(courseIdstring, itemIdstring, attachmentIdstring, addonattachment *AddOnAttachment) *CoursesAnnouncementsAddOnAttachmentsPatchCall

Patch: Updates an add-on attachment. Requires the add-on to have been theoriginal creator of the attachment. This method returns the following errorcodes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if therequest is malformed. * `NOT_FOUND` if one of the identified resources doesnot exist.

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- itemId: Identifier of the post under which the attachment is attached.

typeCoursesAnnouncementsCreateCall ¶

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

func (*CoursesAnnouncementsCreateCall)Context ¶

func (c *CoursesAnnouncementsCreateCall) Context(ctxcontext.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsCreateCall)Header ¶

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

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

typeCoursesAnnouncementsDeleteCall ¶

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

func (*CoursesAnnouncementsDeleteCall)Context ¶

func (c *CoursesAnnouncementsDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsDeleteCall)Header ¶

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

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

typeCoursesAnnouncementsGetAddOnContextCall ¶added inv0.186.0

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

func (*CoursesAnnouncementsGetAddOnContextCall)AddOnToken ¶added inv0.186.0

func (c *CoursesAnnouncementsGetAddOnContextCall) AddOnToken(addOnTokenstring) *CoursesAnnouncementsGetAddOnContextCall

AddOnToken sets the optional parameter "addOnToken": Token that authorizesthe request. The token is passed as a query parameter when the user isredirected from Classroom to the add-on's URL. The authorization token isrequired when neither of the following is true: * The add-on has attachmentson the post. * The developer project issuing the request is the same projectthat created the post.

func (*CoursesAnnouncementsGetAddOnContextCall)AttachmentId ¶added inv0.186.0

func (c *CoursesAnnouncementsGetAddOnContextCall) AttachmentId(attachmentIdstring) *CoursesAnnouncementsGetAddOnContextCall

AttachmentId sets the optional parameter "attachmentId": The identifier ofthe attachment. This field is required for all requests except when the useris in the Attachment Discovery iframe(https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).

func (*CoursesAnnouncementsGetAddOnContextCall)Context ¶added inv0.186.0

func (c *CoursesAnnouncementsGetAddOnContextCall) Context(ctxcontext.Context) *CoursesAnnouncementsGetAddOnContextCall

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

func (*CoursesAnnouncementsGetAddOnContextCall)Do ¶added inv0.186.0

func (c *CoursesAnnouncementsGetAddOnContextCall) Do(opts ...googleapi.CallOption) (*AddOnContext,error)

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

func (*CoursesAnnouncementsGetAddOnContextCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsGetAddOnContextCall)Header ¶added inv0.186.0

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

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

func (*CoursesAnnouncementsGetAddOnContextCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesAnnouncementsGetAddOnContextCall) IfNoneMatch(entityTagstring) *CoursesAnnouncementsGetAddOnContextCall

func (*CoursesAnnouncementsGetAddOnContextCall)PostId ¶added inv0.186.0

func (c *CoursesAnnouncementsGetAddOnContextCall) PostId(postIdstring) *CoursesAnnouncementsGetAddOnContextCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesAnnouncementsGetCall ¶

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

func (*CoursesAnnouncementsGetCall)Context ¶

func (c *CoursesAnnouncementsGetCall) Context(ctxcontext.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsGetCall)Header ¶

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

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

func (*CoursesAnnouncementsGetCall)IfNoneMatch ¶

func (c *CoursesAnnouncementsGetCall) IfNoneMatch(entityTagstring) *CoursesAnnouncementsGetCall

typeCoursesAnnouncementsListCall ¶

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 isleft 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 domainadministrators.

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

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

func (*CoursesAnnouncementsListCall)Context ¶

func (c *CoursesAnnouncementsListCall) Context(ctxcontext.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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CoursesAnnouncementsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsListCall)Header ¶

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

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

func (*CoursesAnnouncementsListCall)IfNoneMatch ¶

func (c *CoursesAnnouncementsListCall) IfNoneMatch(entityTagstring) *CoursesAnnouncementsListCall

func (*CoursesAnnouncementsListCall)OrderBy ¶

func (c *CoursesAnnouncementsListCall) OrderBy(orderBystring) *CoursesAnnouncementsListCall

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

func (*CoursesAnnouncementsListCall)PageSize ¶

func (c *CoursesAnnouncementsListCall) PageSize(pageSizeint64) *CoursesAnnouncementsListCall

func (*CoursesAnnouncementsListCall)PageToken ¶

func (c *CoursesAnnouncementsListCall) PageToken(pageTokenstring) *CoursesAnnouncementsListCall

func (*CoursesAnnouncementsListCall)Pages ¶

func (c *CoursesAnnouncementsListCall) Pages(ctxcontext.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.

typeCoursesAnnouncementsModifyAssigneesCall ¶

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

func (*CoursesAnnouncementsModifyAssigneesCall)Context ¶

func (c *CoursesAnnouncementsModifyAssigneesCall) Context(ctxcontext.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsModifyAssigneesCall)Header ¶

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

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

typeCoursesAnnouncementsPatchCall ¶

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

func (*CoursesAnnouncementsPatchCall)Context ¶

func (c *CoursesAnnouncementsPatchCall) Context(ctxcontext.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesAnnouncementsPatchCall)Header ¶

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

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

func (*CoursesAnnouncementsPatchCall)UpdateMask ¶

func (c *CoursesAnnouncementsPatchCall) UpdateMask(updateMaskstring) *CoursesAnnouncementsPatchCall

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

typeCoursesAnnouncementsService ¶

type CoursesAnnouncementsService struct {AddOnAttachments *CoursesAnnouncementsAddOnAttachmentsService// contains filtered or unexported fields}

funcNewCoursesAnnouncementsService ¶

func NewCoursesAnnouncementsService(s *Service) *CoursesAnnouncementsService

func (*CoursesAnnouncementsService)Create ¶

func (r *CoursesAnnouncementsService) Create(courseIdstring, announcement *Announcement) *CoursesAnnouncementsCreateCall

Create: Creates an announcement. This method returns the following errorcodes: * `PERMISSION_DENIED` if the requesting user is not permitted toaccess the requested course, create announcements in the requested course,share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if therequest 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 theClassroom-assigned identifier or an alias.

func (*CoursesAnnouncementsService)Delete ¶

func (r *CoursesAnnouncementsService) Delete(courseIdstring, idstring) *CoursesAnnouncementsDeleteCall

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

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

func (*CoursesAnnouncementsService)Get ¶

func (r *CoursesAnnouncementsService) Get(courseIdstring, idstring) *CoursesAnnouncementsGetCall

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

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

func (*CoursesAnnouncementsService)GetAddOnContext ¶added inv0.186.0

func (r *CoursesAnnouncementsService) GetAddOnContext(courseIdstring, itemIdstring) *CoursesAnnouncementsGetAddOnContextCall

GetAddOnContext: Gets metadata for Classroom add-ons in the context of aspecific post. To maintain the integrity of its own data and permissionsmodel, an add-on should call this to validate query parameters and therequesting user's role whenever the add-on is opened in an iframe(https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview).This method returns the following error codes: * `PERMISSION_DENIED` foraccess errors. * `INVALID_ARGUMENT` if the request is malformed. *`NOT_FOUND` if one of the identified resources does not exist.

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesAnnouncementsService)List ¶

func (r *CoursesAnnouncementsService) List(courseIdstring) *CoursesAnnouncementsListCall

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

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

func (*CoursesAnnouncementsService)ModifyAssignees ¶

func (r *CoursesAnnouncementsService) ModifyAssignees(courseIdstring, idstring, modifyannouncementassigneesrequest *ModifyAnnouncementAssigneesRequest) *CoursesAnnouncementsModifyAssigneesCall

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

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

func (*CoursesAnnouncementsService)Patch ¶

func (r *CoursesAnnouncementsService) Patch(courseIdstring, idstring, announcement *Announcement) *CoursesAnnouncementsPatchCall

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

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

typeCoursesCourseWorkAddOnAttachmentsCreateCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsCreateCall)AddOnToken ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsCreateCall) AddOnToken(addOnTokenstring) *CoursesCourseWorkAddOnAttachmentsCreateCall

func (*CoursesCourseWorkAddOnAttachmentsCreateCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsCreateCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsCreateCall

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

func (*CoursesCourseWorkAddOnAttachmentsCreateCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsCreateCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesCourseWorkAddOnAttachmentsCreateCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsCreateCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsCreateCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsCreateCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsCreateCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkAddOnAttachmentsDeleteCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsDeleteCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsDeleteCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsDeleteCall

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

func (*CoursesCourseWorkAddOnAttachmentsDeleteCall)Do ¶added inv0.186.0

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

Do executes the "classroom.courses.courseWork.addOnAttachments.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkAddOnAttachmentsDeleteCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsDeleteCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsDeleteCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsDeleteCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsDeleteCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkAddOnAttachmentsGetCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsGetCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsGetCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsGetCall

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

func (*CoursesCourseWorkAddOnAttachmentsGetCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesCourseWorkAddOnAttachmentsGetCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsGetCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsGetCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkAddOnAttachmentsGetCall

func (*CoursesCourseWorkAddOnAttachmentsGetCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsGetCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsGetCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkAddOnAttachmentsListCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsListCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsListCall

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

func (*CoursesCourseWorkAddOnAttachmentsListCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAddOnAttachmentsResponse,error)

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

func (*CoursesCourseWorkAddOnAttachmentsListCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsListCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsListCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkAddOnAttachmentsListCall

func (*CoursesCourseWorkAddOnAttachmentsListCall)PageSize ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) PageSize(pageSizeint64) *CoursesCourseWorkAddOnAttachmentsListCall

func (*CoursesCourseWorkAddOnAttachmentsListCall)PageToken ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) PageToken(pageTokenstring) *CoursesCourseWorkAddOnAttachmentsListCall

func (*CoursesCourseWorkAddOnAttachmentsListCall)Pages ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) Pages(ctxcontext.Context, f func(*ListAddOnAttachmentsResponse)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 (*CoursesCourseWorkAddOnAttachmentsListCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsListCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsListCall

PostId sets the optional parameter "postId": Identifier of the post underthe course whose attachments to enumerate. Deprecated, use `item_id`instead.

typeCoursesCourseWorkAddOnAttachmentsPatchCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsPatchCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsPatchCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsPatchCall

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

func (*CoursesCourseWorkAddOnAttachmentsPatchCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsPatchCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesCourseWorkAddOnAttachmentsPatchCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsPatchCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsPatchCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsPatchCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsPatchCall

PostId sets the optional parameter "postId": Required. Identifier of thepost under which the attachment is attached.

func (*CoursesCourseWorkAddOnAttachmentsPatchCall)UpdateMask ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkAddOnAttachmentsPatchCall

typeCoursesCourseWorkAddOnAttachmentsService ¶added inv0.186.0

type CoursesCourseWorkAddOnAttachmentsService struct {StudentSubmissions *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsService// contains filtered or unexported fields}

funcNewCoursesCourseWorkAddOnAttachmentsService ¶added inv0.186.0

func NewCoursesCourseWorkAddOnAttachmentsService(s *Service) *CoursesCourseWorkAddOnAttachmentsService

func (*CoursesCourseWorkAddOnAttachmentsService)Create ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsService) Create(courseIdstring, itemIdstring, addonattachment *AddOnAttachment) *CoursesCourseWorkAddOnAttachmentsCreateCall

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which to create the attachment. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkAddOnAttachmentsService)Delete ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsService) Delete(courseIdstring, itemIdstring, attachmentIdstring) *CoursesCourseWorkAddOnAttachmentsDeleteCall

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkAddOnAttachmentsService)Get ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsService) Get(courseIdstring, itemIdstring, attachmentIdstring) *CoursesCourseWorkAddOnAttachmentsGetCall

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkAddOnAttachmentsService)List ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsService) List(courseIdstring, itemIdstring) *CoursesCourseWorkAddOnAttachmentsListCall

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` whose attachments should be enumerated. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkAddOnAttachmentsService)Patch ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsService) Patch(courseIdstring, itemIdstring, attachmentIdstring, addonattachment *AddOnAttachment) *CoursesCourseWorkAddOnAttachmentsPatchCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- itemId: Identifier of the post under which the attachment is attached.

typeCoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall) Do(opts ...googleapi.CallOption) (*AddOnAttachmentStudentSubmission,error)

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall ¶added inv0.186.0

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall) Context(ctxcontext.Context) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall) Do(opts ...googleapi.CallOption) (*AddOnAttachmentStudentSubmission,error)

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall) PostId(postIdstring) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall)UpdateMask ¶added inv0.186.0

func (c *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall

typeCoursesCourseWorkAddOnAttachmentsStudentSubmissionsService ¶added inv0.186.0

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

funcNewCoursesCourseWorkAddOnAttachmentsStudentSubmissionsService ¶added inv0.186.0

func NewCoursesCourseWorkAddOnAttachmentsStudentSubmissionsService(s *Service) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsService

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsService)Get ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsService) Get(courseIdstring, itemIdstring, attachmentIdstring, submissionIdstring) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsGetCall

Get: Returns a student submission for an add-on attachment. This methodreturns the following error codes: * `PERMISSION_DENIED` for access errors.* `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one ofthe identified resources does not exist.

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.
submissionId: Identifier of the student’s submission.

func (*CoursesCourseWorkAddOnAttachmentsStudentSubmissionsService)Patch ¶added inv0.186.0

func (r *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsService) Patch(courseIdstring, itemIdstring, attachmentIdstring, submissionIdstring, addonattachmentstudentsubmission *AddOnAttachmentStudentSubmission) *CoursesCourseWorkAddOnAttachmentsStudentSubmissionsPatchCall

Patch: Updates data associated with an add-on attachment submission.Requires the add-on to have been the original creator of the attachment andthe attachment to have a positive `max_points` value set. This methodreturns the following error codes: * `PERMISSION_DENIED` for access errors.* `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one ofthe identified resources does not exist.

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.
submissionId: Identifier of the student's submission.

typeCoursesCourseWorkCreateCall ¶

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

func (*CoursesCourseWorkCreateCall)Context ¶

func (c *CoursesCourseWorkCreateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkCreateCall)Header ¶

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

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

typeCoursesCourseWorkDeleteCall ¶

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

func (*CoursesCourseWorkDeleteCall)Context ¶

func (c *CoursesCourseWorkDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkDeleteCall)Header ¶

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

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

typeCoursesCourseWorkGetAddOnContextCall ¶added inv0.186.0

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

func (*CoursesCourseWorkGetAddOnContextCall)AddOnToken ¶added inv0.186.0

func (c *CoursesCourseWorkGetAddOnContextCall) AddOnToken(addOnTokenstring) *CoursesCourseWorkGetAddOnContextCall

AddOnToken sets the optional parameter "addOnToken": Token that authorizesthe request. The token is passed as a query parameter when the user isredirected from Classroom to the add-on's URL. The authorization token isrequired when neither of the following is true: * The add-on has attachmentson the post. * The developer project issuing the request is the same projectthat created the post.

func (*CoursesCourseWorkGetAddOnContextCall)AttachmentId ¶added inv0.186.0

func (c *CoursesCourseWorkGetAddOnContextCall) AttachmentId(attachmentIdstring) *CoursesCourseWorkGetAddOnContextCall

func (*CoursesCourseWorkGetAddOnContextCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkGetAddOnContextCall) Context(ctxcontext.Context) *CoursesCourseWorkGetAddOnContextCall

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

func (*CoursesCourseWorkGetAddOnContextCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkGetAddOnContextCall) Do(opts ...googleapi.CallOption) (*AddOnContext,error)

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

func (*CoursesCourseWorkGetAddOnContextCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkGetAddOnContextCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkGetAddOnContextCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkGetAddOnContextCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkGetAddOnContextCall

func (*CoursesCourseWorkGetAddOnContextCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkGetAddOnContextCall) PostId(postIdstring) *CoursesCourseWorkGetAddOnContextCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkGetCall ¶

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

func (*CoursesCourseWorkGetCall)Context ¶

func (c *CoursesCourseWorkGetCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkGetCall)Header ¶

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

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

func (*CoursesCourseWorkGetCall)IfNoneMatch ¶

func (c *CoursesCourseWorkGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkGetCall

typeCoursesCourseWorkListCall ¶

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

func (*CoursesCourseWorkListCall)Context ¶

func (c *CoursesCourseWorkListCall) Context(ctxcontext.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": Restrictionon the work status to return. Only courseWork that matches is returned. Ifunspecified, 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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkListCall)Header ¶

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

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

func (*CoursesCourseWorkListCall)IfNoneMatch ¶

func (c *CoursesCourseWorkListCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkListCall

func (*CoursesCourseWorkListCall)OrderBy ¶

func (c *CoursesCourseWorkListCall) OrderBy(orderBystring) *CoursesCourseWorkListCall

OrderBy sets the optional parameter "orderBy": Optional sort ordering forresults. A comma-separated list of fields with an optional sort directionkeyword. Supported fields are `updateTime` and `dueDate`. Supporteddirection 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(pageSizeint64) *CoursesCourseWorkListCall

func (*CoursesCourseWorkListCall)PageToken ¶

func (c *CoursesCourseWorkListCall) PageToken(pageTokenstring) *CoursesCourseWorkListCall

func (*CoursesCourseWorkListCall)Pages ¶

func (c *CoursesCourseWorkListCall) Pages(ctxcontext.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.

typeCoursesCourseWorkMaterialsAddOnAttachmentsCreateCall ¶added inv0.186.0

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall)AddOnToken ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall) AddOnToken(addOnTokenstring) *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall

func (*CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall) PostId(postIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall ¶added inv0.186.0

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall)Do ¶added inv0.186.0

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

Do executes the "classroom.courses.courseWorkMaterials.addOnAttachments.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall) PostId(postIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkMaterialsAddOnAttachmentsGetCall ¶added inv0.186.0

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsGetCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsGetCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsGetCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsGetCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsGetCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall

func (*CoursesCourseWorkMaterialsAddOnAttachmentsGetCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall) PostId(postIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkMaterialsAddOnAttachmentsListCall ¶added inv0.186.0

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsAddOnAttachmentsListCall

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAddOnAttachmentsResponse,error)

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkMaterialsAddOnAttachmentsListCall

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)PageSize ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) PageSize(pageSizeint64) *CoursesCourseWorkMaterialsAddOnAttachmentsListCall

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)PageToken ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) PageToken(pageTokenstring) *CoursesCourseWorkMaterialsAddOnAttachmentsListCall

func (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)Pages ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) Pages(ctxcontext.Context, f func(*ListAddOnAttachmentsResponse)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 (*CoursesCourseWorkMaterialsAddOnAttachmentsListCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsListCall) PostId(postIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsListCall

PostId sets the optional parameter "postId": Identifier of the post underthe course whose attachments to enumerate. Deprecated, use `item_id`instead.

typeCoursesCourseWorkMaterialsAddOnAttachmentsPatchCall ¶added inv0.186.0

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall) PostId(postIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall

PostId sets the optional parameter "postId": Required. Identifier of thepost under which the attachment is attached.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall)UpdateMask ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall

typeCoursesCourseWorkMaterialsAddOnAttachmentsService ¶added inv0.186.0

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

funcNewCoursesCourseWorkMaterialsAddOnAttachmentsService ¶added inv0.186.0

func NewCoursesCourseWorkMaterialsAddOnAttachmentsService(s *Service) *CoursesCourseWorkMaterialsAddOnAttachmentsService

func (*CoursesCourseWorkMaterialsAddOnAttachmentsService)Create ¶added inv0.186.0

func (r *CoursesCourseWorkMaterialsAddOnAttachmentsService) Create(courseIdstring, itemIdstring, addonattachment *AddOnAttachment) *CoursesCourseWorkMaterialsAddOnAttachmentsCreateCall

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which to create the attachment. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsService)Delete ¶added inv0.186.0

func (r *CoursesCourseWorkMaterialsAddOnAttachmentsService) Delete(courseIdstring, itemIdstring, attachmentIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsDeleteCall

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsService)Get ¶added inv0.186.0

func (r *CoursesCourseWorkMaterialsAddOnAttachmentsService) Get(courseIdstring, itemIdstring, attachmentIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsGetCall

attachmentId: Identifier of the attachment.
courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsService)List ¶added inv0.186.0

func (r *CoursesCourseWorkMaterialsAddOnAttachmentsService) List(courseIdstring, itemIdstring) *CoursesCourseWorkMaterialsAddOnAttachmentsListCall

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` whose attachments should be enumerated. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkMaterialsAddOnAttachmentsService)Patch ¶added inv0.186.0

func (r *CoursesCourseWorkMaterialsAddOnAttachmentsService) Patch(courseIdstring, itemIdstring, attachmentIdstring, addonattachment *AddOnAttachment) *CoursesCourseWorkMaterialsAddOnAttachmentsPatchCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- itemId: Identifier of the post under which the attachment is attached.

typeCoursesCourseWorkMaterialsCreateCall ¶added inv0.33.0

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

func (*CoursesCourseWorkMaterialsCreateCall)Context ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsCreateCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsCreateCall

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

func (*CoursesCourseWorkMaterialsCreateCall)Do ¶added inv0.33.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkMaterialsCreateCall)Fields ¶added inv0.33.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsCreateCall)Header ¶added inv0.33.0

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

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

typeCoursesCourseWorkMaterialsDeleteCall ¶added inv0.33.0

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

func (*CoursesCourseWorkMaterialsDeleteCall)Context ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsDeleteCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsDeleteCall

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

func (*CoursesCourseWorkMaterialsDeleteCall)Do ¶added inv0.33.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsDeleteCall)Fields ¶added inv0.33.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsDeleteCall)Header ¶added inv0.33.0

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

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

typeCoursesCourseWorkMaterialsGetAddOnContextCall ¶added inv0.186.0

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

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)AddOnToken ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsGetAddOnContextCall) AddOnToken(addOnTokenstring) *CoursesCourseWorkMaterialsGetAddOnContextCall

AddOnToken sets the optional parameter "addOnToken": Token that authorizesthe request. The token is passed as a query parameter when the user isredirected from Classroom to the add-on's URL. The authorization token isrequired when neither of the following is true: * The add-on has attachmentson the post. * The developer project issuing the request is the same projectthat created the post.

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)AttachmentId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsGetAddOnContextCall) AttachmentId(attachmentIdstring) *CoursesCourseWorkMaterialsGetAddOnContextCall

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)Context ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsGetAddOnContextCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsGetAddOnContextCall

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

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)Do ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsGetAddOnContextCall) Do(opts ...googleapi.CallOption) (*AddOnContext,error)

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

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)Header ¶added inv0.186.0

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

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

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsGetAddOnContextCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkMaterialsGetAddOnContextCall

func (*CoursesCourseWorkMaterialsGetAddOnContextCall)PostId ¶added inv0.186.0

func (c *CoursesCourseWorkMaterialsGetAddOnContextCall) PostId(postIdstring) *CoursesCourseWorkMaterialsGetAddOnContextCall

PostId sets the optional parameter "postId": Deprecated, use `item_id`instead.

typeCoursesCourseWorkMaterialsGetCall ¶added inv0.33.0

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

func (*CoursesCourseWorkMaterialsGetCall)Context ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsGetCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsGetCall

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

func (*CoursesCourseWorkMaterialsGetCall)Do ¶added inv0.33.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkMaterialsGetCall)Fields ¶added inv0.33.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsGetCall)Header ¶added inv0.33.0

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

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

func (*CoursesCourseWorkMaterialsGetCall)IfNoneMatch ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkMaterialsGetCall

typeCoursesCourseWorkMaterialsListCall ¶added inv0.33.0

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

func (*CoursesCourseWorkMaterialsListCall)Context ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsListCall

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

func (*CoursesCourseWorkMaterialsListCall)CourseWorkMaterialStates ¶added inv0.33.0

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

CourseWorkMaterialStates sets the optional parameter"courseWorkMaterialStates": Restriction on the work status to return. Onlycourse work material that matches is returned. If unspecified, items with awork 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 anddomain administrators.

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

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

func (*CoursesCourseWorkMaterialsListCall)Do ¶added inv0.33.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CoursesCourseWorkMaterialsListCall)Fields ¶added inv0.33.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsListCall)Header ¶added inv0.33.0

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

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

func (*CoursesCourseWorkMaterialsListCall)IfNoneMatch ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkMaterialsListCall

func (*CoursesCourseWorkMaterialsListCall)MaterialDriveId ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) MaterialDriveId(materialDriveIdstring) *CoursesCourseWorkMaterialsListCall

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

func (*CoursesCourseWorkMaterialsListCall)MaterialLink ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) MaterialLink(materialLinkstring) *CoursesCourseWorkMaterialsListCall

MaterialLink sets the optional parameter "materialLink": Optional filteringfor course work material with at least one link material whose URL partiallymatches the provided string.

func (*CoursesCourseWorkMaterialsListCall)OrderBy ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) OrderBy(orderBystring) *CoursesCourseWorkMaterialsListCall

func (*CoursesCourseWorkMaterialsListCall)PageSize ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) PageSize(pageSizeint64) *CoursesCourseWorkMaterialsListCall

func (*CoursesCourseWorkMaterialsListCall)PageToken ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) PageToken(pageTokenstring) *CoursesCourseWorkMaterialsListCall

func (*CoursesCourseWorkMaterialsListCall)Pages ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsListCall) Pages(ctxcontext.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.

typeCoursesCourseWorkMaterialsPatchCall ¶added inv0.33.0

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

func (*CoursesCourseWorkMaterialsPatchCall)Context ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsPatchCall) Context(ctxcontext.Context) *CoursesCourseWorkMaterialsPatchCall

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

func (*CoursesCourseWorkMaterialsPatchCall)Do ¶added inv0.33.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkMaterialsPatchCall)Fields ¶added inv0.33.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkMaterialsPatchCall)Header ¶added inv0.33.0

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

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

func (*CoursesCourseWorkMaterialsPatchCall)UpdateMask ¶added inv0.33.0

func (c *CoursesCourseWorkMaterialsPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkMaterialsPatchCall

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

typeCoursesCourseWorkMaterialsService ¶added inv0.33.0

type CoursesCourseWorkMaterialsService struct {AddOnAttachments *CoursesCourseWorkMaterialsAddOnAttachmentsService// contains filtered or unexported fields}

funcNewCoursesCourseWorkMaterialsService ¶added inv0.33.0

func NewCoursesCourseWorkMaterialsService(s *Service) *CoursesCourseWorkMaterialsService

func (*CoursesCourseWorkMaterialsService)Create ¶added inv0.33.0

func (r *CoursesCourseWorkMaterialsService) Create(courseIdstring, courseworkmaterial *CourseWorkMaterial) *CoursesCourseWorkMaterialsCreateCall

Create: Creates a course work material. This method returns the followingerror codes: * `PERMISSION_DENIED` if the requesting user is not permittedto access the requested course, create course work material in the requestedcourse, 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 theClassroom-assigned identifier or an alias.

func (*CoursesCourseWorkMaterialsService)Delete ¶added inv0.33.0

func (r *CoursesCourseWorkMaterialsService) Delete(courseIdstring, idstring) *CoursesCourseWorkMaterialsDeleteCall

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

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

func (*CoursesCourseWorkMaterialsService)Get ¶added inv0.33.0

func (r *CoursesCourseWorkMaterialsService) Get(courseIdstring, idstring) *CoursesCourseWorkMaterialsGetCall

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

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

func (*CoursesCourseWorkMaterialsService)GetAddOnContext ¶added inv0.186.0

func (r *CoursesCourseWorkMaterialsService) GetAddOnContext(courseIdstring, itemIdstring) *CoursesCourseWorkMaterialsGetAddOnContextCall

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkMaterialsService)List ¶added inv0.33.0

func (r *CoursesCourseWorkMaterialsService) List(courseIdstring) *CoursesCourseWorkMaterialsListCall

List: Returns a list of course work material that the requester is permittedto 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 therequesting user is not permitted to access the requested course or foraccess 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 theClassroom-assigned identifier or an alias.

func (*CoursesCourseWorkMaterialsService)Patch ¶added inv0.33.0

func (r *CoursesCourseWorkMaterialsService) Patch(courseIdstring, idstring, courseworkmaterial *CourseWorkMaterial) *CoursesCourseWorkMaterialsPatchCall

Patch: Updates one or more fields of a course work material. This methodreturns the following error codes: * `PERMISSION_DENIED` if the requestingdeveloper project for access errors. * `INVALID_ARGUMENT` if the request ismalformed. * `FAILED_PRECONDITION` if the requested course work material hasalready been deleted. * `NOT_FOUND` if the requested course or course workmaterial does not exist

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

typeCoursesCourseWorkModifyAssigneesCall ¶

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

func (*CoursesCourseWorkModifyAssigneesCall)Context ¶

func (c *CoursesCourseWorkModifyAssigneesCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkModifyAssigneesCall)Header ¶

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

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

typeCoursesCourseWorkPatchCall ¶

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

func (*CoursesCourseWorkPatchCall)Context ¶

func (c *CoursesCourseWorkPatchCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkPatchCall)Header ¶

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

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

func (*CoursesCourseWorkPatchCall)UpdateMask ¶

func (c *CoursesCourseWorkPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkPatchCall

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

typeCoursesCourseWorkRubricsCreateCall ¶added inv0.210.0

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

func (*CoursesCourseWorkRubricsCreateCall)Context ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsCreateCall) Context(ctxcontext.Context) *CoursesCourseWorkRubricsCreateCall

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

func (*CoursesCourseWorkRubricsCreateCall)Do ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsCreateCall) Do(opts ...googleapi.CallOption) (*Rubric,error)

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

func (*CoursesCourseWorkRubricsCreateCall)Fields ¶added inv0.210.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkRubricsCreateCall)Header ¶added inv0.210.0

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

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

typeCoursesCourseWorkRubricsDeleteCall ¶added inv0.210.0

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

func (*CoursesCourseWorkRubricsDeleteCall)Context ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsDeleteCall) Context(ctxcontext.Context) *CoursesCourseWorkRubricsDeleteCall

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

func (*CoursesCourseWorkRubricsDeleteCall)Do ¶added inv0.210.0

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

Do executes the "classroom.courses.courseWork.rubrics.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkRubricsDeleteCall)Fields ¶added inv0.210.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkRubricsDeleteCall)Header ¶added inv0.210.0

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

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

typeCoursesCourseWorkRubricsGetCall ¶added inv0.210.0

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

func (*CoursesCourseWorkRubricsGetCall)Context ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsGetCall) Context(ctxcontext.Context) *CoursesCourseWorkRubricsGetCall

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

func (*CoursesCourseWorkRubricsGetCall)Do ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsGetCall) Do(opts ...googleapi.CallOption) (*Rubric,error)

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

func (*CoursesCourseWorkRubricsGetCall)Fields ¶added inv0.210.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkRubricsGetCall)Header ¶added inv0.210.0

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

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

func (*CoursesCourseWorkRubricsGetCall)IfNoneMatch ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkRubricsGetCall

typeCoursesCourseWorkRubricsListCall ¶added inv0.210.0

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

func (*CoursesCourseWorkRubricsListCall)Context ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsListCall) Context(ctxcontext.Context) *CoursesCourseWorkRubricsListCall

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

func (*CoursesCourseWorkRubricsListCall)Do ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsListCall) Do(opts ...googleapi.CallOption) (*ListRubricsResponse,error)

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

func (*CoursesCourseWorkRubricsListCall)Fields ¶added inv0.210.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkRubricsListCall)Header ¶added inv0.210.0

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

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

func (*CoursesCourseWorkRubricsListCall)IfNoneMatch ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsListCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkRubricsListCall

func (*CoursesCourseWorkRubricsListCall)PageSize ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsListCall) PageSize(pageSizeint64) *CoursesCourseWorkRubricsListCall

PageSize sets the optional parameter "pageSize": The maximum number ofrubrics to return. If unspecified, at most 1 rubric is returned. The maximumvalue is 1; values above 1 are coerced to 1.

func (*CoursesCourseWorkRubricsListCall)PageToken ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsListCall) PageToken(pageTokenstring) *CoursesCourseWorkRubricsListCall

func (*CoursesCourseWorkRubricsListCall)Pages ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsListCall) Pages(ctxcontext.Context, f func(*ListRubricsResponse)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.

typeCoursesCourseWorkRubricsPatchCall ¶added inv0.210.0

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

func (*CoursesCourseWorkRubricsPatchCall)Context ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsPatchCall) Context(ctxcontext.Context) *CoursesCourseWorkRubricsPatchCall

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

func (*CoursesCourseWorkRubricsPatchCall)Do ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsPatchCall) Do(opts ...googleapi.CallOption) (*Rubric,error)

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

func (*CoursesCourseWorkRubricsPatchCall)Fields ¶added inv0.210.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkRubricsPatchCall)Header ¶added inv0.210.0

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

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

func (*CoursesCourseWorkRubricsPatchCall)UpdateMask ¶added inv0.210.0

func (c *CoursesCourseWorkRubricsPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkRubricsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifieswhich fields on the rubric to update. This field is required to do anupdate. The update fails if invalid fields are specified. There are multipleoptions to define the criteria of a rubric: the `source_spreadsheet_id` andthe `criteria` list. Only one of these can be used at a time to define arubric. The rubric `criteria` list is fully replaced by the rubric criteriaspecified in the update request. For example, if a criterion or level ismissing from the request, it is deleted. New criteria and levels are addedand an ID is assigned. Existing criteria and levels retain the previouslyassigned ID if the ID is specified in the request. The following fields canbe specified by teachers: * `criteria` * `source_spreadsheet_id`

typeCoursesCourseWorkRubricsService ¶added inv0.210.0

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

funcNewCoursesCourseWorkRubricsService ¶added inv0.210.0

func NewCoursesCourseWorkRubricsService(s *Service) *CoursesCourseWorkRubricsService

func (*CoursesCourseWorkRubricsService)Create ¶added inv0.210.0

func (r *CoursesCourseWorkRubricsService) Create(courseIdstring, courseWorkIdstring, rubric *Rubric) *CoursesCourseWorkRubricsCreateCall

Create: Creates a rubric. The requesting user and course owner must haverubrics creation capabilities. For details, see licensing requirements(https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements).For further details, see Rubrics structure and known limitations(/classroom/rubrics/limitations). This request must be made by the GoogleCloud console of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create the parentcourse work item. This method returns the following error codes: *`PERMISSION_DENIED` if the requesting user isn't permitted to create rubricsfor course work in the requested course. * `INTERNAL` if the request hasinsufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformedand for the following request error: * `RubricCriteriaInvalidFormat` *`NOT_FOUND` if the requested course or course work don't exist or the userdoesn't have access to the course or course work. * `FAILED_PRECONDITION`for the following request error: * `AttachmentNotVisible`

- courseId: Identifier of the course.- courseWorkId: Identifier of the course work.

func (*CoursesCourseWorkRubricsService)Delete ¶added inv0.210.0

func (r *CoursesCourseWorkRubricsService) Delete(courseIdstring, courseWorkIdstring, idstring) *CoursesCourseWorkRubricsDeleteCall

Delete: Deletes a rubric. The requesting user and course owner must haverubrics creation capabilities. For details, see licensing requirements(https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements).This request must be made by the Google Cloud console of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create thecorresponding rubric. This method returns the following error codes: *`PERMISSION_DENIED` if the requesting developer project didn't create thecorresponding rubric, or if the requesting user isn't permitted to deletethe requested rubric. * `NOT_FOUND` if no rubric exists with the requestedID or the user does not have access to the course, course work, or rubric. *`INVALID_ARGUMENT` if grading has already started on the rubric.

- courseId: Identifier of the course.- courseWorkId: Identifier of the course work.- id: Identifier of the rubric.

func (*CoursesCourseWorkRubricsService)Get ¶added inv0.210.0

func (r *CoursesCourseWorkRubricsService) Get(courseIdstring, courseWorkIdstring, idstring) *CoursesCourseWorkRubricsGetCall

Get: Returns a rubric. This method returns the following error codes: *`PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the requestis malformed. * `NOT_FOUND` if the requested course, course work, or rubricdoesn't exist or if the user doesn't have access to the corresponding coursework.

- courseId: Identifier of the course.- courseWorkId: Identifier of the course work.- id: Identifier of the rubric.

func (*CoursesCourseWorkRubricsService)List ¶added inv0.210.0

func (r *CoursesCourseWorkRubricsService) List(courseIdstring, courseWorkIdstring) *CoursesCourseWorkRubricsListCall

List: Returns a list of rubrics that the requester is permitted to view.This method returns the following error codes: * `PERMISSION_DENIED` foraccess errors. * `INVALID_ARGUMENT` if the request is malformed. *`NOT_FOUND` if the requested course or course work doesn't exist or if theuser doesn't have access to the corresponding course work.

- courseId: Identifier of the course.- courseWorkId: Identifier of the course work.

func (*CoursesCourseWorkRubricsService)Patch ¶added inv0.210.0

func (r *CoursesCourseWorkRubricsService) Patch(courseIdstring, courseWorkIdstring, idstring, rubric *Rubric) *CoursesCourseWorkRubricsPatchCall

Patch: Updates a rubric. See google.classroom.v1.Rubric for details of whichfields can be updated. Rubric update capabilities are limited(/classroom/rubrics/limitations) once grading has started. The requestinguser and course owner must have rubrics creation capabilities. For details,see licensing requirements(https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements).This request must be made by the Google Cloud console of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create the parentcourse work item. This method returns the following error codes: *`PERMISSION_DENIED` if the requesting developer project didn't create thecorresponding course work, if the user isn't permitted to make the requestedmodification to the rubric, or for access errors. This error code is alsoreturned if grading has already started on the rubric. * `INVALID_ARGUMENT`if the request is malformed and for the following request error: *`RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, coursework, or rubric doesn't exist or if the user doesn't have access to thecorresponding course work. * `INTERNAL` if grading has already started onthe rubric.

- courseId: Identifier of the course.- courseWorkId: Identifier of the course work.- id: Optional. Identifier of the rubric.

typeCoursesCourseWorkService ¶

type CoursesCourseWorkService struct {AddOnAttachments *CoursesCourseWorkAddOnAttachmentsServiceRubrics *CoursesCourseWorkRubricsServiceStudentSubmissions *CoursesCourseWorkStudentSubmissionsService// contains filtered or unexported fields}

funcNewCoursesCourseWorkService ¶

func NewCoursesCourseWorkService(s *Service) *CoursesCourseWorkService

func (*CoursesCourseWorkService)Create ¶

func (r *CoursesCourseWorkService) Create(courseIdstring, coursework *CourseWork) *CoursesCourseWorkCreateCall

Create: Creates course work. The resulting course work (and correspondingstudent submissions) are associated with the Developer Console project ofthe OAuth client ID (https://support.google.com/cloud/answer/6158849) usedto make the request. Classroom API requests to modify course work andstudent submissions must be made with an OAuth client ID from the associatedDeveloper Console project. This method returns the following error codes: *`PERMISSION_DENIED` if the requesting user is not permitted to access therequested course, create course work in the requested course, share a Driveattachment, or for access errors. * `INVALID_ARGUMENT` if the request ismalformed. * `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 theClassroom-assigned identifier or an alias.

func (*CoursesCourseWorkService)Delete ¶

func (r *CoursesCourseWorkService) Delete(courseIdstring, idstring) *CoursesCourseWorkDeleteCall

Delete: Deletes a course work. This request must be made by the DeveloperConsole project of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create thecorresponding course work item. This method returns the following errorcodes: * `PERMISSION_DENIED` if the requesting developer project did notcreate the corresponding course work, if the requesting user is notpermitted 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 theClassroom-assigned identifier or an alias.
id: Identifier of the course work to delete. This identifier is aClassroom-assigned identifier.

func (*CoursesCourseWorkService)Get ¶

func (r *CoursesCourseWorkService) Get(courseIdstring, idstring) *CoursesCourseWorkGetCall

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

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

func (*CoursesCourseWorkService)GetAddOnContext ¶added inv0.186.0

func (r *CoursesCourseWorkService) GetAddOnContext(courseIdstring, itemIdstring) *CoursesCourseWorkGetAddOnContextCall

courseId: Identifier of the course.
itemId: Identifier of the `Announcement`, `CourseWork`, or`CourseWorkMaterial` under which the attachment is attached. This field isrequired, but is not marked as such while we are migrating from post_id.

func (*CoursesCourseWorkService)List ¶

func (r *CoursesCourseWorkService) List(courseIdstring) *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 anddomain administrators may view all course work. This method returns thefollowing error codes: * `PERMISSION_DENIED` if the requesting user is notpermitted to access the requested course or for access errors. *`INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if therequested course does not exist.

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

func (*CoursesCourseWorkService)ModifyAssignees ¶

func (r *CoursesCourseWorkService) ModifyAssignees(courseIdstring, idstring, modifycourseworkassigneesrequest *ModifyCourseWorkAssigneesRequest) *CoursesCourseWorkModifyAssigneesCall

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

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

func (*CoursesCourseWorkService)Patch ¶

func (r *CoursesCourseWorkService) Patch(courseIdstring, idstring, coursework *CourseWork) *CoursesCourseWorkPatchCall

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

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

func (*CoursesCourseWorkService)UpdateRubric ¶added inv0.210.0

func (r *CoursesCourseWorkService) UpdateRubric(courseIdstring, courseWorkIdstring, rubric *Rubric) *CoursesCourseWorkUpdateRubricCall

UpdateRubric: Updates a rubric. See google.classroom.v1.Rubric for detailsof which fields can be updated. Rubric update capabilities are limited(/classroom/rubrics/limitations) once grading has started. The requestinguser and course owner must have rubrics creation capabilities. For details,see licensing requirements(https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements).This request must be made by the Google Cloud console of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create the parentcourse work item. This method returns the following error codes: *`PERMISSION_DENIED` if the requesting developer project didn't create thecorresponding course work, if the user isn't permitted to make the requestedmodification to the rubric, or for access errors. This error code is alsoreturned if grading has already started on the rubric. * `INVALID_ARGUMENT`if the request is malformed and for the following request error: *`RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, coursework, or rubric doesn't exist or if the user doesn't have access to thecorresponding course work. * `INTERNAL` if grading has already started onthe rubric.

- courseId: Identifier of the course.- courseWorkId: Identifier of the course work.

typeCoursesCourseWorkStudentSubmissionsGetCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsGetCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkStudentSubmissionsGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsGetCall)Header ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsGetCall)IfNoneMatch ¶

func (c *CoursesCourseWorkStudentSubmissionsGetCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkStudentSubmissionsGetCall

typeCoursesCourseWorkStudentSubmissionsListCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsListCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Context(ctxcontext.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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsListCall)Header ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsListCall)IfNoneMatch ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) IfNoneMatch(entityTagstring) *CoursesCourseWorkStudentSubmissionsListCall

func (*CoursesCourseWorkStudentSubmissionsListCall)Late ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Late(latestring) *CoursesCourseWorkStudentSubmissionsListCall

Late sets the optional parameter "late": Requested lateness value. Ifspecified, returned student submissions are restricted by the requestedvalue. 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(pageSizeint64) *CoursesCourseWorkStudentSubmissionsListCall

func (*CoursesCourseWorkStudentSubmissionsListCall)PageToken ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) PageToken(pageTokenstring) *CoursesCourseWorkStudentSubmissionsListCall

func (*CoursesCourseWorkStudentSubmissionsListCall)Pages ¶

func (c *CoursesCourseWorkStudentSubmissionsListCall) Pages(ctxcontext.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. Ifspecified, returned student submissions match one of the specifiedsubmission 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(userIdstring) *CoursesCourseWorkStudentSubmissionsListCall

UserId sets the optional parameter "userId": Optional argument to restrictreturned student work to those owned by the student with the specifiedidentifier. The identifier can be one of the following: * the numericidentifier for the user * the email address of the user * the string literal"me", indicating the requesting user

typeCoursesCourseWorkStudentSubmissionsModifyAttachmentsCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall)Header ¶

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

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

typeCoursesCourseWorkStudentSubmissionsPatchCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesCourseWorkStudentSubmissionsPatchCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsPatchCall)Header ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall)UpdateMask ¶

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) UpdateMask(updateMaskstring) *CoursesCourseWorkStudentSubmissionsPatchCall

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

typeCoursesCourseWorkStudentSubmissionsReclaimCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsReclaimCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall)Header ¶

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

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

typeCoursesCourseWorkStudentSubmissionsReturnCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsReturnCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsReturnCall)Header ¶

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

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

typeCoursesCourseWorkStudentSubmissionsService ¶

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

funcNewCoursesCourseWorkStudentSubmissionsService ¶

func NewCoursesCourseWorkStudentSubmissionsService(s *Service) *CoursesCourseWorkStudentSubmissionsService

func (*CoursesCourseWorkStudentSubmissionsService)Get ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Get(courseIdstring, courseWorkIdstring, idstring) *CoursesCourseWorkStudentSubmissionsGetCall

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

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

func (*CoursesCourseWorkStudentSubmissionsService)List ¶

func (r *CoursesCourseWorkStudentSubmissionsService) List(courseIdstring, courseWorkIdstring) *CoursesCourseWorkStudentSubmissionsListCall

List: Returns a list of student submissions that the requester is permittedto view, factoring in the OAuth scopes of the request. `-` may be specifiedas the `course_work_id` to include student submissions for multiple coursework items. Course students may only view their own work. Course teachersand domain administrators may view all student submissions. This methodreturns the following error codes: * `PERMISSION_DENIED` if the requestinguser is not permitted to access the requested course or course work, or foraccess 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 theClassroom-assigned identifier or an alias.
courseWorkId: Identifier of the student work to request. This may be setto the string literal "-" to request student work for all course work inthe specified course.

func (*CoursesCourseWorkStudentSubmissionsService)ModifyAttachments ¶

func (r *CoursesCourseWorkStudentSubmissionsService) ModifyAttachments(courseIdstring, courseWorkIdstring, idstring, modifyattachmentsrequest *ModifyAttachmentsRequest) *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall

ModifyAttachments: Modifies attachments of student submission. Attachmentsmay only be added to student submissions belonging to course work objectswith a `workType` of `ASSIGNMENT`. This request must be made by theDeveloper Console project of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create thecorresponding course work item. This method returns the following errorcodes: * `PERMISSION_DENIED` if the requesting user is not permitted toaccess the requested course or course work, if the user is not permitted tomodify attachments on the requested student submission, or for accesserrors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` ifthe requested course, course work, or student submission does not exist.

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

func (*CoursesCourseWorkStudentSubmissionsService)Patch ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Patch(courseIdstring, courseWorkIdstring, idstring, studentsubmission *StudentSubmission) *CoursesCourseWorkStudentSubmissionsPatchCall

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

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

func (*CoursesCourseWorkStudentSubmissionsService)Reclaim ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Reclaim(courseIdstring, courseWorkIdstring, idstring, reclaimstudentsubmissionrequest *ReclaimStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsReclaimCall

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

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

func (*CoursesCourseWorkStudentSubmissionsService)Return ¶

func (r *CoursesCourseWorkStudentSubmissionsService) Return(courseIdstring, courseWorkIdstring, idstring, returnstudentsubmissionrequest *ReturnStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsReturnCall

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

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

func (*CoursesCourseWorkStudentSubmissionsService)TurnIn ¶

func (r *CoursesCourseWorkStudentSubmissionsService) TurnIn(courseIdstring, courseWorkIdstring, idstring, turninstudentsubmissionrequest *TurnInStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsTurnInCall

TurnIn: Turns in a student submission. Turning in a student submissiontransfers ownership of attached Drive files to the teacher and may alsoupdate the submission state. This may only be called by the student thatowns the specified student submission. This request must be made by theDeveloper Console project of the OAuth client ID(https://support.google.com/cloud/answer/6158849) used to create thecorresponding course work item. This method returns the following errorcodes: * `PERMISSION_DENIED` if the requesting user is not permitted toaccess the requested course or course work, turn in the requested studentsubmission, or for access errors. * `INVALID_ARGUMENT` if the request ismalformed. * `NOT_FOUND` if the requested course, course work, or studentsubmission does not exist.

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

typeCoursesCourseWorkStudentSubmissionsTurnInCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsTurnInCall)Context ¶

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall)Header ¶

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

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

typeCoursesCourseWorkUpdateRubricCall ¶added inv0.210.0

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

func (*CoursesCourseWorkUpdateRubricCall)Context ¶added inv0.210.0

func (c *CoursesCourseWorkUpdateRubricCall) Context(ctxcontext.Context) *CoursesCourseWorkUpdateRubricCall

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

func (*CoursesCourseWorkUpdateRubricCall)Do ¶added inv0.210.0

func (c *CoursesCourseWorkUpdateRubricCall) Do(opts ...googleapi.CallOption) (*Rubric,error)

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

func (*CoursesCourseWorkUpdateRubricCall)Fields ¶added inv0.210.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCourseWorkUpdateRubricCall)Header ¶added inv0.210.0

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

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

func (*CoursesCourseWorkUpdateRubricCall)Id ¶added inv0.210.0

func (c *CoursesCourseWorkUpdateRubricCall) Id(idstring) *CoursesCourseWorkUpdateRubricCall

Id sets the optional parameter "id": Identifier of the rubric.

func (*CoursesCourseWorkUpdateRubricCall)UpdateMask ¶added inv0.210.0

func (c *CoursesCourseWorkUpdateRubricCall) UpdateMask(updateMaskstring) *CoursesCourseWorkUpdateRubricCall

typeCoursesCreateCall ¶

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

func (*CoursesCreateCall)Context ¶

func (c *CoursesCreateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesCreateCall)Header ¶

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

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

typeCoursesDeleteCall ¶

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

func (*CoursesDeleteCall)Context ¶

func (c *CoursesDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesDeleteCall)Header ¶

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

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

typeCoursesGetCall ¶

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

func (*CoursesGetCall)Context ¶

func (c *CoursesGetCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesGetCall)Header ¶

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

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

func (*CoursesGetCall)IfNoneMatch ¶

func (c *CoursesGetCall) IfNoneMatch(entityTagstring) *CoursesGetCall

typeCoursesGetGradingPeriodSettingsCall ¶added inv0.229.0

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

func (*CoursesGetGradingPeriodSettingsCall)Context ¶added inv0.229.0

func (c *CoursesGetGradingPeriodSettingsCall) Context(ctxcontext.Context) *CoursesGetGradingPeriodSettingsCall

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

func (*CoursesGetGradingPeriodSettingsCall)Do ¶added inv0.229.0

func (c *CoursesGetGradingPeriodSettingsCall) Do(opts ...googleapi.CallOption) (*GradingPeriodSettings,error)

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

func (*CoursesGetGradingPeriodSettingsCall)Fields ¶added inv0.229.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesGetGradingPeriodSettingsCall)Header ¶added inv0.229.0

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

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

func (*CoursesGetGradingPeriodSettingsCall)IfNoneMatch ¶added inv0.229.0

func (c *CoursesGetGradingPeriodSettingsCall) IfNoneMatch(entityTagstring) *CoursesGetGradingPeriodSettingsCall

typeCoursesListCall ¶

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

func (*CoursesListCall)Context ¶

func (c *CoursesListCall) Context(ctxcontext.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 returnedcourses 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 modifyit or change it to the `ACTIVE` or `DECLINED` states. A course may only bechanged 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 bedisplayed in the web UI. You cannot modify the course except to change it tothe `PROVISIONED` state. A course may only be changed to `DECLINED` if it isin 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 coursemay 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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesListCall)Header ¶

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

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

func (*CoursesListCall)IfNoneMatch ¶

func (c *CoursesListCall) IfNoneMatch(entityTagstring) *CoursesListCall

func (*CoursesListCall)PageSize ¶

func (c *CoursesListCall) PageSize(pageSizeint64) *CoursesListCall

func (*CoursesListCall)PageToken ¶

func (c *CoursesListCall) PageToken(pageTokenstring) *CoursesListCall

func (*CoursesListCall)Pages ¶

func (c *CoursesListCall) Pages(ctxcontext.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(studentIdstring) *CoursesListCall

StudentId sets the optional parameter "studentId": Restricts returnedcourses to those having a student with the specified identifier. Theidentifier can be one of the following: * the numeric identifier for theuser * the email address of the user * the string literal "me", indicatingthe requesting user

func (*CoursesListCall)TeacherId ¶

func (c *CoursesListCall) TeacherId(teacherIdstring) *CoursesListCall

TeacherId sets the optional parameter "teacherId": Restricts returnedcourses to those having a teacher with the specified identifier. Theidentifier can be one of the following: * the numeric identifier for theuser * the email address of the user * the string literal "me", indicatingthe requesting user

typeCoursesPatchCall ¶

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

func (*CoursesPatchCall)Context ¶

func (c *CoursesPatchCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPatchCall)Header ¶

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

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

func (*CoursesPatchCall)UpdateMask ¶

func (c *CoursesPatchCall) UpdateMask(updateMaskstring) *CoursesPatchCall

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

typeCoursesPostsAddOnAttachmentsCreateCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsCreateCall)AddOnToken ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsCreateCall) AddOnToken(addOnTokenstring) *CoursesPostsAddOnAttachmentsCreateCall

func (*CoursesPostsAddOnAttachmentsCreateCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsCreateCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsCreateCall

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

func (*CoursesPostsAddOnAttachmentsCreateCall)Do ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsCreateCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

Do executes the "classroom.courses.posts.addOnAttachments.create" call.Any non-2xx status code is an error. Response headers are in either*AddOnAttachment.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesPostsAddOnAttachmentsCreateCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsCreateCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsCreateCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsCreateCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsCreateCall

ItemId sets the optional parameter "itemId": Identifier of the`Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to createthe attachment. This field is required, but is not marked as such while weare migrating from post_id.

typeCoursesPostsAddOnAttachmentsDeleteCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsDeleteCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsDeleteCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsDeleteCall

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

func (*CoursesPostsAddOnAttachmentsDeleteCall)Do ¶added inv0.186.0

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

Do executes the "classroom.courses.posts.addOnAttachments.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesPostsAddOnAttachmentsDeleteCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsDeleteCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsDeleteCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsDeleteCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsDeleteCall

ItemId sets the optional parameter "itemId": Identifier of the`Announcement`, `CourseWork`, or `CourseWorkMaterial` under which theattachment is attached. This field is required, but is not marked as suchwhile we are migrating from post_id.

typeCoursesPostsAddOnAttachmentsGetCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsGetCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsGetCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsGetCall

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

func (*CoursesPostsAddOnAttachmentsGetCall)Do ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsGetCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

Do executes the "classroom.courses.posts.addOnAttachments.get" call.Any non-2xx status code is an error. Response headers are in either*AddOnAttachment.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesPostsAddOnAttachmentsGetCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsGetCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsGetCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsGetCall) IfNoneMatch(entityTagstring) *CoursesPostsAddOnAttachmentsGetCall

func (*CoursesPostsAddOnAttachmentsGetCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsGetCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsGetCall

typeCoursesPostsAddOnAttachmentsListCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsListCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsListCall

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

func (*CoursesPostsAddOnAttachmentsListCall)Do ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAddOnAttachmentsResponse,error)

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

func (*CoursesPostsAddOnAttachmentsListCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsListCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsListCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) IfNoneMatch(entityTagstring) *CoursesPostsAddOnAttachmentsListCall

func (*CoursesPostsAddOnAttachmentsListCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsListCall

ItemId sets the optional parameter "itemId": Identifier of the`Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachmentsshould be enumerated. This field is required, but is not marked as suchwhile we are migrating from post_id.

func (*CoursesPostsAddOnAttachmentsListCall)PageSize ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) PageSize(pageSizeint64) *CoursesPostsAddOnAttachmentsListCall

func (*CoursesPostsAddOnAttachmentsListCall)PageToken ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) PageToken(pageTokenstring) *CoursesPostsAddOnAttachmentsListCall

func (*CoursesPostsAddOnAttachmentsListCall)Pages ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsListCall) Pages(ctxcontext.Context, f func(*ListAddOnAttachmentsResponse)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.

typeCoursesPostsAddOnAttachmentsPatchCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsPatchCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsPatchCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsPatchCall

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

func (*CoursesPostsAddOnAttachmentsPatchCall)Do ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsPatchCall) Do(opts ...googleapi.CallOption) (*AddOnAttachment,error)

Do executes the "classroom.courses.posts.addOnAttachments.patch" call.Any non-2xx status code is an error. Response headers are in either*AddOnAttachment.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesPostsAddOnAttachmentsPatchCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsPatchCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsPatchCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsPatchCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsPatchCall

ItemId sets the optional parameter "itemId": Identifier of the post underwhich the attachment is attached.

func (*CoursesPostsAddOnAttachmentsPatchCall)UpdateMask ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsPatchCall) UpdateMask(updateMaskstring) *CoursesPostsAddOnAttachmentsPatchCall

typeCoursesPostsAddOnAttachmentsService ¶added inv0.186.0

type CoursesPostsAddOnAttachmentsService struct {StudentSubmissions *CoursesPostsAddOnAttachmentsStudentSubmissionsService// contains filtered or unexported fields}

funcNewCoursesPostsAddOnAttachmentsService ¶added inv0.186.0

func NewCoursesPostsAddOnAttachmentsService(s *Service) *CoursesPostsAddOnAttachmentsService

func (*CoursesPostsAddOnAttachmentsService)Create ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsService) Create(courseIdstring, postIdstring, addonattachment *AddOnAttachment) *CoursesPostsAddOnAttachmentsCreateCall

- courseId: Identifier of the course.- postId: Optional. Deprecated, use `item_id` instead.

func (*CoursesPostsAddOnAttachmentsService)Delete ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsService) Delete(courseIdstring, postIdstring, attachmentIdstring) *CoursesPostsAddOnAttachmentsDeleteCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- postId: Optional. Deprecated, use `item_id` instead.

func (*CoursesPostsAddOnAttachmentsService)Get ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsService) Get(courseIdstring, postIdstring, attachmentIdstring) *CoursesPostsAddOnAttachmentsGetCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- postId: Optional. Deprecated, use `item_id` instead.

func (*CoursesPostsAddOnAttachmentsService)List ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsService) List(courseIdstring, postIdstring) *CoursesPostsAddOnAttachmentsListCall

courseId: Identifier of the course.
postId: Optional. Identifier of the post under the course whoseattachments to enumerate. Deprecated, use `item_id` instead.

func (*CoursesPostsAddOnAttachmentsService)Patch ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsService) Patch(courseIdstring, postIdstring, attachmentIdstring, addonattachment *AddOnAttachment) *CoursesPostsAddOnAttachmentsPatchCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- postId: Identifier of the post under which the attachment is attached.

typeCoursesPostsAddOnAttachmentsStudentSubmissionsGetCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall

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

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall)Do ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall) Do(opts ...googleapi.CallOption) (*AddOnAttachmentStudentSubmission,error)

Do executes the "classroom.courses.posts.addOnAttachments.studentSubmissions.get" call.Any non-2xx status code is an error. Response headers are in either*AddOnAttachmentStudentSubmission.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall) IfNoneMatch(entityTagstring) *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall

typeCoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall ¶added inv0.186.0

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

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall)Context ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall) Context(ctxcontext.Context) *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall

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

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall)Do ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall) Do(opts ...googleapi.CallOption) (*AddOnAttachmentStudentSubmission,error)

Do executes the "classroom.courses.posts.addOnAttachments.studentSubmissions.patch" call.Any non-2xx status code is an error. Response headers are in either*AddOnAttachmentStudentSubmission.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall) ItemId(itemIdstring) *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall)UpdateMask ¶added inv0.186.0

func (c *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall) UpdateMask(updateMaskstring) *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall

typeCoursesPostsAddOnAttachmentsStudentSubmissionsService ¶added inv0.186.0

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

funcNewCoursesPostsAddOnAttachmentsStudentSubmissionsService ¶added inv0.186.0

func NewCoursesPostsAddOnAttachmentsStudentSubmissionsService(s *Service) *CoursesPostsAddOnAttachmentsStudentSubmissionsService

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsService)Get ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsStudentSubmissionsService) Get(courseIdstring, postIdstring, attachmentIdstring, submissionIdstring) *CoursesPostsAddOnAttachmentsStudentSubmissionsGetCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- postId: Optional. Deprecated, use `item_id` instead.- submissionId: Identifier of the student’s submission.

func (*CoursesPostsAddOnAttachmentsStudentSubmissionsService)Patch ¶added inv0.186.0

func (r *CoursesPostsAddOnAttachmentsStudentSubmissionsService) Patch(courseIdstring, postIdstring, attachmentIdstring, submissionIdstring, addonattachmentstudentsubmission *AddOnAttachmentStudentSubmission) *CoursesPostsAddOnAttachmentsStudentSubmissionsPatchCall

- attachmentId: Identifier of the attachment.- courseId: Identifier of the course.- postId: Optional. Deprecated, use `item_id` instead.- submissionId: Identifier of the student's submission.

typeCoursesPostsGetAddOnContextCall ¶added inv0.186.0

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

func (*CoursesPostsGetAddOnContextCall)AddOnToken ¶added inv0.186.0

func (c *CoursesPostsGetAddOnContextCall) AddOnToken(addOnTokenstring) *CoursesPostsGetAddOnContextCall

AddOnToken sets the optional parameter "addOnToken": Token that authorizesthe request. The token is passed as a query parameter when the user isredirected from Classroom to the add-on's URL. The authorization token isrequired when neither of the following is true: * The add-on has attachmentson the post. * The developer project issuing the request is the same projectthat created the post.

func (*CoursesPostsGetAddOnContextCall)AttachmentId ¶added inv0.186.0

func (c *CoursesPostsGetAddOnContextCall) AttachmentId(attachmentIdstring) *CoursesPostsGetAddOnContextCall

func (*CoursesPostsGetAddOnContextCall)Context ¶added inv0.186.0

func (c *CoursesPostsGetAddOnContextCall) Context(ctxcontext.Context) *CoursesPostsGetAddOnContextCall

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

func (*CoursesPostsGetAddOnContextCall)Do ¶added inv0.186.0

func (c *CoursesPostsGetAddOnContextCall) Do(opts ...googleapi.CallOption) (*AddOnContext,error)

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

func (*CoursesPostsGetAddOnContextCall)Fields ¶added inv0.186.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesPostsGetAddOnContextCall)Header ¶added inv0.186.0

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

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

func (*CoursesPostsGetAddOnContextCall)IfNoneMatch ¶added inv0.186.0

func (c *CoursesPostsGetAddOnContextCall) IfNoneMatch(entityTagstring) *CoursesPostsGetAddOnContextCall

func (*CoursesPostsGetAddOnContextCall)ItemId ¶added inv0.186.0

func (c *CoursesPostsGetAddOnContextCall) ItemId(itemIdstring) *CoursesPostsGetAddOnContextCall

typeCoursesPostsService ¶added inv0.186.0

type CoursesPostsService struct {AddOnAttachments *CoursesPostsAddOnAttachmentsService// contains filtered or unexported fields}

funcNewCoursesPostsService ¶added inv0.186.0

func NewCoursesPostsService(s *Service) *CoursesPostsService

func (*CoursesPostsService)GetAddOnContext ¶added inv0.186.0

func (r *CoursesPostsService) GetAddOnContext(courseIdstring, postIdstring) *CoursesPostsGetAddOnContextCall

- courseId: Identifier of the course.- postId: Optional. Deprecated, use `item_id` instead.

typeCoursesService ¶

type CoursesService struct {Aliases *CoursesAliasesServiceAnnouncements *CoursesAnnouncementsServiceCourseWork *CoursesCourseWorkServiceCourseWorkMaterials *CoursesCourseWorkMaterialsServicePosts *CoursesPostsServiceStudents *CoursesStudentsServiceTeachers *CoursesTeachersServiceTopics *CoursesTopicsService// contains filtered or unexported fields}

funcNewCoursesService ¶

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 ofthe created course and added as a teacher. A non-admin requesting user canonly create a course with themselves as the owner. Domain admins can createcourses owned by any user within their domain. This method returns thefollowing error codes: * `PERMISSION_DENIED` if the requesting user is notpermitted to create courses or for access errors. * `NOT_FOUND` if theprimary teacher is not a valid user. * `FAILED_PRECONDITION` if the courseowner's account is disabled or for the following request errors: *UserCannotOwnCourse * UserGroupsMembershipLimitReached *CourseTitleCannotContainUrl * `ALREADY_EXISTS` if an alias was specified inthe `id` and already exists.

func (*CoursesService)Delete ¶

func (r *CoursesService) Delete(idstring) *CoursesDeleteCall

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

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

func (*CoursesService)Get ¶

func (r *CoursesService) Get(idstring) *CoursesGetCall

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

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

func (*CoursesService)GetGradingPeriodSettings ¶added inv0.229.0

func (r *CoursesService) GetGradingPeriodSettings(courseIdstring) *CoursesGetGradingPeriodSettingsCall

GetGradingPeriodSettings: Returns the grading period settings in a course.This method returns the following error codes: * `PERMISSION_DENIED` if therequesting user isn't permitted to access the grading period settings in therequested course or for access errors. * `NOT_FOUND` if the requested coursedoes not exist.

- courseId: The identifier of the course.

func (*CoursesService)List ¶

func (r *CoursesService) List() *CoursesListCall

List: Returns a list of courses that the requesting user is permitted toview, restricted to those that match the request. Returned courses areordered by creation time, with the most recently created coming first. Thismethod returns the following error codes: * `PERMISSION_DENIED` for accesserrors. * `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(idstring, course *Course) *CoursesPatchCall

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

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

func (*CoursesService)Update ¶

func (r *CoursesService) Update(idstring, 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 therequested course or for access errors. * `NOT_FOUND` if no course existswith the requested ID. * `FAILED_PRECONDITION` for the following requesterrors: * CourseNotModifiable * CourseTitleCannotContainUrl

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

func (*CoursesService)UpdateGradingPeriodSettings ¶added inv0.229.0

func (r *CoursesService) UpdateGradingPeriodSettings(courseIdstring, gradingperiodsettings *GradingPeriodSettings) *CoursesUpdateGradingPeriodSettingsCall

UpdateGradingPeriodSettings: Updates grading period settings of a course.Individual grading periods can be added, removed, or modified using thismethod. The requesting user and course owner must be eligible to modifyGrading Periods. For details, see licensing requirements(https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements).This method returns the following error codes: * `PERMISSION_DENIED` if therequesting user is not permitted to modify the grading period settings in acourse or for access errors: * UserIneligibleToUpdateGradingPeriodSettings *`INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if therequested course does not exist.

- courseId: The identifier of the course.

typeCoursesStudentsCreateCall ¶

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

func (*CoursesStudentsCreateCall)Context ¶

func (c *CoursesStudentsCreateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsCreateCall)EnrollmentCode ¶

func (c *CoursesStudentsCreateCall) EnrollmentCode(enrollmentCodestring) *CoursesStudentsCreateCall

EnrollmentCode sets the optional parameter "enrollmentCode": Enrollment codeof the course to create the student in. This code is required if userIdcorresponds to the requesting user; it may be omitted if the requesting userhas 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesStudentsCreateCall)Header ¶

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

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

typeCoursesStudentsDeleteCall ¶

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

func (*CoursesStudentsDeleteCall)Context ¶

func (c *CoursesStudentsDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesStudentsDeleteCall)Header ¶

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

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

typeCoursesStudentsGetCall ¶

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

func (*CoursesStudentsGetCall)Context ¶

func (c *CoursesStudentsGetCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesStudentsGetCall)Header ¶

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

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

func (*CoursesStudentsGetCall)IfNoneMatch ¶

func (c *CoursesStudentsGetCall) IfNoneMatch(entityTagstring) *CoursesStudentsGetCall

typeCoursesStudentsListCall ¶

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

func (*CoursesStudentsListCall)Context ¶

func (c *CoursesStudentsListCall) Context(ctxcontext.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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesStudentsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesStudentsListCall)Header ¶

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

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

func (*CoursesStudentsListCall)IfNoneMatch ¶

func (c *CoursesStudentsListCall) IfNoneMatch(entityTagstring) *CoursesStudentsListCall

func (*CoursesStudentsListCall)PageSize ¶

func (c *CoursesStudentsListCall) PageSize(pageSizeint64) *CoursesStudentsListCall

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

func (*CoursesStudentsListCall)PageToken ¶

func (c *CoursesStudentsListCall) PageToken(pageTokenstring) *CoursesStudentsListCall

func (*CoursesStudentsListCall)Pages ¶

func (c *CoursesStudentsListCall) Pages(ctxcontext.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.

typeCoursesStudentsService ¶

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

funcNewCoursesStudentsService ¶

func NewCoursesStudentsService(s *Service) *CoursesStudentsService

func (*CoursesStudentsService)Create ¶

func (r *CoursesStudentsService) Create(courseIdstring, student *Student) *CoursesStudentsCreateCall

Create: Adds a user as a student of a course. Domain administrators arepermitted to directly add(https://developers.google.com/workspace/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 enrollmentcode. This method returns the following error codes: * `PERMISSION_DENIED`if the requesting user is not permitted to create students in this course orfor access errors. * `NOT_FOUND` if the requested course ID does not exist.* `FAILED_PRECONDITION` if the requested user's account is disabled, for thefollowing request errors: * CourseMemberLimitReached * CourseNotModifiable *UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` ifthe user is already a student or teacher in the course.

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

func (*CoursesStudentsService)Delete ¶

func (r *CoursesStudentsService) Delete(courseIdstring, userIdstring) *CoursesStudentsDeleteCall

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

courseId: Identifier of the course. This identifier can be either theClassroom-assigned identifier or an alias.
userId: Identifier of the student to delete. The identifier can be one ofthe following: * the numeric identifier for the user * the email addressof the user * the string literal "me", indicating the requesting user.

func (*CoursesStudentsService)Get ¶

func (r *CoursesStudentsService) Get(courseIdstring, userIdstring) *CoursesStudentsGetCall

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

courseId: Identifier of the course. This identifier can be either theClassroom-assigned identifier or an alias.
userId: Identifier of the student to return. The identifier can be one ofthe following: * the numeric identifier for the user * the email addressof the user * the string literal "me", indicating the requesting user.

func (*CoursesStudentsService)List ¶

func (r *CoursesStudentsService) List(courseIdstring) *CoursesStudentsListCall

List: Returns a list of students of this course that the requester ispermitted to view. This method returns the following error codes: *`NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for accesserrors.

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

typeCoursesTeachersCreateCall ¶

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

func (*CoursesTeachersCreateCall)Context ¶

func (c *CoursesTeachersCreateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTeachersCreateCall)Header ¶

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

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

typeCoursesTeachersDeleteCall ¶

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

func (*CoursesTeachersDeleteCall)Context ¶

func (c *CoursesTeachersDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTeachersDeleteCall)Header ¶

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

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

typeCoursesTeachersGetCall ¶

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

func (*CoursesTeachersGetCall)Context ¶

func (c *CoursesTeachersGetCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTeachersGetCall)Header ¶

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

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

func (*CoursesTeachersGetCall)IfNoneMatch ¶

func (c *CoursesTeachersGetCall) IfNoneMatch(entityTagstring) *CoursesTeachersGetCall

typeCoursesTeachersListCall ¶

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

func (*CoursesTeachersListCall)Context ¶

func (c *CoursesTeachersListCall) Context(ctxcontext.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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesTeachersListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTeachersListCall)Header ¶

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

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

func (*CoursesTeachersListCall)IfNoneMatch ¶

func (c *CoursesTeachersListCall) IfNoneMatch(entityTagstring) *CoursesTeachersListCall

func (*CoursesTeachersListCall)PageSize ¶

func (c *CoursesTeachersListCall) PageSize(pageSizeint64) *CoursesTeachersListCall

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

func (*CoursesTeachersListCall)PageToken ¶

func (c *CoursesTeachersListCall) PageToken(pageTokenstring) *CoursesTeachersListCall

func (*CoursesTeachersListCall)Pages ¶

func (c *CoursesTeachersListCall) Pages(ctxcontext.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.

typeCoursesTeachersService ¶

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

funcNewCoursesTeachersService ¶

func NewCoursesTeachersService(s *Service) *CoursesTeachersService

func (*CoursesTeachersService)Create ¶

func (r *CoursesTeachersService) Create(courseIdstring, teacher *Teacher) *CoursesTeachersCreateCall

Create: Creates a teacher of a course. Domain administrators are permittedto directly add(https://developers.google.com/workspace/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 thefollowing error codes: * `PERMISSION_DENIED` if the requesting user is notpermitted 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 thefollowing request errors: * CourseMemberLimitReached * CourseNotModifiable *CourseTeacherLimitReached * UserGroupsMembershipLimitReached *InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher orstudent in the course.

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

func (*CoursesTeachersService)Delete ¶

func (r *CoursesTeachersService) Delete(courseIdstring, userIdstring) *CoursesTeachersDeleteCall

Delete: Removes the specified teacher from the specified course. This methodreturns the following error codes: * `PERMISSION_DENIED` if the requestinguser is not permitted to delete teachers of this course or for accesserrors. * `NOT_FOUND` if no teacher of this course has the requested ID orif the course does not exist. * `FAILED_PRECONDITION` if the requested IDbelongs to the primary teacher of this course. * `FAILED_PRECONDITION` ifthe 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 theClassroom-assigned identifier or an alias.
userId: Identifier of the teacher to delete. The identifier can be one ofthe following: * the numeric identifier for the user * the email addressof the user * the string literal "me", indicating the requesting user.

func (*CoursesTeachersService)Get ¶

func (r *CoursesTeachersService) Get(courseIdstring, userIdstring) *CoursesTeachersGetCall

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

courseId: Identifier of the course. This identifier can be either theClassroom-assigned identifier or an alias.
userId: Identifier of the teacher to return. The identifier can be one ofthe following: * the numeric identifier for the user * the email addressof the user * the string literal "me", indicating the requesting user.

func (*CoursesTeachersService)List ¶

func (r *CoursesTeachersService) List(courseIdstring) *CoursesTeachersListCall

List: Returns a list of teachers of this course that the requester ispermitted to view. This method returns the following error codes: *`NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for accesserrors.

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

typeCoursesTopicsCreateCall ¶added inv0.3.1

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

func (*CoursesTopicsCreateCall)Context ¶added inv0.3.1

func (c *CoursesTopicsCreateCall) Context(ctxcontext.Context) *CoursesTopicsCreateCall

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

func (*CoursesTopicsCreateCall)Do ¶added inv0.3.1

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsCreateCall)Fields ¶added inv0.3.1

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTopicsCreateCall)Header ¶added inv0.3.1

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

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

typeCoursesTopicsDeleteCall ¶added inv0.3.1

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

func (*CoursesTopicsDeleteCall)Context ¶added inv0.3.1

func (c *CoursesTopicsDeleteCall) Context(ctxcontext.Context) *CoursesTopicsDeleteCall

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

func (*CoursesTopicsDeleteCall)Do ¶added inv0.3.1

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsDeleteCall)Fields ¶added inv0.3.1

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTopicsDeleteCall)Header ¶added inv0.3.1

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

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

typeCoursesTopicsGetCall ¶added inv0.3.1

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

func (*CoursesTopicsGetCall)Context ¶added inv0.3.1

func (c *CoursesTopicsGetCall) Context(ctxcontext.Context) *CoursesTopicsGetCall

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

func (*CoursesTopicsGetCall)Do ¶added inv0.3.1

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsGetCall)Fields ¶added inv0.3.1

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTopicsGetCall)Header ¶added inv0.3.1

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

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

func (*CoursesTopicsGetCall)IfNoneMatch ¶added inv0.3.1

func (c *CoursesTopicsGetCall) IfNoneMatch(entityTagstring) *CoursesTopicsGetCall

typeCoursesTopicsListCall ¶added inv0.3.1

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

func (*CoursesTopicsListCall)Context ¶added inv0.3.1

func (c *CoursesTopicsListCall) Context(ctxcontext.Context) *CoursesTopicsListCall

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

func (*CoursesTopicsListCall)Do ¶added inv0.3.1

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CoursesTopicsListCall)Fields ¶added inv0.3.1

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTopicsListCall)Header ¶added inv0.3.1

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

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

func (*CoursesTopicsListCall)IfNoneMatch ¶added inv0.3.1

func (c *CoursesTopicsListCall) IfNoneMatch(entityTagstring) *CoursesTopicsListCall

func (*CoursesTopicsListCall)PageSize ¶added inv0.3.1

func (c *CoursesTopicsListCall) PageSize(pageSizeint64) *CoursesTopicsListCall

func (*CoursesTopicsListCall)PageToken ¶added inv0.3.1

func (c *CoursesTopicsListCall) PageToken(pageTokenstring) *CoursesTopicsListCall

func (*CoursesTopicsListCall)Pages ¶added inv0.3.1

func (c *CoursesTopicsListCall) Pages(ctxcontext.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.

typeCoursesTopicsPatchCall ¶added inv0.3.1

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

func (*CoursesTopicsPatchCall)Context ¶added inv0.3.1

func (c *CoursesTopicsPatchCall) Context(ctxcontext.Context) *CoursesTopicsPatchCall

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

func (*CoursesTopicsPatchCall)Do ¶added inv0.3.1

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsPatchCall)Fields ¶added inv0.3.1

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesTopicsPatchCall)Header ¶added inv0.3.1

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

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

func (*CoursesTopicsPatchCall)UpdateMask ¶added inv0.3.1

func (c *CoursesTopicsPatchCall) UpdateMask(updateMaskstring) *CoursesTopicsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifieswhich 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 emptyvalues, it can be cleared by specifying it in the update mask and not in theTopic object. If a field that does not support empty values is included inthe update mask and not set in the Topic object, an `INVALID_ARGUMENT` erroris returned. The following fields may be specified: * `name`

typeCoursesTopicsService ¶added inv0.3.1

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

funcNewCoursesTopicsService ¶added inv0.3.1

func NewCoursesTopicsService(s *Service) *CoursesTopicsService

func (*CoursesTopicsService)Create ¶added inv0.3.1

func (r *CoursesTopicsService) Create(courseIdstring, 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 therequested course, create a topic in the requested course, or for accesserrors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS`if there exists a topic in the course with the same name. *`FAILED_PRECONDITION` for the following request error: *CourseTopicLimitReached * `NOT_FOUND` if the requested course does notexist.

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

func (*CoursesTopicsService)Delete ¶added inv0.3.1

func (r *CoursesTopicsService) Delete(courseIdstring, idstring) *CoursesTopicsDeleteCall

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

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

func (*CoursesTopicsService)Get ¶added inv0.3.1

func (r *CoursesTopicsService) Get(courseIdstring, idstring) *CoursesTopicsGetCall

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

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

func (*CoursesTopicsService)List ¶added inv0.3.1

func (r *CoursesTopicsService) List(courseIdstring) *CoursesTopicsListCall

List: Returns the list of topics that the requester is permitted to view.This method returns the following error codes: * `PERMISSION_DENIED` if therequesting user is not permitted to access the requested course or foraccess 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 theClassroom-assigned identifier or an alias.

func (*CoursesTopicsService)Patch ¶added inv0.3.1

func (r *CoursesTopicsService) Patch(courseIdstring, idstring, topic *Topic) *CoursesTopicsPatchCall

Patch: Updates one or more fields of a topic. This method returns thefollowing error codes: * `PERMISSION_DENIED` if the requesting developerproject did not create the corresponding topic or for access errors. *`INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` ifthere exists a topic in the course with the same name. * `NOT_FOUND` if therequested course or topic does not exist

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

typeCoursesUpdateCall ¶

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

func (*CoursesUpdateCall)Context ¶

func (c *CoursesUpdateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesUpdateCall)Header ¶

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

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

typeCoursesUpdateGradingPeriodSettingsCall ¶added inv0.229.0

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

func (*CoursesUpdateGradingPeriodSettingsCall)Context ¶added inv0.229.0

func (c *CoursesUpdateGradingPeriodSettingsCall) Context(ctxcontext.Context) *CoursesUpdateGradingPeriodSettingsCall

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

func (*CoursesUpdateGradingPeriodSettingsCall)Do ¶added inv0.229.0

func (c *CoursesUpdateGradingPeriodSettingsCall) Do(opts ...googleapi.CallOption) (*GradingPeriodSettings,error)

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

func (*CoursesUpdateGradingPeriodSettingsCall)Fields ¶added inv0.229.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CoursesUpdateGradingPeriodSettingsCall)Header ¶added inv0.229.0

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

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

func (*CoursesUpdateGradingPeriodSettingsCall)UpdateMask ¶added inv0.229.0

func (c *CoursesUpdateGradingPeriodSettingsCall) UpdateMask(updateMaskstring) *CoursesUpdateGradingPeriodSettingsCall

UpdateMask sets the optional parameter "updateMask": Mask that identifieswhich fields in the GradingPeriodSettings to update. TheGradingPeriodSettings `grading_periods` list will be fully replaced by thegrading periods specified in the update request. For example: * Gradingperiods included in the list without an ID are considered additions, and anew ID will be assigned when the request is made. * Grading periods thatcurrently exist, but are missing from the request will be considereddeletions. * Grading periods with an existing ID and modified data areconsidered edits. Unmodified data will be left as is. * Grading periodsincluded with an unknown ID will result in an error. The following fieldsmay be specified: * `grading_periods` * `apply_to_existing_coursework`

typeCriterion ¶added inv0.210.0

type Criterion struct {// Description: The description of the criterion.Descriptionstring `json:"description,omitempty"`// Id: The criterion ID. On creation, an ID is assigned.Idstring `json:"id,omitempty"`// Levels: The list of levels within this criterion.Levels []*Level `json:"levels,omitempty"`// Title: The title of the criterion.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`}

Criterion: A rubric criterion. Each criterion is a dimension on whichperformance is rated.

func (Criterion)MarshalJSON ¶added inv0.210.0

func (sCriterion) MarshalJSON() ([]byte,error)

typeDate ¶

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.Dayint64 `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.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `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:"-"`}

Date: Represents a whole or partial calendar date, such as a birthday. Thetime of day and time zone are either specified elsewhere or areinsignificant. The date is relative to the Gregorian Calendar. This canrepresent 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, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (Date)MarshalJSON ¶

func (sDate) MarshalJSON() ([]byte,error)

typeDriveFile ¶

type DriveFile struct {// AlternateLink: URL that can be used to access the Drive item. Read-only.AlternateLinkstring `json:"alternateLink,omitempty"`// Id: Drive API resource ID.Idstring `json:"id,omitempty"`// ThumbnailUrl: URL of a thumbnail image of the Drive item. Read-only.ThumbnailUrlstring `json:"thumbnailUrl,omitempty"`// Title: Title of the Drive item. Read-only.Titlestring `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:"-"`}

DriveFile: Representation of a Google Drive file.

func (DriveFile)MarshalJSON ¶

func (sDriveFile) MarshalJSON() ([]byte,error)

typeDriveFolder ¶

type DriveFolder struct {// AlternateLink: URL that can be used to access the Drive folder. Read-only.AlternateLinkstring `json:"alternateLink,omitempty"`// Id: Drive API resource ID.Idstring `json:"id,omitempty"`// Title: Title of the Drive folder. Read-only.Titlestring `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:"-"`}

DriveFolder: Representation of a Google Drive folder.

func (DriveFolder)MarshalJSON ¶

func (sDriveFolder) MarshalJSON() ([]byte,error)

typeEmbedUri ¶added inv0.186.0

type EmbedUri struct {// Uri: Required. URI to be iframed after being populated with query// parameters. This must be a valid UTF-8 string containing between 1 and 1800// characters.Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "Uri") 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. "Uri") 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:"-"`}

EmbedUri: URI to be iframed after being populated with query parameters.

func (EmbedUri)MarshalJSON ¶added inv0.186.0

func (sEmbedUri) MarshalJSON() ([]byte,error)

typeEmpty ¶

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

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

typeFeed ¶

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).FeedTypestring `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:"-"`}

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

func (Feed)MarshalJSON ¶

func (sFeed) MarshalJSON() ([]byte,error)

typeForm ¶

type Form struct {// FormUrl: URL of the form.FormUrlstring `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.ResponseUrlstring `json:"responseUrl,omitempty"`// ThumbnailUrl: URL of a thumbnail image of the Form. Read-only.ThumbnailUrlstring `json:"thumbnailUrl,omitempty"`// Title: Title of the Form. Read-only.Titlestring `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:"-"`}

Form: Google Forms item.

func (Form)MarshalJSON ¶

func (sForm) MarshalJSON() ([]byte,error)

typeGeminiGem ¶added inv0.236.0

type GeminiGem struct {// Id: Gems resource id.Idstring `json:"id,omitempty"`// Title: Title of the Gem.Titlestring `json:"title,omitempty"`// Url: URL that can be used to access the Gem.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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:"-"`}

GeminiGem: Gemini Gem link.

func (GeminiGem)MarshalJSON ¶added inv0.236.0

func (sGeminiGem) MarshalJSON() ([]byte,error)

typeGlobalPermission ¶

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.Permissionstring `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:"-"`}

GlobalPermission: Global user permission description.

func (GlobalPermission)MarshalJSON ¶

func (sGlobalPermission) MarshalJSON() ([]byte,error)

typeGradeCategory ¶added inv0.67.0

type GradeCategory struct {// DefaultGradeDenominator: Default value of denominator. Only applicable when// grade calculation type is TOTAL_POINTS.DefaultGradeDenominatorint64 `json:"defaultGradeDenominator,omitempty"`// Id: ID of the grade category.Idstring `json:"id,omitempty"`// Name: Name of the grade category.Namestring `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.Weightint64 `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:"-"`}

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

func (GradeCategory)MarshalJSON ¶added inv0.67.0

func (sGradeCategory) MarshalJSON() ([]byte,error)

typeGradeHistory ¶

type GradeHistory struct {// ActorUserId: The teacher who made the grade change.ActorUserIdstring `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.GradeChangeTypestring `json:"gradeChangeType,omitempty"`// GradeTimestamp: When the grade of the submission was changed.GradeTimestampstring `json:"gradeTimestamp,omitempty"`// MaxPoints: The denominator of the grade at this time in the submission grade// history.MaxPointsfloat64 `json:"maxPoints,omitempty"`// PointsEarned: The numerator of the grade at this time in the submission// grade history.PointsEarnedfloat64 `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:"-"`}

GradeHistory: The history of each grade on this submission.

func (GradeHistory)MarshalJSON ¶

func (sGradeHistory) MarshalJSON() ([]byte,error)

func (*GradeHistory)UnmarshalJSON ¶

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

typeGradebookSettings ¶added inv0.67.0

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.CalculationTypestring `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.DisplaySettingstring `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:"-"`}

GradebookSettings: The gradebook settings for a course. See the help centerarticle (https://support.google.com/edu/classroom/answer/9184995) fordetails.

func (GradebookSettings)MarshalJSON ¶added inv0.67.0

func (sGradebookSettings) MarshalJSON() ([]byte,error)

typeGradingPeriod ¶added inv0.229.0

type GradingPeriod struct {// EndDate: Required. End date, in UTC, of the grading period. Inclusive.EndDate *Date `json:"endDate,omitempty"`// Id: Output only. System generated grading period ID. Read-only.Idstring `json:"id,omitempty"`// StartDate: Required. Start date, in UTC, of the grading period. Inclusive.StartDate *Date `json:"startDate,omitempty"`// Title: Required. Title of the grading period. For example, “Semester 1”.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "EndDate") 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. "EndDate") 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:"-"`}

GradingPeriod: An individual grading period. Grading periods must not haveoverlapping date ranges and must be listed in chronological order. Forexample, if the end_date of a grading period is 2024-01-25, then thestart_date of the next grading period must be 2024-01-26 or later. Eachgrading period must have a unique title within a course.

func (GradingPeriod)MarshalJSON ¶added inv0.229.0

func (sGradingPeriod) MarshalJSON() ([]byte,error)

typeGradingPeriodSettings ¶added inv0.229.0

type GradingPeriodSettings struct {// ApplyToExistingCoursework: Supports toggling the application of grading// periods on existing stream items. Once set, this value is persisted meaning// that it does not need to be set in every request to update// `GradingPeriodSettings`. If not previously set, the default is False.ApplyToExistingCourseworkbool `json:"applyToExistingCoursework,omitempty"`// GradingPeriods: The list of grading periods in a specific course. Grading// periods must not have overlapping date ranges and must be listed in// chronological order. Each grading period must have a unique title within a// course.GradingPeriods []*GradingPeriod `json:"gradingPeriods,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ApplyToExistingCoursework")// 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. "ApplyToExistingCoursework") 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:"-"`}

GradingPeriodSettings: Grading period settings that include all theindividual grading periods in a course.

func (GradingPeriodSettings)MarshalJSON ¶added inv0.229.0

func (sGradingPeriodSettings) MarshalJSON() ([]byte,error)

typeGuardian ¶

type Guardian struct {// GuardianId: Identifier for the guardian.GuardianIdstring `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.InvitedEmailAddressstring `json:"invitedEmailAddress,omitempty"`// StudentId: Identifier for the student to whom the guardian relationship// applies.StudentIdstring `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:"-"`}

Guardian: Association between a student and a guardian of that student. Theguardian may receive information about the student's course work.

func (Guardian)MarshalJSON ¶

func (sGuardian) MarshalJSON() ([]byte,error)

typeGuardianInvitation ¶

type GuardianInvitation struct {// CreationTime: The time that this invitation was created. Read-only.CreationTimestring `json:"creationTime,omitempty"`// InvitationId: Unique identifier for this invitation. Read-only.InvitationIdstring `json:"invitationId,omitempty"`// InvitedEmailAddress: Email address that the invitation was sent to. This// field is only visible to domain administrators.InvitedEmailAddressstring `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.Statestring `json:"state,omitempty"`// StudentId: ID of the student (in standard format)StudentIdstring `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:"-"`}

GuardianInvitation: An invitation to become the guardian of a specifieduser, sent to a specified email address.

func (GuardianInvitation)MarshalJSON ¶

func (sGuardianInvitation) MarshalJSON() ([]byte,error)

typeIndividualStudentsOptions ¶

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:"-"`}

IndividualStudentsOptions: Assignee details about a coursework/announcement.This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.

func (IndividualStudentsOptions)MarshalJSON ¶

func (sIndividualStudentsOptions) MarshalJSON() ([]byte,error)

typeInvitation ¶

type Invitation struct {// CourseId: Identifier of the course to invite the user to.CourseIdstring `json:"courseId,omitempty"`// Id: Identifier assigned by Classroom. Read-only.Idstring `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.Rolestring `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 userUserIdstring `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:"-"`}

Invitation: An invitation to join a course.

func (Invitation)MarshalJSON ¶

func (sInvitation) MarshalJSON() ([]byte,error)

typeInvitationsAcceptCall ¶

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

func (*InvitationsAcceptCall)Context ¶

func (c *InvitationsAcceptCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*InvitationsAcceptCall)Header ¶

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

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

typeInvitationsCreateCall ¶

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

func (*InvitationsCreateCall)Context ¶

func (c *InvitationsCreateCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*InvitationsCreateCall)Header ¶

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

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

typeInvitationsDeleteCall ¶

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

func (*InvitationsDeleteCall)Context ¶

func (c *InvitationsDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*InvitationsDeleteCall)Header ¶

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

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

typeInvitationsGetCall ¶

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

func (*InvitationsGetCall)Context ¶

func (c *InvitationsGetCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*InvitationsGetCall)Header ¶

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

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

func (*InvitationsGetCall)IfNoneMatch ¶

func (c *InvitationsGetCall) IfNoneMatch(entityTagstring) *InvitationsGetCall

typeInvitationsListCall ¶

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

func (*InvitationsListCall)Context ¶

func (c *InvitationsListCall) Context(ctxcontext.Context) *InvitationsListCall

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

func (*InvitationsListCall)CourseId ¶

func (c *InvitationsListCall) CourseId(courseIdstring) *InvitationsListCall

CourseId sets the optional parameter "courseId": Restricts returnedinvitations 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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*InvitationsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*InvitationsListCall)Header ¶

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

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

func (*InvitationsListCall)IfNoneMatch ¶

func (c *InvitationsListCall) IfNoneMatch(entityTagstring) *InvitationsListCall

func (*InvitationsListCall)PageSize ¶

func (c *InvitationsListCall) PageSize(pageSizeint64) *InvitationsListCall

PageSize sets the optional parameter "pageSize": Maximum number of items toreturn. The default is 500 if unspecified or `0`. The server may returnfewer than the specified number of results.

func (*InvitationsListCall)PageToken ¶

func (c *InvitationsListCall) PageToken(pageTokenstring) *InvitationsListCall

func (*InvitationsListCall)Pages ¶

func (c *InvitationsListCall) Pages(ctxcontext.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(userIdstring) *InvitationsListCall

UserId sets the optional parameter "userId": Restricts returned invitationsto 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 * thestring literal "me", indicating the requesting user

typeInvitationsService ¶

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

funcNewInvitationsService ¶

func NewInvitationsService(s *Service) *InvitationsService

func (*InvitationsService)Accept ¶

func (r *InvitationsService) Accept(idstring) *InvitationsAcceptCall

Accept: Accepts an invitation, removing it and adding the invited user tothe teachers or students (as appropriate) of the specified course. Only theinvited user may accept an invitation. This method returns the followingerror codes: * `PERMISSION_DENIED` if the requesting user is not permittedto 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 withthe 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 mayexist at a time. Delete and re-create an invitation to make changes. Thismethod returns the following error codes: * `PERMISSION_DENIED` if therequesting user is not permitted to create invitations for this course orfor access errors. * `NOT_FOUND` if the course or the user does not exist. *`FAILED_PRECONDITION`: * if the requested user's account is disabled. * ifthe user already has this role or a role with greater permissions. * for thefollowing request errors: * IneligibleOwner * `ALREADY_EXISTS` if aninvitation for the specified user and course already exists.

func (*InvitationsService)Delete ¶

func (r *InvitationsService) Delete(idstring) *InvitationsDeleteCall

Delete: Deletes an invitation. This method returns the following errorcodes: * `PERMISSION_DENIED` if the requesting user is not permitted todelete the requested invitation or for access errors. * `NOT_FOUND` if noinvitation exists with the requested ID.

- id: Identifier of the invitation to delete.

func (*InvitationsService)Get ¶

func (r *InvitationsService) Get(idstring) *InvitationsGetCall

Get: Returns an invitation. This method returns the following error codes: *`PERMISSION_DENIED` if the requesting user is not permitted to view therequested invitation or for access errors. * `NOT_FOUND` if no invitationexists 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 toview, restricted to those that match the list request. *Note:* At least oneof `user_id` or `course_id` must be supplied. Both fields can be supplied.This method returns the following error codes: * `PERMISSION_DENIED` foraccess errors.

typeLevel ¶added inv0.210.0

type Level struct {// Description: The description of the level.Descriptionstring `json:"description,omitempty"`// Id: The level ID. On creation, an ID is assigned.Idstring `json:"id,omitempty"`// Points: Optional points associated with this level. If set, all levels// within the rubric must specify points and the value must be distinct across// all levels within a single criterion. 0 is distinct from no points.Pointsfloat64 `json:"points,omitempty"`// Title: The title of the level. If the level has no points set, title must be// set.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`}

Level: A level of the criterion.

func (Level)MarshalJSON ¶added inv0.210.0

func (sLevel) MarshalJSON() ([]byte,error)

func (*Level)UnmarshalJSON ¶added inv0.210.0

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

typeLink ¶

type Link struct {// ThumbnailUrl: URL of a thumbnail image of the target URL. Read-only.ThumbnailUrlstring `json:"thumbnailUrl,omitempty"`// Title: Title of the target of the URL. Read-only.Titlestring `json:"title,omitempty"`// Url: URL to link to. This must be a valid UTF-8 string containing between 1// and 2024 characters.Urlstring `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:"-"`}

Link: URL item.

func (Link)MarshalJSON ¶

func (sLink) MarshalJSON() ([]byte,error)

typeListAddOnAttachmentsResponse ¶added inv0.186.0

type ListAddOnAttachmentsResponse struct {// AddOnAttachments: Attachments under the given post.AddOnAttachments []*AddOnAttachment `json:"addOnAttachments,omitempty"`// NextPageToken: A token, which can be sent as `pageToken` to retrieve the// next page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `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. "AddOnAttachments") 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. "AddOnAttachments") 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:"-"`}

ListAddOnAttachmentsResponse: Response when listing add-on attachments.

func (ListAddOnAttachmentsResponse)MarshalJSON ¶added inv0.186.0

func (sListAddOnAttachmentsResponse) MarshalJSON() ([]byte,error)

typeListAnnouncementsResponse ¶

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.NextPageTokenstring `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:"-"`}

ListAnnouncementsResponse: Response when listing course work.

func (ListAnnouncementsResponse)MarshalJSON ¶

func (sListAnnouncementsResponse) MarshalJSON() ([]byte,error)

typeListCourseAliasesResponse ¶

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.NextPageTokenstring `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:"-"`}

ListCourseAliasesResponse: Response when listing course aliases.

func (ListCourseAliasesResponse)MarshalJSON ¶

func (sListCourseAliasesResponse) MarshalJSON() ([]byte,error)

typeListCourseWorkMaterialResponse ¶added inv0.33.0

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.NextPageTokenstring `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:"-"`}

ListCourseWorkMaterialResponse: Response when listing course work material.

func (ListCourseWorkMaterialResponse)MarshalJSON ¶added inv0.33.0

func (sListCourseWorkMaterialResponse) MarshalJSON() ([]byte,error)

typeListCourseWorkResponse ¶

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.NextPageTokenstring `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:"-"`}

ListCourseWorkResponse: Response when listing course work.

func (ListCourseWorkResponse)MarshalJSON ¶

func (sListCourseWorkResponse) MarshalJSON() ([]byte,error)

typeListCoursesResponse ¶

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.NextPageTokenstring `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:"-"`}

ListCoursesResponse: Response when listing courses.

func (ListCoursesResponse)MarshalJSON ¶

func (sListCoursesResponse) MarshalJSON() ([]byte,error)

typeListGuardianInvitationsResponse ¶

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.NextPageTokenstring `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:"-"`}

ListGuardianInvitationsResponse: Response when listing guardian invitations.

func (ListGuardianInvitationsResponse)MarshalJSON ¶

func (sListGuardianInvitationsResponse) MarshalJSON() ([]byte,error)

typeListGuardiansResponse ¶

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.NextPageTokenstring `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:"-"`}

ListGuardiansResponse: Response when listing guardians.

func (ListGuardiansResponse)MarshalJSON ¶

func (sListGuardiansResponse) MarshalJSON() ([]byte,error)

typeListInvitationsResponse ¶

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.NextPageTokenstring `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:"-"`}

ListInvitationsResponse: Response when listing invitations.

func (ListInvitationsResponse)MarshalJSON ¶

func (sListInvitationsResponse) MarshalJSON() ([]byte,error)

typeListRubricsResponse ¶added inv0.210.0

type ListRubricsResponse struct {// NextPageToken: Token identifying the next page of results to return. If// empty, no further results are available.NextPageTokenstring `json:"nextPageToken,omitempty"`// Rubrics: Rubrics that match the request.Rubrics []*Rubric `json:"rubrics,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:"-"`}

ListRubricsResponse: Response when listing rubrics.

func (ListRubricsResponse)MarshalJSON ¶added inv0.210.0

func (sListRubricsResponse) MarshalJSON() ([]byte,error)

typeListStudentSubmissionsResponse ¶

type ListStudentSubmissionsResponse struct {// NextPageToken: Token identifying the next page of results to return. If// empty, no further results are available.NextPageTokenstring `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:"-"`}

ListStudentSubmissionsResponse: Response when listing student submissions.

func (ListStudentSubmissionsResponse)MarshalJSON ¶

func (sListStudentSubmissionsResponse) MarshalJSON() ([]byte,error)

typeListStudentsResponse ¶

type ListStudentsResponse struct {// NextPageToken: Token identifying the next page of results to return. If// empty, no further results are available.NextPageTokenstring `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:"-"`}

ListStudentsResponse: Response when listing students.

func (ListStudentsResponse)MarshalJSON ¶

func (sListStudentsResponse) MarshalJSON() ([]byte,error)

typeListTeachersResponse ¶

type ListTeachersResponse struct {// NextPageToken: Token identifying the next page of results to return. If// empty, no further results are available.NextPageTokenstring `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:"-"`}

ListTeachersResponse: Response when listing teachers.

func (ListTeachersResponse)MarshalJSON ¶

func (sListTeachersResponse) MarshalJSON() ([]byte,error)

typeListTopicResponse ¶added inv0.3.1

type ListTopicResponse struct {// NextPageToken: Token identifying the next page of results to return. If// empty, no further results are available.NextPageTokenstring `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:"-"`}

ListTopicResponse: Response when listing topics.

func (ListTopicResponse)MarshalJSON ¶added inv0.3.1

func (sListTopicResponse) MarshalJSON() ([]byte,error)

typeMaterial ¶

type Material struct {// DriveFile: Google Drive file material.DriveFile *SharedDriveFile `json:"driveFile,omitempty"`// Form: Google Forms material. Read-only.Form *Form `json:"form,omitempty"`// Gem: Gemini Gem material. Read-only.Gem *GeminiGem `json:"gem,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"`// Notebook: NotebookLM Notebook material. Read-only.Notebook *NotebookLmNotebook `json:"notebook,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:"-"`}

Material: Material attached to course work. When creating attachments,setting the `form`, `gem`, or `notebook` field is not supported.

func (Material)MarshalJSON ¶

func (sMaterial) MarshalJSON() ([]byte,error)

typeModifyAnnouncementAssigneesRequest ¶

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.AssigneeModestring `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:"-"`}

ModifyAnnouncementAssigneesRequest: Request to modify assignee mode andoptions of an announcement.

func (ModifyAnnouncementAssigneesRequest)MarshalJSON ¶

func (sModifyAnnouncementAssigneesRequest) MarshalJSON() ([]byte,error)

typeModifyAttachmentsRequest ¶

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:"-"`}

ModifyAttachmentsRequest: Request to modify the attachments of a studentsubmission.

func (ModifyAttachmentsRequest)MarshalJSON ¶

func (sModifyAttachmentsRequest) MarshalJSON() ([]byte,error)

typeModifyCourseWorkAssigneesRequest ¶

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.AssigneeModestring `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:"-"`}

ModifyCourseWorkAssigneesRequest: Request to modify assignee mode andoptions of a coursework.

func (ModifyCourseWorkAssigneesRequest)MarshalJSON ¶

func (sModifyCourseWorkAssigneesRequest) MarshalJSON() ([]byte,error)

typeModifyIndividualStudentsOptions ¶

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:"-"`}

ModifyIndividualStudentsOptions: Contains fields to add or remove studentsfrom a course work or announcement where the `assigneeMode` is set to`INDIVIDUAL_STUDENTS`.

func (ModifyIndividualStudentsOptions)MarshalJSON ¶

func (sModifyIndividualStudentsOptions) MarshalJSON() ([]byte,error)

typeMultipleChoiceQuestion ¶

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:"-"`}

MultipleChoiceQuestion: Additional details for multiple-choice questions.

func (MultipleChoiceQuestion)MarshalJSON ¶

func (sMultipleChoiceQuestion) MarshalJSON() ([]byte,error)

typeMultipleChoiceSubmission ¶

type MultipleChoiceSubmission struct {// Answer: Student's select choice.Answerstring `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:"-"`}

MultipleChoiceSubmission: Student work for a multiple-choice question.

func (MultipleChoiceSubmission)MarshalJSON ¶

func (sMultipleChoiceSubmission) MarshalJSON() ([]byte,error)

typeName ¶

type Name struct {// FamilyName: The user's last name. Read-only.FamilyNamestring `json:"familyName,omitempty"`// FullName: The user's full name formed by concatenating the first and last// name values. Read-only.FullNamestring `json:"fullName,omitempty"`// GivenName: The user's first name. Read-only.GivenNamestring `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:"-"`}

Name: Details of the user's name.

func (Name)MarshalJSON ¶

func (sName) MarshalJSON() ([]byte,error)

typeNotebookLmNotebook ¶added inv0.236.0

type NotebookLmNotebook struct {// Id: Notebook resource id.Idstring `json:"id,omitempty"`// Title: Title of the Notebook.Titlestring `json:"title,omitempty"`// Url: URL that can be used to access the Notebook.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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:"-"`}

NotebookLmNotebook: NotebookLM Notebook link.

func (NotebookLmNotebook)MarshalJSON ¶added inv0.236.0

func (sNotebookLmNotebook) MarshalJSON() ([]byte,error)

typeReclaimStudentSubmissionRequest ¶

type ReclaimStudentSubmissionRequest struct {}

ReclaimStudentSubmissionRequest: Request to reclaim a student submission.

typeRegistration ¶

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.ExpiryTimestring `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.RegistrationIdstring `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:"-"`}

Registration: An instruction to Classroom to send notifications from the`feed` to the provided destination.

func (Registration)MarshalJSON ¶

func (sRegistration) MarshalJSON() ([]byte,error)

typeRegistrationsCreateCall ¶

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

func (*RegistrationsCreateCall)Context ¶

func (c *RegistrationsCreateCall) Context(ctxcontext.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 checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RegistrationsCreateCall)Header ¶

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

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

typeRegistrationsDeleteCall ¶

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

func (*RegistrationsDeleteCall)Context ¶

func (c *RegistrationsDeleteCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RegistrationsDeleteCall)Header ¶

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

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

typeRegistrationsService ¶

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

funcNewRegistrationsService ¶

func NewRegistrationsService(s *Service) *RegistrationsService

func (*RegistrationsService)Create ¶

func (r *RegistrationsService) Create(registration *Registration) *RegistrationsCreateCall

Create: Creates a `Registration`, causing Classroom to start sendingnotifications from the provided `feed` to the destination provided in`cloudPubSubTopic`. Returns the created `Registration`. Currently, this willbe 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 validatethe `cloudPubSubTopic` and return errors on a best effort basis, it is thecaller's responsibility to ensure that it exists and that Classroom haspermission to publish to it. This method may return the following errorcodes: * `PERMISSION_DENIED` if: * the authenticated user does not havepermission to receive notifications from the requested field; or * thecurrent user has not granted access to the current Cloud project with theappropriate scope for the requested feed. Note that domain-wide delegationof authority is not currently supported for this purpose. If the request hasthe 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 notvalid; or * no `feed` is specified, or the specified `feed` is not valid. *`NOT_FOUND` if: * the specified `feed` cannot be located, or the requestinguser does not have permission to determine whether or not it exists; or *the specified `cloudPubsubTopic` cannot be located, or Classroom has notbeen granted permission to publish to it.

func (*RegistrationsService)Delete ¶

func (r *RegistrationsService) Delete(registrationIdstring) *RegistrationsDeleteCall

Delete: Deletes a `Registration`, causing Classroom to stop sendingnotifications for that `Registration`.

- registrationId: The `registration_id` of the `Registration` to be deleted.

typeReturnStudentSubmissionRequest ¶

type ReturnStudentSubmissionRequest struct {}

ReturnStudentSubmissionRequest: Request to return a student submission.

typeRubric ¶added inv0.210.0

type Rubric struct {// CourseId: Identifier of the course. Read-only.CourseIdstring `json:"courseId,omitempty"`// CourseWorkId: Identifier for the course work this corresponds to. Read-only.CourseWorkIdstring `json:"courseWorkId,omitempty"`// CreationTime: Output only. Timestamp when this rubric was created.// Read-only.CreationTimestring `json:"creationTime,omitempty"`// Criteria: List of criteria. Each criterion is a dimension on which// performance is rated.Criteria []*Criterion `json:"criteria,omitempty"`// Id: Classroom-assigned identifier for the rubric. This is unique among// rubrics for the relevant course work. Read-only.Idstring `json:"id,omitempty"`// SourceSpreadsheetId: Input only. Immutable. Google Sheets ID of the// spreadsheet. This spreadsheet must contain formatted rubric settings. See// Create or reuse a rubric for an assignment// (https://support.google.com/edu/classroom/answer/9335069). Use of this field// requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or// `https://www.googleapis.com/auth/spreadsheets` scope.SourceSpreadsheetIdstring `json:"sourceSpreadsheetId,omitempty"`// UpdateTime: Output only. Timestamp of the most recent change to this rubric.// Read-only.UpdateTimestring `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:"-"`}

Rubric: The rubric of the course work. A rubric is a scoring guide used toevaluate student work and give feedback. For further details, see Rubricsstructure and known limitations (/classroom/rubrics/limitations).

func (Rubric)MarshalJSON ¶added inv0.210.0

func (sRubric) MarshalJSON() ([]byte,error)

typeRubricGrade ¶added inv0.210.0

type RubricGrade struct {// CriterionId: Optional. Criterion ID.CriterionIdstring `json:"criterionId,omitempty"`// LevelId: Optional. Optional level ID of the selected level. If empty, no// level was selected.LevelIdstring `json:"levelId,omitempty"`// Points: Optional. Optional points assigned for this criterion, typically// based on the level. Levels might or might not have points. If unset, no// points were set for this criterion.Pointsfloat64 `json:"points,omitempty"`// ForceSendFields is a list of field names (e.g. "CriterionId") 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. "CriterionId") 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:"-"`}

RubricGrade: A rubric grade set for the student submission. There is at mostone entry per rubric criterion.

func (RubricGrade)MarshalJSON ¶added inv0.210.0

func (sRubricGrade) MarshalJSON() ([]byte,error)

func (*RubricGrade)UnmarshalJSON ¶added inv0.210.0

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

typeService ¶

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentCourses *CoursesServiceInvitations *InvitationsServiceRegistrations *RegistrationsServiceUserProfiles *UserProfilesService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewService ¶added inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeSharedDriveFile ¶

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.ShareModestring `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:"-"`}

SharedDriveFile: Drive file that is used as material for course work.

func (SharedDriveFile)MarshalJSON ¶

func (sSharedDriveFile) MarshalJSON() ([]byte,error)

typeShortAnswerSubmission ¶

type ShortAnswerSubmission struct {// Answer: Student response to a short-answer question.Answerstring `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:"-"`}

ShortAnswerSubmission: Student work for a short answer question.

func (ShortAnswerSubmission)MarshalJSON ¶

func (sShortAnswerSubmission) MarshalJSON() ([]byte,error)

typeStateHistory ¶

type StateHistory struct {// ActorUserId: The teacher or student who made the change.ActorUserIdstring `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.Statestring `json:"state,omitempty"`// StateTimestamp: When the submission entered this state.StateTimestampstring `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:"-"`}

StateHistory: The history of each state this submission has been in.

func (StateHistory)MarshalJSON ¶

func (sStateHistory) MarshalJSON() ([]byte,error)

typeStudent ¶

type Student struct {// CourseId: Identifier of the course. Read-only.CourseIdstring `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 userUserIdstring `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:"-"`}

Student: Student in a course.

func (Student)MarshalJSON ¶

func (sStudent) MarshalJSON() ([]byte,error)

typeStudentContext ¶added inv0.186.0

type StudentContext struct {// SubmissionId: Requesting user's submission id to be used for grade passback// and to identify the student when showing student work to the teacher. This// is set exactly when `supportsStudentWork` is `true`.SubmissionIdstring `json:"submissionId,omitempty"`// ForceSendFields is a list of field names (e.g. "SubmissionId") 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. "SubmissionId") 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:"-"`}

StudentContext: Role-specific context if the requesting user is a student.

func (StudentContext)MarshalJSON ¶added inv0.186.0

func (sStudentContext) MarshalJSON() ([]byte,error)

typeStudentSubmission ¶

type StudentSubmission struct {// AlternateLink: Absolute link to the submission in the Classroom web UI.// Read-only.AlternateLinkstring `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.AssignedGradefloat64 `json:"assignedGrade,omitempty"`// AssignedRubricGrades: Assigned rubric grades based on the rubric's Criteria.// This map is empty if there is no rubric attached to this course work or if a// rubric is attached, but no grades have been set on any Criteria. Entries are// only populated for grades that have been set. Key: The rubric's criterion// ID. Read-only.AssignedRubricGrades map[string]RubricGrade `json:"assignedRubricGrades,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.AssociatedWithDeveloperbool `json:"associatedWithDeveloper,omitempty"`// CourseId: Identifier of the course. Read-only.CourseIdstring `json:"courseId,omitempty"`// CourseWorkId: Identifier for the course work this corresponds to. Read-only.CourseWorkIdstring `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.CourseWorkTypestring `json:"courseWorkType,omitempty"`// CreationTime: Creation time of this submission. This may be unset if the// student has not accessed this item. Read-only.CreationTimestring `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.DraftGradefloat64 `json:"draftGrade,omitempty"`// DraftRubricGrades: Pending rubric grades based on the rubric's criteria.// This map is empty if there is no rubric attached to this course work or if a// rubric is attached, but no grades have been set on any criteria. Entries are// only populated for grades that have been set. Key: The rubric's criterion// ID. Read-only.DraftRubricGrades map[string]RubricGrade `json:"draftRubricGrades,omitempty"`// Id: Classroom-assigned Identifier for the student submission. This is unique// among submissions for the relevant course work. Read-only.Idstring `json:"id,omitempty"`// Late: Whether this submission is late. Read-only.Latebool `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.Statestring `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.UpdateTimestring `json:"updateTime,omitempty"`// UserId: Identifier for the student that owns this submission. Read-only.UserIdstring `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:"-"`}

StudentSubmission: Student submission for course work. `StudentSubmission`items are generated when a `CourseWork` item is created. Student submissionsthat have never been accessed (i.e. with `state` = NEW) may not have acreation time or update time.

func (StudentSubmission)MarshalJSON ¶

func (sStudentSubmission) MarshalJSON() ([]byte,error)

func (*StudentSubmission)UnmarshalJSON ¶

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

typeSubmissionHistory ¶

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:"-"`}

SubmissionHistory: The history of the submission. This currently includesstate and grade histories.

func (SubmissionHistory)MarshalJSON ¶

func (sSubmissionHistory) MarshalJSON() ([]byte,error)

typeTeacher ¶

type Teacher struct {// CourseId: Identifier of the course. Read-only.CourseIdstring `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 userUserIdstring `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:"-"`}

Teacher: Teacher of a course.

func (Teacher)MarshalJSON ¶

func (sTeacher) MarshalJSON() ([]byte,error)

typeTeacherContext ¶added inv0.186.0

type TeacherContext struct {}

TeacherContext: Role-specific context if the requesting user is a teacher.

typeTimeOfDay ¶

type TimeOfDay struct {// Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0// and typically must be less than or equal to 23. An API may choose to allow// the value "24:00:00" for scenarios like business closing time.Hoursint64 `json:"hours,omitempty"`// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less// than or equal to 59.Minutesint64 `json:"minutes,omitempty"`// Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal// to 0 and less than or equal to 999,999,999.Nanosint64 `json:"nanos,omitempty"`// Seconds: Seconds of a minute. Must be greater than or equal to 0 and// typically must be less than or equal to 59. An API may allow the value 60 if// it allows leap-seconds.Secondsint64 `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:"-"`}

TimeOfDay: Represents a time of day. The date and time zone are either notsignificant or are specified elsewhere. An API may choose to allow leapseconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

func (TimeOfDay)MarshalJSON ¶

func (sTimeOfDay) MarshalJSON() ([]byte,error)

typeTopic ¶added inv0.3.1

type Topic struct {// CourseId: Identifier of the course. Read-only.CourseIdstring `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.Namestring `json:"name,omitempty"`// TopicId: Unique identifier for the topic. Read-only.TopicIdstring `json:"topicId,omitempty"`// UpdateTime: The time the topic was last updated by the system. Read-only.UpdateTimestring `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:"-"`}

Topic: Topic created by a teacher for the course

func (Topic)MarshalJSON ¶added inv0.3.1

func (sTopic) MarshalJSON() ([]byte,error)

typeTurnInStudentSubmissionRequest ¶

type TurnInStudentSubmissionRequest struct {}

TurnInStudentSubmissionRequest: Request to turn in a student submission.

typeUserProfile ¶

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.EmailAddressstring `json:"emailAddress,omitempty"`// Id: Identifier of the user. Read-only.Idstring `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.PhotoUrlstring `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-onlyVerifiedTeacherbool `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:"-"`}

UserProfile: Global information for a user.

func (UserProfile)MarshalJSON ¶

func (sUserProfile) MarshalJSON() ([]byte,error)

typeUserProfilesGetCall ¶

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

func (*UserProfilesGetCall)Context ¶

func (c *UserProfilesGetCall) Context(ctxcontext.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGetCall)Header ¶

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

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

func (*UserProfilesGetCall)IfNoneMatch ¶

func (c *UserProfilesGetCall) IfNoneMatch(entityTagstring) *UserProfilesGetCall

typeUserProfilesGuardianInvitationsCreateCall ¶

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

func (*UserProfilesGuardianInvitationsCreateCall)Context ¶

func (c *UserProfilesGuardianInvitationsCreateCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*UserProfilesGuardianInvitationsCreateCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardianInvitationsCreateCall)Header ¶

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

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

typeUserProfilesGuardianInvitationsGetCall ¶

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

func (*UserProfilesGuardianInvitationsGetCall)Context ¶

func (c *UserProfilesGuardianInvitationsGetCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*UserProfilesGuardianInvitationsGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardianInvitationsGetCall)Header ¶

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

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

func (*UserProfilesGuardianInvitationsGetCall)IfNoneMatch ¶

func (c *UserProfilesGuardianInvitationsGetCall) IfNoneMatch(entityTagstring) *UserProfilesGuardianInvitationsGetCall

typeUserProfilesGuardianInvitationsListCall ¶

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

func (*UserProfilesGuardianInvitationsListCall)Context ¶

func (c *UserProfilesGuardianInvitationsListCall) Context(ctxcontext.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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardianInvitationsListCall)Header ¶

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

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

func (*UserProfilesGuardianInvitationsListCall)IfNoneMatch ¶

func (c *UserProfilesGuardianInvitationsListCall) IfNoneMatch(entityTagstring) *UserProfilesGuardianInvitationsListCall

func (*UserProfilesGuardianInvitationsListCall)InvitedEmailAddress ¶

func (c *UserProfilesGuardianInvitationsListCall) InvitedEmailAddress(invitedEmailAddressstring) *UserProfilesGuardianInvitationsListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress": Ifspecified, only results with the specified `invited_email_address` arereturned.

func (*UserProfilesGuardianInvitationsListCall)PageSize ¶

func (c *UserProfilesGuardianInvitationsListCall) PageSize(pageSizeint64) *UserProfilesGuardianInvitationsListCall

func (*UserProfilesGuardianInvitationsListCall)PageToken ¶

func (c *UserProfilesGuardianInvitationsListCall) PageToken(pageTokenstring) *UserProfilesGuardianInvitationsListCall

func (*UserProfilesGuardianInvitationsListCall)Pages ¶

func (c *UserProfilesGuardianInvitationsListCall) Pages(ctxcontext.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 withthe 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.

typeUserProfilesGuardianInvitationsPatchCall ¶

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

func (*UserProfilesGuardianInvitationsPatchCall)Context ¶

func (c *UserProfilesGuardianInvitationsPatchCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*UserProfilesGuardianInvitationsPatchCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardianInvitationsPatchCall)Header ¶

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

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

func (*UserProfilesGuardianInvitationsPatchCall)UpdateMask ¶

func (c *UserProfilesGuardianInvitationsPatchCall) UpdateMask(updateMaskstring) *UserProfilesGuardianInvitationsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask that identifieswhich fields on the course to update. This field is required to do anupdate. The update fails if invalid fields are specified. The followingfields are valid: * `state` When set in a query parameter, this field shouldbe specified as `updateMask=,,...`

typeUserProfilesGuardianInvitationsService ¶

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

funcNewUserProfilesGuardianInvitationsService ¶

func NewUserProfilesGuardianInvitationsService(s *Service) *UserProfilesGuardianInvitationsService

func (*UserProfilesGuardianInvitationsService)Create ¶

func (r *UserProfilesGuardianInvitationsService) Create(studentIdstring, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsCreateCall

Create: Creates a guardian invitation, and sends an email to the guardianasking them to confirm that they are the student's guardian. Once theguardian accepts the invitation, their `state` will change to `COMPLETED`and they will start receiving guardian notifications. A `Guardian` resourcewill also be created to represent the active guardian. The request objectmust have the `student_id` and `invited_email_address` fields set. Failingto set these fields, or setting any other fields in the request, will resultin an error. This method returns the following error codes: *`PERMISSION_DENIED` if the current user does not have permission to manageguardians, if the guardian in question has already rejected too manyrequests for that student, if guardians are not enabled for the domain inquestion, or for other access errors. * `RESOURCE_EXHAUSTED` if the studentor guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` ifthe guardian email address is not valid (for example, if it is too long), orif the format of the student ID provided cannot be recognized (it is not anemail address, nor a `user_id` from this API). This error will also bereturned if read-only fields are set, or if the `state` field is set to to avalue other than `PENDING`. * `NOT_FOUND` if the student ID provided is avalid student ID, but Classroom has no record of that student. *`ALREADY_EXISTS` if there is already a pending guardian invitation for thestudent 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(studentIdstring, invitationIdstring) *UserProfilesGuardianInvitationsGetCall

Get: Returns a specific guardian invitation. This method returns thefollowing error codes: * `PERMISSION_DENIED` if the requesting user is notpermitted to view guardian invitations for the student identified by the`student_id`, if guardians are not enabled for the domain in question, orfor other access errors. * `INVALID_ARGUMENT` if a `student_id` isspecified, 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 nothave access to see that student.

invitationId: The `id` field of the `GuardianInvitation` being requested.
studentId: The ID of the student whose guardian invitation is beingrequested.

func (*UserProfilesGuardianInvitationsService)List ¶

func (r *UserProfilesGuardianInvitationsService) List(studentIdstring) *UserProfilesGuardianInvitationsListCall

List: Returns a list of guardian invitations that the requesting user ispermitted to view, filtered by the parameters provided. This method returnsthe following error codes: * `PERMISSION_DENIED` if a `student_id` isspecified, and the requesting user is not permitted to view guardianinvitations for that student, if "-" is specified as the `student_id` andthe user is not a domain administrator, if guardians are not enabled for thedomain in question, or for other access errors. * `INVALID_ARGUMENT` if a`student_id` is specified, but its format cannot be recognized (it is not anemail address, nor a `student_id` from the API, nor the literal string`me`). May also be returned if an invalid `page_token` or `state` isprovided. * `NOT_FOUND` if a `student_id` is specified, and its format canbe recognized, but Classroom has no record of that student.

studentId: The ID of the student whose guardian invitations are to bereturned. The identifier can be one of the following: * the numericidentifier for the user * the email address of the user * the stringliteral "me", indicating the requesting user * the string literal "-",indicating that results should be returned for all students that therequesting user is permitted to view guardian invitations.

func (*UserProfilesGuardianInvitationsService)Patch ¶

func (r *UserProfilesGuardianInvitationsService) Patch(studentIdstring, invitationIdstring, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsPatchCall

Patch: Modifies a guardian invitation. Currently, the only validmodification is to change the `state` from `PENDING` to `COMPLETE`. This hasthe effect of withdrawing the invitation. This method returns the followingerror codes: * `PERMISSION_DENIED` if the current user does not havepermission to manage guardians, if guardians are not enabled for the domainin question or for other access errors. * `FAILED_PRECONDITION` if theguardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if theformat of the student ID provided cannot be recognized (it is not an emailaddress, nor a `user_id` from this API), or if the passed`GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifiesfields other than `state`. * `NOT_FOUND` if the student ID provided is avalid 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 bemodified.

typeUserProfilesGuardiansDeleteCall ¶

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

func (*UserProfilesGuardiansDeleteCall)Context ¶

func (c *UserProfilesGuardiansDeleteCall) Context(ctxcontext.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)

Do executes the "classroom.userProfiles.guardians.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardiansDeleteCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardiansDeleteCall)Header ¶

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

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

typeUserProfilesGuardiansGetCall ¶

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

func (*UserProfilesGuardiansGetCall)Context ¶

func (c *UserProfilesGuardiansGetCall) Context(ctxcontext.Context) *UserProfilesGuardiansGetCall

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

func (*UserProfilesGuardiansGetCall)Do ¶

func (c *UserProfilesGuardiansGetCall) Do(opts ...googleapi.CallOption) (*Guardian,error)

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

func (*UserProfilesGuardiansGetCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardiansGetCall)Header ¶

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

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

func (*UserProfilesGuardiansGetCall)IfNoneMatch ¶

func (c *UserProfilesGuardiansGetCall) IfNoneMatch(entityTagstring) *UserProfilesGuardiansGetCall

typeUserProfilesGuardiansListCall ¶

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

func (*UserProfilesGuardiansListCall)Context ¶

func (c *UserProfilesGuardiansListCall) Context(ctxcontext.Context) *UserProfilesGuardiansListCall

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

func (*UserProfilesGuardiansListCall)Do ¶

func (c *UserProfilesGuardiansListCall) Do(opts ...googleapi.CallOption) (*ListGuardiansResponse,error)

Do executes the "classroom.userProfiles.guardians.list" call.Any non-2xx status code is an error. Response headers are in either*ListGuardiansResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*UserProfilesGuardiansListCall)Fields ¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UserProfilesGuardiansListCall)Header ¶

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

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

func (*UserProfilesGuardiansListCall)IfNoneMatch ¶

func (c *UserProfilesGuardiansListCall) IfNoneMatch(entityTagstring) *UserProfilesGuardiansListCall

func (*UserProfilesGuardiansListCall)InvitedEmailAddress ¶

func (c *UserProfilesGuardiansListCall) InvitedEmailAddress(invitedEmailAddressstring) *UserProfilesGuardiansListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress":Filter results by the email address that the original invitation was sentto, resulting in this guardian link. This filter can only be used by domainadministrators.

func (*UserProfilesGuardiansListCall)PageSize ¶

func (c *UserProfilesGuardiansListCall) PageSize(pageSizeint64) *UserProfilesGuardiansListCall

func (*UserProfilesGuardiansListCall)PageToken ¶

func (c *UserProfilesGuardiansListCall) PageToken(pageTokenstring) *UserProfilesGuardiansListCall

func (*UserProfilesGuardiansListCall)Pages ¶

func (c *UserProfilesGuardiansListCall) Pages(ctxcontext.Context, f func(*ListGuardiansResponse)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.

typeUserProfilesGuardiansService ¶

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

funcNewUserProfilesGuardiansService ¶

func NewUserProfilesGuardiansService(s *Service) *UserProfilesGuardiansService

func (*UserProfilesGuardiansService)Delete ¶

func (r *UserProfilesGuardiansService) Delete(studentIdstring, guardianIdstring) *UserProfilesGuardiansDeleteCall

Delete: Deletes a guardian. The guardian will no longer receive guardiannotifications and the guardian will no longer be accessible via the API.This method returns the following error codes: * `PERMISSION_DENIED` if nouser that matches the provided `student_id` is visible to the requestinguser, if the requesting user is not permitted to manage guardians for thestudent identified by the `student_id`, if guardians are not enabled for thedomain in question, or for other access errors. * `INVALID_ARGUMENT` if a`student_id` is specified, but its format cannot be recognized (it is not anemail address, nor a `student_id` from the API). * `NOT_FOUND` if therequesting user is permitted to modify guardians for the requested`student_id`, but no `Guardian` record exists for that student with theprovided `guardian_id`.

guardianId: The `id` field from a `Guardian`.
studentId: The student whose guardian is to be deleted. One of thefollowing: * the numeric identifier for the user * the email address ofthe user * the string literal "me", indicating the requesting user.

func (*UserProfilesGuardiansService)Get ¶

func (r *UserProfilesGuardiansService) Get(studentIdstring, guardianIdstring) *UserProfilesGuardiansGetCall

Get: Returns a specific guardian. This method returns the following errorcodes: * `PERMISSION_DENIED` if no user that matches the provided`student_id` is visible to the requesting user, if the requesting user isnot permitted to view guardian information for the student identified by the`student_id`, if guardians are not enabled for the domain in question, orfor other access errors. * `INVALID_ARGUMENT` if a `student_id` isspecified, 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 the requesting user is permitted to view guardians for the requested`student_id`, but no `Guardian` record exists for that student that matchesthe provided `guardian_id`.

guardianId: The `id` field from a `Guardian`.
studentId: The student whose guardian is being requested. One of thefollowing: * the numeric identifier for the user * the email address ofthe user * the string literal "me", indicating the requesting user.

func (*UserProfilesGuardiansService)List ¶

func (r *UserProfilesGuardiansService) List(studentIdstring) *UserProfilesGuardiansListCall

List: Returns a list of guardians that the requesting user is permitted toview, restricted to those that match the request. To list guardians for anystudent that the requesting user may view guardians for, use the literalcharacter `-` for the student ID. This method returns the following errorcodes: * `PERMISSION_DENIED` if a `student_id` is specified, and therequesting user is not permitted to view guardian information for thatstudent, if "-" is specified as the `student_id` and the user is not adomain administrator, if guardians are not enabled for the domain inquestion, if the `invited_email_address` filter is set by a user who is nota domain administrator, or for other access errors. * `INVALID_ARGUMENT` ifa `student_id` is specified, but its format cannot be recognized (it is notan email address, nor a `student_id` from the API, nor the literal string`me`). May also be returned if an invalid `page_token` is provided. *`NOT_FOUND` if a `student_id` is specified, and its format can berecognized, but Classroom has no record of that student.

studentId: Filter results by the student who the guardian is linked to.The identifier can be one of the following: * the numeric identifier forthe user * the email address of the user * the string literal "me",indicating the requesting user * the string literal "-", indicating thatresults should be returned for all students that the requesting user hasaccess to view.

typeUserProfilesService ¶

type UserProfilesService struct {GuardianInvitations *UserProfilesGuardianInvitationsServiceGuardians *UserProfilesGuardiansService// contains filtered or unexported fields}

funcNewUserProfilesService ¶

func NewUserProfilesService(s *Service) *UserProfilesService

func (*UserProfilesService)Get ¶

func (r *UserProfilesService) Get(userIdstring) *UserProfilesGetCall

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

userId: Identifier of the profile to return. The identifier can be one ofthe following: * the numeric identifier for the user * the email addressof the user * the string literal "me", indicating the requesting user.

typeYouTubeVideo ¶

type YouTubeVideo struct {// AlternateLink: URL that can be used to view the YouTube video. Read-only.AlternateLinkstring `json:"alternateLink,omitempty"`// Id: YouTube API resource ID.Idstring `json:"id,omitempty"`// ThumbnailUrl: URL of a thumbnail image of the YouTube video. Read-only.ThumbnailUrlstring `json:"thumbnailUrl,omitempty"`// Title: Title of the YouTube video. Read-only.Titlestring `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:"-"`}

YouTubeVideo: YouTube video item.

func (YouTubeVideo)MarshalJSON ¶

func (sYouTubeVideo) MarshalJSON() ([]byte,error)

Source Files¶

View all Source files

classroom-gen.go

?	: This menu
/	: Search site
f orF	: Jump to
y orY	: Canonical URL

Movatterモバイル変換

Details

Repository

Links

Documentation¶

Overview¶

Library status¶

Creating a client¶

Other authentication options¶

Index¶

Constants¶

Variables¶

Functions¶

Types¶

typeAddOnAttachment¶added inv0.186.0

func (AddOnAttachment)MarshalJSON¶added inv0.186.0

func (*AddOnAttachment)UnmarshalJSON¶added inv0.186.0

typeAddOnAttachmentStudentSubmission¶added inv0.186.0

func (AddOnAttachmentStudentSubmission)MarshalJSON¶added inv0.186.0

func (*AddOnAttachmentStudentSubmission)UnmarshalJSON¶added inv0.186.0

typeAddOnContext¶added inv0.186.0

func (AddOnContext)MarshalJSON¶added inv0.186.0

typeAnnouncement¶

func (Announcement)MarshalJSON¶

typeAssignment¶

func (Assignment)MarshalJSON¶

typeAssignmentSubmission¶

func (AssignmentSubmission)MarshalJSON¶

typeAttachment¶

func (Attachment)MarshalJSON¶

typeCloudPubsubTopic¶

func (CloudPubsubTopic)MarshalJSON¶

typeCopyHistory¶added inv0.186.0

func (CopyHistory)MarshalJSON¶added inv0.186.0

typeCourse¶

func (Course)MarshalJSON¶

typeCourseAlias¶

func (CourseAlias)MarshalJSON¶

typeCourseMaterial¶

func (CourseMaterial)MarshalJSON¶

typeCourseMaterialSet¶

func (CourseMaterialSet)MarshalJSON¶

typeCourseRosterChangesInfo¶

func (CourseRosterChangesInfo)MarshalJSON¶

typeCourseWork¶

func (CourseWork)MarshalJSON¶

func (*CourseWork)UnmarshalJSON¶

typeCourseWorkChangesInfo¶

func (CourseWorkChangesInfo)MarshalJSON¶

typeCourseWorkMaterial¶added inv0.33.0

func (CourseWorkMaterial)MarshalJSON¶added inv0.33.0

typeCoursesAliasesCreateCall¶

func (*CoursesAliasesCreateCall)Context¶

func (*CoursesAliasesCreateCall)Do¶

func (*CoursesAliasesCreateCall)Fields¶

func (*CoursesAliasesCreateCall)Header¶

typeCoursesAliasesDeleteCall¶

func (*CoursesAliasesDeleteCall)Context¶

func (*CoursesAliasesDeleteCall)Do¶

func (*CoursesAliasesDeleteCall)Fields¶

func (*CoursesAliasesDeleteCall)Header¶

typeCoursesAliasesListCall¶

func (*CoursesAliasesListCall)Context¶

func (*CoursesAliasesListCall)Do¶

func (*CoursesAliasesListCall)Fields¶

func (*CoursesAliasesListCall)Header¶

func (*CoursesAliasesListCall)IfNoneMatch¶

func (*CoursesAliasesListCall)PageSize¶

func (*CoursesAliasesListCall)PageToken¶

func (*CoursesAliasesListCall)Pages¶

typeCoursesAliasesService¶

funcNewCoursesAliasesService¶

func (*CoursesAliasesService)Create¶

func (*CoursesAliasesService)Delete¶

func (*CoursesAliasesService)List¶

typeCoursesAnnouncementsAddOnAttachmentsCreateCall¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)AddOnToken¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Context¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Do¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Fields¶added inv0.186.0

Documentation ¶

typeAddOnAttachment ¶added inv0.186.0

func (AddOnAttachment)MarshalJSON ¶added inv0.186.0

func (*AddOnAttachment)UnmarshalJSON ¶added inv0.186.0

typeAddOnAttachmentStudentSubmission ¶added inv0.186.0

func (AddOnAttachmentStudentSubmission)MarshalJSON ¶added inv0.186.0

func (*AddOnAttachmentStudentSubmission)UnmarshalJSON ¶added inv0.186.0

typeAddOnContext ¶added inv0.186.0

func (AddOnContext)MarshalJSON ¶added inv0.186.0

typeAnnouncement ¶

func (Announcement)MarshalJSON ¶

typeAssignment ¶

func (Assignment)MarshalJSON ¶

typeAssignmentSubmission ¶

func (AssignmentSubmission)MarshalJSON ¶

typeAttachment ¶

func (Attachment)MarshalJSON ¶

typeCloudPubsubTopic ¶

func (CloudPubsubTopic)MarshalJSON ¶

typeCopyHistory ¶added inv0.186.0

func (CopyHistory)MarshalJSON ¶added inv0.186.0

typeCourse ¶

func (Course)MarshalJSON ¶

typeCourseAlias ¶

func (CourseAlias)MarshalJSON ¶

typeCourseMaterial ¶

func (CourseMaterial)MarshalJSON ¶

typeCourseMaterialSet ¶

func (CourseMaterialSet)MarshalJSON ¶

typeCourseRosterChangesInfo ¶

func (CourseRosterChangesInfo)MarshalJSON ¶

typeCourseWork ¶

func (CourseWork)MarshalJSON ¶

func (*CourseWork)UnmarshalJSON ¶

typeCourseWorkChangesInfo ¶

func (CourseWorkChangesInfo)MarshalJSON ¶

typeCourseWorkMaterial ¶added inv0.33.0

func (CourseWorkMaterial)MarshalJSON ¶added inv0.33.0

typeCoursesAliasesCreateCall ¶

func (*CoursesAliasesCreateCall)Context ¶

func (*CoursesAliasesCreateCall)Do ¶

func (*CoursesAliasesCreateCall)Fields ¶

func (*CoursesAliasesCreateCall)Header ¶

typeCoursesAliasesDeleteCall ¶

func (*CoursesAliasesDeleteCall)Context ¶

func (*CoursesAliasesDeleteCall)Do ¶

func (*CoursesAliasesDeleteCall)Fields ¶

func (*CoursesAliasesDeleteCall)Header ¶

typeCoursesAliasesListCall ¶

func (*CoursesAliasesListCall)Context ¶

func (*CoursesAliasesListCall)Do ¶

func (*CoursesAliasesListCall)Fields ¶

func (*CoursesAliasesListCall)Header ¶

func (*CoursesAliasesListCall)IfNoneMatch ¶

func (*CoursesAliasesListCall)PageSize ¶

func (*CoursesAliasesListCall)PageToken ¶

func (*CoursesAliasesListCall)Pages ¶

typeCoursesAliasesService ¶

funcNewCoursesAliasesService ¶

func (*CoursesAliasesService)Create ¶

func (*CoursesAliasesService)Delete ¶

func (*CoursesAliasesService)List ¶

typeCoursesAnnouncementsAddOnAttachmentsCreateCall ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)AddOnToken ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Context ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Do ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Fields ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)Header ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsCreateCall)PostId ¶added inv0.186.0

typeCoursesAnnouncementsAddOnAttachmentsDeleteCall ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Context ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Do ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Fields ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)Header ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsDeleteCall)PostId ¶added inv0.186.0

typeCoursesAnnouncementsAddOnAttachmentsGetCall ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Context ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Do ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Fields ¶added inv0.186.0

func (*CoursesAnnouncementsAddOnAttachmentsGetCall)Header ¶added inv0.186.0