/
analytics_admin.proto
1415 lines (1249 loc) · 51.5 KB
/
analytics_admin.proto
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 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.analytics.admin.v1alpha;
import "google/analytics/admin/v1alpha/resources.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin";
option java_multiple_files = true;
option java_outer_classname = "AnalyticsAdminProto";
option java_package = "com.google.analytics.admin.v1alpha";
// Service Interface for the Analytics Admin API (GA4).
service AnalyticsAdminService {
option (google.api.default_host) = "analyticsadmin.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/analytics.edit,"
"https://www.googleapis.com/auth/analytics.manage.users,"
"https://www.googleapis.com/auth/analytics.manage.users.readonly,"
"https://www.googleapis.com/auth/analytics.readonly";
// Lookup for a single Account.
rpc GetAccount(GetAccountRequest) returns (Account) {
option (google.api.http) = {
get: "/v1alpha/{name=accounts/*}"
};
option (google.api.method_signature) = "name";
}
// Returns all accounts accessible by the caller.
//
// Note that these accounts might not currently have GA4 properties.
// Soft-deleted (ie: "trashed") accounts are excluded by default.
// Returns an empty list if no relevant accounts are found.
rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) {
option (google.api.http) = {
get: "/v1alpha/accounts"
};
}
// Marks target Account as soft-deleted (ie: "trashed") and returns it.
//
// This API does not have a method to restore soft-deleted accounts.
// However, they can be restored using the Trash Can UI.
//
// If the accounts are not restored before the expiration time, the account
// and all child resources (eg: Properties, GoogleAdsLinks, Streams,
// UserLinks) will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
// Returns an error if the target is not found.
rpc DeleteAccount(DeleteAccountRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=accounts/*}"
};
option (google.api.method_signature) = "name";
}
// Updates an account.
rpc UpdateAccount(UpdateAccountRequest) returns (Account) {
option (google.api.http) = {
patch: "/v1alpha/{account.name=accounts/*}"
body: "account"
};
option (google.api.method_signature) = "account,update_mask";
}
// Requests a ticket for creating an account.
rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse) {
option (google.api.http) = {
post: "/v1alpha/accounts:provisionAccountTicket"
body: "*"
};
}
// Returns summaries of all accounts accessible by the caller.
rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse) {
option (google.api.http) = {
get: "/v1alpha/accountSummaries"
};
}
// Lookup for a single "GA4" Property.
rpc GetProperty(GetPropertyRequest) returns (Property) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*}"
};
option (google.api.method_signature) = "name";
}
// Returns child Properties under the specified parent Account.
//
// Only "GA4" properties will be returned.
// Properties will be excluded if the caller does not have access.
// Soft-deleted (ie: "trashed") properties are excluded by default.
// Returns an empty list if no relevant properties are found.
rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse) {
option (google.api.http) = {
get: "/v1alpha/properties"
};
}
// Creates an "GA4" property with the specified location and attributes.
rpc CreateProperty(CreatePropertyRequest) returns (Property) {
option (google.api.http) = {
post: "/v1alpha/properties"
body: "property"
};
option (google.api.method_signature) = "property";
}
// Marks target Property as soft-deleted (ie: "trashed") and returns it.
//
// This API does not have a method to restore soft-deleted properties.
// However, they can be restored using the Trash Can UI.
//
// If the properties are not restored before the expiration time, the Property
// and all child resources (eg: GoogleAdsLinks, Streams, UserLinks)
// will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
// Returns an error if the target is not found, or is not an GA4 Property.
rpc DeleteProperty(DeletePropertyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*}"
};
option (google.api.method_signature) = "name";
}
// Updates a property.
rpc UpdateProperty(UpdatePropertyRequest) returns (Property) {
option (google.api.http) = {
patch: "/v1alpha/{property.name=properties/*}"
body: "property"
};
option (google.api.method_signature) = "property,update_mask";
}
// Gets information about a user's link to an account or property.
rpc GetUserLink(GetUserLinkRequest) returns (UserLink) {
option (google.api.http) = {
get: "/v1alpha/{name=accounts/*/userLinks/*}"
additional_bindings {
get: "/v1alpha/{name=properties/*/userLinks/*}"
}
};
option (google.api.method_signature) = "name";
}
// Gets information about multiple users' links to an account or property.
rpc BatchGetUserLinks(BatchGetUserLinksRequest) returns (BatchGetUserLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=accounts/*}/userLinks:batchGet"
additional_bindings {
get: "/v1alpha/{parent=properties/*}/userLinks:batchGet"
}
};
}
// Lists all user links on an account or property.
rpc ListUserLinks(ListUserLinksRequest) returns (ListUserLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=accounts/*}/userLinks"
additional_bindings {
get: "/v1alpha/{parent=properties/*}/userLinks"
}
};
option (google.api.method_signature) = "parent";
}
// Lists all user links on an account or property, including implicit ones
// that come from effective permissions granted by groups or organization
// admin roles.
//
// If a returned user link does not have direct permissions, they cannot
// be removed from the account or property directly with the DeleteUserLink
// command. They have to be removed from the group/etc that gives them
// permissions, which is currently only usable/discoverable in the GA or GMP
// UIs.
rpc AuditUserLinks(AuditUserLinksRequest) returns (AuditUserLinksResponse) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:audit"
body: "*"
additional_bindings {
post: "/v1alpha/{parent=properties/*}/userLinks:audit"
body: "*"
}
};
}
// Creates a user link on an account or property.
//
// If the user with the specified email already has permissions on the
// account or property, then the user's existing permissions will be unioned
// with the permissions specified in the new UserLink.
rpc CreateUserLink(CreateUserLinkRequest) returns (UserLink) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks"
body: "user_link"
additional_bindings {
post: "/v1alpha/{parent=properties/*}/userLinks"
body: "user_link"
}
};
option (google.api.method_signature) = "parent,user_link";
}
// Creates information about multiple users' links to an account or property.
//
// This method is transactional. If any UserLink cannot be created, none of
// the UserLinks will be created.
rpc BatchCreateUserLinks(BatchCreateUserLinksRequest) returns (BatchCreateUserLinksResponse) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:batchCreate"
body: "*"
additional_bindings {
post: "/v1alpha/{parent=properties/*}/userLinks:batchCreate"
body: "*"
}
};
}
// Updates a user link on an account or property.
rpc UpdateUserLink(UpdateUserLinkRequest) returns (UserLink) {
option (google.api.http) = {
patch: "/v1alpha/{user_link.name=accounts/*/userLinks/*}"
body: "user_link"
additional_bindings {
patch: "/v1alpha/{user_link.name=properties/*/userLinks/*}"
body: "user_link"
}
};
option (google.api.method_signature) = "user_link";
}
// Updates information about multiple users' links to an account or property.
rpc BatchUpdateUserLinks(BatchUpdateUserLinksRequest) returns (BatchUpdateUserLinksResponse) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:batchUpdate"
body: "*"
additional_bindings {
post: "/v1alpha/{parent=properties/*}/userLinks:batchUpdate"
body: "*"
}
};
}
// Deletes a user link on an account or property.
rpc DeleteUserLink(DeleteUserLinkRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=accounts/*/userLinks/*}"
additional_bindings {
delete: "/v1alpha/{name=properties/*/userLinks/*}"
}
};
option (google.api.method_signature) = "name";
}
// Deletes information about multiple users' links to an account or property.
rpc BatchDeleteUserLinks(BatchDeleteUserLinksRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:batchDelete"
body: "*"
additional_bindings {
post: "/v1alpha/{parent=properties/*}/userLinks:batchDelete"
body: "*"
}
};
}
// Lookup for a single WebDataStream
rpc GetWebDataStream(GetWebDataStreamRequest) returns (WebDataStream) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/webDataStreams/*}"
};
option (google.api.method_signature) = "name";
}
// Deletes a web stream on a property.
rpc DeleteWebDataStream(DeleteWebDataStreamRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/webDataStreams/*}"
};
option (google.api.method_signature) = "name";
}
// Updates a web stream on a property.
rpc UpdateWebDataStream(UpdateWebDataStreamRequest) returns (WebDataStream) {
option (google.api.http) = {
patch: "/v1alpha/{web_data_stream.name=properties/*/webDataStreams/*}"
body: "web_data_stream"
};
option (google.api.method_signature) = "web_data_stream,update_mask";
}
// Creates a web stream with the specified location and attributes.
rpc CreateWebDataStream(CreateWebDataStreamRequest) returns (WebDataStream) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/webDataStreams"
body: "web_data_stream"
};
option (google.api.method_signature) = "parent,web_data_stream";
}
// Returns child web data streams under the specified parent property.
//
// Web data streams will be excluded if the caller does not have access.
// Returns an empty list if no relevant web data streams are found.
rpc ListWebDataStreams(ListWebDataStreamsRequest) returns (ListWebDataStreamsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/webDataStreams"
};
option (google.api.method_signature) = "parent";
}
// Lookup for a single IosAppDataStream
rpc GetIosAppDataStream(GetIosAppDataStreamRequest) returns (IosAppDataStream) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/iosAppDataStreams/*}"
};
option (google.api.method_signature) = "name";
}
// Deletes an iOS app stream on a property.
rpc DeleteIosAppDataStream(DeleteIosAppDataStreamRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/iosAppDataStreams/*}"
};
option (google.api.method_signature) = "name";
}
// Updates an iOS app stream on a property.
rpc UpdateIosAppDataStream(UpdateIosAppDataStreamRequest) returns (IosAppDataStream) {
option (google.api.http) = {
patch: "/v1alpha/{ios_app_data_stream.name=properties/*/iosAppDataStreams/*}"
body: "ios_app_data_stream"
};
option (google.api.method_signature) = "ios_app_data_stream,update_mask";
}
// Creates an iOS app data stream with the specified location and attributes.
rpc CreateIosAppDataStream(CreateIosAppDataStreamRequest) returns (IosAppDataStream) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/iosAppDataStreams"
body: "ios_app_data_stream"
};
option (google.api.method_signature) = "parent,ios_app_data_stream";
}
// Returns child iOS app data streams under the specified parent property.
//
// iOS app data streams will be excluded if the caller does not have access.
// Returns an empty list if no relevant iOS app data streams are found.
rpc ListIosAppDataStreams(ListIosAppDataStreamsRequest) returns (ListIosAppDataStreamsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/iosAppDataStreams"
};
option (google.api.method_signature) = "parent";
}
// Lookup for a single AndroidAppDataStream
rpc GetAndroidAppDataStream(GetAndroidAppDataStreamRequest) returns (AndroidAppDataStream) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/androidAppDataStreams/*}"
};
option (google.api.method_signature) = "name";
}
// Deletes an android app stream on a property.
rpc DeleteAndroidAppDataStream(DeleteAndroidAppDataStreamRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/androidAppDataStreams/*}"
};
option (google.api.method_signature) = "name";
}
// Updates an android app stream on a property.
rpc UpdateAndroidAppDataStream(UpdateAndroidAppDataStreamRequest) returns (AndroidAppDataStream) {
option (google.api.http) = {
patch: "/v1alpha/{android_app_data_stream.name=properties/*/androidAppDataStreams/*}"
body: "android_app_data_stream"
};
option (google.api.method_signature) = "android_app_data_stream,update_mask";
}
// Creates an android app stream with the specified location and attributes.
rpc CreateAndroidAppDataStream(CreateAndroidAppDataStreamRequest) returns (AndroidAppDataStream) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/androidAppDataStreams"
body: "android_app_data_stream"
};
option (google.api.method_signature) = "parent,android_app_data_stream";
}
// Returns child android app streams under the specified parent property.
//
// Android app streams will be excluded if the caller does not have access.
// Returns an empty list if no relevant android app streams are found.
rpc ListAndroidAppDataStreams(ListAndroidAppDataStreamsRequest) returns (ListAndroidAppDataStreamsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/androidAppDataStreams"
};
option (google.api.method_signature) = "parent";
}
// Returns the singleton enhanced measurement settings for this web stream.
// Note that the stream must enable enhanced measurement for these settings to
// take effect.
rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/webDataStreams/*/enhancedMeasurementSettings}"
};
option (google.api.method_signature) = "name";
}
// Updates the singleton enhanced measurement settings for this web stream.
// Note that the stream must enable enhanced measurement for these settings to
// take effect.
rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings) {
option (google.api.http) = {
patch: "/v1alpha/{enhanced_measurement_settings.name=properties/*/webDataStreams/*/enhancedMeasurementSettings}"
body: "enhanced_measurement_settings"
};
option (google.api.method_signature) = "enhanced_measurement_settings,update_mask";
}
// Creates a FirebaseLink.
//
// Properties can have at most one FirebaseLink.
rpc CreateFirebaseLink(CreateFirebaseLinkRequest) returns (FirebaseLink) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/firebaseLinks"
body: "firebase_link"
};
option (google.api.method_signature) = "parent,firebase_link";
}
// Updates a FirebaseLink on a property
rpc UpdateFirebaseLink(UpdateFirebaseLinkRequest) returns (FirebaseLink) {
option (google.api.http) = {
patch: "/v1alpha/{firebase_link.name=properties/*/firebaseLinks/*}"
body: "firebase_link"
};
option (google.api.method_signature) = "firebase_link,update_mask";
}
// Deletes a FirebaseLink on a property
rpc DeleteFirebaseLink(DeleteFirebaseLinkRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/firebaseLinks/*}"
};
option (google.api.method_signature) = "name";
}
// Lists FirebaseLinks on a property.
// Properties can have at most one FirebaseLink.
rpc ListFirebaseLinks(ListFirebaseLinksRequest) returns (ListFirebaseLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/firebaseLinks"
};
option (google.api.method_signature) = "parent";
}
// Returns the Site Tag for the specified web stream.
// Site Tags are immutable singletons.
rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/webDataStreams/*/globalSiteTag}"
};
option (google.api.method_signature) = "name";
}
// Creates a GoogleAdsLink.
rpc CreateGoogleAdsLink(CreateGoogleAdsLinkRequest) returns (GoogleAdsLink) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/googleAdsLinks"
body: "google_ads_link"
};
option (google.api.method_signature) = "parent,google_ads_link";
}
// Updates a GoogleAdsLink on a property
rpc UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest) returns (GoogleAdsLink) {
option (google.api.http) = {
patch: "/v1alpha/{google_ads_link.name=properties/*/googleAdsLinks/*}"
body: "google_ads_link"
};
option (google.api.method_signature) = "google_ads_link,update_mask";
}
// Deletes a GoogleAdsLink on a property
rpc DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/googleAdsLinks/*}"
};
option (google.api.method_signature) = "name";
}
// Lists GoogleAdsLinks on a property.
rpc ListGoogleAdsLinks(ListGoogleAdsLinksRequest) returns (ListGoogleAdsLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/googleAdsLinks"
};
option (google.api.method_signature) = "parent";
}
// Get data sharing settings on an account.
// Data sharing settings are singletons.
rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings) {
option (google.api.http) = {
get: "/v1alpha/{name=accounts/*/dataSharingSettings}"
};
option (google.api.method_signature) = "name";
}
}
// Request message for GetAccount RPC.
message GetAccountRequest {
// Required. The name of the account to lookup.
// Format: accounts/{account}
// Example: "accounts/100"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/Account"
}
];
}
// Request message for ListAccounts RPC.
message ListAccountsRequest {
// The maximum number of resources to return. The service may return
// fewer than this value, even if there are additional pages.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
int32 page_size = 1;
// A page token, received from a previous `ListAccounts` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListAccounts` must
// match the call that provided the page token.
string page_token = 2;
// Whether to include soft-deleted (ie: "trashed") Accounts in the
// results. Accounts can be inspected to determine whether they are deleted or
// not.
bool show_deleted = 3;
}
// Request message for ListAccounts RPC.
message ListAccountsResponse {
// Results that were accessible to the caller.
repeated Account accounts = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for DeleteAccount RPC.
message DeleteAccountRequest {
// Required. The name of the Account to soft-delete.
// Format: accounts/{account}
// Example: "accounts/100"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/Account"
}
];
}
// Request message for UpdateAccount RPC.
message UpdateAccountRequest {
// Required. The account to update.
// The account's `name` field is used to identify the account.
Account account = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of fields to be updated. Omitted fields will not be updated.
// To replace the entire entity, use one path with the string "*" to match
// all fields.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for ProvisionAccountTicket RPC.
message ProvisionAccountTicketRequest {
// The account to create.
Account account = 1;
// Redirect URI where the user will be sent after accepting Terms of Service.
// Must be configured in Developers Console as a Redirect URI
string redirect_uri = 2;
}
// Response message for ProvisionAccountTicket RPC.
message ProvisionAccountTicketResponse {
// The param to be passed in the ToS link.
string account_ticket_id = 1;
}
// Request message for GetProperty RPC.
message GetPropertyRequest {
// Required. The name of the property to lookup.
// Format: properties/{property_id}
// Example: "properties/1000"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/Property"
}
];
}
// Request message for ListProperties RPC.
message ListPropertiesRequest {
// Required. An expression for filtering the results of the request.
// Fields eligible for filtering are:
// `parent:`(The resource name of the parent account) or
// `firebase_project:`(The id or number of the linked firebase project).
// Some examples of filters:
//
// ```
// | Filter | Description |
// |-----------------------------|-------------------------------------------|
// | parent:accounts/123 | The account with account id: 123. |
// | firebase_project:project-id | The firebase project with id: project-id. |
// | firebase_project:123 | The firebase project with number: 123. |
// ```
string filter = 1 [(google.api.field_behavior) = REQUIRED];
// The maximum number of resources to return. The service may return
// fewer than this value, even if there are additional pages.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
int32 page_size = 2;
// A page token, received from a previous `ListProperties` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListProperties` must
// match the call that provided the page token.
string page_token = 3;
// Whether to include soft-deleted (ie: "trashed") Properties in the
// results. Properties can be inspected to determine whether they are deleted
// or not.
bool show_deleted = 4;
}
// Response message for ListProperties RPC.
message ListPropertiesResponse {
// Results that matched the filter criteria and were accessible to the caller.
repeated Property properties = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for UpdateProperty RPC.
message UpdatePropertyRequest {
// Required. The property to update.
// The property's `name` field is used to identify the property to be
// updated.
Property property = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of fields to be updated. Omitted fields will not be updated.
// To replace the entire entity, use one path with the string "*" to match
// all fields.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for CreateProperty RPC.
message CreatePropertyRequest {
// Required. The property to create.
// Note: the supplied property must specify its parent.
Property property = 1 [(google.api.field_behavior) = REQUIRED];
}
// Request message for DeleteProperty RPC.
message DeletePropertyRequest {
// Required. The name of the Property to soft-delete.
// Format: properties/{property_id}
// Example: "properties/1000"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/Property"
}
];
}
// Request message for GetUserLink RPC.
message GetUserLinkRequest {
// Required. Example format: accounts/1234/userLinks/5678
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/UserLink"
}
];
}
// Request message for BatchGetUserLinks RPC.
message BatchGetUserLinksRequest {
// Required. The account or property that all user links in the request are
// for. The parent of all provided values for the 'names' field must match
// this field.
// Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// Required. The names of the user links to retrieve.
// A maximum of 1000 user links can be retrieved in a batch.
// Format: accounts/{accountId}/userLinks/{userLinkId}
repeated string names = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/UserLink"
}
];
}
// Response message for BatchGetUserLinks RPC.
message BatchGetUserLinksResponse {
// The requested user links.
repeated UserLink user_links = 1;
}
// Request message for ListUserLinks RPC.
message ListUserLinksRequest {
// Required. Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// The maximum number of user links to return.
// The service may return fewer than this value.
// If unspecified, at most 200 user links will be returned.
// The maximum value is 500; values above 500 will be coerced to 500.
int32 page_size = 2;
// A page token, received from a previous `ListUserLinks` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListUserLinks` must
// match the call that provided the page token.
string page_token = 3;
}
// Response message for ListUserLinks RPC.
message ListUserLinksResponse {
// List of UserLinks. These will be ordered stably, but in an arbitrary order.
repeated UserLink user_links = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for AuditUserLinks RPC.
message AuditUserLinksRequest {
// Required. Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// The maximum number of user links to return.
// The service may return fewer than this value.
// If unspecified, at most 1000 user links will be returned.
// The maximum value is 5000; values above 5000 will be coerced to 5000.
int32 page_size = 2;
// A page token, received from a previous `AuditUserLinks` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `AuditUserLinks` must
// match the call that provided the page token.
string page_token = 3;
}
// Response message for AuditUserLinks RPC.
message AuditUserLinksResponse {
// List of AuditUserLinks. These will be ordered stably, but in an arbitrary
// order.
repeated AuditUserLink user_links = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for CreateUserLink RPC.
//
// Users can have multiple email addresses associated with their Google
// account, and one of these email addresses is the "primary" email address.
// Any of the email addresses associated with a Google account may be used
// for a new UserLink, but the returned UserLink will always contain the
// "primary" email address. As a result, the input and output email address
// for this request may differ.
message CreateUserLinkRequest {
// Required. Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// Optional. If set, then email the new user notifying them that they've been granted
// permissions to the resource.
bool notify_new_user = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. The user link to create.
UserLink user_link = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for BatchCreateUserLinks RPC.
message BatchCreateUserLinksRequest {
// Required. The account or property that all user links in the request are for.
// This field is required. The parent field in the CreateUserLinkRequest
// messages must either be empty or match this field.
// Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// Optional. If set, then email the new users notifying them that they've been granted
// permissions to the resource. Regardless of whether this is set or not,
// notify_new_user field inside each individual request is ignored.
bool notify_new_users = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. The requests specifying the user links to create.
// A maximum of 1000 user links can be created in a batch.
repeated CreateUserLinkRequest requests = 3 [(google.api.field_behavior) = REQUIRED];
}
// Response message for BatchCreateUserLinks RPC.
message BatchCreateUserLinksResponse {
// The user links created.
repeated UserLink user_links = 1;
}
// Request message for UpdateUserLink RPC.
message UpdateUserLinkRequest {
// Required. The user link to update.
UserLink user_link = 1 [(google.api.field_behavior) = REQUIRED];
}
// Request message for BatchUpdateUserLinks RPC.
message BatchUpdateUserLinksRequest {
// Required. The account or property that all user links in the request are
// for. The parent field in the UpdateUserLinkRequest messages must either be
// empty or match this field.
// Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// Required. The requests specifying the user links to update.
// A maximum of 1000 user links can be updated in a batch.
repeated UpdateUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}
// Response message for BatchUpdateUserLinks RPC.
message BatchUpdateUserLinksResponse {
// The user links updated.
repeated UserLink user_links = 1;
}
// Request message for DeleteUserLink RPC.
message DeleteUserLinkRequest {
// Required. Example format: accounts/1234/userLinks/5678
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/UserLink"
}
];
}
// Request message for BatchDeleteUserLinks RPC.
message BatchDeleteUserLinksRequest {
// Required. The account or property that all user links in the request are
// for. The parent of all values for user link names to delete must match this
// field.
// Example format: accounts/1234
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/UserLink"
}
];
// Required. The requests specifying the user links to update.
// A maximum of 1000 user links can be updated in a batch.
repeated DeleteUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for GetWebDataStream RPC.
message GetWebDataStreamRequest {
// Required. The name of the web data stream to lookup.
// Format: properties/{property_id}/webDataStreams/{stream_id}
// Example: "properties/123/webDataStreams/456"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/WebDataStream"
}
];
}
// Request message for DeleteWebDataStream RPC.
message DeleteWebDataStreamRequest {
// Required. The name of the web data stream to delete.
// Format: properties/{property_id}/webDataStreams/{stream_id}
// Example: "properties/123/webDataStreams/456"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "analyticsadmin.googleapis.com/WebDataStream"
}
];
}
// Request message for UpdateWebDataStream RPC.
message UpdateWebDataStreamRequest {
// Required. The web stream to update.
// The `name` field is used to identify the web stream to be updated.
WebDataStream web_data_stream = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of fields to be updated. Omitted fields will not be updated.
// To replace the entire entity, use one path with the string "*" to match
// all fields.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for CreateWebDataStream RPC.
message CreateWebDataStreamRequest {
// Required. The web stream to create.
WebDataStream web_data_stream = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The parent resource where this web data stream will be created.
// Format: properties/123
string parent = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/WebDataStream"
}
];
}
// Request message for ListWebDataStreams RPC.
message ListWebDataStreamsRequest {
// Required. The name of the parent property.
// For example, to list results of web streams under the property with Id
// 123: "properties/123"
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "analyticsadmin.googleapis.com/WebDataStream"
}
];
// The maximum number of resources to return.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)