-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
admin-gen.go
2718 lines (2468 loc) · 128 KB
/
admin-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 2022 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 admin provides access to the Admin SDK API.
//
// For product documentation, see: https://developers.google.com/admin-sdk/
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/admin/reports/v1"
// ...
// ctx := context.Background()
// adminService, err := admin.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 option.WithScopes:
//
// adminService, err := admin.NewService(ctx, option.WithScopes(admin.AdminReportsUsageReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// adminService, err := admin.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// adminService, err := admin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package admin // import "google.golang.org/api/admin/reports/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
const apiId = "admin:reports_v1"
const apiName = "admin"
const apiVersion = "reports_v1"
const basePath = "https://admin.googleapis.com/"
const mtlsBasePath = "https://admin.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View audit reports for your G Suite domain
AdminReportsAuditReadonlyScope = "https://www.googleapis.com/auth/admin.reports.audit.readonly"
// View usage reports for your G Suite domain
AdminReportsUsageReadonlyScope = "https://www.googleapis.com/auth/admin.reports.usage.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/admin.reports.audit.readonly",
"https://www.googleapis.com/auth/admin.reports.usage.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.WithDefaultMTLSEndpoint(mtlsBasePath))
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.Activities = NewActivitiesService(s)
s.Channels = NewChannelsService(s)
s.CustomerUsageReports = NewCustomerUsageReportsService(s)
s.EntityUsageReports = NewEntityUsageReportsService(s)
s.UserUsageReport = NewUserUsageReportService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Activities *ActivitiesService
Channels *ChannelsService
CustomerUsageReports *CustomerUsageReportsService
EntityUsageReports *EntityUsageReportsService
UserUsageReport *UserUsageReportService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewActivitiesService(s *Service) *ActivitiesService {
rs := &ActivitiesService{s: s}
return rs
}
type ActivitiesService struct {
s *Service
}
func NewChannelsService(s *Service) *ChannelsService {
rs := &ChannelsService{s: s}
return rs
}
type ChannelsService struct {
s *Service
}
func NewCustomerUsageReportsService(s *Service) *CustomerUsageReportsService {
rs := &CustomerUsageReportsService{s: s}
return rs
}
type CustomerUsageReportsService struct {
s *Service
}
func NewEntityUsageReportsService(s *Service) *EntityUsageReportsService {
rs := &EntityUsageReportsService{s: s}
return rs
}
type EntityUsageReportsService struct {
s *Service
}
func NewUserUsageReportService(s *Service) *UserUsageReportService {
rs := &UserUsageReportService{s: s}
return rs
}
type UserUsageReportService struct {
s *Service
}
// Activities: JSON template for a collection of activities.
type Activities struct {
// Etag: ETag of the resource.
Etag string `json:"etag,omitempty"`
// Items: Each activity record in the response.
Items []*Activity `json:"items,omitempty"`
// Kind: The type of API resource. For an activity report, the value is
// `reports#activities`.
Kind string `json:"kind,omitempty"`
// NextPageToken: Token for retrieving the follow-on next page of the
// report. The `nextPageToken` value is used in the request's
// `pageToken` query string.
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. "Etag") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Etag") 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 (s *Activities) MarshalJSON() ([]byte, error) {
type NoMethod Activities
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Activity: JSON template for the activity resource.
type Activity struct {
// Actor: User doing the action.
Actor *ActivityActor `json:"actor,omitempty"`
// Etag: ETag of the entry.
Etag string `json:"etag,omitempty"`
// Events: Activity events in the report.
Events []*ActivityEvents `json:"events,omitempty"`
// Id: Unique identifier for each activity record.
Id *ActivityId `json:"id,omitempty"`
// IpAddress: IP address of the user doing the action. This is the
// Internet Protocol (IP) address of the user when logging into Google
// Workspace, which may or may not reflect the user's physical location.
// For example, the IP address can be the user's proxy server's address
// or a virtual private network (VPN) address. The API supports IPv4 and
// IPv6.
IpAddress string `json:"ipAddress,omitempty"`
// Kind: The type of API resource. For an activity report, the value is
// `audit#activity`.
Kind string `json:"kind,omitempty"`
// OwnerDomain: This is the domain that is affected by the report's
// event. For example domain of Admin console or the Drive application's
// document owner.
OwnerDomain string `json:"ownerDomain,omitempty"`
// ForceSendFields is a list of field names (e.g. "Actor") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Actor") 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 (s *Activity) MarshalJSON() ([]byte, error) {
type NoMethod Activity
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ActivityActor: User doing the action.
type ActivityActor struct {
// CallerType: The type of actor.
CallerType string `json:"callerType,omitempty"`
// Email: The primary email address of the actor. May be absent if there
// is no email address associated with the actor.
Email string `json:"email,omitempty"`
// Key: Only present when `callerType` is `KEY`. Can be the
// `consumer_key` of the requestor for OAuth 2LO API requests or an
// identifier for robot accounts.
Key string `json:"key,omitempty"`
// ProfileId: The unique Google Workspace profile ID of the actor. This
// value might be absent if the actor is not a Google Workspace user, or
// may be the number 105250506097979753968 which acts as a placeholder
// ID.
ProfileId string `json:"profileId,omitempty"`
// ForceSendFields is a list of field names (e.g. "CallerType") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CallerType") 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 (s *ActivityActor) MarshalJSON() ([]byte, error) {
type NoMethod ActivityActor
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ActivityEvents struct {
// Name: Name of the event. This is the specific name of the activity
// reported by the API. And each `eventName` is related to a specific
// Google Workspace service or feature which the API organizes into
// types of events. For `eventName` request parameters in general: - If
// no `eventName` is given, the report returns all possible instances of
// an `eventName`. - When you request an `eventName`, the API's response
// returns all activities which contain that `eventName`. It is possible
// that the returned activities will have other `eventName` properties
// in addition to the one requested. For more information about
// `eventName` properties, see the list of event names for various
// applications above in `applicationName`.
Name string `json:"name,omitempty"`
// Parameters: Parameter value pairs for various applications. For more
// information about `eventName` parameters, see the list of event names
// for various applications above in `applicationName`.
Parameters []*ActivityEventsParameters `json:"parameters,omitempty"`
// Type: Type of event. The Google Workspace service or feature that an
// administrator changes is identified in the `type` property which
// identifies an event using the `eventName` property. For a full list
// of the API's `type` categories, see the list of event names for
// various applications above in `applicationName`.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Name") 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 (s *ActivityEvents) MarshalJSON() ([]byte, error) {
type NoMethod ActivityEvents
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ActivityEventsParameters struct {
// BoolValue: Boolean value of the parameter.
BoolValue bool `json:"boolValue,omitempty"`
// IntValue: Integer value of the parameter.
IntValue int64 `json:"intValue,omitempty,string"`
// MessageValue: Nested parameter value pairs associated with this
// parameter. Complex value type for a parameter are returned as a list
// of parameter values. For example, the address parameter may have a
// value as `[{parameter: [{name: city, value: abc}]}]`
MessageValue *ActivityEventsParametersMessageValue `json:"messageValue,omitempty"`
// MultiIntValue: Integer values of the parameter.
MultiIntValue googleapi.Int64s `json:"multiIntValue,omitempty"`
// MultiMessageValue: List of `messageValue` objects.
MultiMessageValue []*ActivityEventsParametersMultiMessageValue `json:"multiMessageValue,omitempty"`
// MultiValue: String values of the parameter.
MultiValue []string `json:"multiValue,omitempty"`
// Name: The name of the parameter.
Name string `json:"name,omitempty"`
// Value: String value of the parameter.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "BoolValue") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "BoolValue") 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 (s *ActivityEventsParameters) MarshalJSON() ([]byte, error) {
type NoMethod ActivityEventsParameters
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ActivityEventsParametersMessageValue: Nested parameter value pairs
// associated with this parameter. Complex value type for a parameter
// are returned as a list of parameter values. For example, the address
// parameter may have a value as `[{parameter: [{name: city, value:
// abc}]}]`
type ActivityEventsParametersMessageValue struct {
// Parameter: Parameter values
Parameter []*NestedParameter `json:"parameter,omitempty"`
// ForceSendFields is a list of field names (e.g. "Parameter") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Parameter") 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 (s *ActivityEventsParametersMessageValue) MarshalJSON() ([]byte, error) {
type NoMethod ActivityEventsParametersMessageValue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ActivityEventsParametersMultiMessageValue struct {
// Parameter: Parameter values
Parameter []*NestedParameter `json:"parameter,omitempty"`
// ForceSendFields is a list of field names (e.g. "Parameter") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Parameter") 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 (s *ActivityEventsParametersMultiMessageValue) MarshalJSON() ([]byte, error) {
type NoMethod ActivityEventsParametersMultiMessageValue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ActivityId: Unique identifier for each activity record.
type ActivityId struct {
// ApplicationName: Application name to which the event belongs. For
// possible values see the list of applications above in
// `applicationName`.
ApplicationName string `json:"applicationName,omitempty"`
// CustomerId: The unique identifier for a Google Workspace account.
CustomerId string `json:"customerId,omitempty"`
// Time: Time of occurrence of the activity. This is in UNIX epoch time
// in seconds.
Time string `json:"time,omitempty"`
// UniqueQualifier: Unique qualifier if multiple events have the same
// time.
UniqueQualifier int64 `json:"uniqueQualifier,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "ApplicationName") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "ApplicationName") 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 (s *ActivityId) MarshalJSON() ([]byte, error) {
type NoMethod ActivityId
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Channel: A notification channel used to watch for resource changes.
type Channel struct {
// Address: The address where notifications are delivered for this
// channel.
Address string `json:"address,omitempty"`
// Expiration: Date and time of notification channel expiration,
// expressed as a Unix timestamp, in milliseconds. Optional.
Expiration int64 `json:"expiration,omitempty,string"`
// Id: A UUID or similar unique string that identifies this channel.
Id string `json:"id,omitempty"`
// Kind: Identifies this as a notification channel used to watch for
// changes to a resource, which is "api#channel".
Kind string `json:"kind,omitempty"`
// Params: Additional parameters controlling delivery channel behavior.
// Optional.
Params map[string]string `json:"params,omitempty"`
// Payload: A Boolean value to indicate whether payload is wanted.
// Optional.
Payload bool `json:"payload,omitempty"`
// ResourceId: An opaque ID that identifies the resource being watched
// on this channel. Stable across different API versions.
ResourceId string `json:"resourceId,omitempty"`
// ResourceUri: A version-specific identifier for the watched resource.
ResourceUri string `json:"resourceUri,omitempty"`
// Token: An arbitrary string delivered to the target address with each
// notification delivered over this channel. Optional.
Token string `json:"token,omitempty"`
// Type: The type of delivery mechanism used for this channel. The value
// should be set to "web_hook".
Type string `json:"type,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Address") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Address") 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 (s *Channel) MarshalJSON() ([]byte, error) {
type NoMethod Channel
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// NestedParameter: JSON template for a parameter used in various
// reports.
type NestedParameter struct {
// BoolValue: Boolean value of the parameter.
BoolValue bool `json:"boolValue,omitempty"`
// IntValue: Integer value of the parameter.
IntValue int64 `json:"intValue,omitempty,string"`
// MultiBoolValue: Multiple boolean values of the parameter.
MultiBoolValue []bool `json:"multiBoolValue,omitempty"`
// MultiIntValue: Multiple integer values of the parameter.
MultiIntValue googleapi.Int64s `json:"multiIntValue,omitempty"`
// MultiValue: Multiple string values of the parameter.
MultiValue []string `json:"multiValue,omitempty"`
// Name: The name of the parameter.
Name string `json:"name,omitempty"`
// Value: String value of the parameter.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "BoolValue") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "BoolValue") 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 (s *NestedParameter) MarshalJSON() ([]byte, error) {
type NoMethod NestedParameter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// UsageReport: JSON template for a usage report.
type UsageReport struct {
// Date: Output only. The date of the report request.
Date string `json:"date,omitempty"`
// Entity: Output only. Information about the type of the item.
Entity *UsageReportEntity `json:"entity,omitempty"`
// Etag: ETag of the resource.
Etag string `json:"etag,omitempty"`
// Kind: The type of API resource. For a usage report, the value is
// `admin#reports#usageReport`.
Kind string `json:"kind,omitempty"`
// Parameters: Output only. Parameter value pairs for various
// applications. For the Entity Usage Report parameters and values, see
// the Entity Usage parameters reference
// (/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
Parameters []*UsageReportParameters `json:"parameters,omitempty"`
// ForceSendFields is a list of field names (e.g. "Date") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Date") 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 (s *UsageReport) MarshalJSON() ([]byte, error) {
type NoMethod UsageReport
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// UsageReportEntity: Output only. Information about the type of the
// item.
type UsageReportEntity struct {
// CustomerId: Output only. The unique identifier of the customer's
// account.
CustomerId string `json:"customerId,omitempty"`
// EntityId: Output only. Object key. Only relevant if entity.type =
// "OBJECT" Note: external-facing name of report is "Entities" rather
// than "Objects".
EntityId string `json:"entityId,omitempty"`
// ProfileId: Output only. The user's immutable Google Workspace profile
// identifier.
ProfileId string `json:"profileId,omitempty"`
// Type: Output only. The type of item. The value is `user`.
Type string `json:"type,omitempty"`
// UserEmail: Output only. The user's email address. Only relevant if
// entity.type = "USER"
UserEmail string `json:"userEmail,omitempty"`
// ForceSendFields is a list of field names (e.g. "CustomerId") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CustomerId") 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 (s *UsageReportEntity) MarshalJSON() ([]byte, error) {
type NoMethod UsageReportEntity
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type UsageReportParameters struct {
// BoolValue: Output only. Boolean value of the parameter.
BoolValue bool `json:"boolValue,omitempty"`
// DatetimeValue: The RFC 3339 formatted value of the parameter, for
// example 2010-10-28T10:26:35.000Z.
DatetimeValue string `json:"datetimeValue,omitempty"`
// IntValue: Output only. Integer value of the parameter.
IntValue int64 `json:"intValue,omitempty,string"`
// MsgValue: Output only. Nested message value of the parameter.
MsgValue []googleapi.RawMessage `json:"msgValue,omitempty"`
// Name: The name of the parameter. For the User Usage Report parameter
// names, see the User Usage parameters reference.
Name string `json:"name,omitempty"`
// StringValue: Output only. String value of the parameter.
StringValue string `json:"stringValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "BoolValue") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "BoolValue") 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 (s *UsageReportParameters) MarshalJSON() ([]byte, error) {
type NoMethod UsageReportParameters
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type UsageReports struct {
// Etag: ETag of the resource.
Etag string `json:"etag,omitempty"`
// Kind: The type of API resource. For a usage report, the value is
// `admin#reports#usageReports`.
Kind string `json:"kind,omitempty"`
// NextPageToken: Token to specify next page. A report with multiple
// pages has a `nextPageToken` property in the response. For your
// follow-on requests getting all of the report's pages, enter the
// `nextPageToken` value in the `pageToken` query string.
NextPageToken string `json:"nextPageToken,omitempty"`
// UsageReports: Various application parameter records.
UsageReports []*UsageReport `json:"usageReports,omitempty"`
// Warnings: Warnings, if any.
Warnings []*UsageReportsWarnings `json:"warnings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Etag") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Etag") 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 (s *UsageReports) MarshalJSON() ([]byte, error) {
type NoMethod UsageReports
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type UsageReportsWarnings struct {
// Code: Machine readable code or warning type. The warning code value
// is `200`.
Code string `json:"code,omitempty"`
// Data: Key-value pairs to give detailed information on the warning.
Data []*UsageReportsWarningsData `json:"data,omitempty"`
// Message: The human readable messages for a warning are: - Data is not
// available warning - Sorry, data for date yyyy-mm-dd for application
// "application name" is not available. - Partial data is available
// warning - Data for date yyyy-mm-dd for application "application
// name" is not available right now, please try again after a few
// hours.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Code") 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 (s *UsageReportsWarnings) MarshalJSON() ([]byte, error) {
type NoMethod UsageReportsWarnings
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type UsageReportsWarningsData struct {
// Key: Key associated with a key-value pair to give detailed
// information on the warning.
Key string `json:"key,omitempty"`
// Value: Value associated with a key-value pair to give detailed
// information on the warning.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Key") 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 (s *UsageReportsWarningsData) MarshalJSON() ([]byte, error) {
type NoMethod UsageReportsWarningsData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// method id "reports.activities.list":
type ActivitiesListCall struct {
s *Service
userKey string
applicationName string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// List: Retrieves a list of activities for a specific customer's
// account and application such as the Admin console application or the
// Google Drive application. For more information, see the guides for
// administrator and Google Drive activity reports. For more information
// about the activity report's parameters, see the activity parameters
// reference guides.
//
// - applicationName: Application name for which the events are to be
// retrieved.
// - userKey: Represents the profile ID or the user email for which the
// data should be filtered. Can be `all` for all information, or
// `userKey` for a user's unique Google Workspace profile ID or their
// primary email address. Must not be a deleted user. For a deleted
// user, call `users.list` in Directory API with `showDeleted=true`,
// then use the returned `ID` as the `userKey`.
func (r *ActivitiesService) List(userKey string, applicationName string) *ActivitiesListCall {
c := &ActivitiesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.userKey = userKey
c.applicationName = applicationName
return c
}
// ActorIpAddress sets the optional parameter "actorIpAddress": The
// Internet Protocol (IP) Address of host where the event was performed.
// This is an additional way to filter a report's summary using the IP
// address of the user whose activity is being reported. This IP address
// may or may not reflect the user's physical location. For example, the
// IP address can be the user's proxy server's address or a virtual
// private network (VPN) address. This parameter supports both IPv4 and
// IPv6 address versions.
func (c *ActivitiesListCall) ActorIpAddress(actorIpAddress string) *ActivitiesListCall {
c.urlParams_.Set("actorIpAddress", actorIpAddress)
return c
}
// CustomerId sets the optional parameter "customerId": The unique ID of
// the customer to retrieve data for.
func (c *ActivitiesListCall) CustomerId(customerId string) *ActivitiesListCall {
c.urlParams_.Set("customerId", customerId)
return c
}
// EndTime sets the optional parameter "endTime": Sets the end of the
// range of time shown in the report. The date is in the RFC 3339
// format, for example 2010-10-28T10:26:35.000Z. The default value is
// the approximate time of the API request. An API report has three
// basic time concepts: - *Date of the API's request for a report*: When
// the API created and retrieved the report. - *Report's start time*:
// The beginning of the timespan shown in the report. The `startTime`
// must be before the `endTime` (if specified) and the current time when
// the request is made, or the API returns an error. - *Report's end
// time*: The end of the timespan shown in the report. For example, the
// timespan of events summarized in a report can start in April and end
// in May. The report itself can be requested in August. If the
// `endTime` is not specified, the report returns all activities from
// the `startTime` until the current time or the most recent 180 days if
// the `startTime` is more than 180 days in the past.
func (c *ActivitiesListCall) EndTime(endTime string) *ActivitiesListCall {
c.urlParams_.Set("endTime", endTime)
return c
}
// EventName sets the optional parameter "eventName": The name of the
// event being queried by the API. Each `eventName` is related to a
// specific Google Workspace service or feature which the API organizes
// into types of events. An example is the Google Calendar events in the
// Admin console application's reports. The Calendar Settings `type`
// structure has all of the Calendar `eventName` activities reported by
// the API. When an administrator changes a Calendar setting, the API
// reports this activity in the Calendar Settings `type` and `eventName`
// parameters. For more information about `eventName` query strings and
// parameters, see the list of event names for various applications
// above in `applicationName`.
func (c *ActivitiesListCall) EventName(eventName string) *ActivitiesListCall {
c.urlParams_.Set("eventName", eventName)
return c
}