@google-analytics/data 4.0.1 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1035,13 +1035,13 @@
1035
1035
  "java_outer_classname": "ReportingApiProto",
1036
1036
  "java_package": "com.google.analytics.data.v1alpha",
1037
1037
  "(google.api.resource_definition).type": "analyticsadmin.googleapis.com/Property",
1038
- "(google.api.resource_definition).pattern": "properties/{propertyId}"
1038
+ "(google.api.resource_definition).pattern": "properties/{property}"
1039
1039
  },
1040
1040
  "nested": {
1041
1041
  "AlphaAnalyticsData": {
1042
1042
  "options": {
1043
1043
  "(google.api.default_host)": "analyticsdata.googleapis.com",
1044
- "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/analytics,https://www.googleapis.com/auth/analytics.readonly"
1044
+ "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/analytics,https://www.googleapis.com/auth/analytics.readonly,https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/drive.file,https://www.googleapis.com/auth/spreadsheets"
1045
1045
  },
1046
1046
  "methods": {
1047
1047
  "RunFunnelReport": {
@@ -1108,6 +1108,26 @@
1108
1108
  }
1109
1109
  ]
1110
1110
  },
1111
+ "SheetExportAudienceList": {
1112
+ "requestType": "SheetExportAudienceListRequest",
1113
+ "responseType": "SheetExportAudienceListResponse",
1114
+ "options": {
1115
+ "(google.api.http).post": "/v1alpha/{name=properties/*/audienceLists/*}:exportSheet",
1116
+ "(google.api.http).body": "*",
1117
+ "(google.api.method_signature)": "name"
1118
+ },
1119
+ "parsedOptions": [
1120
+ {
1121
+ "(google.api.http)": {
1122
+ "post": "/v1alpha/{name=properties/*/audienceLists/*}:exportSheet",
1123
+ "body": "*"
1124
+ }
1125
+ },
1126
+ {
1127
+ "(google.api.method_signature)": "name"
1128
+ }
1129
+ ]
1130
+ },
1111
1131
  "GetAudienceList": {
1112
1132
  "requestType": "GetAudienceListRequest",
1113
1133
  "responseType": "AudienceList",
@@ -1143,6 +1163,204 @@
1143
1163
  "(google.api.method_signature)": "parent"
1144
1164
  }
1145
1165
  ]
1166
+ },
1167
+ "CreateRecurringAudienceList": {
1168
+ "requestType": "CreateRecurringAudienceListRequest",
1169
+ "responseType": "RecurringAudienceList",
1170
+ "options": {
1171
+ "(google.api.http).post": "/v1alpha/{parent=properties/*}/recurringAudienceLists",
1172
+ "(google.api.http).body": "recurring_audience_list",
1173
+ "(google.api.method_signature)": "parent,recurring_audience_list"
1174
+ },
1175
+ "parsedOptions": [
1176
+ {
1177
+ "(google.api.http)": {
1178
+ "post": "/v1alpha/{parent=properties/*}/recurringAudienceLists",
1179
+ "body": "recurring_audience_list"
1180
+ }
1181
+ },
1182
+ {
1183
+ "(google.api.method_signature)": "parent,recurring_audience_list"
1184
+ }
1185
+ ]
1186
+ },
1187
+ "GetRecurringAudienceList": {
1188
+ "requestType": "GetRecurringAudienceListRequest",
1189
+ "responseType": "RecurringAudienceList",
1190
+ "options": {
1191
+ "(google.api.http).get": "/v1alpha/{name=properties/*/recurringAudienceLists/*}",
1192
+ "(google.api.method_signature)": "name"
1193
+ },
1194
+ "parsedOptions": [
1195
+ {
1196
+ "(google.api.http)": {
1197
+ "get": "/v1alpha/{name=properties/*/recurringAudienceLists/*}"
1198
+ }
1199
+ },
1200
+ {
1201
+ "(google.api.method_signature)": "name"
1202
+ }
1203
+ ]
1204
+ },
1205
+ "ListRecurringAudienceLists": {
1206
+ "requestType": "ListRecurringAudienceListsRequest",
1207
+ "responseType": "ListRecurringAudienceListsResponse",
1208
+ "options": {
1209
+ "(google.api.http).get": "/v1alpha/{parent=properties/*}/recurringAudienceLists",
1210
+ "(google.api.method_signature)": "parent"
1211
+ },
1212
+ "parsedOptions": [
1213
+ {
1214
+ "(google.api.http)": {
1215
+ "get": "/v1alpha/{parent=properties/*}/recurringAudienceLists"
1216
+ }
1217
+ },
1218
+ {
1219
+ "(google.api.method_signature)": "parent"
1220
+ }
1221
+ ]
1222
+ }
1223
+ }
1224
+ },
1225
+ "CreateRecurringAudienceListRequest": {
1226
+ "fields": {
1227
+ "parent": {
1228
+ "type": "string",
1229
+ "id": 1,
1230
+ "options": {
1231
+ "(google.api.field_behavior)": "REQUIRED",
1232
+ "(google.api.resource_reference).child_type": "analyticsdata.googleapis.com/RecurringAudienceList"
1233
+ }
1234
+ },
1235
+ "recurringAudienceList": {
1236
+ "type": "RecurringAudienceList",
1237
+ "id": 2,
1238
+ "options": {
1239
+ "(google.api.field_behavior)": "REQUIRED"
1240
+ }
1241
+ }
1242
+ }
1243
+ },
1244
+ "RecurringAudienceList": {
1245
+ "options": {
1246
+ "(google.api.resource).type": "analyticsdata.googleapis.com/RecurringAudienceList",
1247
+ "(google.api.resource).pattern": "properties/{property}/recurringAudienceLists/{recurring_audience_list}",
1248
+ "(google.api.resource).plural": "recurringAudienceLists",
1249
+ "(google.api.resource).singular": "recurringAudienceList"
1250
+ },
1251
+ "oneofs": {
1252
+ "_activeDaysRemaining": {
1253
+ "oneof": [
1254
+ "activeDaysRemaining"
1255
+ ]
1256
+ }
1257
+ },
1258
+ "fields": {
1259
+ "name": {
1260
+ "type": "string",
1261
+ "id": 1,
1262
+ "options": {
1263
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
1264
+ }
1265
+ },
1266
+ "audience": {
1267
+ "type": "string",
1268
+ "id": 2,
1269
+ "options": {
1270
+ "(google.api.field_behavior)": "REQUIRED"
1271
+ }
1272
+ },
1273
+ "audienceDisplayName": {
1274
+ "type": "string",
1275
+ "id": 3,
1276
+ "options": {
1277
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
1278
+ }
1279
+ },
1280
+ "dimensions": {
1281
+ "rule": "repeated",
1282
+ "type": "AudienceDimension",
1283
+ "id": 4,
1284
+ "options": {
1285
+ "(google.api.field_behavior)": "REQUIRED"
1286
+ }
1287
+ },
1288
+ "activeDaysRemaining": {
1289
+ "type": "int32",
1290
+ "id": 5,
1291
+ "options": {
1292
+ "(google.api.field_behavior)": "OPTIONAL",
1293
+ "proto3_optional": true
1294
+ }
1295
+ },
1296
+ "audienceLists": {
1297
+ "rule": "repeated",
1298
+ "type": "string",
1299
+ "id": 6,
1300
+ "options": {
1301
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
1302
+ }
1303
+ }
1304
+ }
1305
+ },
1306
+ "GetRecurringAudienceListRequest": {
1307
+ "fields": {
1308
+ "name": {
1309
+ "type": "string",
1310
+ "id": 1,
1311
+ "options": {
1312
+ "(google.api.field_behavior)": "REQUIRED",
1313
+ "(google.api.resource_reference).type": "analyticsdata.googleapis.com/RecurringAudienceList"
1314
+ }
1315
+ }
1316
+ }
1317
+ },
1318
+ "ListRecurringAudienceListsRequest": {
1319
+ "fields": {
1320
+ "parent": {
1321
+ "type": "string",
1322
+ "id": 1,
1323
+ "options": {
1324
+ "(google.api.field_behavior)": "REQUIRED",
1325
+ "(google.api.resource_reference).child_type": "analyticsdata.googleapis.com/RecurringAudienceList"
1326
+ }
1327
+ },
1328
+ "pageSize": {
1329
+ "type": "int32",
1330
+ "id": 2,
1331
+ "options": {
1332
+ "(google.api.field_behavior)": "OPTIONAL"
1333
+ }
1334
+ },
1335
+ "pageToken": {
1336
+ "type": "string",
1337
+ "id": 3,
1338
+ "options": {
1339
+ "(google.api.field_behavior)": "OPTIONAL"
1340
+ }
1341
+ }
1342
+ }
1343
+ },
1344
+ "ListRecurringAudienceListsResponse": {
1345
+ "oneofs": {
1346
+ "_nextPageToken": {
1347
+ "oneof": [
1348
+ "nextPageToken"
1349
+ ]
1350
+ }
1351
+ },
1352
+ "fields": {
1353
+ "recurringAudienceLists": {
1354
+ "rule": "repeated",
1355
+ "type": "RecurringAudienceList",
1356
+ "id": 1
1357
+ },
1358
+ "nextPageToken": {
1359
+ "type": "string",
1360
+ "id": 2,
1361
+ "options": {
1362
+ "proto3_optional": true
1363
+ }
1146
1364
  }
1147
1365
  }
1148
1366
  },
@@ -1170,11 +1388,17 @@
1170
1388
  },
1171
1389
  "pageSize": {
1172
1390
  "type": "int32",
1173
- "id": 2
1391
+ "id": 2,
1392
+ "options": {
1393
+ "(google.api.field_behavior)": "OPTIONAL"
1394
+ }
1174
1395
  },
1175
1396
  "pageToken": {
1176
1397
  "type": "string",
1177
- "id": 3
1398
+ "id": 3,
1399
+ "options": {
1400
+ "(google.api.field_behavior)": "OPTIONAL"
1401
+ }
1178
1402
  }
1179
1403
  }
1180
1404
  },
@@ -1223,7 +1447,9 @@
1223
1447
  "AudienceList": {
1224
1448
  "options": {
1225
1449
  "(google.api.resource).type": "analyticsdata.googleapis.com/AudienceList",
1226
- "(google.api.resource).pattern": "properties/{propertyId}/audienceLists/{audienceListId}"
1450
+ "(google.api.resource).pattern": "properties/{property}/audienceLists/{audience_list}",
1451
+ "(google.api.resource).plural": "audienceLists",
1452
+ "(google.api.resource).singular": "audienceList"
1227
1453
  },
1228
1454
  "oneofs": {
1229
1455
  "_state": {
@@ -1235,6 +1461,26 @@
1235
1461
  "oneof": [
1236
1462
  "beginCreatingTime"
1237
1463
  ]
1464
+ },
1465
+ "_rowCount": {
1466
+ "oneof": [
1467
+ "rowCount"
1468
+ ]
1469
+ },
1470
+ "_errorMessage": {
1471
+ "oneof": [
1472
+ "errorMessage"
1473
+ ]
1474
+ },
1475
+ "_percentageCompleted": {
1476
+ "oneof": [
1477
+ "percentageCompleted"
1478
+ ]
1479
+ },
1480
+ "_recurringAudienceList": {
1481
+ "oneof": [
1482
+ "recurringAudienceList"
1483
+ ]
1238
1484
  }
1239
1485
  },
1240
1486
  "fields": {
@@ -1282,6 +1528,45 @@
1282
1528
  "(google.api.field_behavior)": "OUTPUT_ONLY",
1283
1529
  "proto3_optional": true
1284
1530
  }
1531
+ },
1532
+ "creationQuotaTokensCharged": {
1533
+ "type": "int32",
1534
+ "id": 7,
1535
+ "options": {
1536
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
1537
+ }
1538
+ },
1539
+ "rowCount": {
1540
+ "type": "int32",
1541
+ "id": 8,
1542
+ "options": {
1543
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
1544
+ "proto3_optional": true
1545
+ }
1546
+ },
1547
+ "errorMessage": {
1548
+ "type": "string",
1549
+ "id": 9,
1550
+ "options": {
1551
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
1552
+ "proto3_optional": true
1553
+ }
1554
+ },
1555
+ "percentageCompleted": {
1556
+ "type": "double",
1557
+ "id": 11,
1558
+ "options": {
1559
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
1560
+ "proto3_optional": true
1561
+ }
1562
+ },
1563
+ "recurringAudienceList": {
1564
+ "type": "string",
1565
+ "id": 12,
1566
+ "options": {
1567
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
1568
+ "proto3_optional": true
1569
+ }
1285
1570
  }
1286
1571
  },
1287
1572
  "nested": {
@@ -1302,15 +1587,24 @@
1302
1587
  "fields": {
1303
1588
  "name": {
1304
1589
  "type": "string",
1305
- "id": 1
1590
+ "id": 1,
1591
+ "options": {
1592
+ "(google.api.field_behavior)": "REQUIRED"
1593
+ }
1306
1594
  },
1307
1595
  "offset": {
1308
1596
  "type": "int64",
1309
- "id": 2
1597
+ "id": 2,
1598
+ "options": {
1599
+ "(google.api.field_behavior)": "OPTIONAL"
1600
+ }
1310
1601
  },
1311
1602
  "limit": {
1312
1603
  "type": "int64",
1313
- "id": 3
1604
+ "id": 3,
1605
+ "options": {
1606
+ "(google.api.field_behavior)": "OPTIONAL"
1607
+ }
1314
1608
  }
1315
1609
  }
1316
1610
  },
@@ -1349,6 +1643,86 @@
1349
1643
  }
1350
1644
  }
1351
1645
  },
1646
+ "SheetExportAudienceListRequest": {
1647
+ "fields": {
1648
+ "name": {
1649
+ "type": "string",
1650
+ "id": 1,
1651
+ "options": {
1652
+ "(google.api.field_behavior)": "REQUIRED",
1653
+ "(google.api.resource_reference).type": "analyticsdata.googleapis.com/AudienceList"
1654
+ }
1655
+ },
1656
+ "offset": {
1657
+ "type": "int64",
1658
+ "id": 2,
1659
+ "options": {
1660
+ "(google.api.field_behavior)": "OPTIONAL"
1661
+ }
1662
+ },
1663
+ "limit": {
1664
+ "type": "int64",
1665
+ "id": 3,
1666
+ "options": {
1667
+ "(google.api.field_behavior)": "OPTIONAL"
1668
+ }
1669
+ }
1670
+ }
1671
+ },
1672
+ "SheetExportAudienceListResponse": {
1673
+ "oneofs": {
1674
+ "_spreadsheetUri": {
1675
+ "oneof": [
1676
+ "spreadsheetUri"
1677
+ ]
1678
+ },
1679
+ "_spreadsheetId": {
1680
+ "oneof": [
1681
+ "spreadsheetId"
1682
+ ]
1683
+ },
1684
+ "_rowCount": {
1685
+ "oneof": [
1686
+ "rowCount"
1687
+ ]
1688
+ },
1689
+ "_audienceList": {
1690
+ "oneof": [
1691
+ "audienceList"
1692
+ ]
1693
+ }
1694
+ },
1695
+ "fields": {
1696
+ "spreadsheetUri": {
1697
+ "type": "string",
1698
+ "id": 1,
1699
+ "options": {
1700
+ "proto3_optional": true
1701
+ }
1702
+ },
1703
+ "spreadsheetId": {
1704
+ "type": "string",
1705
+ "id": 2,
1706
+ "options": {
1707
+ "proto3_optional": true
1708
+ }
1709
+ },
1710
+ "rowCount": {
1711
+ "type": "int32",
1712
+ "id": 3,
1713
+ "options": {
1714
+ "proto3_optional": true
1715
+ }
1716
+ },
1717
+ "audienceList": {
1718
+ "type": "AudienceList",
1719
+ "id": 4,
1720
+ "options": {
1721
+ "proto3_optional": true
1722
+ }
1723
+ }
1724
+ }
1725
+ },
1352
1726
  "AudienceRow": {
1353
1727
  "fields": {
1354
1728
  "dimensionValues": {
@@ -1362,7 +1736,10 @@
1362
1736
  "fields": {
1363
1737
  "dimensionName": {
1364
1738
  "type": "string",
1365
- "id": 1
1739
+ "id": 1,
1740
+ "options": {
1741
+ "(google.api.field_behavior)": "OPTIONAL"
1742
+ }
1366
1743
  }
1367
1744
  }
1368
1745
  },
@@ -1385,45 +1762,75 @@
1385
1762
  "fields": {
1386
1763
  "property": {
1387
1764
  "type": "string",
1388
- "id": 1
1765
+ "id": 1,
1766
+ "options": {
1767
+ "(google.api.field_behavior)": "OPTIONAL"
1768
+ }
1389
1769
  },
1390
1770
  "dateRanges": {
1391
1771
  "rule": "repeated",
1392
1772
  "type": "DateRange",
1393
- "id": 2
1773
+ "id": 2,
1774
+ "options": {
1775
+ "(google.api.field_behavior)": "OPTIONAL"
1776
+ }
1394
1777
  },
1395
1778
  "funnel": {
1396
1779
  "type": "Funnel",
1397
- "id": 3
1780
+ "id": 3,
1781
+ "options": {
1782
+ "(google.api.field_behavior)": "OPTIONAL"
1783
+ }
1398
1784
  },
1399
1785
  "funnelBreakdown": {
1400
1786
  "type": "FunnelBreakdown",
1401
- "id": 4
1787
+ "id": 4,
1788
+ "options": {
1789
+ "(google.api.field_behavior)": "OPTIONAL"
1790
+ }
1402
1791
  },
1403
1792
  "funnelNextAction": {
1404
1793
  "type": "FunnelNextAction",
1405
- "id": 5
1794
+ "id": 5,
1795
+ "options": {
1796
+ "(google.api.field_behavior)": "OPTIONAL"
1797
+ }
1406
1798
  },
1407
1799
  "funnelVisualizationType": {
1408
1800
  "type": "FunnelVisualizationType",
1409
- "id": 6
1801
+ "id": 6,
1802
+ "options": {
1803
+ "(google.api.field_behavior)": "OPTIONAL"
1804
+ }
1410
1805
  },
1411
1806
  "segments": {
1412
1807
  "rule": "repeated",
1413
1808
  "type": "Segment",
1414
- "id": 7
1809
+ "id": 7,
1810
+ "options": {
1811
+ "(google.api.field_behavior)": "OPTIONAL"
1812
+ }
1415
1813
  },
1416
1814
  "limit": {
1417
1815
  "type": "int64",
1418
- "id": 9
1816
+ "id": 9,
1817
+ "options": {
1818
+ "(google.api.field_behavior)": "OPTIONAL"
1819
+ }
1419
1820
  },
1420
1821
  "dimensionFilter": {
1421
1822
  "type": "FilterExpression",
1422
- "id": 10
1823
+ "id": 10,
1824
+ "options": {
1825
+ "(google.api.field_behavior)": "OPTIONAL"
1826
+ }
1423
1827
  },
1424
1828
  "returnPropertyQuota": {
1425
1829
  "type": "bool",
1426
- "id": 12
1830
+ "id": 12,
1831
+ "options": {
1832
+ "(google.api.field_behavior)": "OPTIONAL"
1833
+ }
1427
1834
  }
1428
1835
  },
1429
1836
  "nested": {