/
analyticsadmin.v1alpha.json
5802 lines (5802 loc) 路 261 KB
/
analyticsadmin.v1alpha.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/analytics.edit": {
"description": "Edit Google Analytics management entities"
},
"https://www.googleapis.com/auth/analytics.manage.users": {
"description": "Manage Google Analytics Account users by email address"
},
"https://www.googleapis.com/auth/analytics.manage.users.readonly": {
"description": "View Google Analytics user permissions"
},
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "See and download your Google Analytics data"
}
}
}
},
"basePath": "",
"baseUrl": "https://analyticsadmin.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Google Analytics Admin",
"description": "",
"discoveryVersion": "v1",
"documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "analyticsadmin:v1alpha",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://analyticsadmin.mtls.googleapis.com/",
"name": "analyticsadmin",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"accountSummaries": {
"methods": {
"list": {
"description": "Returns summaries of all accounts accessible by the caller.",
"flatPath": "v1alpha/accountSummaries",
"httpMethod": "GET",
"id": "analyticsadmin.accountSummaries.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of AccountSummary 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)",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/accountSummaries",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
},
"accounts": {
"methods": {
"delete": {
"description": "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.",
"flatPath": "v1alpha/accounts/{accountsId}",
"httpMethod": "DELETE",
"id": "analyticsadmin.accounts.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Lookup for a single Account.",
"flatPath": "v1alpha/accounts/{accountsId}",
"httpMethod": "GET",
"id": "analyticsadmin.accounts.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaAccount"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"getDataSharingSettings": {
"description": "Get data sharing settings on an account. Data sharing settings are singletons.",
"flatPath": "v1alpha/accounts/{accountsId}/dataSharingSettings",
"httpMethod": "GET",
"id": "analyticsadmin.accounts.getDataSharingSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"",
"location": "path",
"pattern": "^accounts/[^/]+/dataSharingSettings$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaDataSharingSettings"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"list": {
"description": "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.",
"flatPath": "v1alpha/accounts",
"httpMethod": "GET",
"id": "analyticsadmin.accounts.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "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)",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "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.",
"location": "query",
"type": "string"
},
"showDeleted": {
"description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/accounts",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaListAccountsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates an account.",
"flatPath": "v1alpha/accounts/{accountsId}",
"httpMethod": "PATCH",
"id": "analyticsadmin.accounts.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaAccount"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaAccount"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"provisionAccountTicket": {
"description": "Requests a ticket for creating an account.",
"flatPath": "v1alpha/accounts:provisionAccountTicket",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.provisionAccountTicket",
"parameterOrder": [],
"parameters": {},
"path": "v1alpha/accounts:provisionAccountTicket",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"searchChangeHistoryEvents": {
"description": "Searches through all changes to an account or its children given the specified set of filters.",
"flatPath": "v1alpha/accounts/{accountsId}:searchChangeHistoryEvents",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.searchChangeHistoryEvents",
"parameterOrder": [
"account"
],
"parameters": {
"account": {
"description": "Required. The account resource for which to return change history resources.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+account}:searchChangeHistoryEvents",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
}
},
"resources": {
"userLinks": {
"methods": {
"audit": {
"description": "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.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks:audit",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.userLinks.audit",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Example format: accounts/1234",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks:audit",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
]
},
"batchCreate": {
"description": "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.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchCreate",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.userLinks.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "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",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks:batchCreate",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"batchDelete": {
"description": "Deletes information about multiple users' links to an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchDelete",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.userLinks.batchDelete",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "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",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks:batchDelete",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"batchGet": {
"description": "Gets information about multiple users' links to an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchGet",
"httpMethod": "GET",
"id": "analyticsadmin.accounts.userLinks.batchGet",
"parameterOrder": [
"parent"
],
"parameters": {
"names": {
"description": "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}",
"location": "query",
"repeated": true,
"type": "string"
},
"parent": {
"description": "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",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks:batchGet",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
]
},
"batchUpdate": {
"description": "Updates information about multiple users' links to an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchUpdate",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.userLinks.batchUpdate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "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",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks:batchUpdate",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"create": {
"description": "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.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks",
"httpMethod": "POST",
"id": "analyticsadmin.accounts.userLinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"notifyNewUser": {
"description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. Example format: accounts/1234",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaUserLink"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"delete": {
"description": "Deletes a user link on an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}",
"httpMethod": "DELETE",
"id": "analyticsadmin.accounts.userLinks.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Example format: accounts/1234/userLinks/5678",
"location": "path",
"pattern": "^accounts/[^/]+/userLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
},
"get": {
"description": "Gets information about a user's link to an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}",
"httpMethod": "GET",
"id": "analyticsadmin.accounts.userLinks.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Example format: accounts/1234/userLinks/5678",
"location": "path",
"pattern": "^accounts/[^/]+/userLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
]
},
"list": {
"description": "Lists all user links on an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks",
"httpMethod": "GET",
"id": "analyticsadmin.accounts.userLinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Example format: accounts/1234",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/userLinks",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users",
"https://www.googleapis.com/auth/analytics.manage.users.readonly"
]
},
"patch": {
"description": "Updates a user link on an account or property.",
"flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}",
"httpMethod": "PATCH",
"id": "analyticsadmin.accounts.userLinks.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Example format: properties/1234/userLinks/5678",
"location": "path",
"pattern": "^accounts/[^/]+/userLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaUserLink"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaUserLink"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.manage.users"
]
}
}
}
}
},
"properties": {
"methods": {
"acknowledgeUserDataCollection": {
"description": "Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.",
"flatPath": "v1alpha/properties/{propertiesId}:acknowledgeUserDataCollection",
"httpMethod": "POST",
"id": "analyticsadmin.properties.acknowledgeUserDataCollection",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "Required. The property for which to acknowledge user data collection.",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+property}:acknowledgeUserDataCollection",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"create": {
"description": "Creates an \"GA4\" property with the specified location and attributes.",
"flatPath": "v1alpha/properties",
"httpMethod": "POST",
"id": "analyticsadmin.properties.create",
"parameterOrder": [],
"parameters": {},
"path": "v1alpha/properties",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaProperty"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaProperty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"delete": {
"description": "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.",
"flatPath": "v1alpha/properties/{propertiesId}",
"httpMethod": "DELETE",
"id": "analyticsadmin.properties.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaProperty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"get": {
"description": "Lookup for a single \"GA4\" Property.",
"flatPath": "v1alpha/properties/{propertiesId}",
"httpMethod": "GET",
"id": "analyticsadmin.properties.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaProperty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"getAttributionSettings": {
"description": "Lookup for a AttributionSettings singleton.",
"flatPath": "v1alpha/properties/{propertiesId}/attributionSettings",
"httpMethod": "GET",
"id": "analyticsadmin.properties.getAttributionSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings",
"location": "path",
"pattern": "^properties/[^/]+/attributionSettings$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaAttributionSettings"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"getDataRetentionSettings": {
"description": "Returns the singleton data retention settings for this property.",
"flatPath": "v1alpha/properties/{propertiesId}/dataRetentionSettings",
"httpMethod": "GET",
"id": "analyticsadmin.properties.getDataRetentionSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"",
"location": "path",
"pattern": "^properties/[^/]+/dataRetentionSettings$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"getGoogleSignalsSettings": {
"description": "Lookup for Google Signals settings for a property.",
"flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings",
"httpMethod": "GET",
"id": "analyticsadmin.properties.getGoogleSignalsSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings",
"location": "path",
"pattern": "^properties/[^/]+/googleSignalsSettings$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"list": {
"description": "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.",
"flatPath": "v1alpha/properties",
"httpMethod": "GET",
"id": "analyticsadmin.properties.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(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. | | parent:properties/123 | The property with property id: 123. | | ancestor: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. | ```",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "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)",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "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.",
"location": "query",
"type": "string"
},
"showDeleted": {
"description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/properties",
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaListPropertiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"patch": {
"description": "Updates a property.",
"flatPath": "v1alpha/properties/{propertiesId}",
"httpMethod": "PATCH",
"id": "analyticsadmin.properties.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaProperty"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaProperty"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"runAccessReport": {
"description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).",
"flatPath": "v1alpha/properties/{propertiesId}:runAccessReport",
"httpMethod": "POST",
"id": "analyticsadmin.properties.runAccessReport",
"parameterOrder": [
"entity"
],
"parameters": {
"entity": {
"description": "The Data Access Report is requested for this property. For example if \"123\" is your GA4 property ID, then entity should be \"properties/123\".",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+entity}:runAccessReport",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaRunAccessReportRequest"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaRunAccessReportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"updateAttributionSettings": {
"description": "Updates attribution settings on a property.",
"flatPath": "v1alpha/properties/{propertiesId}/attributionSettings",
"httpMethod": "PATCH",
"id": "analyticsadmin.properties.updateAttributionSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: \"properties/1000/attributionSettings\"",
"location": "path",
"pattern": "^properties/[^/]+/attributionSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaAttributionSettings"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaAttributionSettings"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"updateDataRetentionSettings": {
"description": "Updates the singleton data retention settings for this property.",
"flatPath": "v1alpha/properties/{propertiesId}/dataRetentionSettings",
"httpMethod": "PATCH",
"id": "analyticsadmin.properties.updateDataRetentionSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings",
"location": "path",
"pattern": "^properties/[^/]+/dataRetentionSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings"
},
"response": {
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings"
},
"scopes": [
"https://www.googleapis.com/auth/analytics.edit"
]
},
"updateGoogleSignalsSettings": {
"description": "Updates Google Signals settings for a property.",
"flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings",
"httpMethod": "PATCH",
"id": "analyticsadmin.properties.updateGoogleSignalsSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: \"properties/1000/googleSignalsSettings\"",
"location": "path",