@google-analytics/data 4.5.0 → 4.7.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.
@@ -1513,6 +1513,90 @@
1513
1513
  "(google.api.method_signature)": "parent"
1514
1514
  }
1515
1515
  ]
1516
+ },
1517
+ "CreateReportTask": {
1518
+ "requestType": "CreateReportTaskRequest",
1519
+ "responseType": "google.longrunning.Operation",
1520
+ "options": {
1521
+ "(google.api.http).post": "/v1alpha/{parent=properties/*}/reportTasks",
1522
+ "(google.api.http).body": "report_task",
1523
+ "(google.api.method_signature)": "parent,report_task",
1524
+ "(google.longrunning.operation_info).response_type": "ReportTask",
1525
+ "(google.longrunning.operation_info).metadata_type": "ReportTaskMetadata"
1526
+ },
1527
+ "parsedOptions": [
1528
+ {
1529
+ "(google.api.http)": {
1530
+ "post": "/v1alpha/{parent=properties/*}/reportTasks",
1531
+ "body": "report_task"
1532
+ }
1533
+ },
1534
+ {
1535
+ "(google.api.method_signature)": "parent,report_task"
1536
+ },
1537
+ {
1538
+ "(google.longrunning.operation_info)": {
1539
+ "response_type": "ReportTask",
1540
+ "metadata_type": "ReportTaskMetadata"
1541
+ }
1542
+ }
1543
+ ]
1544
+ },
1545
+ "QueryReportTask": {
1546
+ "requestType": "QueryReportTaskRequest",
1547
+ "responseType": "QueryReportTaskResponse",
1548
+ "options": {
1549
+ "(google.api.http).post": "/v1alpha/{name=properties/*/reportTasks/*}:query",
1550
+ "(google.api.http).body": "*",
1551
+ "(google.api.method_signature)": "name"
1552
+ },
1553
+ "parsedOptions": [
1554
+ {
1555
+ "(google.api.http)": {
1556
+ "post": "/v1alpha/{name=properties/*/reportTasks/*}:query",
1557
+ "body": "*"
1558
+ }
1559
+ },
1560
+ {
1561
+ "(google.api.method_signature)": "name"
1562
+ }
1563
+ ]
1564
+ },
1565
+ "GetReportTask": {
1566
+ "requestType": "GetReportTaskRequest",
1567
+ "responseType": "ReportTask",
1568
+ "options": {
1569
+ "(google.api.http).get": "/v1alpha/{name=properties/*/reportTasks/*}",
1570
+ "(google.api.method_signature)": "name"
1571
+ },
1572
+ "parsedOptions": [
1573
+ {
1574
+ "(google.api.http)": {
1575
+ "get": "/v1alpha/{name=properties/*/reportTasks/*}"
1576
+ }
1577
+ },
1578
+ {
1579
+ "(google.api.method_signature)": "name"
1580
+ }
1581
+ ]
1582
+ },
1583
+ "ListReportTasks": {
1584
+ "requestType": "ListReportTasksRequest",
1585
+ "responseType": "ListReportTasksResponse",
1586
+ "options": {
1587
+ "(google.api.http).get": "/v1alpha/{parent=properties/*}/reportTasks",
1588
+ "(google.api.method_signature)": "parent"
1589
+ },
1590
+ "parsedOptions": [
1591
+ {
1592
+ "(google.api.http)": {
1593
+ "get": "/v1alpha/{parent=properties/*}/reportTasks"
1594
+ }
1595
+ },
1596
+ {
1597
+ "(google.api.method_signature)": "parent"
1598
+ }
1599
+ ]
1516
1600
  }
1517
1601
  }
1518
1602
  },
@@ -2215,6 +2299,370 @@
2215
2299
  }
2216
2300
  }
2217
2301
  },
2302
+ "ReportTask": {
2303
+ "options": {
2304
+ "(google.api.resource).type": "analyticsdata.googleapis.com/ReportTask",
2305
+ "(google.api.resource).pattern": "properties/{property}/reportTasks/{report_task}",
2306
+ "(google.api.resource).plural": "reportTasks",
2307
+ "(google.api.resource).singular": "reportTask"
2308
+ },
2309
+ "fields": {
2310
+ "name": {
2311
+ "type": "string",
2312
+ "id": 1,
2313
+ "options": {
2314
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2315
+ }
2316
+ },
2317
+ "reportDefinition": {
2318
+ "type": "ReportDefinition",
2319
+ "id": 2,
2320
+ "options": {
2321
+ "(google.api.field_behavior)": "OPTIONAL"
2322
+ }
2323
+ },
2324
+ "reportMetadata": {
2325
+ "type": "ReportMetadata",
2326
+ "id": 3,
2327
+ "options": {
2328
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2329
+ }
2330
+ }
2331
+ },
2332
+ "nested": {
2333
+ "ReportDefinition": {
2334
+ "fields": {
2335
+ "dimensions": {
2336
+ "rule": "repeated",
2337
+ "type": "Dimension",
2338
+ "id": 2,
2339
+ "options": {
2340
+ "(google.api.field_behavior)": "OPTIONAL"
2341
+ }
2342
+ },
2343
+ "metrics": {
2344
+ "rule": "repeated",
2345
+ "type": "Metric",
2346
+ "id": 3,
2347
+ "options": {
2348
+ "(google.api.field_behavior)": "OPTIONAL"
2349
+ }
2350
+ },
2351
+ "dateRanges": {
2352
+ "rule": "repeated",
2353
+ "type": "DateRange",
2354
+ "id": 4,
2355
+ "options": {
2356
+ "(google.api.field_behavior)": "OPTIONAL"
2357
+ }
2358
+ },
2359
+ "dimensionFilter": {
2360
+ "type": "FilterExpression",
2361
+ "id": 5,
2362
+ "options": {
2363
+ "(google.api.field_behavior)": "OPTIONAL"
2364
+ }
2365
+ },
2366
+ "metricFilter": {
2367
+ "type": "FilterExpression",
2368
+ "id": 6,
2369
+ "options": {
2370
+ "(google.api.field_behavior)": "OPTIONAL"
2371
+ }
2372
+ },
2373
+ "offset": {
2374
+ "type": "int64",
2375
+ "id": 7,
2376
+ "options": {
2377
+ "(google.api.field_behavior)": "OPTIONAL"
2378
+ }
2379
+ },
2380
+ "limit": {
2381
+ "type": "int64",
2382
+ "id": 8,
2383
+ "options": {
2384
+ "(google.api.field_behavior)": "OPTIONAL"
2385
+ }
2386
+ },
2387
+ "metricAggregations": {
2388
+ "rule": "repeated",
2389
+ "type": "MetricAggregation",
2390
+ "id": 9,
2391
+ "options": {
2392
+ "(google.api.field_behavior)": "OPTIONAL"
2393
+ }
2394
+ },
2395
+ "orderBys": {
2396
+ "rule": "repeated",
2397
+ "type": "OrderBy",
2398
+ "id": 10,
2399
+ "options": {
2400
+ "(google.api.field_behavior)": "OPTIONAL"
2401
+ }
2402
+ },
2403
+ "currencyCode": {
2404
+ "type": "string",
2405
+ "id": 11,
2406
+ "options": {
2407
+ "(google.api.field_behavior)": "OPTIONAL"
2408
+ }
2409
+ },
2410
+ "cohortSpec": {
2411
+ "type": "CohortSpec",
2412
+ "id": 12,
2413
+ "options": {
2414
+ "(google.api.field_behavior)": "OPTIONAL"
2415
+ }
2416
+ },
2417
+ "keepEmptyRows": {
2418
+ "type": "bool",
2419
+ "id": 13,
2420
+ "options": {
2421
+ "(google.api.field_behavior)": "OPTIONAL"
2422
+ }
2423
+ }
2424
+ }
2425
+ },
2426
+ "ReportMetadata": {
2427
+ "oneofs": {
2428
+ "_state": {
2429
+ "oneof": [
2430
+ "state"
2431
+ ]
2432
+ },
2433
+ "_beginCreatingTime": {
2434
+ "oneof": [
2435
+ "beginCreatingTime"
2436
+ ]
2437
+ },
2438
+ "_taskRowCount": {
2439
+ "oneof": [
2440
+ "taskRowCount"
2441
+ ]
2442
+ },
2443
+ "_errorMessage": {
2444
+ "oneof": [
2445
+ "errorMessage"
2446
+ ]
2447
+ },
2448
+ "_totalRowCount": {
2449
+ "oneof": [
2450
+ "totalRowCount"
2451
+ ]
2452
+ }
2453
+ },
2454
+ "fields": {
2455
+ "state": {
2456
+ "type": "State",
2457
+ "id": 1,
2458
+ "options": {
2459
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2460
+ "proto3_optional": true
2461
+ }
2462
+ },
2463
+ "beginCreatingTime": {
2464
+ "type": "google.protobuf.Timestamp",
2465
+ "id": 2,
2466
+ "options": {
2467
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2468
+ "proto3_optional": true
2469
+ }
2470
+ },
2471
+ "creationQuotaTokensCharged": {
2472
+ "type": "int32",
2473
+ "id": 3,
2474
+ "options": {
2475
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2476
+ }
2477
+ },
2478
+ "taskRowCount": {
2479
+ "type": "int32",
2480
+ "id": 4,
2481
+ "options": {
2482
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2483
+ "proto3_optional": true
2484
+ }
2485
+ },
2486
+ "errorMessage": {
2487
+ "type": "string",
2488
+ "id": 5,
2489
+ "options": {
2490
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2491
+ "proto3_optional": true
2492
+ }
2493
+ },
2494
+ "totalRowCount": {
2495
+ "type": "int32",
2496
+ "id": 6,
2497
+ "options": {
2498
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2499
+ "proto3_optional": true
2500
+ }
2501
+ }
2502
+ },
2503
+ "nested": {
2504
+ "State": {
2505
+ "values": {
2506
+ "STATE_UNSPECIFIED": 0,
2507
+ "CREATING": 1,
2508
+ "ACTIVE": 2,
2509
+ "FAILED": 3
2510
+ }
2511
+ }
2512
+ }
2513
+ }
2514
+ }
2515
+ },
2516
+ "CreateReportTaskRequest": {
2517
+ "fields": {
2518
+ "parent": {
2519
+ "type": "string",
2520
+ "id": 1,
2521
+ "options": {
2522
+ "(google.api.field_behavior)": "REQUIRED",
2523
+ "(google.api.resource_reference).child_type": "analyticsdata.googleapis.com/ReportTask"
2524
+ }
2525
+ },
2526
+ "reportTask": {
2527
+ "type": "ReportTask",
2528
+ "id": 2,
2529
+ "options": {
2530
+ "(google.api.field_behavior)": "REQUIRED"
2531
+ }
2532
+ }
2533
+ }
2534
+ },
2535
+ "ReportTaskMetadata": {
2536
+ "fields": {}
2537
+ },
2538
+ "QueryReportTaskRequest": {
2539
+ "fields": {
2540
+ "name": {
2541
+ "type": "string",
2542
+ "id": 1,
2543
+ "options": {
2544
+ "(google.api.field_behavior)": "REQUIRED"
2545
+ }
2546
+ },
2547
+ "offset": {
2548
+ "type": "int64",
2549
+ "id": 2,
2550
+ "options": {
2551
+ "(google.api.field_behavior)": "OPTIONAL"
2552
+ }
2553
+ },
2554
+ "limit": {
2555
+ "type": "int64",
2556
+ "id": 3,
2557
+ "options": {
2558
+ "(google.api.field_behavior)": "OPTIONAL"
2559
+ }
2560
+ }
2561
+ }
2562
+ },
2563
+ "QueryReportTaskResponse": {
2564
+ "fields": {
2565
+ "dimensionHeaders": {
2566
+ "rule": "repeated",
2567
+ "type": "DimensionHeader",
2568
+ "id": 1
2569
+ },
2570
+ "metricHeaders": {
2571
+ "rule": "repeated",
2572
+ "type": "MetricHeader",
2573
+ "id": 2
2574
+ },
2575
+ "rows": {
2576
+ "rule": "repeated",
2577
+ "type": "Row",
2578
+ "id": 3
2579
+ },
2580
+ "totals": {
2581
+ "rule": "repeated",
2582
+ "type": "Row",
2583
+ "id": 4
2584
+ },
2585
+ "maximums": {
2586
+ "rule": "repeated",
2587
+ "type": "Row",
2588
+ "id": 5
2589
+ },
2590
+ "minimums": {
2591
+ "rule": "repeated",
2592
+ "type": "Row",
2593
+ "id": 6
2594
+ },
2595
+ "rowCount": {
2596
+ "type": "int32",
2597
+ "id": 7
2598
+ },
2599
+ "metadata": {
2600
+ "type": "ResponseMetaData",
2601
+ "id": 8
2602
+ }
2603
+ }
2604
+ },
2605
+ "GetReportTaskRequest": {
2606
+ "fields": {
2607
+ "name": {
2608
+ "type": "string",
2609
+ "id": 1,
2610
+ "options": {
2611
+ "(google.api.field_behavior)": "REQUIRED",
2612
+ "(google.api.resource_reference).type": "analyticsdata.googleapis.com/ReportTask"
2613
+ }
2614
+ }
2615
+ }
2616
+ },
2617
+ "ListReportTasksRequest": {
2618
+ "fields": {
2619
+ "parent": {
2620
+ "type": "string",
2621
+ "id": 1,
2622
+ "options": {
2623
+ "(google.api.field_behavior)": "REQUIRED",
2624
+ "(google.api.resource_reference).child_type": "analyticsdata.googleapis.com/ReportTask"
2625
+ }
2626
+ },
2627
+ "pageSize": {
2628
+ "type": "int32",
2629
+ "id": 2,
2630
+ "options": {
2631
+ "(google.api.field_behavior)": "OPTIONAL"
2632
+ }
2633
+ },
2634
+ "pageToken": {
2635
+ "type": "string",
2636
+ "id": 3,
2637
+ "options": {
2638
+ "(google.api.field_behavior)": "OPTIONAL"
2639
+ }
2640
+ }
2641
+ }
2642
+ },
2643
+ "ListReportTasksResponse": {
2644
+ "oneofs": {
2645
+ "_nextPageToken": {
2646
+ "oneof": [
2647
+ "nextPageToken"
2648
+ ]
2649
+ }
2650
+ },
2651
+ "fields": {
2652
+ "reportTasks": {
2653
+ "rule": "repeated",
2654
+ "type": "ReportTask",
2655
+ "id": 1
2656
+ },
2657
+ "nextPageToken": {
2658
+ "type": "string",
2659
+ "id": 2,
2660
+ "options": {
2661
+ "proto3_optional": true
2662
+ }
2663
+ }
2664
+ }
2665
+ },
2218
2666
  "DateRange": {
2219
2667
  "fields": {
2220
2668
  "startDate": {
@@ -2291,6 +2739,22 @@
2291
2739
  }
2292
2740
  }
2293
2741
  },
2742
+ "Metric": {
2743
+ "fields": {
2744
+ "name": {
2745
+ "type": "string",
2746
+ "id": 1
2747
+ },
2748
+ "expression": {
2749
+ "type": "string",
2750
+ "id": 2
2751
+ },
2752
+ "invisible": {
2753
+ "type": "bool",
2754
+ "id": 3
2755
+ }
2756
+ }
2757
+ },
2294
2758
  "FilterExpression": {
2295
2759
  "oneofs": {
2296
2760
  "expr": {
@@ -2430,6 +2894,62 @@
2430
2894
  }
2431
2895
  }
2432
2896
  },
2897
+ "OrderBy": {
2898
+ "oneofs": {
2899
+ "oneOrderBy": {
2900
+ "oneof": [
2901
+ "metric",
2902
+ "dimension"
2903
+ ]
2904
+ }
2905
+ },
2906
+ "fields": {
2907
+ "metric": {
2908
+ "type": "MetricOrderBy",
2909
+ "id": 1
2910
+ },
2911
+ "dimension": {
2912
+ "type": "DimensionOrderBy",
2913
+ "id": 2
2914
+ },
2915
+ "desc": {
2916
+ "type": "bool",
2917
+ "id": 4
2918
+ }
2919
+ },
2920
+ "nested": {
2921
+ "MetricOrderBy": {
2922
+ "fields": {
2923
+ "metricName": {
2924
+ "type": "string",
2925
+ "id": 1
2926
+ }
2927
+ }
2928
+ },
2929
+ "DimensionOrderBy": {
2930
+ "fields": {
2931
+ "dimensionName": {
2932
+ "type": "string",
2933
+ "id": 1
2934
+ },
2935
+ "orderType": {
2936
+ "type": "OrderType",
2937
+ "id": 2
2938
+ }
2939
+ },
2940
+ "nested": {
2941
+ "OrderType": {
2942
+ "values": {
2943
+ "ORDER_TYPE_UNSPECIFIED": 0,
2944
+ "ALPHANUMERIC": 1,
2945
+ "CASE_INSENSITIVE_ALPHANUMERIC": 2,
2946
+ "NUMERIC": 3
2947
+ }
2948
+ }
2949
+ }
2950
+ }
2951
+ }
2952
+ },
2433
2953
  "BetweenFilter": {
2434
2954
  "fields": {
2435
2955
  "fromValue": {
@@ -2462,6 +2982,179 @@
2462
2982
  }
2463
2983
  }
2464
2984
  },
2985
+ "CohortSpec": {
2986
+ "fields": {
2987
+ "cohorts": {
2988
+ "rule": "repeated",
2989
+ "type": "Cohort",
2990
+ "id": 1
2991
+ },
2992
+ "cohortsRange": {
2993
+ "type": "CohortsRange",
2994
+ "id": 2
2995
+ },
2996
+ "cohortReportSettings": {
2997
+ "type": "CohortReportSettings",
2998
+ "id": 3
2999
+ }
3000
+ }
3001
+ },
3002
+ "Cohort": {
3003
+ "fields": {
3004
+ "name": {
3005
+ "type": "string",
3006
+ "id": 1
3007
+ },
3008
+ "dimension": {
3009
+ "type": "string",
3010
+ "id": 2
3011
+ },
3012
+ "dateRange": {
3013
+ "type": "DateRange",
3014
+ "id": 3
3015
+ }
3016
+ }
3017
+ },
3018
+ "CohortsRange": {
3019
+ "fields": {
3020
+ "granularity": {
3021
+ "type": "Granularity",
3022
+ "id": 1
3023
+ },
3024
+ "startOffset": {
3025
+ "type": "int32",
3026
+ "id": 2
3027
+ },
3028
+ "endOffset": {
3029
+ "type": "int32",
3030
+ "id": 3
3031
+ }
3032
+ },
3033
+ "nested": {
3034
+ "Granularity": {
3035
+ "values": {
3036
+ "GRANULARITY_UNSPECIFIED": 0,
3037
+ "DAILY": 1,
3038
+ "WEEKLY": 2,
3039
+ "MONTHLY": 3
3040
+ }
3041
+ }
3042
+ }
3043
+ },
3044
+ "CohortReportSettings": {
3045
+ "fields": {
3046
+ "accumulate": {
3047
+ "type": "bool",
3048
+ "id": 1
3049
+ }
3050
+ }
3051
+ },
3052
+ "ResponseMetaData": {
3053
+ "oneofs": {
3054
+ "_schemaRestrictionResponse": {
3055
+ "oneof": [
3056
+ "schemaRestrictionResponse"
3057
+ ]
3058
+ },
3059
+ "_currencyCode": {
3060
+ "oneof": [
3061
+ "currencyCode"
3062
+ ]
3063
+ },
3064
+ "_timeZone": {
3065
+ "oneof": [
3066
+ "timeZone"
3067
+ ]
3068
+ },
3069
+ "_emptyReason": {
3070
+ "oneof": [
3071
+ "emptyReason"
3072
+ ]
3073
+ },
3074
+ "_subjectToThresholding": {
3075
+ "oneof": [
3076
+ "subjectToThresholding"
3077
+ ]
3078
+ }
3079
+ },
3080
+ "fields": {
3081
+ "dataLossFromOtherRow": {
3082
+ "type": "bool",
3083
+ "id": 3
3084
+ },
3085
+ "schemaRestrictionResponse": {
3086
+ "type": "SchemaRestrictionResponse",
3087
+ "id": 4,
3088
+ "options": {
3089
+ "proto3_optional": true
3090
+ }
3091
+ },
3092
+ "currencyCode": {
3093
+ "type": "string",
3094
+ "id": 5,
3095
+ "options": {
3096
+ "proto3_optional": true
3097
+ }
3098
+ },
3099
+ "timeZone": {
3100
+ "type": "string",
3101
+ "id": 6,
3102
+ "options": {
3103
+ "proto3_optional": true
3104
+ }
3105
+ },
3106
+ "emptyReason": {
3107
+ "type": "string",
3108
+ "id": 7,
3109
+ "options": {
3110
+ "proto3_optional": true
3111
+ }
3112
+ },
3113
+ "subjectToThresholding": {
3114
+ "type": "bool",
3115
+ "id": 8,
3116
+ "options": {
3117
+ "proto3_optional": true
3118
+ }
3119
+ }
3120
+ },
3121
+ "nested": {
3122
+ "SchemaRestrictionResponse": {
3123
+ "fields": {
3124
+ "activeMetricRestrictions": {
3125
+ "rule": "repeated",
3126
+ "type": "ActiveMetricRestriction",
3127
+ "id": 1
3128
+ }
3129
+ },
3130
+ "nested": {
3131
+ "ActiveMetricRestriction": {
3132
+ "oneofs": {
3133
+ "_metricName": {
3134
+ "oneof": [
3135
+ "metricName"
3136
+ ]
3137
+ }
3138
+ },
3139
+ "fields": {
3140
+ "metricName": {
3141
+ "type": "string",
3142
+ "id": 1,
3143
+ "options": {
3144
+ "proto3_optional": true
3145
+ }
3146
+ },
3147
+ "restrictedMetricTypes": {
3148
+ "rule": "repeated",
3149
+ "type": "RestrictedMetricType",
3150
+ "id": 2
3151
+ }
3152
+ }
3153
+ }
3154
+ }
3155
+ }
3156
+ }
3157
+ },
2465
3158
  "DimensionHeader": {
2466
3159
  "fields": {
2467
3160
  "name": {
@@ -3366,6 +4059,15 @@
3366
4059
  }
3367
4060
  }
3368
4061
  },
4062
+ "MetricAggregation": {
4063
+ "values": {
4064
+ "METRIC_AGGREGATION_UNSPECIFIED": 0,
4065
+ "TOTAL": 1,
4066
+ "MINIMUM": 5,
4067
+ "MAXIMUM": 6,
4068
+ "COUNT": 4
4069
+ }
4070
+ },
3369
4071
  "MetricType": {
3370
4072
  "values": {
3371
4073
  "METRIC_TYPE_UNSPECIFIED": 0,
@@ -3382,6 +4084,13 @@
3382
4084
  "TYPE_METERS": 12,
3383
4085
  "TYPE_KILOMETERS": 13
3384
4086
  }
4087
+ },
4088
+ "RestrictedMetricType": {
4089
+ "values": {
4090
+ "RESTRICTED_METRIC_TYPE_UNSPECIFIED": 0,
4091
+ "COST_DATA": 1,
4092
+ "REVENUE_DATA": 2
4093
+ }
3385
4094
  }
3386
4095
  }
3387
4096
  },