Package classroom

import "google.golang.org/api/classroom/v1"
...
classroomService, err := classroom.New(oauthHttpClient)

Constants

OAuth2 scopes used by this API.

const (
    // Manage your Google Classroom classes
    ClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses"

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

    // Manage your course work and view your grades in Google Classroom
    ClassroomCourseworkMeScope = "https://www.googleapis.com/auth/classroom.coursework.me"

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

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

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

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

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

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

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

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

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

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

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

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

type Assignment ¶

Assignment: Additional details for assignments.

type Assignment struct {
    // StudentWorkFolder: Drive folder where attachments from student
    // submissions are placed.
    // This is only populated for course teachers.
    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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*Assignment) MarshalJSON ¶

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

type AssignmentSubmission ¶

AssignmentSubmission: Student work for an assignment.

type AssignmentSubmission struct {
    // Attachments: Attachments added by the student.
    // Drive files that correspond to materials with a share mode
    // of
    // STUDENT_COPY may not exist yet if the student has not accessed
    // the
    // assignment in Classroom.
    //
    // Some attachment metadata is only populated if the requesting user
    // has
    // permission to access it. Identifier and alternate_link fields are
    // always
    // available, but others (e.g. 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*AssignmentSubmission) MarshalJSON ¶

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

type Attachment ¶

Attachment: Attachment added to student assignment work.

When creating attachments, setting the `form` field is not supported.

type Attachment struct {
    // DriveFile: Google Drive file attachment.
    DriveFile *DriveFile `json:"driveFile,omitempty"`

    // Form: Google Forms attachment.
    Form *Form `json:"form,omitempty"`

    // Link: Link attachment.
    Link *Link `json:"link,omitempty"`

    // YouTubeVideo: Youtube video attachment.
    YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Attachment) MarshalJSON ¶

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

type Course ¶

Course: A Course in Classroom.

type Course struct {
    // AlternateLink: Absolute link to this course in the Classroom web
    // UI.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // CalendarId: The Calendar ID for a calendar that all course members
    // can see, to which
    // Classroom adds events for course work and announcements in the
    // course.
    //
    // Read-only.
    CalendarId string `json:"calendarId,omitempty"`

    // CourseGroupEmail: The email address of a Google group containing all
    // members of the course.
    // This group does not accept email and can only be used for
    // permissions.
    //
    // Read-only.
    CourseGroupEmail string `json:"courseGroupEmail,omitempty"`

    // CourseMaterialSets: Sets of materials that appear on the "about" page
    // of this course.
    //
    // Read-only.
    CourseMaterialSets []*CourseMaterialSet `json:"courseMaterialSets,omitempty"`

    // CourseState: State of the course.
    // If unspecified, the default state is `PROVISIONED`.
    //
    // Possible values:
    //   "COURSE_STATE_UNSPECIFIED" - No course state. No returned Course
    // message will use this value.
    //   "ACTIVE" - The course is active.
    //   "ARCHIVED" - The course has been archived. You cannot modify it
    // except to change it
    // to a different state.
    //   "PROVISIONED" - The course has been created, but not yet activated.
    // It is accessible by
    // the primary teacher and domain administrators, who may modify it
    // or
    // change it to the `ACTIVE` or `DECLINED` states.
    // A course may only be changed to `PROVISIONED` if it is in the
    // `DECLINED`
    // state.
    //   "DECLINED" - The course has been created, but declined. It is
    // accessible by the
    // course owner and domain administrators, though it will not
    // be
    // displayed in the web UI. You cannot modify the course except to
    // change it
    // to the `PROVISIONED` state.
    // A course may only be changed to `DECLINED` if it is in the
    // `PROVISIONED`
    // state.
    //   "SUSPENDED" - The course has been suspended. You cannot modify the
    // course, and only the
    // user identified by the `owner_id` can view the course.
    // A course may be placed in this state if it potentially violates
    // the
    // Terms of Service.
    CourseState string `json:"courseState,omitempty"`

    // CreationTime: Creation time of the course.
    // Specifying this field in a course update mask results in an
    // error.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

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

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

    // EnrollmentCode: Enrollment code to use when joining this
    // course.
    // Specifying this field in a course update mask results in an
    // error.
    //
    // Read-only.
    EnrollmentCode string `json:"enrollmentCode,omitempty"`

    // GuardiansEnabled: Whether or not guardian notifications are enabled
    // for this course.
    //
    // Read-only.
    GuardiansEnabled bool `json:"guardiansEnabled,omitempty"`

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

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

    // OwnerId: The identifier of the owner of a course.
    //
    // When specified as a parameter of a
    // create course request, this
    // field is required.
    // The identifier can be one of the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    //
    // This must be set in a create request. Specifying this field in a
    // course
    // update mask results in an `INVALID_ARGUMENT` error.
    OwnerId string `json:"ownerId,omitempty"`

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

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

    // TeacherFolder: Information about a Drive Folder that is shared with
    // all teachers of the
    // course.
    //
    // This field will only be set for teachers of the course and domain
    // administrators.
    //
    // Read-only.
    TeacherFolder *DriveFolder `json:"teacherFolder,omitempty"`

    // TeacherGroupEmail: The email address of a Google group containing all
    // teachers of the course.
    // This group does not accept email and can only be used for
    // permissions.
    //
    // Read-only.
    TeacherGroupEmail string `json:"teacherGroupEmail,omitempty"`

    // UpdateTime: Time of the most recent update to this course.
    // Specifying this field in a course update mask results in an
    // error.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Course) MarshalJSON ¶

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

type CourseAlias ¶

CourseAlias: Alternative identifier for a course.

An alias uniquely identifies a course. It must be unique within one of the following scopes:

* domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom.

* project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.

type CourseAlias struct {
    // Alias: Alias string. The format of the string indicates the desired
    // alias scoping.
    //
    // * `d:<name>` indicates a domain-scoped alias.
    //   Example: `d:math_101`
    // * `p:<name>` indicates a project-scoped alias.
    //   Example: `p:abc123`
    //
    // This field has a maximum length of 256 characters.
    Alias string `json:"alias,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Alias") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*CourseAlias) MarshalJSON ¶

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

type CourseMaterial ¶

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

type CourseMaterial struct {
    // DriveFile: Google Drive file attachment.
    DriveFile *DriveFile `json:"driveFile,omitempty"`

    // Form: Google Forms attachment.
    Form *Form `json:"form,omitempty"`

    // Link: Link atatchment.
    Link *Link `json:"link,omitempty"`

    // YouTubeVideo: Youtube video attachment.
    YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*CourseMaterial) MarshalJSON ¶

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

type CourseMaterialSet ¶

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

type CourseMaterialSet struct {
    // Materials: Materials attached to this set.
    Materials []*CourseMaterial `json:"materials,omitempty"`

    // Title: Title for this set.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Materials") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*CourseMaterialSet) MarshalJSON ¶

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

type CourseWork ¶

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

type CourseWork struct {
    // AlternateLink: Absolute link to this course work in the Classroom web
    // UI.
    // This is only populated if `state` is `PUBLISHED`.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // 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 google.classroom.Work.CreateCourseWork for
    // more
    // details.
    //
    // Read-only.
    AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`

    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // CreationTime: Timestamp when this course work was
    // created.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // Description: Optional description of this course work.
    // If set, the description must be a valid UTF-8 string containing no
    // more
    // than 30,000 characters.
    Description string `json:"description,omitempty"`

    // DueDate: Optional date, in UTC, that submissions for this 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 this
    // course work
    // are due.
    // This must be specified if `due_date` is specified.
    DueTime *TimeOfDay `json:"dueTime,omitempty"`

    // Id: Classroom-assigned identifier of this course work, unique per
    // course.
    //
    // Read-only.
    Id string `json:"id,omitempty"`

    // Materials: Additional materials.
    //
    // CourseWork must have no more than 20 material items.
    Materials []*Material `json:"materials,omitempty"`

    // MaxPoints: Maximum grade for this course work.
    // If zero or unspecified, this assignment is considered ungraded.
    // This must be a non-negative integer value.
    MaxPoints float64 `json:"maxPoints,omitempty"`

    // MultipleChoiceQuestion: Multiple choice question details.
    // For read operations, this field is populated only when `work_type`
    // is
    // `MULTIPLE_CHOICE_QUESTION`.
    // For write operations, this field must be specified when creating
    // course
    // work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must
    // not be
    // set otherwise.
    MultipleChoiceQuestion *MultipleChoiceQuestion `json:"multipleChoiceQuestion,omitempty"`

    // ScheduledTime: Optional timestamp when this course work is scheduled
    // to be published.
    ScheduledTime string `json:"scheduledTime,omitempty"`

    // State: Status of this course work.
    // If unspecified, the default state is `DRAFT`.
    //
    // Possible values:
    //   "COURSE_WORK_STATE_UNSPECIFIED" - No state specified. This is never
    // returned.
    //   "PUBLISHED" - Status for work that has been published.
    // This is the default state.
    //   "DRAFT" - Status for work that is not yet published.
    // Work in this state is visible only to course teachers and
    // domain
    // administrators.
    //   "DELETED" - Status for work that was published but is now
    // deleted.
    // Work in this state is visible only to course teachers and
    // domain
    // administrators.
    // Work in this state is deleted after some time.
    State string `json:"state,omitempty"`

    // SubmissionModificationMode: Setting to determine when students are
    // allowed to modify submissions.
    // If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
    //
    // Possible values:
    //   "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" - No modification mode
    // specified. This is never returned.
    //   "MODIFIABLE_UNTIL_TURNED_IN" - Submisisons can be modified before
    // being turned in.
    //   "MODIFIABLE" - Submisisons can be modified at any time.
    SubmissionModificationMode string `json:"submissionModificationMode,omitempty"`

    // Title: Title of this course work.
    // The title must be a valid UTF-8 string containing between 1 and
    // 3000
    // characters.
    Title string `json:"title,omitempty"`

    // UpdateTime: Timestamp of the most recent change to this course
    // work.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // WorkType: Type of this course work.
    //
    // The type is set when the course work is created and cannot be
    // changed.
    //
    // Possible values:
    //   "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is
    // never returned.
    //   "ASSIGNMENT" - An assignment.
    //   "SHORT_ANSWER_QUESTION" - A short answer question.
    //   "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
    WorkType string `json:"workType,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*CourseWork) MarshalJSON ¶

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

func (*CourseWork) UnmarshalJSON ¶

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

type CoursesAliasesCreateCall ¶

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

func (*CoursesAliasesCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAliasesCreateCall) Do ¶

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

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

func (*CoursesAliasesCreateCall) Fields ¶

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

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

func (*CoursesAliasesCreateCall) Header ¶

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

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

type CoursesAliasesDeleteCall ¶

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

func (*CoursesAliasesDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAliasesDeleteCall) Do ¶

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

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

func (*CoursesAliasesDeleteCall) Fields ¶

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

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

func (*CoursesAliasesDeleteCall) Header ¶

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

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

type CoursesAliasesListCall ¶

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

func (*CoursesAliasesListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAliasesListCall) Do ¶

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

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

func (*CoursesAliasesListCall) Fields ¶

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

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

func (*CoursesAliasesListCall) Header ¶

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

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

func (*CoursesAliasesListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesAliasesListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

func (*CoursesAliasesListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesAliasesListCall) Pages ¶

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

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

type CoursesAliasesService ¶

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

func NewCoursesAliasesService ¶

func NewCoursesAliasesService(s *Service) *CoursesAliasesService

func (*CoursesAliasesService) Create ¶

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

Create: Creates an alias for a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the

requesting user or course (for example, if a user not in a domain
attempts to access a domain-scoped alias).

func (*CoursesAliasesService) Delete ¶

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

Delete: Deletes an alias of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the

requesting user or course (for example, if a user not in a domain
attempts to delete a domain-scoped alias).

func (*CoursesAliasesService) List ¶

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

List: Returns a list of aliases for a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

type CoursesCourseWorkCreateCall ¶

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

func (*CoursesCourseWorkCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkCreateCall) Do ¶

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

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

func (*CoursesCourseWorkCreateCall) Fields ¶

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

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

func (*CoursesCourseWorkCreateCall) Header ¶

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

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

type CoursesCourseWorkDeleteCall ¶

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

func (*CoursesCourseWorkDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkDeleteCall) Do ¶

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

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

func (*CoursesCourseWorkDeleteCall) Fields ¶

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

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

func (*CoursesCourseWorkDeleteCall) Header ¶

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

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

type CoursesCourseWorkGetCall ¶

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

func (*CoursesCourseWorkGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkGetCall) Do ¶

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

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

func (*CoursesCourseWorkGetCall) Fields ¶

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

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

func (*CoursesCourseWorkGetCall) Header ¶

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

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

func (*CoursesCourseWorkGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesCourseWorkListCall ¶

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

func (*CoursesCourseWorkListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkListCall) CourseWorkStates ¶

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

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

Possible values:

"COURSE_WORK_STATE_UNSPECIFIED"
"PUBLISHED"
"DRAFT"
"DELETED"

func (*CoursesCourseWorkListCall) Do ¶

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

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

func (*CoursesCourseWorkListCall) Fields ¶

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

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

func (*CoursesCourseWorkListCall) Header ¶

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

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

func (*CoursesCourseWorkListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesCourseWorkListCall) OrderBy ¶

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

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

func (*CoursesCourseWorkListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

func (*CoursesCourseWorkListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesCourseWorkListCall) Pages ¶

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

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

type CoursesCourseWorkPatchCall ¶

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

func (*CoursesCourseWorkPatchCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkPatchCall) Do ¶

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

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

func (*CoursesCourseWorkPatchCall) Fields ¶

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

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

func (*CoursesCourseWorkPatchCall) Header ¶

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

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

func (*CoursesCourseWorkPatchCall) UpdateMask ¶

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

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

The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `submission_modification_mode`

type CoursesCourseWorkService ¶

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

func NewCoursesCourseWorkService ¶

func NewCoursesCourseWorkService(s *Service) *CoursesCourseWorkService

func (*CoursesCourseWorkService) Create ¶

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

Create: Creates course work.

The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error:

* AttachmentNotVisible

func (*CoursesCourseWorkService) Delete ¶

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

Delete: Deletes a course work.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesCourseWorkService) Get ¶

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

Get: Returns course work.

This method returns the following error codes:

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

func (*CoursesCourseWorkService) List ¶

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

List: Returns a list of course work that the requester is permitted to view.

Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

func (*CoursesCourseWorkService) Patch ¶

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

Patch: Updates one or more fields of a course work.

See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

type CoursesCourseWorkStudentSubmissionsGetCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsGetCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsGetCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsGetCall) Header ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesCourseWorkStudentSubmissionsListCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsListCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsListCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsListCall) Header ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesCourseWorkStudentSubmissionsListCall) Late ¶

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

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

Possible values:

"LATE_VALUES_UNSPECIFIED"
"LATE_ONLY"
"NOT_LATE_ONLY"

func (*CoursesCourseWorkStudentSubmissionsListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

func (*CoursesCourseWorkStudentSubmissionsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesCourseWorkStudentSubmissionsListCall) Pages ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsListCall) States ¶

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

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

Possible values:

"SUBMISSION_STATE_UNSPECIFIED"
"NEW"
"CREATED"
"TURNED_IN"
"RETURNED"
"RECLAIMED_BY_STUDENT"

func (*CoursesCourseWorkStudentSubmissionsListCall) UserId ¶

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

UserId sets the optional parameter "userId": Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following:

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

type CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Header ¶

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

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

type CoursesCourseWorkStudentSubmissionsPatchCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Header ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall) UpdateMask ¶

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified.

The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`

type CoursesCourseWorkStudentSubmissionsReclaimCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Header ¶

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

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

type CoursesCourseWorkStudentSubmissionsReturnCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Header ¶

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

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

type CoursesCourseWorkStudentSubmissionsService ¶

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

func NewCoursesCourseWorkStudentSubmissionsService ¶

func NewCoursesCourseWorkStudentSubmissionsService(s *Service) *CoursesCourseWorkStudentSubmissionsService

func (*CoursesCourseWorkStudentSubmissionsService) Get ¶

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

Get: Returns a student submission.

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

func (*CoursesCourseWorkStudentSubmissionsService) List ¶

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

List: Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items.

Course students may only view their own work. Course teachers and domain administrators may view all student submissions.

This method returns the following error codes:

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

func (*CoursesCourseWorkStudentSubmissionsService) ModifyAttachments ¶

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

ModifyAttachments: Modifies attachments of student submission.

Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

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

func (*CoursesCourseWorkStudentSubmissionsService) Patch ¶

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

Patch: Updates one or more fields of a student submission.

See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) Reclaim ¶

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

Reclaim: Reclaims a student submission on behalf of the student that owns it.

Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state.

Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) Return ¶

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

Return: Returns a student submission.

Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value.

Only a teacher of the course that contains the requested student submission may call this method.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

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

func (*CoursesCourseWorkStudentSubmissionsService) TurnIn ¶

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

TurnIn: Turns in a student submission.

Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state.

This may only be called by the student that owns the specified student submission.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

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

type CoursesCourseWorkStudentSubmissionsTurnInCall ¶

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

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Do ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Fields ¶

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

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

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Header ¶

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

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

type CoursesCreateCall ¶

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

func (*CoursesCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCreateCall) Do ¶

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

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

func (*CoursesCreateCall) Fields ¶

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

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

func (*CoursesCreateCall) Header ¶

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

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

type CoursesDeleteCall ¶

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

func (*CoursesDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesDeleteCall) Do ¶

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

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

func (*CoursesDeleteCall) Fields ¶

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

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

func (*CoursesDeleteCall) Header ¶

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

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

type CoursesGetCall ¶

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

func (*CoursesGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesGetCall) Do ¶

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

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

func (*CoursesGetCall) Fields ¶

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

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

func (*CoursesGetCall) Header ¶

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

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

func (*CoursesGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesListCall ¶

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

func (*CoursesListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesListCall) CourseStates ¶

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

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

Possible values:

"COURSE_STATE_UNSPECIFIED"
"ACTIVE"
"ARCHIVED"
"PROVISIONED"
"DECLINED"
"SUSPENDED"

func (*CoursesListCall) Do ¶

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

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

func (*CoursesListCall) Fields ¶

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

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

func (*CoursesListCall) Header ¶

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

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

func (*CoursesListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

func (*CoursesListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesListCall) Pages ¶

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

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

func (*CoursesListCall) StudentId ¶

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

StudentId sets the optional parameter "studentId": Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following:

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

func (*CoursesListCall) TeacherId ¶

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

TeacherId sets the optional parameter "teacherId": Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following:

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

type CoursesPatchCall ¶

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

func (*CoursesPatchCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesPatchCall) Do ¶

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

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

func (*CoursesPatchCall) Fields ¶

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

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

func (*CoursesPatchCall) Header ¶

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

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

func (*CoursesPatchCall) UpdateMask ¶

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid:

* `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState`

When set in a query parameter, this field should be specified as

`updateMask=<field1>,<field2>,...`

type CoursesService ¶

type CoursesService struct {
    Aliases *CoursesAliasesService

    CourseWork *CoursesCourseWorkService

    Students *CoursesStudentsService

    Teachers *CoursesTeachersService
    // contains filtered or unexported fields
}

func NewCoursesService ¶

func NewCoursesService(s *Service) *CoursesService

func (*CoursesService) Create ¶

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

Create: Creates a course.

The user specified in `ownerId` is the owner of the created course and added as a teacher.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors:

* UserGroupsMembershipLimitReached

* `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.

func (*CoursesService) Delete ¶

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

Delete: Deletes a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesService) Get ¶

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

Get: Returns a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesService) List ¶

func (r *CoursesService) List() *CoursesListCall

List: Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request.

This method returns the following error codes:

* `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

func (*CoursesService) Patch ¶

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

Patch: Updates one or more fields in a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors:

* CourseNotModifiable

func (*CoursesService) Update ¶

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

Update: Updates a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors:

* CourseNotModifiable

type CoursesStudentsCreateCall ¶

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

func (*CoursesStudentsCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsCreateCall) Do ¶

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

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

func (*CoursesStudentsCreateCall) EnrollmentCode ¶

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

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

func (*CoursesStudentsCreateCall) Fields ¶

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

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

func (*CoursesStudentsCreateCall) Header ¶

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

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

type CoursesStudentsDeleteCall ¶

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

func (*CoursesStudentsDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsDeleteCall) Do ¶

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

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

func (*CoursesStudentsDeleteCall) Fields ¶

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

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

func (*CoursesStudentsDeleteCall) Header ¶

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

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

type CoursesStudentsGetCall ¶

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

func (*CoursesStudentsGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsGetCall) Do ¶

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

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

func (*CoursesStudentsGetCall) Fields ¶

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

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

func (*CoursesStudentsGetCall) Header ¶

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

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

func (*CoursesStudentsGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesStudentsListCall ¶

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

func (*CoursesStudentsListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsListCall) Do ¶

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

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

func (*CoursesStudentsListCall) Fields ¶

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

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

func (*CoursesStudentsListCall) Header ¶

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

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

func (*CoursesStudentsListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesStudentsListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero means no maximum.

The server may return fewer than the specified number of results.

func (*CoursesStudentsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesStudentsListCall) Pages ¶

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

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

type CoursesStudentsService ¶

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

func NewCoursesStudentsService ¶

func NewCoursesStudentsService(s *Service) *CoursesStudentsService

func (*CoursesStudentsService) Create ¶

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

Create: Adds a user as a student of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors:

* CourseMemberLimitReached
* CourseNotModifiable
* UserGroupsMembershipLimitReached

* `ALREADY_EXISTS` if the user is already a student or teacher in the course.

func (*CoursesStudentsService) Delete ¶

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

Delete: Deletes a student of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

func (*CoursesStudentsService) Get ¶

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

Get: Returns a student of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

func (*CoursesStudentsService) List ¶

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

List: Returns a list of students of this course that the requester is permitted to view.

This method returns the following error codes:

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

type CoursesTeachersCreateCall ¶

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

func (*CoursesTeachersCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersCreateCall) Do ¶

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

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

func (*CoursesTeachersCreateCall) Fields ¶

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

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

func (*CoursesTeachersCreateCall) Header ¶

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

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

type CoursesTeachersDeleteCall ¶

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

func (*CoursesTeachersDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersDeleteCall) Do ¶

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

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

func (*CoursesTeachersDeleteCall) Fields ¶

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

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

func (*CoursesTeachersDeleteCall) Header ¶

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

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

type CoursesTeachersGetCall ¶

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

func (*CoursesTeachersGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersGetCall) Do ¶

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

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

func (*CoursesTeachersGetCall) Fields ¶

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

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

func (*CoursesTeachersGetCall) Header ¶

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

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

func (*CoursesTeachersGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesTeachersListCall ¶

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

func (*CoursesTeachersListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersListCall) Do ¶

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

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

func (*CoursesTeachersListCall) Fields ¶

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

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

func (*CoursesTeachersListCall) Header ¶

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

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

func (*CoursesTeachersListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesTeachersListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero means no maximum.

The server may return fewer than the specified number of results.

func (*CoursesTeachersListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesTeachersListCall) Pages ¶

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

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

type CoursesTeachersService ¶

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

func NewCoursesTeachersService ¶

func NewCoursesTeachersService(s *Service) *CoursesTeachersService

func (*CoursesTeachersService) Create ¶

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

Create: Creates a teacher of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors:

* CourseMemberLimitReached
* CourseNotModifiable
* CourseTeacherLimitReached
* UserGroupsMembershipLimitReached

* `ALREADY_EXISTS` if the user is already a teacher or student in the course.

func (*CoursesTeachersService) Delete ¶

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

Delete: Deletes a teacher of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.

func (*CoursesTeachersService) Get ¶

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

Get: Returns a teacher of a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

func (*CoursesTeachersService) List ¶

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

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

This method returns the following error codes:

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

type CoursesUpdateCall ¶

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

func (*CoursesUpdateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesUpdateCall) Do ¶

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

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

func (*CoursesUpdateCall) Fields ¶

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

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

func (*CoursesUpdateCall) Header ¶

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

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

type Date ¶

Date: Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

type Date struct {
    // Day: Day of month. Must be from 1 to 31 and valid for the year and
    // month, or 0
    // if specifying a year/month where the day is not significant.
    Day int64 `json:"day,omitempty"`

    // Month: Month of year. Must be from 1 to 12.
    Month int64 `json:"month,omitempty"`

    // Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
    // without
    // a year.
    Year int64 `json:"year,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Day") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Date) MarshalJSON ¶

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

type DriveFile ¶

DriveFile: Representation of a Google Drive file.

type DriveFile struct {
    // AlternateLink: URL that can be used to access the Drive
    // item.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // Id: Drive API resource ID.
    Id string `json:"id,omitempty"`

    // ThumbnailUrl: URL of a thumbnail image of the Drive item.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the Drive item.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*DriveFile) MarshalJSON ¶

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

type DriveFolder ¶

DriveFolder: Representation of a Google Drive folder.

type DriveFolder struct {
    // AlternateLink: URL that can be used to access the Drive
    // folder.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // Id: Drive API resource ID.
    Id string `json:"id,omitempty"`

    // Title: Title of the Drive folder.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*DriveFolder) MarshalJSON ¶

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

type Empty ¶

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty);

}

The JSON representation for `Empty` is empty JSON object `{}`.

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

type Form ¶

Form: Google Forms item.

type Form struct {
    // FormUrl: URL of the form.
    FormUrl string `json:"formUrl,omitempty"`

    // ResponseUrl: URL of the form responses document.
    // Only set if respsonses have been recorded and only when
    // the
    // requesting user is an editor of the form.
    //
    // Read-only.
    ResponseUrl string `json:"responseUrl,omitempty"`

    // ThumbnailUrl: URL of a thumbnail image of the Form.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the Form.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FormUrl") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Form) MarshalJSON ¶

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

type GlobalPermission ¶

GlobalPermission: Global user permission description.

type GlobalPermission struct {
    // Permission: Permission value.
    //
    // Possible values:
    //   "PERMISSION_UNSPECIFIED" - No permission is specified. This is not
    // returned and is not a
    // valid value.
    //   "CREATE_COURSE" - User is permitted to create a course.
    Permission string `json:"permission,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Permission") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*GlobalPermission) MarshalJSON ¶

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

type Guardian ¶

Guardian: Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

type Guardian struct {
    // GuardianId: Identifier for the guardian.
    GuardianId string `json:"guardianId,omitempty"`

    // GuardianProfile: User profile for the guardian.
    GuardianProfile *UserProfile `json:"guardianProfile,omitempty"`

    // InvitedEmailAddress: The email address to which the initial guardian
    // invitation was sent.
    // This field is only visible to domain administrators.
    InvitedEmailAddress string `json:"invitedEmailAddress,omitempty"`

    // StudentId: Identifier for the student to whom the guardian
    // relationship applies.
    StudentId string `json:"studentId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "GuardianId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Guardian) MarshalJSON ¶

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

type GuardianInvitation ¶

GuardianInvitation: An invitation to become the guardian of a specified user, sent to a specified email address.

type GuardianInvitation struct {
    // CreationTime: The time that this invitation was created.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // InvitationId: Unique identifier for this invitation.
    //
    // Read-only.
    InvitationId string `json:"invitationId,omitempty"`

    // InvitedEmailAddress: Email address that the invitation was sent
    // to.
    // This field is only visible to domain administrators.
    InvitedEmailAddress string `json:"invitedEmailAddress,omitempty"`

    // State: The state that this invitation is in.
    //
    // Possible values:
    //   "GUARDIAN_INVITATION_STATE_UNSPECIFIED" - Should never be returned.
    //   "PENDING" - The invitation is active and awaiting a response.
    //   "COMPLETE" - The invitation is no longer active. It may have been
    // accepted, declined,
    // withdrawn or it may have expired.
    State string `json:"state,omitempty"`

    // StudentId: ID of the student (in standard format)
    StudentId string `json:"studentId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CreationTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*GuardianInvitation) MarshalJSON ¶

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

type Invitation ¶

Invitation: An invitation to join a course.

type Invitation struct {
    // CourseId: Identifier of the course to invite the user to.
    CourseId string `json:"courseId,omitempty"`

    // Id: Identifier assigned by Classroom.
    //
    // Read-only.
    Id string `json:"id,omitempty"`

    // Role: Role to invite the user to have.
    // Must not be `COURSE_ROLE_UNSPECIFIED`.
    //
    // Possible values:
    //   "COURSE_ROLE_UNSPECIFIED" - No course role.
    //   "STUDENT" - Student in the course.
    //   "TEACHER" - Teacher of the course.
    Role string `json:"role,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Invitation) MarshalJSON ¶

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

type InvitationsAcceptCall ¶

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

func (*InvitationsAcceptCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsAcceptCall) Do ¶

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

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

func (*InvitationsAcceptCall) Fields ¶

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

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

func (*InvitationsAcceptCall) Header ¶

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

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

type InvitationsCreateCall ¶

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

func (*InvitationsCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsCreateCall) Do ¶

func (c *InvitationsCreateCall) Do(opts ...googleapi.CallOption) (*Invitation, error)

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

func (*InvitationsCreateCall) Fields ¶

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

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

func (*InvitationsCreateCall) Header ¶

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

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

type InvitationsDeleteCall ¶

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

func (*InvitationsDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsDeleteCall) Do ¶

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

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

func (*InvitationsDeleteCall) Fields ¶

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

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

func (*InvitationsDeleteCall) Header ¶

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

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

type InvitationsGetCall ¶

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

func (*InvitationsGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsGetCall) Do ¶

func (c *InvitationsGetCall) Do(opts ...googleapi.CallOption) (*Invitation, error)

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

func (*InvitationsGetCall) Fields ¶

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

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

func (*InvitationsGetCall) Header ¶

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

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

func (*InvitationsGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type InvitationsListCall ¶

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

func (*InvitationsListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsListCall) CourseId ¶

func (c *InvitationsListCall) CourseId(courseId string) *InvitationsListCall

CourseId sets the optional parameter "courseId": Restricts returned invitations to those for a course with the specified identifier.

func (*InvitationsListCall) Do ¶

func (c *InvitationsListCall) Do(opts ...googleapi.CallOption) (*ListInvitationsResponse, error)

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

func (*InvitationsListCall) Fields ¶

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

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

func (*InvitationsListCall) Header ¶

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

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

func (*InvitationsListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*InvitationsListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero means no maximum.

The server may return fewer than the specified number of results.

func (*InvitationsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*InvitationsListCall) Pages ¶

func (c *InvitationsListCall) Pages(ctx context.Context, f func(*ListInvitationsResponse) error) error

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

func (*InvitationsListCall) UserId ¶

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

UserId sets the optional parameter "userId": Restricts returned invitations to those for a specific user. The identifier can be one of the following:

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

type InvitationsService ¶

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

func NewInvitationsService ¶

func NewInvitationsService(s *Service) *InvitationsService

func (*InvitationsService) Accept ¶

func (r *InvitationsService) Accept(id string) *InvitationsAcceptCall

Accept: Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors:

* CourseMemberLimitReached
* CourseNotModifiable
* CourseTeacherLimitReached
* UserGroupsMembershipLimitReached

* `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) Create ¶

func (r *InvitationsService) Create(invitation *Invitation) *InvitationsCreateCall

Create: Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

func (*InvitationsService) Delete ¶

func (r *InvitationsService) Delete(id string) *InvitationsDeleteCall

Delete: Deletes an invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) Get ¶

func (r *InvitationsService) Get(id string) *InvitationsGetCall

Get: Returns an invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) List ¶

func (r *InvitationsService) List() *InvitationsListCall

List: Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.

*Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied.

This method returns the following error codes:

* `PERMISSION_DENIED` for access errors.

type Link ¶

Link: URL item.

type Link struct {
    // ThumbnailUrl: URL of a thumbnail image of the target URL.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the target of the URL.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // Url: URL to link to.
    // This must be a valid UTF-8 string containing between 1 and 2024
    // characters.
    Url string `json:"url,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ThumbnailUrl") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Link) MarshalJSON ¶

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

type ListCourseAliasesResponse ¶

ListCourseAliasesResponse: Response when listing course aliases.

type ListCourseAliasesResponse struct {
    // Aliases: The course aliases.
    Aliases []*CourseAlias `json:"aliases,omitempty"`

    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Aliases") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListCourseAliasesResponse) MarshalJSON ¶

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

type ListCourseWorkResponse ¶

ListCourseWorkResponse: Response when listing course work.

type ListCourseWorkResponse struct {
    // CourseWork: Course work items that match the request.
    CourseWork []*CourseWork `json:"courseWork,omitempty"`

    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseWork") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListCourseWorkResponse) MarshalJSON ¶

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

type ListCoursesResponse ¶

ListCoursesResponse: Response when listing courses.

type ListCoursesResponse struct {
    // Courses: Courses that match the list request.
    Courses []*Course `json:"courses,omitempty"`

    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Courses") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListCoursesResponse) MarshalJSON ¶

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

type ListGuardianInvitationsResponse ¶

ListGuardianInvitationsResponse: Response when listing guardian invitations.

type ListGuardianInvitationsResponse struct {
    // GuardianInvitations: Guardian invitations that matched the list
    // request.
    GuardianInvitations []*GuardianInvitation `json:"guardianInvitations,omitempty"`

    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "GuardianInvitations")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*ListGuardianInvitationsResponse) MarshalJSON ¶

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

type ListGuardiansResponse ¶

ListGuardiansResponse: Response when listing guardians.

type ListGuardiansResponse struct {
    // Guardians: Guardians on this page of results that met the criteria
    // specified in
    // the request.
    Guardians []*Guardian `json:"guardians,omitempty"`

    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Guardians") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListGuardiansResponse) MarshalJSON ¶

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

type ListInvitationsResponse ¶

ListInvitationsResponse: Response when listing invitations.

type ListInvitationsResponse struct {
    // Invitations: Invitations that match the list request.
    Invitations []*Invitation `json:"invitations,omitempty"`

    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Invitations") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListInvitationsResponse) MarshalJSON ¶

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

type ListStudentSubmissionsResponse ¶

ListStudentSubmissionsResponse: Response when listing student submissions.

type ListStudentSubmissionsResponse struct {
    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // StudentSubmissions: Student work that matches the request.
    StudentSubmissions []*StudentSubmission `json:"studentSubmissions,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListStudentSubmissionsResponse) MarshalJSON ¶

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

type ListStudentsResponse ¶

ListStudentsResponse: Response when listing students.

type ListStudentsResponse struct {
    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // Students: Students who match the list request.
    Students []*Student `json:"students,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListStudentsResponse) MarshalJSON ¶

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

type ListTeachersResponse ¶

ListTeachersResponse: Response when listing teachers.

type ListTeachersResponse struct {
    // NextPageToken: Token identifying the next page of results to return.
    // If empty, no further
    // results are available.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // Teachers: Teachers who match the list request.
    Teachers []*Teacher `json:"teachers,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListTeachersResponse) MarshalJSON ¶

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

type Material ¶

Material: Material attached to course work.

When creating attachments, setting the `form` field is not supported.

type Material struct {
    // DriveFile: Google Drive file material.
    DriveFile *SharedDriveFile `json:"driveFile,omitempty"`

    // Form: Google Forms material.
    Form *Form `json:"form,omitempty"`

    // Link: Link material. On creation, will be upgraded to a more
    // appropriate type
    // if possible, and this will be reflected in the response.
    Link *Link `json:"link,omitempty"`

    // YoutubeVideo: YouTube video material.
    YoutubeVideo *YouTubeVideo `json:"youtubeVideo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Material) MarshalJSON ¶

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

type ModifyAttachmentsRequest ¶

ModifyAttachmentsRequest: Request to modify the attachments of a student submission.

type ModifyAttachmentsRequest struct {
    // AddAttachments: Attachments to add.
    // A student submission may not have more than 20 attachments.
    //
    // Form attachments are not supported.
    AddAttachments []*Attachment `json:"addAttachments,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AddAttachments") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*ModifyAttachmentsRequest) MarshalJSON ¶

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

type MultipleChoiceQuestion ¶

MultipleChoiceQuestion: Additional details for multiple-choice questions.

type MultipleChoiceQuestion struct {
    // Choices: Possible choices.
    Choices []string `json:"choices,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Choices") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*MultipleChoiceQuestion) MarshalJSON ¶

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

type MultipleChoiceSubmission ¶

MultipleChoiceSubmission: Student work for a multiple-choice question.

type MultipleChoiceSubmission struct {
    // Answer: Student's select choice.
    Answer string `json:"answer,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Answer") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*MultipleChoiceSubmission) MarshalJSON ¶

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

type Name ¶

Name: Details of the user's name.

type Name struct {
    // FamilyName: The user's last name.
    //
    // Read-only.
    FamilyName string `json:"familyName,omitempty"`

    // FullName: The user's full name formed by concatenating the first and
    // last name
    // values.
    //
    // Read-only.
    FullName string `json:"fullName,omitempty"`

    // GivenName: The user's first name.
    //
    // Read-only.
    GivenName string `json:"givenName,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FamilyName") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Name) MarshalJSON ¶

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

type ReclaimStudentSubmissionRequest ¶

ReclaimStudentSubmissionRequest: Request to reclaim a student submission.

type ReclaimStudentSubmissionRequest struct {
}

type ReturnStudentSubmissionRequest ¶

ReturnStudentSubmissionRequest: Request to return a student submission.

type ReturnStudentSubmissionRequest struct {
}

type Service ¶

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Courses *CoursesService

    Invitations *InvitationsService

    UserProfiles *UserProfilesService
    // contains filtered or unexported fields
}

func New ¶

func New(client *http.Client) (*Service, error)

type SharedDriveFile ¶

SharedDriveFile: Drive file that is used as material for course work.

type SharedDriveFile struct {
    // DriveFile: Drive file details.
    DriveFile *DriveFile `json:"driveFile,omitempty"`

    // ShareMode: Mechanism by which students access the Drive item.
    //
    // Possible values:
    //   "UNKNOWN_SHARE_MODE" - No sharing mode specified. This should never
    // be returned.
    //   "VIEW" - Students can view the shared file.
    //   "EDIT" - Students can edit the shared file.
    //   "STUDENT_COPY" - Students have a personal copy of the shared file.
    ShareMode string `json:"shareMode,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*SharedDriveFile) MarshalJSON ¶

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

type ShortAnswerSubmission ¶

ShortAnswerSubmission: Student work for a short answer question.

type ShortAnswerSubmission struct {
    // Answer: Student response to a short-answer question.
    Answer string `json:"answer,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Answer") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ShortAnswerSubmission) MarshalJSON ¶

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

type Student ¶

Student: Student in a course.

type Student struct {
    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // Profile: Global user information for the student.
    //
    // Read-only.
    Profile *UserProfile `json:"profile,omitempty"`

    // StudentWorkFolder: Information about a Drive Folder for this
    // student's work in this course.
    // Only visible to the student and domain administrators.
    //
    // Read-only.
    StudentWorkFolder *DriveFolder `json:"studentWorkFolder,omitempty"`

    // UserId: Identifier of the user.
    //
    // When specified as a parameter of a request, this identifier can be
    // one of
    // the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Student) MarshalJSON ¶

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

type StudentSubmission ¶

StudentSubmission: Student submission for course work.

StudentSubmission items are generated when a CourseWork item is created.

StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.

type StudentSubmission struct {
    // AlternateLink: Absolute link to the submission in the Classroom web
    // UI.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // AssignedGrade: Optional grade. If unset, no grade was set.
    // This must be a non-negative integer value.
    //
    // This may be modified only by course teachers.
    AssignedGrade float64 `json:"assignedGrade,omitempty"`

    // AssignmentSubmission: Submission content when course_work_type is
    // ASSIGNMENT .
    AssignmentSubmission *AssignmentSubmission `json:"assignmentSubmission,omitempty"`

    // AssociatedWithDeveloper: Whether this student submission is
    // associated with the Developer Console
    // project making the request.
    //
    // See google.classroom.Work.CreateCourseWork for
    // more
    // details.
    //
    // Read-only.
    AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`

    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // CourseWorkId: Identifier for the course work this corresponds
    // to.
    //
    // Read-only.
    CourseWorkId string `json:"courseWorkId,omitempty"`

    // CourseWorkType: Type of course work this submission is
    // for.
    //
    // Read-only.
    //
    // Possible values:
    //   "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is
    // never returned.
    //   "ASSIGNMENT" - An assignment.
    //   "SHORT_ANSWER_QUESTION" - A short answer question.
    //   "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
    CourseWorkType string `json:"courseWorkType,omitempty"`

    // CreationTime: Creation time of this submission.
    // This may be unset if the student has not accessed this
    // item.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // DraftGrade: Optional pending grade. If unset, no grade was set.
    // This must be a non-negative integer value.
    //
    // This is only visible to and modifiable by course teachers.
    DraftGrade float64 `json:"draftGrade,omitempty"`

    // Id: Classroom-assigned Identifier for the student submission.
    // This is unique among submissions for the relevant course
    // work.
    //
    // Read-only.
    Id string `json:"id,omitempty"`

    // Late: Whether this submission is late.
    //
    // Read-only.
    Late bool `json:"late,omitempty"`

    // MultipleChoiceSubmission: Submission content when course_work_type is
    // MULTIPLE_CHOICE_QUESTION.
    MultipleChoiceSubmission *MultipleChoiceSubmission `json:"multipleChoiceSubmission,omitempty"`

    // ShortAnswerSubmission: Submission content when course_work_type is
    // SHORT_ANSWER_QUESTION.
    ShortAnswerSubmission *ShortAnswerSubmission `json:"shortAnswerSubmission,omitempty"`

    // State: State of this submission.
    //
    // Read-only.
    //
    // Possible values:
    //   "SUBMISSION_STATE_UNSPECIFIED" - No state specified. This should
    // never be returned.
    //   "NEW" - The student has never accessed this submission. Attachments
    // are not
    // returned and timestamps is not set.
    //   "CREATED" - Has been created.
    //   "TURNED_IN" - Has been turned in to the teacher.
    //   "RETURNED" - Has been returned to the student.
    //   "RECLAIMED_BY_STUDENT" - Student chose to "unsubmit" the
    // assignment.
    State string `json:"state,omitempty"`

    // UpdateTime: Last update time of this submission.
    // This may be unset if the student has not accessed this
    // item.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // UserId: Identifier for the student that owns this
    // submission.
    //
    // Read-only.
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*StudentSubmission) MarshalJSON ¶

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

func (*StudentSubmission) UnmarshalJSON ¶

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

type Teacher ¶

Teacher: Teacher of a course.

type Teacher struct {
    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // Profile: Global user information for the teacher.
    //
    // Read-only.
    Profile *UserProfile `json:"profile,omitempty"`

    // UserId: Identifier of the user.
    //
    // When specified as a parameter of a request, this identifier can be
    // one of
    // the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Teacher) MarshalJSON ¶

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

type TimeOfDay ¶

TimeOfDay: Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

type TimeOfDay struct {
    // Hours: Hours of day in 24 hour format. Should be from 0 to 23. An API
    // may choose
    // to allow the value "24:00:00" for scenarios like business closing
    // time.
    Hours int64 `json:"hours,omitempty"`

    // Minutes: Minutes of hour of day. Must be from 0 to 59.
    Minutes int64 `json:"minutes,omitempty"`

    // Nanos: Fractions of seconds in nanoseconds. Must be from 0 to
    // 999,999,999.
    Nanos int64 `json:"nanos,omitempty"`

    // Seconds: Seconds of minutes of the time. Must normally be from 0 to
    // 59. An API may
    // allow the value 60 if it allows leap-seconds.
    Seconds int64 `json:"seconds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Hours") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*TimeOfDay) MarshalJSON ¶

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

type TurnInStudentSubmissionRequest ¶

TurnInStudentSubmissionRequest: Request to turn in a student submission.

type TurnInStudentSubmissionRequest struct {
}

type UserProfile ¶

UserProfile: Global information for a user.

type UserProfile struct {
    // EmailAddress: Email address of the user.
    //
    // Read-only.
    EmailAddress string `json:"emailAddress,omitempty"`

    // Id: Identifier of the user.
    //
    // Read-only.
    Id string `json:"id,omitempty"`

    // Name: Name of the user.
    //
    // Read-only.
    Name *Name `json:"name,omitempty"`

    // Permissions: Global permissions of the user.
    //
    // Read-only.
    Permissions []*GlobalPermission `json:"permissions,omitempty"`

    // PhotoUrl: URL of user's profile photo.
    //
    // Read-only.
    PhotoUrl string `json:"photoUrl,omitempty"`

    // VerifiedTeacher: Whether or not the user is a verified
    // teacher
    //
    // Read-only
    VerifiedTeacher bool `json:"verifiedTeacher,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "EmailAddress") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*UserProfile) MarshalJSON ¶

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

type UserProfilesGetCall ¶

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

func (*UserProfilesGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGetCall) Do ¶

func (c *UserProfilesGetCall) Do(opts ...googleapi.CallOption) (*UserProfile, error)

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

func (*UserProfilesGetCall) Fields ¶

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

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

func (*UserProfilesGetCall) Header ¶

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

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

func (*UserProfilesGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserProfilesGuardianInvitationsCreateCall ¶

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

func (*UserProfilesGuardianInvitationsCreateCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsCreateCall) Do ¶

func (c *UserProfilesGuardianInvitationsCreateCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

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

func (*UserProfilesGuardianInvitationsCreateCall) Fields ¶

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

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

func (*UserProfilesGuardianInvitationsCreateCall) Header ¶

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

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

type UserProfilesGuardianInvitationsGetCall ¶

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

func (*UserProfilesGuardianInvitationsGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsGetCall) Do ¶

func (c *UserProfilesGuardianInvitationsGetCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

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

func (*UserProfilesGuardianInvitationsGetCall) Fields ¶

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

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

func (*UserProfilesGuardianInvitationsGetCall) Header ¶

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

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

func (*UserProfilesGuardianInvitationsGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserProfilesGuardianInvitationsListCall ¶

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

func (*UserProfilesGuardianInvitationsListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsListCall) Do ¶

func (c *UserProfilesGuardianInvitationsListCall) Do(opts ...googleapi.CallOption) (*ListGuardianInvitationsResponse, error)

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

func (*UserProfilesGuardianInvitationsListCall) Fields ¶

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

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

func (*UserProfilesGuardianInvitationsListCall) Header ¶

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

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

func (*UserProfilesGuardianInvitationsListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*UserProfilesGuardianInvitationsListCall) InvitedEmailAddress ¶

func (c *UserProfilesGuardianInvitationsListCall) InvitedEmailAddress(invitedEmailAddress string) *UserProfilesGuardianInvitationsListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress": If specified, only results with the specified `invited_email_address` will be returned.

func (*UserProfilesGuardianInvitationsListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

func (*UserProfilesGuardianInvitationsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*UserProfilesGuardianInvitationsListCall) Pages ¶

func (c *UserProfilesGuardianInvitationsListCall) Pages(ctx context.Context, f func(*ListGuardianInvitationsResponse) error) error

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

func (*UserProfilesGuardianInvitationsListCall) States ¶

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

States sets the optional parameter "states": If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.

Possible values:

"GUARDIAN_INVITATION_STATE_UNSPECIFIED"
"PENDING"
"COMPLETE"

type UserProfilesGuardianInvitationsPatchCall ¶

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

func (*UserProfilesGuardianInvitationsPatchCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsPatchCall) Do ¶

func (c *UserProfilesGuardianInvitationsPatchCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

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

func (*UserProfilesGuardianInvitationsPatchCall) Fields ¶

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

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

func (*UserProfilesGuardianInvitationsPatchCall) Header ¶

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

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

func (*UserProfilesGuardianInvitationsPatchCall) UpdateMask ¶

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid:

* `state`

When set in a query parameter, this field should be specified as

`updateMask=<field1>,<field2>,...`

type UserProfilesGuardianInvitationsService ¶

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

func NewUserProfilesGuardianInvitationsService ¶

func NewUserProfilesGuardianInvitationsService(s *Service) *UserProfilesGuardianInvitationsService

func (*UserProfilesGuardianInvitationsService) Create ¶

func (r *UserProfilesGuardianInvitationsService) Create(studentId string, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsCreateCall

Create: Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.

Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.

The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.

This method returns the following error codes:

* `PERMISSION_DENIED` if the current user does not have permission to

manage guardians, if the guardian in question has already rejected
too many requests for that student, if guardians are not enabled

for the

domain in question, or for other access errors.

* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian

link limit.

* `INVALID_ARGUMENT` if the guardian email address is not valid (for

example, if it is too long), or if the format of the student ID

provided

cannot be recognized (it is not an email address, nor a `user_id`

from

this API). This error will also be returned if read-only fields are

set,

or if the `state` field is set to to a value other than

`PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but

Classroom has no record of that student.

* `ALREADY_EXISTS` if there is already a pending guardian invitation for

the student and `invited_email_address` provided, or if the

provided

`invited_email_address` matches the Google account of an existing
`Guardian` for this user.

func (*UserProfilesGuardianInvitationsService) Get ¶

func (r *UserProfilesGuardianInvitationsService) Get(studentId string, invitationId string) *UserProfilesGuardianInvitationsGetCall

Get: Returns a specific guardian invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to view

guardian invitations for the student identified by the

`student_id`, if

guardians are not enabled for the domain in question, or for other
access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`).

* `NOT_FOUND` if Classroom cannot find any record of the given student or

`invitation_id`. May also be returned if the student exists, but

the

requesting user does not have access to see that student.

func (*UserProfilesGuardianInvitationsService) List ¶

func (r *UserProfilesGuardianInvitationsService) List(studentId string) *UserProfilesGuardianInvitationsListCall

List: Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.

This method returns the following error codes:

* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting

user is not permitted to view guardian invitations for that

student, if

"-" is specified as the `student_id` and the user is not a

domain

administrator, if guardians are not enabled for the domain in

question,

or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`). May also be returned if an

invalid

`page_token` or `state` is provided.

* `NOT_FOUND` if a `student_id` is specified, and its format can be

recognized, but Classroom has no record of that student.

func (*UserProfilesGuardianInvitationsService) Patch ¶

func (r *UserProfilesGuardianInvitationsService) Patch(studentId string, invitationId string, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsPatchCall

Patch: Modifies a guardian invitation.

Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the current user does not have permission to

manage guardians, if guardians are not enabled for the domain in

question

or for other access errors.

* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided

cannot be recognized (it is not an email address, nor a `user_id`

from

this API), or if the passed `GuardianInvitation` has a `state`

other than

`COMPLETE`, or if it modifies fields other than `state`.

* `NOT_FOUND` if the student ID provided is a valid student ID, but

Classroom has no record of that student, or if the `id` field does

not

refer to a guardian invitation known to Classroom.

type UserProfilesGuardiansDeleteCall ¶

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

func (*UserProfilesGuardiansDeleteCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardiansDeleteCall) Do ¶

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

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

func (*UserProfilesGuardiansDeleteCall) Fields ¶

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

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

func (*UserProfilesGuardiansDeleteCall) Header ¶

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

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

type UserProfilesGuardiansGetCall ¶

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

func (*UserProfilesGuardiansGetCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardiansGetCall) Do ¶

func (c *UserProfilesGuardiansGetCall) Do(opts ...googleapi.CallOption) (*Guardian, error)

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

func (*UserProfilesGuardiansGetCall) Fields ¶

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

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

func (*UserProfilesGuardiansGetCall) Header ¶

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

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

func (*UserProfilesGuardiansGetCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserProfilesGuardiansListCall ¶

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

func (*UserProfilesGuardiansListCall) Context ¶

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardiansListCall) Do ¶

func (c *UserProfilesGuardiansListCall) Do(opts ...googleapi.CallOption) (*ListGuardiansResponse, error)

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

func (*UserProfilesGuardiansListCall) Fields ¶

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

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

func (*UserProfilesGuardiansListCall) Header ¶

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

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

func (*UserProfilesGuardiansListCall) IfNoneMatch ¶

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*UserProfilesGuardiansListCall) InvitedEmailAddress ¶

func (c *UserProfilesGuardiansListCall) InvitedEmailAddress(invitedEmailAddress string) *UserProfilesGuardiansListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress": Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

func (*UserProfilesGuardiansListCall) PageSize ¶

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

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

func (*UserProfilesGuardiansListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*UserProfilesGuardiansListCall) Pages ¶

func (c *UserProfilesGuardiansListCall) Pages(ctx context.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.

type UserProfilesGuardiansService ¶

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

func NewUserProfilesGuardiansService ¶

func NewUserProfilesGuardiansService(s *Service) *UserProfilesGuardiansService

func (*UserProfilesGuardiansService) Delete ¶

func (r *UserProfilesGuardiansService) Delete(studentId string, guardianId string) *UserProfilesGuardiansDeleteCall

Delete: Deletes a guardian.

The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API.

This method returns the following error codes:

* `PERMISSION_DENIED` if no user that matches the provided `student_id`

is visible to the requesting user, if the requesting user is not
permitted to manage guardians for the student identified by the
`student_id`, if guardians are not enabled for the domain in

question,

or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API).

* `NOT_FOUND` if the requesting user is permitted to modify guardians for

the requested `student_id`, but no `Guardian` record exists for

that

student with the provided `guardian_id`.

func (*UserProfilesGuardiansService) Get ¶

func (r *UserProfilesGuardiansService) Get(studentId string, guardianId string) *UserProfilesGuardiansGetCall

Get: Returns a specific guardian.

This method returns the following error codes:

* `PERMISSION_DENIED` if no user that matches the provided `student_id`

is visible to the requesting user, if the requesting user is not
permitted to view guardian information for the student identified

by the

`student_id`, if guardians are not enabled for the domain in

question,

or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`).

* `NOT_FOUND` if the requesting user is permitted to view guardians for

the requested `student_id`, but no `Guardian` record exists for

that

student that matches the provided `guardian_id`.

func (*UserProfilesGuardiansService) List ¶

func (r *UserProfilesGuardiansService) List(studentId string) *UserProfilesGuardiansListCall

List: Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.

To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID.

This method returns the following error codes:

* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting

user is not permitted to view guardian information for that

student, if

"-" is specified as the `student_id` and the user is not a

domain

administrator, if guardians are not enabled for the domain in

question,

if the `invited_email_address` filter is set by a user who is not

a

domain administrator, or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`). May also be returned if an

invalid

`page_token` is provided.

* `NOT_FOUND` if a `student_id` is specified, and its format can be

recognized, but Classroom has no record of that student.

type UserProfilesService ¶

type UserProfilesService struct {
    GuardianInvitations *UserProfilesGuardianInvitationsService

    Guardians *UserProfilesGuardiansService
    // contains filtered or unexported fields
}

func NewUserProfilesService ¶

func NewUserProfilesService(s *Service) *UserProfilesService

func (*UserProfilesService) Get ¶

func (r *UserProfilesService) Get(userId string) *UserProfilesGetCall

Get: Returns a user profile.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.

type YouTubeVideo ¶

YouTubeVideo: YouTube video item.

type YouTubeVideo struct {
    // AlternateLink: URL that can be used to view the YouTube
    // video.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // Id: YouTube API resource ID.
    Id string `json:"id,omitempty"`

    // ThumbnailUrl: URL of a thumbnail image of the YouTube
    // video.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the YouTube video.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*YouTubeVideo) MarshalJSON ¶

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