-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
classroom-gen.go
10331 lines (9592 loc) · 392 KB
/
classroom-gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package classroom provides access to the Google Classroom API.
//
// For product documentation, see: https://developers.google.com/classroom/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/classroom/v1"
// ...
// ctx := context.Background()
// classroomService, err := classroom.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate.
// To restrict scopes, use [google.golang.org/api/option.WithScopes]:
//
// classroomService, err := classroom.NewService(ctx, option.WithScopes(classroom.ClassroomTopicsReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// classroomService, err := classroom.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// classroomService, err := classroom.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package classroom // import "google.golang.org/api/classroom/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "classroom:v1"
const apiName = "classroom"
const apiVersion = "v1"
const basePath = "https://classroom.googleapis.com/"
const basePathTemplate = "https://classroom.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://classroom.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage announcements in Google Classroom
ClassroomAnnouncementsScope = "https://www.googleapis.com/auth/classroom.announcements"
// View announcements in Google Classroom
ClassroomAnnouncementsReadonlyScope = "https://www.googleapis.com/auth/classroom.announcements.readonly"
// See, edit, create, and permanently delete your Google Classroom classes
ClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses"
// View your Google Classroom classes
ClassroomCoursesReadonlyScope = "https://www.googleapis.com/auth/classroom.courses.readonly"
// See, create and edit coursework items including assignments, questions, and
// grades
ClassroomCourseworkMeScope = "https://www.googleapis.com/auth/classroom.coursework.me"
// View your course work and grades in Google Classroom
ClassroomCourseworkMeReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.me.readonly"
// Manage course work and grades for students in the Google Classroom classes
// you teach and view the course work and grades for classes you administer
ClassroomCourseworkStudentsScope = "https://www.googleapis.com/auth/classroom.coursework.students"
// View course work and grades for students in the Google Classroom classes you
// teach or administer
ClassroomCourseworkStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
// See, edit, and create classwork materials in Google Classroom
ClassroomCourseworkmaterialsScope = "https://www.googleapis.com/auth/classroom.courseworkmaterials"
// See all classwork materials for your Google Classroom classes
ClassroomCourseworkmaterialsReadonlyScope = "https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly"
// View your Google Classroom guardians
ClassroomGuardianlinksMeReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"
// View and manage guardians for students in your Google Classroom classes
ClassroomGuardianlinksStudentsScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students"
// View guardians for students in your Google Classroom classes
ClassroomGuardianlinksStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
// View the email addresses of people in your classes
ClassroomProfileEmailsScope = "https://www.googleapis.com/auth/classroom.profile.emails"
// View the profile photos of people in your classes
ClassroomProfilePhotosScope = "https://www.googleapis.com/auth/classroom.profile.photos"
// Receive notifications about your Google Classroom data
ClassroomPushNotificationsScope = "https://www.googleapis.com/auth/classroom.push-notifications"
// Manage your Google Classroom class rosters
ClassroomRostersScope = "https://www.googleapis.com/auth/classroom.rosters"
// View your Google Classroom class rosters
ClassroomRostersReadonlyScope = "https://www.googleapis.com/auth/classroom.rosters.readonly"
// View your course work and grades in Google Classroom
ClassroomStudentSubmissionsMeReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"
// View course work and grades for students in the Google Classroom classes you
// teach or administer
ClassroomStudentSubmissionsStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
// See, create, and edit topics in Google Classroom
ClassroomTopicsScope = "https://www.googleapis.com/auth/classroom.topics"
// View topics in Google Classroom
ClassroomTopicsReadonlyScope = "https://www.googleapis.com/auth/classroom.topics.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/classroom.announcements",
"https://www.googleapis.com/auth/classroom.announcements.readonly",
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly",
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
"https://www.googleapis.com/auth/classroom.coursework.students",
"https://www.googleapis.com/auth/classroom.coursework.students.readonly",
"https://www.googleapis.com/auth/classroom.courseworkmaterials",
"https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly",
"https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly",
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.push-notifications",
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly",
"https://www.googleapis.com/auth/classroom.topics",
"https://www.googleapis.com/auth/classroom.topics.readonly",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.EnableNewAuthLibrary())
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Courses = NewCoursesService(s)
s.Invitations = NewInvitationsService(s)
s.Registrations = NewRegistrationsService(s)
s.UserProfiles = NewUserProfilesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Courses *CoursesService
Invitations *InvitationsService
Registrations *RegistrationsService
UserProfiles *UserProfilesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewCoursesService(s *Service) *CoursesService {
rs := &CoursesService{s: s}
rs.Aliases = NewCoursesAliasesService(s)
rs.Announcements = NewCoursesAnnouncementsService(s)
rs.CourseWork = NewCoursesCourseWorkService(s)
rs.CourseWorkMaterials = NewCoursesCourseWorkMaterialsService(s)
rs.Students = NewCoursesStudentsService(s)
rs.Teachers = NewCoursesTeachersService(s)
rs.Topics = NewCoursesTopicsService(s)
return rs
}
type CoursesService struct {
s *Service
Aliases *CoursesAliasesService
Announcements *CoursesAnnouncementsService
CourseWork *CoursesCourseWorkService
CourseWorkMaterials *CoursesCourseWorkMaterialsService
Students *CoursesStudentsService
Teachers *CoursesTeachersService
Topics *CoursesTopicsService
}
func NewCoursesAliasesService(s *Service) *CoursesAliasesService {
rs := &CoursesAliasesService{s: s}
return rs
}
type CoursesAliasesService struct {
s *Service
}
func NewCoursesAnnouncementsService(s *Service) *CoursesAnnouncementsService {
rs := &CoursesAnnouncementsService{s: s}
return rs
}
type CoursesAnnouncementsService struct {
s *Service
}
func NewCoursesCourseWorkService(s *Service) *CoursesCourseWorkService {
rs := &CoursesCourseWorkService{s: s}
rs.StudentSubmissions = NewCoursesCourseWorkStudentSubmissionsService(s)
return rs
}
type CoursesCourseWorkService struct {
s *Service
StudentSubmissions *CoursesCourseWorkStudentSubmissionsService
}
func NewCoursesCourseWorkStudentSubmissionsService(s *Service) *CoursesCourseWorkStudentSubmissionsService {
rs := &CoursesCourseWorkStudentSubmissionsService{s: s}
return rs
}
type CoursesCourseWorkStudentSubmissionsService struct {
s *Service
}
func NewCoursesCourseWorkMaterialsService(s *Service) *CoursesCourseWorkMaterialsService {
rs := &CoursesCourseWorkMaterialsService{s: s}
return rs
}
type CoursesCourseWorkMaterialsService struct {
s *Service
}
func NewCoursesStudentsService(s *Service) *CoursesStudentsService {
rs := &CoursesStudentsService{s: s}
return rs
}
type CoursesStudentsService struct {
s *Service
}
func NewCoursesTeachersService(s *Service) *CoursesTeachersService {
rs := &CoursesTeachersService{s: s}
return rs
}
type CoursesTeachersService struct {
s *Service
}
func NewCoursesTopicsService(s *Service) *CoursesTopicsService {
rs := &CoursesTopicsService{s: s}
return rs
}
type CoursesTopicsService struct {
s *Service
}
func NewInvitationsService(s *Service) *InvitationsService {
rs := &InvitationsService{s: s}
return rs
}
type InvitationsService struct {
s *Service
}
func NewRegistrationsService(s *Service) *RegistrationsService {
rs := &RegistrationsService{s: s}
return rs
}
type RegistrationsService struct {
s *Service
}
func NewUserProfilesService(s *Service) *UserProfilesService {
rs := &UserProfilesService{s: s}
rs.GuardianInvitations = NewUserProfilesGuardianInvitationsService(s)
rs.Guardians = NewUserProfilesGuardiansService(s)
return rs
}
type UserProfilesService struct {
s *Service
GuardianInvitations *UserProfilesGuardianInvitationsService
Guardians *UserProfilesGuardiansService
}
func NewUserProfilesGuardianInvitationsService(s *Service) *UserProfilesGuardianInvitationsService {
rs := &UserProfilesGuardianInvitationsService{s: s}
return rs
}
type UserProfilesGuardianInvitationsService struct {
s *Service
}
func NewUserProfilesGuardiansService(s *Service) *UserProfilesGuardiansService {
rs := &UserProfilesGuardiansService{s: s}
return rs
}
type UserProfilesGuardiansService struct {
s *Service
}
// Announcement: Announcement created by a teacher for students of the course
type Announcement struct {
// AlternateLink: Absolute link to this announcement in the Classroom web UI.
// This is only populated if `state` is `PUBLISHED`. Read-only.
AlternateLink string `json:"alternateLink,omitempty"`
// AssigneeMode: Assignee mode of the announcement. If unspecified, the default
// value is `ALL_STUDENTS`.
//
// Possible values:
// "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
// "ALL_STUDENTS" - All students can see the item. This is the default state.
// "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
AssigneeMode string `json:"assigneeMode,omitempty"`
// CourseId: Identifier of the course. Read-only.
CourseId string `json:"courseId,omitempty"`
// CreationTime: Timestamp when this announcement was created. Read-only.
CreationTime string `json:"creationTime,omitempty"`
// CreatorUserId: Identifier for the user that created the announcement.
// Read-only.
CreatorUserId string `json:"creatorUserId,omitempty"`
// Id: Classroom-assigned identifier of this announcement, unique per course.
// Read-only.
Id string `json:"id,omitempty"`
// IndividualStudentsOptions: Identifiers of students with access to the
// announcement. This field is set only if `assigneeMode` is
// `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then
// only students specified in this field can see the announcement.
IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`
// Materials: Additional materials. Announcements must have no more than 20
// material items.
Materials []*Material `json:"materials,omitempty"`
// ScheduledTime: Optional timestamp when this announcement is scheduled to be
// published.
ScheduledTime string `json:"scheduledTime,omitempty"`
// State: Status of this announcement. If unspecified, the default state is
// `DRAFT`.
//
// Possible values:
// "ANNOUNCEMENT_STATE_UNSPECIFIED" - No state specified. This is never
// returned.
// "PUBLISHED" - Status for announcement that has been published. This is the
// default state.
// "DRAFT" - Status for an announcement that is not yet published.
// Announcement in this state is visible only to course teachers and domain
// administrators.
// "DELETED" - Status for announcement that was published but is now deleted.
// Announcement in this state is visible only to course teachers and domain
// administrators. Announcement in this state is deleted after some time.
State string `json:"state,omitempty"`
// Text: Description of this announcement. The text must be a valid UTF-8
// string containing no more than 30,000 characters.
Text string `json:"text,omitempty"`
// UpdateTime: Timestamp of the most recent change to this announcement.
// Read-only.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlternateLink") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlternateLink") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Announcement) MarshalJSON() ([]byte, error) {
type NoMethod Announcement
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Assignment: Additional details for assignments.
type Assignment struct {
// StudentWorkFolder: Drive folder where attachments from student submissions
// are placed. This is only populated for course teachers and administrators.
StudentWorkFolder *DriveFolder `json:"studentWorkFolder,omitempty"`
// ForceSendFields is a list of field names (e.g. "StudentWorkFolder") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "StudentWorkFolder") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Assignment) MarshalJSON() ([]byte, error) {
type NoMethod Assignment
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AssignmentSubmission: Student work for an assignment.
type AssignmentSubmission struct {
// Attachments: Attachments added by the student. Drive files that correspond
// to materials with a share mode of STUDENT_COPY may not exist yet if the
// student has not accessed the assignment in Classroom. Some attachment
// metadata is only populated if the requesting user has permission to access
// it. Identifier and alternate_link fields are always available, but others
// (for example, title) may not be.
Attachments []*Attachment `json:"attachments,omitempty"`
// ForceSendFields is a list of field names (e.g. "Attachments") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Attachments") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AssignmentSubmission) MarshalJSON() ([]byte, error) {
type NoMethod AssignmentSubmission
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Attachment: Attachment added to student assignment work. When creating
// attachments, setting the `form` field is not supported.
type Attachment struct {
// DriveFile: Google Drive file attachment.
DriveFile *DriveFile `json:"driveFile,omitempty"`
// Form: Google Forms attachment.
Form *Form `json:"form,omitempty"`
// Link: Link attachment.
Link *Link `json:"link,omitempty"`
// YouTubeVideo: Youtube video attachment.
YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`
// ForceSendFields is a list of field names (e.g. "DriveFile") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DriveFile") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Attachment) MarshalJSON() ([]byte, error) {
type NoMethod Attachment
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CloudPubsubTopic: A reference to a Cloud Pub/Sub topic. To register for
// notifications, the owner of the topic must grant
// `[email protected]` the
// `projects.topics.publish` permission.
type CloudPubsubTopic struct {
// TopicName: The `name` field of a Cloud Pub/Sub Topic
// (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
TopicName string `json:"topicName,omitempty"`
// ForceSendFields is a list of field names (e.g. "TopicName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "TopicName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CloudPubsubTopic) MarshalJSON() ([]byte, error) {
type NoMethod CloudPubsubTopic
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Course: A Course in Classroom.
type Course struct {
// AlternateLink: Absolute link to this course in the Classroom web UI.
// Read-only.
AlternateLink string `json:"alternateLink,omitempty"`
// CalendarId: The Calendar ID for a calendar that all course members can see,
// to which Classroom adds events for course work and announcements in the
// course. The Calendar for a course is created asynchronously when the course
// is set to `CourseState.ACTIVE` for the first time (at creation time or when
// it is updated to `ACTIVE` through the UI or the API). The Calendar ID will
// not be populated until the creation process is completed. Read-only.
CalendarId string `json:"calendarId,omitempty"`
// CourseGroupEmail: The email address of a Google group containing all members
// of the course. This group does not accept email and can only be used for
// permissions. Read-only.
CourseGroupEmail string `json:"courseGroupEmail,omitempty"`
// CourseMaterialSets: Sets of materials that appear on the "about" page of
// this course. Read-only.
CourseMaterialSets []*CourseMaterialSet `json:"courseMaterialSets,omitempty"`
// CourseState: State of the course. If unspecified, the default state is
// `PROVISIONED`.
//
// Possible values:
// "COURSE_STATE_UNSPECIFIED" - No course state. No returned Course message
// will use this value.
// "ACTIVE" - The course is active.
// "ARCHIVED" - The course has been archived. You cannot modify it except to
// change it to a different state.
// "PROVISIONED" - The course has been created, but not yet activated. It is
// accessible by the primary teacher and domain administrators, who may modify
// it or change it to the `ACTIVE` or `DECLINED` states. A course may only be
// changed to `PROVISIONED` if it is in the `DECLINED` state.
// "DECLINED" - The course has been created, but declined. It is accessible
// by the course owner and domain administrators, though it will not be
// displayed in the web UI. You cannot modify the course except to change it to
// the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is
// in the `PROVISIONED` state.
// "SUSPENDED" - The course has been suspended. You cannot modify the course,
// and only the user identified by the `owner_id` can view the course. A course
// may be placed in this state if it potentially violates the Terms of Service.
CourseState string `json:"courseState,omitempty"`
// CreationTime: Creation time of the course. Specifying this field in a course
// update mask results in an error. Read-only.
CreationTime string `json:"creationTime,omitempty"`
// Description: Optional description. For example, "We'll be learning about the
// structure of living creatures from a combination of textbooks, guest
// lectures, and lab work. Expect to be excited!" If set, this field must be a
// valid UTF-8 string and no longer than 30,000 characters.
Description string `json:"description,omitempty"`
// DescriptionHeading: Optional heading for the description. For example,
// "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8
// string and no longer than 3600 characters.
DescriptionHeading string `json:"descriptionHeading,omitempty"`
// EnrollmentCode: Enrollment code to use when joining this course. Specifying
// this field in a course update mask results in an error. Read-only.
EnrollmentCode string `json:"enrollmentCode,omitempty"`
// GradebookSettings: The gradebook settings that specify how a student's
// overall grade for the course will be calculated and who it will be displayed
// to. Read-only
GradebookSettings *GradebookSettings `json:"gradebookSettings,omitempty"`
// GuardiansEnabled: Whether or not guardian notifications are enabled for this
// course. Read-only.
GuardiansEnabled bool `json:"guardiansEnabled,omitempty"`
// Id: Identifier for this course assigned by Classroom. When creating a
// course, you may optionally set this identifier to an alias string in the
// request to create a corresponding alias. The `id` is still assigned by
// Classroom and cannot be updated after the course is created. Specifying this
// field in a course update mask results in an error.
Id string `json:"id,omitempty"`
// Name: Name of the course. For example, "10th Grade Biology". The name is
// required. It must be between 1 and 750 characters and a valid UTF-8 string.
Name string `json:"name,omitempty"`
// OwnerId: The identifier of the owner of a course. When specified as a
// parameter of a create course request, this field is required. The identifier
// can be one of the following: * the numeric identifier for the user * the
// email address of the user * the string literal "me", indicating the
// requesting user This must be set in a create request. Admins can also
// specify this field in a patch course request to transfer ownership. In other
// contexts, it is read-only.
OwnerId string `json:"ownerId,omitempty"`
// Room: Optional room location. For example, "301". If set, this field must be
// a valid UTF-8 string and no longer than 650 characters.
Room string `json:"room,omitempty"`
// Section: Section of the course. For example, "Period 2". If set, this field
// must be a valid UTF-8 string and no longer than 2800 characters.
Section string `json:"section,omitempty"`
// TeacherFolder: Information about a Drive Folder that is shared with all
// teachers of the course. This field will only be set for teachers of the
// course and domain administrators. Read-only.
TeacherFolder *DriveFolder `json:"teacherFolder,omitempty"`
// TeacherGroupEmail: The email address of a Google group containing all
// teachers of the course. This group does not accept email and can only be
// used for permissions. Read-only.
TeacherGroupEmail string `json:"teacherGroupEmail,omitempty"`
// UpdateTime: Time of the most recent update to this course. Specifying this
// field in a course update mask results in an error. Read-only.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlternateLink") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlternateLink") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Course) MarshalJSON() ([]byte, error) {
type NoMethod Course
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CourseAlias: Alternative identifier for a course. An alias uniquely
// identifies a course. It must be unique within one of the following scopes: *
// domain: A domain-scoped alias is visible to all users within the alias
// creator's domain and can be created only by a domain admin. A domain-scoped
// alias is often used when a course has an identifier external to Classroom. *
// project: A project-scoped alias is visible to any request from an
// application using the Developer Console project ID that created the alias
// and can be created by any project. A project-scoped alias is often used when
// an application has alternative identifiers. A random value can also be used
// to avoid duplicate courses in the event of transmission failures, as
// retrying a request will return `ALREADY_EXISTS` if a previous one has
// succeeded.
type CourseAlias struct {
// Alias: Alias string. The format of the string indicates the desired alias
// scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` *
// `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a
// maximum length of 256 characters.
Alias string `json:"alias,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Alias") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Alias") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CourseAlias) MarshalJSON() ([]byte, error) {
type NoMethod CourseAlias
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CourseMaterial: A material attached to a course as part of a material set.
type CourseMaterial struct {
// DriveFile: Google Drive file attachment.
DriveFile *DriveFile `json:"driveFile,omitempty"`
// Form: Google Forms attachment.
Form *Form `json:"form,omitempty"`
// Link: Link atatchment.
Link *Link `json:"link,omitempty"`
// YouTubeVideo: Youtube video attachment.
YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`
// ForceSendFields is a list of field names (e.g. "DriveFile") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DriveFile") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CourseMaterial) MarshalJSON() ([]byte, error) {
type NoMethod CourseMaterial
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CourseMaterialSet: A set of materials that appears on the "About" page of
// the course. These materials might include a syllabus, schedule, or other
// background information relating to the course as a whole.
type CourseMaterialSet struct {
// Materials: Materials attached to this set.
Materials []*CourseMaterial `json:"materials,omitempty"`
// Title: Title for this set.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Materials") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Materials") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CourseMaterialSet) MarshalJSON() ([]byte, error) {
type NoMethod CourseMaterialSet
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CourseRosterChangesInfo: Information about a `Feed` with a `feed_type` of
// `COURSE_ROSTER_CHANGES`.
type CourseRosterChangesInfo struct {
// CourseId: The `course_id` of the course to subscribe to roster changes for.
CourseId string `json:"courseId,omitempty"`
// ForceSendFields is a list of field names (e.g. "CourseId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CourseId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CourseRosterChangesInfo) MarshalJSON() ([]byte, error) {
type NoMethod CourseRosterChangesInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CourseWork: Course work created by a teacher for students of the course.
type CourseWork struct {
// AlternateLink: Absolute link to this course work in the Classroom web UI.
// This is only populated if `state` is `PUBLISHED`. Read-only.
AlternateLink string `json:"alternateLink,omitempty"`
// AssigneeMode: Assignee mode of the coursework. If unspecified, the default
// value is `ALL_STUDENTS`.
//
// Possible values:
// "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never returned.
// "ALL_STUDENTS" - All students can see the item. This is the default state.
// "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
AssigneeMode string `json:"assigneeMode,omitempty"`
// Assignment: Assignment details. This is populated only when `work_type` is
// `ASSIGNMENT`. Read-only.
Assignment *Assignment `json:"assignment,omitempty"`
// AssociatedWithDeveloper: Whether this course work item is associated with
// the Developer Console project making the request. See CreateCourseWork for
// more details. Read-only.
AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`
// CourseId: Identifier of the course. Read-only.
CourseId string `json:"courseId,omitempty"`
// CreationTime: Timestamp when this course work was created. Read-only.
CreationTime string `json:"creationTime,omitempty"`
// CreatorUserId: Identifier for the user that created the coursework.
// Read-only.
CreatorUserId string `json:"creatorUserId,omitempty"`
// Description: Optional description of this course work. If set, the
// description must be a valid UTF-8 string containing no more than 30,000
// characters.
Description string `json:"description,omitempty"`
// DueDate: Optional date, in UTC, that submissions for this course work are
// due. This must be specified if `due_time` is specified.
DueDate *Date `json:"dueDate,omitempty"`
// DueTime: Optional time of day, in UTC, that submissions for this course work
// are due. This must be specified if `due_date` is specified.
DueTime *TimeOfDay `json:"dueTime,omitempty"`
// GradeCategory: The category that this coursework's grade contributes to.
// Present only when a category has been chosen for the coursework. May be used
// in calculating the overall grade. Read-only.
GradeCategory *GradeCategory `json:"gradeCategory,omitempty"`
// Id: Classroom-assigned identifier of this course work, unique per course.
// Read-only.
Id string `json:"id,omitempty"`
// IndividualStudentsOptions: Identifiers of students with access to the
// coursework. This field is set only if `assigneeMode` is
// `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then
// only students specified in this field are assigned the coursework.
IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`
// Materials: Additional materials. CourseWork must have no more than 20
// material items.
Materials []*Material `json:"materials,omitempty"`
// MaxPoints: Maximum grade for this course work. If zero or unspecified, this
// assignment is considered ungraded. This must be a non-negative integer
// value.
MaxPoints float64 `json:"maxPoints,omitempty"`
// MultipleChoiceQuestion: Multiple choice question details. For read
// operations, this field is populated only when `work_type` is
// `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be
// specified when creating course work with a `work_type` of
// `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
MultipleChoiceQuestion *MultipleChoiceQuestion `json:"multipleChoiceQuestion,omitempty"`
// ScheduledTime: Optional timestamp when this course work is scheduled to be
// published.
ScheduledTime string `json:"scheduledTime,omitempty"`
// State: Status of this course work. If unspecified, the default state is
// `DRAFT`.
//
// Possible values:
// "COURSE_WORK_STATE_UNSPECIFIED" - No state specified. This is never
// returned.
// "PUBLISHED" - Status for work that has been published. This is the default
// state.
// "DRAFT" - Status for work that is not yet published. Work in this state is
// visible only to course teachers and domain administrators.
// "DELETED" - Status for work that was published but is now deleted. Work in
// this state is visible only to course teachers and domain administrators.
// Work in this state is deleted after some time.
State string `json:"state,omitempty"`
// SubmissionModificationMode: Setting to determine when students are allowed
// to modify submissions. If unspecified, the default value is
// `MODIFIABLE_UNTIL_TURNED_IN`.
//
// Possible values:
// "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" - No modification mode
// specified. This is never returned.
// "MODIFIABLE_UNTIL_TURNED_IN" - Submissions can be modified before being
// turned in.
// "MODIFIABLE" - Submissions can be modified at any time.
SubmissionModificationMode string `json:"submissionModificationMode,omitempty"`
// Title: Title of this course work. The title must be a valid UTF-8 string
// containing between 1 and 3000 characters.
Title string `json:"title,omitempty"`
// TopicId: Identifier for the topic that this coursework is associated with.
// Must match an existing topic in the course.
TopicId string `json:"topicId,omitempty"`
// UpdateTime: Timestamp of the most recent change to this course work.
// Read-only.
UpdateTime string `json:"updateTime,omitempty"`
// WorkType: Type of this course work. The type is set when the course work is
// created and cannot be changed.
//
// Possible values:
// "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is never
// returned.
// "ASSIGNMENT" - An assignment.
// "SHORT_ANSWER_QUESTION" - A short answer question.
// "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
WorkType string `json:"workType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlternateLink") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlternateLink") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CourseWork) MarshalJSON() ([]byte, error) {
type NoMethod CourseWork
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
func (s *CourseWork) UnmarshalJSON(data []byte) error {
type NoMethod CourseWork
var s1 struct {
MaxPoints gensupport.JSONFloat64 `json:"maxPoints"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.MaxPoints = float64(s1.MaxPoints)
return nil
}
// CourseWorkChangesInfo: Information about a `Feed` with a `feed_type` of
// `COURSE_WORK_CHANGES`.
type CourseWorkChangesInfo struct {
// CourseId: The `course_id` of the course to subscribe to work changes for.
CourseId string `json:"courseId,omitempty"`
// ForceSendFields is a list of field names (e.g. "CourseId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CourseId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CourseWorkChangesInfo) MarshalJSON() ([]byte, error) {
type NoMethod CourseWorkChangesInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CourseWorkMaterial: Course work material created by a teacher for students
// of the course
type CourseWorkMaterial struct {
// AlternateLink: Absolute link to this course work material in the Classroom
// web UI. This is only populated if `state` is `PUBLISHED`. Read-only.