/
analyticsadmin-gen.go
9491 lines (8702 loc) · 353 KB
/
analyticsadmin-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 2023 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 analyticsadmin provides access to the Google Analytics Admin API.
//
// For product documentation, see: http://code.google.com/apis/analytics/docs/mgmt/home.html
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/analyticsadmin/v1beta"
// ...
// ctx := context.Background()
// analyticsadminService, err := analyticsadmin.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:
//
// analyticsadminService, err := analyticsadmin.NewService(ctx, option.WithScopes(analyticsadmin.AnalyticsReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// analyticsadminService, err := analyticsadmin.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, ...)
// analyticsadminService, err := analyticsadmin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package analyticsadmin // import "google.golang.org/api/analyticsadmin/v1beta"
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 = "analyticsadmin:v1beta"
const apiName = "analyticsadmin"
const apiVersion = "v1beta"
const basePath = "https://analyticsadmin.googleapis.com/"
const mtlsBasePath = "https://analyticsadmin.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// Edit Google Analytics management entities
AnalyticsEditScope = "https://www.googleapis.com/auth/analytics.edit"
// See and download your Google Analytics data
AnalyticsReadonlyScope = "https://www.googleapis.com/auth/analytics.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.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.AccountSummaries = NewAccountSummariesService(s)
s.Accounts = NewAccountsService(s)
s.Properties = NewPropertiesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
AccountSummaries *AccountSummariesService
Accounts *AccountsService
Properties *PropertiesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewAccountSummariesService(s *Service) *AccountSummariesService {
rs := &AccountSummariesService{s: s}
return rs
}
type AccountSummariesService struct {
s *Service
}
func NewAccountsService(s *Service) *AccountsService {
rs := &AccountsService{s: s}
return rs
}
type AccountsService struct {
s *Service
}
func NewPropertiesService(s *Service) *PropertiesService {
rs := &PropertiesService{s: s}
rs.ConversionEvents = NewPropertiesConversionEventsService(s)
rs.CustomDimensions = NewPropertiesCustomDimensionsService(s)
rs.CustomMetrics = NewPropertiesCustomMetricsService(s)
rs.DataStreams = NewPropertiesDataStreamsService(s)
rs.FirebaseLinks = NewPropertiesFirebaseLinksService(s)
rs.GoogleAdsLinks = NewPropertiesGoogleAdsLinksService(s)
return rs
}
type PropertiesService struct {
s *Service
ConversionEvents *PropertiesConversionEventsService
CustomDimensions *PropertiesCustomDimensionsService
CustomMetrics *PropertiesCustomMetricsService
DataStreams *PropertiesDataStreamsService
FirebaseLinks *PropertiesFirebaseLinksService
GoogleAdsLinks *PropertiesGoogleAdsLinksService
}
func NewPropertiesConversionEventsService(s *Service) *PropertiesConversionEventsService {
rs := &PropertiesConversionEventsService{s: s}
return rs
}
type PropertiesConversionEventsService struct {
s *Service
}
func NewPropertiesCustomDimensionsService(s *Service) *PropertiesCustomDimensionsService {
rs := &PropertiesCustomDimensionsService{s: s}
return rs
}
type PropertiesCustomDimensionsService struct {
s *Service
}
func NewPropertiesCustomMetricsService(s *Service) *PropertiesCustomMetricsService {
rs := &PropertiesCustomMetricsService{s: s}
return rs
}
type PropertiesCustomMetricsService struct {
s *Service
}
func NewPropertiesDataStreamsService(s *Service) *PropertiesDataStreamsService {
rs := &PropertiesDataStreamsService{s: s}
rs.MeasurementProtocolSecrets = NewPropertiesDataStreamsMeasurementProtocolSecretsService(s)
return rs
}
type PropertiesDataStreamsService struct {
s *Service
MeasurementProtocolSecrets *PropertiesDataStreamsMeasurementProtocolSecretsService
}
func NewPropertiesDataStreamsMeasurementProtocolSecretsService(s *Service) *PropertiesDataStreamsMeasurementProtocolSecretsService {
rs := &PropertiesDataStreamsMeasurementProtocolSecretsService{s: s}
return rs
}
type PropertiesDataStreamsMeasurementProtocolSecretsService struct {
s *Service
}
func NewPropertiesFirebaseLinksService(s *Service) *PropertiesFirebaseLinksService {
rs := &PropertiesFirebaseLinksService{s: s}
return rs
}
type PropertiesFirebaseLinksService struct {
s *Service
}
func NewPropertiesGoogleAdsLinksService(s *Service) *PropertiesGoogleAdsLinksService {
rs := &PropertiesGoogleAdsLinksService{s: s}
return rs
}
type PropertiesGoogleAdsLinksService struct {
s *Service
}
// GoogleAnalyticsAdminV1betaAccount: A resource message representing a
// Google Analytics account.
type GoogleAnalyticsAdminV1betaAccount struct {
// CreateTime: Output only. Time when this account was originally
// created.
CreateTime string `json:"createTime,omitempty"`
// Deleted: Output only. Indicates whether this Account is soft-deleted
// or not. Deleted accounts are excluded from List results unless
// specifically requested.
Deleted bool `json:"deleted,omitempty"`
// DisplayName: Required. Human-readable display name for this account.
DisplayName string `json:"displayName,omitempty"`
// Name: Output only. Resource name of this account. Format:
// accounts/{account} Example: "accounts/100"
Name string `json:"name,omitempty"`
// RegionCode: Country of business. Must be a Unicode CLDR region code.
RegionCode string `json:"regionCode,omitempty"`
// UpdateTime: Output only. Time when account payload fields were last
// updated.
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. "CreateTime") 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. "CreateTime") 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 *GoogleAnalyticsAdminV1betaAccount) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaAccount
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaAccountSummary: A virtual resource
// representing an overview of an account and all its child GA4
// properties.
type GoogleAnalyticsAdminV1betaAccountSummary struct {
// Account: Resource name of account referred to by this account summary
// Format: accounts/{account_id} Example: "accounts/1000"
Account string `json:"account,omitempty"`
// DisplayName: Display name for the account referred to in this account
// summary.
DisplayName string `json:"displayName,omitempty"`
// Name: Resource name for this account summary. Format:
// accountSummaries/{account_id} Example: "accountSummaries/1000"
Name string `json:"name,omitempty"`
// PropertySummaries: List of summaries for child accounts of this
// account.
PropertySummaries []*GoogleAnalyticsAdminV1betaPropertySummary `json:"propertySummaries,omitempty"`
// ForceSendFields is a list of field names (e.g. "Account") 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. "Account") 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 *GoogleAnalyticsAdminV1betaAccountSummary) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaAccountSummary
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest:
// Request message for AcknowledgeUserDataCollection RPC.
type GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest struct {
// Acknowledgement: Required. An acknowledgement that the caller of this
// method understands the terms of user data collection. This field must
// contain the exact value: "I acknowledge that I have the necessary
// privacy disclosures and rights from my end users for the collection
// and processing of their data, including the association of such data
// with the visitation information Google Analytics collects from my
// site and/or app property."
Acknowledgement string `json:"acknowledgement,omitempty"`
// ForceSendFields is a list of field names (e.g. "Acknowledgement") 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. "Acknowledgement") 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 *GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse:
// Response message for AcknowledgeUserDataCollection RPC.
type GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest: Request
// message for ArchiveCustomDimension RPC.
type GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest struct {
}
// GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest: Request message
// for ArchiveCustomMetric RPC.
type GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest struct {
}
// GoogleAnalyticsAdminV1betaChangeHistoryChange: A description of a
// change to a single Google Analytics resource.
type GoogleAnalyticsAdminV1betaChangeHistoryChange struct {
// Action: The type of action that changed this resource.
//
// Possible values:
// "ACTION_TYPE_UNSPECIFIED" - Action type unknown or not specified.
// "CREATED" - Resource was created in this change.
// "UPDATED" - Resource was updated in this change.
// "DELETED" - Resource was deleted in this change.
Action string `json:"action,omitempty"`
// Resource: Resource name of the resource whose changes are described
// by this entry.
Resource string `json:"resource,omitempty"`
// ResourceAfterChange: Resource contents from after the change was
// made. If this resource was deleted in this change, this field will be
// missing.
ResourceAfterChange *GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource `json:"resourceAfterChange,omitempty"`
// ResourceBeforeChange: Resource contents from before the change was
// made. If this resource was created in this change, this field will be
// missing.
ResourceBeforeChange *GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource `json:"resourceBeforeChange,omitempty"`
// ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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 *GoogleAnalyticsAdminV1betaChangeHistoryChange) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaChangeHistoryChange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource: A
// snapshot of a resource as before or after the result of a change in
// change history.
type GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource struct {
// Account: A snapshot of an Account resource in change history.
Account *GoogleAnalyticsAdminV1betaAccount `json:"account,omitempty"`
// ConversionEvent: A snapshot of a ConversionEvent resource in change
// history.
ConversionEvent *GoogleAnalyticsAdminV1betaConversionEvent `json:"conversionEvent,omitempty"`
// DataRetentionSettings: A snapshot of a data retention settings
// resource in change history.
DataRetentionSettings *GoogleAnalyticsAdminV1betaDataRetentionSettings `json:"dataRetentionSettings,omitempty"`
// DataStream: A snapshot of a DataStream resource in change history.
DataStream *GoogleAnalyticsAdminV1betaDataStream `json:"dataStream,omitempty"`
// FirebaseLink: A snapshot of a FirebaseLink resource in change
// history.
FirebaseLink *GoogleAnalyticsAdminV1betaFirebaseLink `json:"firebaseLink,omitempty"`
// GoogleAdsLink: A snapshot of a GoogleAdsLink resource in change
// history.
GoogleAdsLink *GoogleAnalyticsAdminV1betaGoogleAdsLink `json:"googleAdsLink,omitempty"`
// MeasurementProtocolSecret: A snapshot of a MeasurementProtocolSecret
// resource in change history.
MeasurementProtocolSecret *GoogleAnalyticsAdminV1betaMeasurementProtocolSecret `json:"measurementProtocolSecret,omitempty"`
// Property: A snapshot of a Property resource in change history.
Property *GoogleAnalyticsAdminV1betaProperty `json:"property,omitempty"`
// ForceSendFields is a list of field names (e.g. "Account") 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. "Account") 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 *GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaChangeHistoryEvent: A set of changes within
// a Google Analytics account or its child properties that resulted from
// the same cause. Common causes would be updates made in the Google
// Analytics UI, changes from customer support, or automatic Google
// Analytics system changes.
type GoogleAnalyticsAdminV1betaChangeHistoryEvent struct {
// ActorType: The type of actor that made this change.
//
// Possible values:
// "ACTOR_TYPE_UNSPECIFIED" - Unknown or unspecified actor type.
// "USER" - Changes made by the user specified in actor_email.
// "SYSTEM" - Changes made by the Google Analytics system.
// "SUPPORT" - Changes made by Google Analytics support team staff.
ActorType string `json:"actorType,omitempty"`
// ChangeTime: Time when change was made.
ChangeTime string `json:"changeTime,omitempty"`
// Changes: A list of changes made in this change history event that fit
// the filters specified in SearchChangeHistoryEventsRequest.
Changes []*GoogleAnalyticsAdminV1betaChangeHistoryChange `json:"changes,omitempty"`
// ChangesFiltered: If true, then the list of changes returned was
// filtered, and does not represent all changes that occurred in this
// event.
ChangesFiltered bool `json:"changesFiltered,omitempty"`
// Id: ID of this change history event. This ID is unique across Google
// Analytics.
Id string `json:"id,omitempty"`
// UserActorEmail: Email address of the Google account that made the
// change. This will be a valid email address if the actor field is set
// to USER, and empty otherwise. Google accounts that have been deleted
// will cause an error.
UserActorEmail string `json:"userActorEmail,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActorType") 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. "ActorType") 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 *GoogleAnalyticsAdminV1betaChangeHistoryEvent) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaChangeHistoryEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaConversionEvent: A conversion event in a
// Google Analytics property.
type GoogleAnalyticsAdminV1betaConversionEvent struct {
// CreateTime: Output only. Time when this conversion event was created
// in the property.
CreateTime string `json:"createTime,omitempty"`
// Custom: Output only. If set to true, this conversion event refers to
// a custom event. If set to false, this conversion event refers to a
// default event in GA. Default events typically have special meaning in
// GA. Default events are usually created for you by the GA system, but
// in some cases can be created by property admins. Custom events count
// towards the maximum number of custom conversion events that may be
// created per property.
Custom bool `json:"custom,omitempty"`
// Deletable: Output only. If set, this event can currently be deleted
// via DeleteConversionEvent.
Deletable bool `json:"deletable,omitempty"`
// EventName: Immutable. The event name for this conversion event.
// Examples: 'click', 'purchase'
EventName string `json:"eventName,omitempty"`
// Name: Output only. Resource name of this conversion event. Format:
// properties/{property}/conversionEvents/{conversion_event}
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *GoogleAnalyticsAdminV1betaConversionEvent) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaConversionEvent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaCustomDimension: A definition for a
// CustomDimension.
type GoogleAnalyticsAdminV1betaCustomDimension struct {
// Description: Optional. Description for this custom dimension. Max
// length of 150 characters.
Description string `json:"description,omitempty"`
// DisallowAdsPersonalization: Optional. If set to true, sets this
// dimension as NPA and excludes it from ads personalization. This is
// currently only supported by user-scoped custom dimensions.
DisallowAdsPersonalization bool `json:"disallowAdsPersonalization,omitempty"`
// DisplayName: Required. Display name for this custom dimension as
// shown in the Analytics UI. Max length of 82 characters, alphanumeric
// plus space and underscore starting with a letter. Legacy
// system-generated display names may contain square brackets, but
// updates to this field will never permit square brackets.
DisplayName string `json:"displayName,omitempty"`
// Name: Output only. Resource name for this CustomDimension resource.
// Format: properties/{property}/customDimensions/{customDimension}
Name string `json:"name,omitempty"`
// ParameterName: Required. Immutable. Tagging parameter name for this
// custom dimension. If this is a user-scoped dimension, then this is
// the user property name. If this is an event-scoped dimension, then
// this is the event parameter name. May only contain alphanumeric and
// underscore characters, starting with a letter. Max length of 24
// characters for user-scoped dimensions, 40 characters for event-scoped
// dimensions.
ParameterName string `json:"parameterName,omitempty"`
// Scope: Required. Immutable. The scope of this dimension.
//
// Possible values:
// "DIMENSION_SCOPE_UNSPECIFIED" - Scope unknown or not specified.
// "EVENT" - Dimension scoped to an event.
// "USER" - Dimension scoped to a user.
Scope string `json:"scope,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. 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. "Description") 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 *GoogleAnalyticsAdminV1betaCustomDimension) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaCustomDimension
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaCustomMetric: A definition for a custom
// metric.
type GoogleAnalyticsAdminV1betaCustomMetric struct {
// Description: Optional. Description for this custom dimension. Max
// length of 150 characters.
Description string `json:"description,omitempty"`
// DisplayName: Required. Display name for this custom metric as shown
// in the Analytics UI. Max length of 82 characters, alphanumeric plus
// space and underscore starting with a letter. Legacy system-generated
// display names may contain square brackets, but updates to this field
// will never permit square brackets.
DisplayName string `json:"displayName,omitempty"`
// MeasurementUnit: Required. The type for the custom metric's value.
//
// Possible values:
// "MEASUREMENT_UNIT_UNSPECIFIED" - MeasurementUnit unspecified or
// missing.
// "STANDARD" - This metric uses default units.
// "CURRENCY" - This metric measures a currency.
// "FEET" - This metric measures feet.
// "METERS" - This metric measures meters.
// "KILOMETERS" - This metric measures kilometers.
// "MILES" - This metric measures miles.
// "MILLISECONDS" - This metric measures milliseconds.
// "SECONDS" - This metric measures seconds.
// "MINUTES" - This metric measures minutes.
// "HOURS" - This metric measures hours.
MeasurementUnit string `json:"measurementUnit,omitempty"`
// Name: Output only. Resource name for this CustomMetric resource.
// Format: properties/{property}/customMetrics/{customMetric}
Name string `json:"name,omitempty"`
// ParameterName: Required. Immutable. Tagging name for this custom
// metric. If this is an event-scoped metric, then this is the event
// parameter name. May only contain alphanumeric and underscore
// charactes, starting with a letter. Max length of 40 characters for
// event-scoped metrics.
ParameterName string `json:"parameterName,omitempty"`
// RestrictedMetricType: Optional. Types of restricted data that this
// metric may contain. Required for metrics with CURRENCY measurement
// unit. Must be empty for metrics with a non-CURRENCY measurement unit.
//
// Possible values:
// "RESTRICTED_METRIC_TYPE_UNSPECIFIED" - Type unknown or unspecified.
// "COST_DATA" - Metric reports cost data.
// "REVENUE_DATA" - Metric reports revenue data.
RestrictedMetricType []string `json:"restrictedMetricType,omitempty"`
// Scope: Required. Immutable. The scope of this custom metric.
//
// Possible values:
// "METRIC_SCOPE_UNSPECIFIED" - Scope unknown or not specified.
// "EVENT" - Metric scoped to an event.
Scope string `json:"scope,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. 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. "Description") 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 *GoogleAnalyticsAdminV1betaCustomMetric) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaCustomMetric
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaDataRetentionSettings: Settings values for
// data retention. This is a singleton resource.
type GoogleAnalyticsAdminV1betaDataRetentionSettings struct {
// EventDataRetention: The length of time that event-level data is
// retained.
//
// Possible values:
// "RETENTION_DURATION_UNSPECIFIED" - Data retention time duration is
// not specified.
// "TWO_MONTHS" - The data retention time duration is 2 months.
// "FOURTEEN_MONTHS" - The data retention time duration is 14 months.
// "TWENTY_SIX_MONTHS" - The data retention time duration is 26
// months. Available to 360 properties only.
// "THIRTY_EIGHT_MONTHS" - The data retention time duration is 38
// months. Available to 360 properties only.
// "FIFTY_MONTHS" - The data retention time duration is 50 months.
// Available to 360 properties only.
EventDataRetention string `json:"eventDataRetention,omitempty"`
// Name: Output only. Resource name for this DataRetentionSetting
// resource. Format: properties/{property}/dataRetentionSettings
Name string `json:"name,omitempty"`
// ResetUserDataOnNewActivity: If true, reset the retention period for
// the user identifier with every event from that user.
ResetUserDataOnNewActivity bool `json:"resetUserDataOnNewActivity,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "EventDataRetention")
// 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. "EventDataRetention") 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 *GoogleAnalyticsAdminV1betaDataRetentionSettings) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaDataRetentionSettings
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaDataSharingSettings: A resource message
// representing data sharing settings of a Google Analytics account.
type GoogleAnalyticsAdminV1betaDataSharingSettings struct {
// Name: Output only. Resource name. Format:
// accounts/{account}/dataSharingSettings Example:
// "accounts/1000/dataSharingSettings"
Name string `json:"name,omitempty"`
// SharingWithGoogleAnySalesEnabled: Allows any of Google sales to
// access the data in order to suggest configuration changes to improve
// results.
SharingWithGoogleAnySalesEnabled bool `json:"sharingWithGoogleAnySalesEnabled,omitempty"`
// SharingWithGoogleAssignedSalesEnabled: Allows Google sales teams that
// are assigned to the customer to access the data in order to suggest
// configuration changes to improve results. Sales team restrictions
// still apply when enabled.
SharingWithGoogleAssignedSalesEnabled bool `json:"sharingWithGoogleAssignedSalesEnabled,omitempty"`
// SharingWithGoogleProductsEnabled: Allows Google to use the data to
// improve other Google products or services.
SharingWithGoogleProductsEnabled bool `json:"sharingWithGoogleProductsEnabled,omitempty"`
// SharingWithGoogleSupportEnabled: Allows Google support to access the
// data in order to help troubleshoot issues.
SharingWithGoogleSupportEnabled bool `json:"sharingWithGoogleSupportEnabled,omitempty"`
// SharingWithOthersEnabled: Allows Google to share the data anonymously
// in aggregate form with others.
SharingWithOthersEnabled bool `json:"sharingWithOthersEnabled,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// 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 *GoogleAnalyticsAdminV1betaDataSharingSettings) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaDataSharingSettings
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaDataStream: A resource message representing
// a data stream.
type GoogleAnalyticsAdminV1betaDataStream struct {
// AndroidAppStreamData: Data specific to Android app streams. Must be
// populated if type is ANDROID_APP_DATA_STREAM.
AndroidAppStreamData *GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData `json:"androidAppStreamData,omitempty"`
// CreateTime: Output only. Time when this stream was originally
// created.
CreateTime string `json:"createTime,omitempty"`
// DisplayName: Human-readable display name for the Data Stream.
// Required for web data streams. The max allowed display name length is
// 255 UTF-16 code units.
DisplayName string `json:"displayName,omitempty"`
// IosAppStreamData: Data specific to iOS app streams. Must be populated
// if type is IOS_APP_DATA_STREAM.
IosAppStreamData *GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData `json:"iosAppStreamData,omitempty"`
// Name: Output only. Resource name of this Data Stream. Format:
// properties/{property_id}/dataStreams/{stream_id} Example:
// "properties/1000/dataStreams/2000"
Name string `json:"name,omitempty"`
// Type: Required. Immutable. The type of this DataStream resource.
//
// Possible values:
// "DATA_STREAM_TYPE_UNSPECIFIED" - Type unknown or not specified.
// "WEB_DATA_STREAM" - Web data stream.
// "ANDROID_APP_DATA_STREAM" - Android app data stream.
// "IOS_APP_DATA_STREAM" - iOS app data stream.
Type string `json:"type,omitempty"`
// UpdateTime: Output only. Time when stream payload fields were last
// updated.
UpdateTime string `json:"updateTime,omitempty"`
// WebStreamData: Data specific to web streams. Must be populated if
// type is WEB_DATA_STREAM.
WebStreamData *GoogleAnalyticsAdminV1betaDataStreamWebStreamData `json:"webStreamData,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "AndroidAppStreamData") 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. "AndroidAppStreamData") 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 *GoogleAnalyticsAdminV1betaDataStream) MarshalJSON() ([]byte, error) {
type NoMethod GoogleAnalyticsAdminV1betaDataStream
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData: Data
// specific to Android app streams.
type GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData struct {
// FirebaseAppId: Output only. ID of the corresponding Android app in
// Firebase, if any. This ID can change if the Android app is deleted
// and recreated.
FirebaseAppId string `json:"firebaseAppId,omitempty"`
// PackageName: Immutable. The package name for the app being measured.
// Example: "com.example.myandroidapp"
PackageName string `json:"packageName,omitempty"`
// ForceSendFields is a list of field names (e.g. "FirebaseAppId") 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. "FirebaseAppId") 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 *GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData) MarshalJSON() ([]byte, error) {