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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740
// This file is @generated by prost-build.
/// A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
/// Requests are allowed up to 4 date ranges.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DateRange {
/// The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
/// be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
/// accepted, and in that case, the date is inferred based on the property's
/// reporting time zone.
#[prost(string, tag = "1")]
pub start_date: ::prost::alloc::string::String,
/// The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot
/// be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is
/// also accepted, and in that case, the date is inferred based on the
/// property's reporting time zone.
#[prost(string, tag = "2")]
pub end_date: ::prost::alloc::string::String,
/// Assigns a name to this date range. The dimension `dateRange` is valued to
/// this name in a report response. If set, cannot begin with `date_range_` or
/// `RESERVED_`. If not set, date ranges are named by their zero based index in
/// the request: `date_range_0`, `date_range_1`, etc.
#[prost(string, tag = "3")]
pub name: ::prost::alloc::string::String,
}
/// Dimensions are attributes of your data. For example, the dimension city
/// indicates the city from which an event originates. Dimension values in report
/// responses are strings; for example, the city could be "Paris" or "New York".
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Dimension {
/// The name of the dimension. See the [API
/// Dimensions](<https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions>)
/// for the list of dimension names supported by core reporting methods such
/// as `runReport` and `batchRunReports`. See
/// [Realtime
/// Dimensions](<https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions>)
/// for the list of dimension names supported by the `runRealtimeReport`
/// method. See
/// [Funnel
/// Dimensions](<https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions>)
/// for the list of dimension names supported by the `runFunnelReport`
/// method.
///
/// If `dimensionExpression` is specified, `name` can be any string that you
/// would like within the allowed character set. For example if a
/// `dimensionExpression` concatenates `country` and `city`, you could call
/// that dimension `countryAndCity`. Dimension names that you choose must match
/// the regular expression `^\[a-zA-Z0-9_\]$`.
///
/// Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
/// `dimensionExpression`, and `pivots`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// One dimension can be the result of an expression of multiple dimensions.
/// For example, dimension "country, city": concatenate(country, ", ", city).
#[prost(message, optional, tag = "2")]
pub dimension_expression: ::core::option::Option<DimensionExpression>,
}
/// Used to express a dimension which is the result of a formula of multiple
/// dimensions. Example usages:
/// 1) lower_case(dimension)
/// 2) concatenate(dimension1, symbol, dimension2).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DimensionExpression {
/// Specify one type of dimension expression for `DimensionExpression`.
#[prost(oneof = "dimension_expression::OneExpression", tags = "4, 5, 6")]
pub one_expression: ::core::option::Option<dimension_expression::OneExpression>,
}
/// Nested message and enum types in `DimensionExpression`.
pub mod dimension_expression {
/// Used to convert a dimension value to a single case.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CaseExpression {
/// Name of a dimension. The name must refer back to a name in dimensions
/// field of the request.
#[prost(string, tag = "1")]
pub dimension_name: ::prost::alloc::string::String,
}
/// Used to combine dimension values to a single dimension.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ConcatenateExpression {
/// Names of dimensions. The names must refer back to names in the dimensions
/// field of the request.
#[prost(string, repeated, tag = "1")]
pub dimension_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The delimiter placed between dimension names.
///
/// Delimiters are often single characters such as "|" or "," but can be
/// longer strings. If a dimension value contains the delimiter, both will be
/// present in response with no distinction. For example if dimension 1 value
/// = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the
/// response will contain "US,FR,JP".
#[prost(string, tag = "2")]
pub delimiter: ::prost::alloc::string::String,
}
/// Specify one type of dimension expression for `DimensionExpression`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneExpression {
/// Used to convert a dimension value to lower case.
#[prost(message, tag = "4")]
LowerCase(CaseExpression),
/// Used to convert a dimension value to upper case.
#[prost(message, tag = "5")]
UpperCase(CaseExpression),
/// Used to combine dimension values to a single dimension.
/// For example, dimension "country, city": concatenate(country, ", ", city).
#[prost(message, tag = "6")]
Concatenate(ConcatenateExpression),
}
}
/// The quantitative measurements of a report. For example, the metric
/// `eventCount` is the total number of events. Requests are allowed up to 10
/// metrics.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Metric {
/// The name of the metric. See the [API
/// Metrics](<https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics>)
/// for the list of metric names supported by core reporting methods such
/// as `runReport` and `batchRunReports`. See
/// [Realtime
/// Metrics](<https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics>)
/// for the list of metric names supported by the `runRealtimeReport`
/// method. See
/// [Funnel
/// Metrics](<https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics>)
/// for the list of metric names supported by the `runFunnelReport`
/// method.
///
/// If `expression` is specified, `name` can be any string that you would like
/// within the allowed character set. For example if `expression` is
/// `screenPageViews/sessions`, you could call that metric's name =
/// `viewsPerSession`. Metric names that you choose must match the regular
/// expression `^\[a-zA-Z0-9_\]$`.
///
/// Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
/// `expression`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// A mathematical expression for derived metrics. For example, the metric
/// Event count per user is `eventCount/totalUsers`.
#[prost(string, tag = "2")]
pub expression: ::prost::alloc::string::String,
/// Indicates if a metric is invisible in the report response. If a metric is
/// invisible, the metric will not produce a column in the response, but can be
/// used in `metricFilter`, `orderBys`, or a metric `expression`.
#[prost(bool, tag = "3")]
pub invisible: bool,
}
/// To express dimension or metric filters. The fields in the same
/// FilterExpression need to be either all dimensions or all metrics.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FilterExpression {
/// Specify one type of filter expression for `FilterExpression`.
#[prost(oneof = "filter_expression::Expr", tags = "1, 2, 3, 4")]
pub expr: ::core::option::Option<filter_expression::Expr>,
}
/// Nested message and enum types in `FilterExpression`.
pub mod filter_expression {
/// Specify one type of filter expression for `FilterExpression`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Expr {
/// The FilterExpressions in and_group have an AND relationship.
#[prost(message, tag = "1")]
AndGroup(super::FilterExpressionList),
/// The FilterExpressions in or_group have an OR relationship.
#[prost(message, tag = "2")]
OrGroup(super::FilterExpressionList),
/// The FilterExpression is NOT of not_expression.
#[prost(message, tag = "3")]
NotExpression(::prost::alloc::boxed::Box<super::FilterExpression>),
/// A primitive filter. In the same FilterExpression, all of the filter's
/// field names need to be either all dimensions or all metrics.
#[prost(message, tag = "4")]
Filter(super::Filter),
}
}
/// A list of filter expressions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FilterExpressionList {
/// A list of filter expressions.
#[prost(message, repeated, tag = "1")]
pub expressions: ::prost::alloc::vec::Vec<FilterExpression>,
}
/// An expression to filter dimension or metric values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Filter {
/// The dimension name or metric name. Must be a name defined in dimensions
/// or metrics.
#[prost(string, tag = "1")]
pub field_name: ::prost::alloc::string::String,
/// Specify one type of filter for `Filter`.
#[prost(oneof = "filter::OneFilter", tags = "2, 3, 4, 5")]
pub one_filter: ::core::option::Option<filter::OneFilter>,
}
/// Nested message and enum types in `Filter`.
pub mod filter {
/// Specify one type of filter for `Filter`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneFilter {
/// Strings related filter.
#[prost(message, tag = "2")]
StringFilter(super::StringFilter),
/// A filter for in list values.
#[prost(message, tag = "3")]
InListFilter(super::InListFilter),
/// A filter for numeric or date values.
#[prost(message, tag = "4")]
NumericFilter(super::NumericFilter),
/// A filter for between two values.
#[prost(message, tag = "5")]
BetweenFilter(super::BetweenFilter),
}
}
/// The filter for string
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StringFilter {
/// The match type for this filter.
#[prost(enumeration = "string_filter::MatchType", tag = "1")]
pub match_type: i32,
/// The string value used for the matching.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
/// If true, the string value is case sensitive.
#[prost(bool, tag = "3")]
pub case_sensitive: bool,
}
/// Nested message and enum types in `StringFilter`.
pub mod string_filter {
/// The match type of a string filter
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MatchType {
/// Unspecified
Unspecified = 0,
/// Exact match of the string value.
Exact = 1,
/// Begins with the string value.
BeginsWith = 2,
/// Ends with the string value.
EndsWith = 3,
/// Contains the string value.
Contains = 4,
/// Full match for the regular expression with the string value.
FullRegexp = 5,
/// Partial match for the regular expression with the string value.
PartialRegexp = 6,
}
impl MatchType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
MatchType::Unspecified => "MATCH_TYPE_UNSPECIFIED",
MatchType::Exact => "EXACT",
MatchType::BeginsWith => "BEGINS_WITH",
MatchType::EndsWith => "ENDS_WITH",
MatchType::Contains => "CONTAINS",
MatchType::FullRegexp => "FULL_REGEXP",
MatchType::PartialRegexp => "PARTIAL_REGEXP",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MATCH_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"EXACT" => Some(Self::Exact),
"BEGINS_WITH" => Some(Self::BeginsWith),
"ENDS_WITH" => Some(Self::EndsWith),
"CONTAINS" => Some(Self::Contains),
"FULL_REGEXP" => Some(Self::FullRegexp),
"PARTIAL_REGEXP" => Some(Self::PartialRegexp),
_ => None,
}
}
}
}
/// The result needs to be in a list of string values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InListFilter {
/// The list of string values.
/// Must be non-empty.
#[prost(string, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// If true, the string value is case sensitive.
#[prost(bool, tag = "2")]
pub case_sensitive: bool,
}
/// Filters for numeric or date values.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NumericFilter {
/// The operation type for this filter.
#[prost(enumeration = "numeric_filter::Operation", tag = "1")]
pub operation: i32,
/// A numeric value or a date value.
#[prost(message, optional, tag = "2")]
pub value: ::core::option::Option<NumericValue>,
}
/// Nested message and enum types in `NumericFilter`.
pub mod numeric_filter {
/// The operation applied to a numeric filter
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Operation {
/// Unspecified.
Unspecified = 0,
/// Equal
Equal = 1,
/// Less than
LessThan = 2,
/// Less than or equal
LessThanOrEqual = 3,
/// Greater than
GreaterThan = 4,
/// Greater than or equal
GreaterThanOrEqual = 5,
}
impl Operation {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Operation::Unspecified => "OPERATION_UNSPECIFIED",
Operation::Equal => "EQUAL",
Operation::LessThan => "LESS_THAN",
Operation::LessThanOrEqual => "LESS_THAN_OR_EQUAL",
Operation::GreaterThan => "GREATER_THAN",
Operation::GreaterThanOrEqual => "GREATER_THAN_OR_EQUAL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATION_UNSPECIFIED" => Some(Self::Unspecified),
"EQUAL" => Some(Self::Equal),
"LESS_THAN" => Some(Self::LessThan),
"LESS_THAN_OR_EQUAL" => Some(Self::LessThanOrEqual),
"GREATER_THAN" => Some(Self::GreaterThan),
"GREATER_THAN_OR_EQUAL" => Some(Self::GreaterThanOrEqual),
_ => None,
}
}
}
}
/// Order bys define how rows will be sorted in the response. For example,
/// ordering rows by descending event count is one ordering, and ordering rows by
/// the event name string is a different ordering.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OrderBy {
/// If true, sorts by descending order.
#[prost(bool, tag = "4")]
pub desc: bool,
/// Specify one type of order by for `OrderBy`.
#[prost(oneof = "order_by::OneOrderBy", tags = "1, 2")]
pub one_order_by: ::core::option::Option<order_by::OneOrderBy>,
}
/// Nested message and enum types in `OrderBy`.
pub mod order_by {
/// Sorts by metric values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricOrderBy {
/// A metric name in the request to order by.
#[prost(string, tag = "1")]
pub metric_name: ::prost::alloc::string::String,
}
/// Sorts by dimension values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DimensionOrderBy {
/// A dimension name in the request to order by.
#[prost(string, tag = "1")]
pub dimension_name: ::prost::alloc::string::String,
/// Controls the rule for dimension value ordering.
#[prost(enumeration = "dimension_order_by::OrderType", tag = "2")]
pub order_type: i32,
}
/// Nested message and enum types in `DimensionOrderBy`.
pub mod dimension_order_by {
/// Rule to order the string dimension values by.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum OrderType {
/// Unspecified.
Unspecified = 0,
/// Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
/// "b" < "z".
Alphanumeric = 1,
/// Case insensitive alphanumeric sort by lower case Unicode code point.
/// For example, "2" < "A" < "b" < "X" < "z".
CaseInsensitiveAlphanumeric = 2,
/// Dimension values are converted to numbers before sorting. For example
/// in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
/// "25". Non-numeric dimension values all have equal ordering value below
/// all numeric values.
Numeric = 3,
}
impl OrderType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
OrderType::Unspecified => "ORDER_TYPE_UNSPECIFIED",
OrderType::Alphanumeric => "ALPHANUMERIC",
OrderType::CaseInsensitiveAlphanumeric => {
"CASE_INSENSITIVE_ALPHANUMERIC"
}
OrderType::Numeric => "NUMERIC",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ORDER_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"ALPHANUMERIC" => Some(Self::Alphanumeric),
"CASE_INSENSITIVE_ALPHANUMERIC" => {
Some(Self::CaseInsensitiveAlphanumeric)
}
"NUMERIC" => Some(Self::Numeric),
_ => None,
}
}
}
}
/// Specify one type of order by for `OrderBy`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneOrderBy {
/// Sorts results by a metric's values.
#[prost(message, tag = "1")]
Metric(MetricOrderBy),
/// Sorts results by a dimension's values.
#[prost(message, tag = "2")]
Dimension(DimensionOrderBy),
}
}
/// To express that the result needs to be between two numbers (inclusive).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BetweenFilter {
/// Begins with this number.
#[prost(message, optional, tag = "1")]
pub from_value: ::core::option::Option<NumericValue>,
/// Ends with this number.
#[prost(message, optional, tag = "2")]
pub to_value: ::core::option::Option<NumericValue>,
}
/// To represent a number.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NumericValue {
/// One of a numeric value
#[prost(oneof = "numeric_value::OneValue", tags = "1, 2")]
pub one_value: ::core::option::Option<numeric_value::OneValue>,
}
/// Nested message and enum types in `NumericValue`.
pub mod numeric_value {
/// One of a numeric value
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum OneValue {
/// Integer value
#[prost(int64, tag = "1")]
Int64Value(i64),
/// Double value
#[prost(double, tag = "2")]
DoubleValue(f64),
}
}
/// The specification of cohorts for a cohort report.
///
/// Cohort reports create a time series of user retention for the cohort. For
/// example, you could select the cohort of users that were acquired in the first
/// week of September and follow that cohort for the next six weeks. Selecting
/// the users acquired in the first week of September cohort is specified in the
/// `cohort` object. Following that cohort for the next six weeks is specified in
/// the `cohortsRange` object.
///
/// For examples, see [Cohort Report
/// Examples](<https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples>).
///
/// The report response could show a weekly time series where say your app has
/// retained 60% of this cohort after three weeks and 25% of this cohort after
/// six weeks. These two percentages can be calculated by the metric
/// `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CohortSpec {
/// Defines the selection criteria to group users into cohorts.
///
/// Most cohort reports define only a single cohort. If multiple cohorts are
/// specified, each cohort can be recognized in the report by their name.
#[prost(message, repeated, tag = "1")]
pub cohorts: ::prost::alloc::vec::Vec<Cohort>,
/// Cohort reports follow cohorts over an extended reporting date range. This
/// range specifies an offset duration to follow the cohorts over.
#[prost(message, optional, tag = "2")]
pub cohorts_range: ::core::option::Option<CohortsRange>,
/// Optional settings for a cohort report.
#[prost(message, optional, tag = "3")]
pub cohort_report_settings: ::core::option::Option<CohortReportSettings>,
}
/// Defines a cohort selection criteria. A cohort is a group of users who share
/// a common characteristic. For example, users with the same `firstSessionDate`
/// belong to the same cohort.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Cohort {
/// Assigns a name to this cohort. The dimension `cohort` is valued to this
/// name in a report response. If set, cannot begin with `cohort_` or
/// `RESERVED_`. If not set, cohorts are named by their zero based index
/// `cohort_0`, `cohort_1`, etc.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Dimension used by the cohort. Required and only supports
/// `firstSessionDate`.
#[prost(string, tag = "2")]
pub dimension: ::prost::alloc::string::String,
/// The cohort selects users whose first touch date is between start date and
/// end date defined in the `dateRange`. This `dateRange` does not specify the
/// full date range of event data that is present in a cohort report. In a
/// cohort report, this `dateRange` is extended by the granularity and offset
/// present in the `cohortsRange`; event data for the extended reporting date
/// range is present in a cohort report.
///
/// In a cohort request, this `dateRange` is required and the `dateRanges` in
/// the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
///
/// This `dateRange` should generally be aligned with the cohort's granularity.
/// If `CohortsRange` uses daily granularity, this `dateRange` can be a single
/// day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
/// aligned to a week boundary, starting at Sunday and ending Saturday. If
/// `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
/// a month, starting at the first and ending on the last day of the month.
#[prost(message, optional, tag = "3")]
pub date_range: ::core::option::Option<DateRange>,
}
/// Configures the extended reporting date range for a cohort report. Specifies
/// an offset duration to follow the cohorts over.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CohortsRange {
/// Required. The granularity used to interpret the `startOffset` and
/// `endOffset` for the extended reporting date range for a cohort report.
#[prost(enumeration = "cohorts_range::Granularity", tag = "1")]
pub granularity: i32,
/// `startOffset` specifies the start date of the extended reporting date range
/// for a cohort report. `startOffset` is commonly set to 0 so that reports
/// contain data from the acquisition of the cohort forward.
///
/// If `granularity` is `DAILY`, the `startDate` of the extended reporting date
/// range is `startDate` of the cohort plus `startOffset` days.
///
/// If `granularity` is `WEEKLY`, the `startDate` of the extended reporting
/// date range is `startDate` of the cohort plus `startOffset * 7` days.
///
/// If `granularity` is `MONTHLY`, the `startDate` of the extended reporting
/// date range is `startDate` of the cohort plus `startOffset * 30` days.
#[prost(int32, tag = "2")]
pub start_offset: i32,
/// Required. `endOffset` specifies the end date of the extended reporting date
/// range for a cohort report. `endOffset` can be any positive integer but is
/// commonly set to 5 to 10 so that reports contain data on the cohort for the
/// next several granularity time periods.
///
/// If `granularity` is `DAILY`, the `endDate` of the extended reporting date
/// range is `endDate` of the cohort plus `endOffset` days.
///
/// If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date
/// range is `endDate` of the cohort plus `endOffset * 7` days.
///
/// If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date
/// range is `endDate` of the cohort plus `endOffset * 30` days.
#[prost(int32, tag = "3")]
pub end_offset: i32,
}
/// Nested message and enum types in `CohortsRange`.
pub mod cohorts_range {
/// The granularity used to interpret the `startOffset` and `endOffset` for the
/// extended reporting date range for a cohort report.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Granularity {
/// Should never be specified.
Unspecified = 0,
/// Daily granularity. Commonly used if the cohort's `dateRange` is a single
/// day and the request contains `cohortNthDay`.
Daily = 1,
/// Weekly granularity. Commonly used if the cohort's `dateRange` is a week
/// in duration (starting on Sunday and ending on Saturday) and the request
/// contains `cohortNthWeek`.
Weekly = 2,
/// Monthly granularity. Commonly used if the cohort's `dateRange` is a month
/// in duration and the request contains `cohortNthMonth`.
Monthly = 3,
}
impl Granularity {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Granularity::Unspecified => "GRANULARITY_UNSPECIFIED",
Granularity::Daily => "DAILY",
Granularity::Weekly => "WEEKLY",
Granularity::Monthly => "MONTHLY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"GRANULARITY_UNSPECIFIED" => Some(Self::Unspecified),
"DAILY" => Some(Self::Daily),
"WEEKLY" => Some(Self::Weekly),
"MONTHLY" => Some(Self::Monthly),
_ => None,
}
}
}
}
/// Optional settings of a cohort report.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CohortReportSettings {
/// If true, accumulates the result from first touch day to the end day. Not
/// supported in `RunReportRequest`.
#[prost(bool, tag = "1")]
pub accumulate: bool,
}
/// Response's metadata carrying additional information about the report content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResponseMetaData {
/// If true, indicates some buckets of dimension combinations are rolled into
/// "(other)" row. This can happen for high cardinality reports.
///
/// The metadata parameter dataLossFromOtherRow is populated based on the
/// aggregated data table used in the report. The parameter will be accurately
/// populated regardless of the filters and limits in the report.
///
/// For example, the (other) row could be dropped from the report because the
/// request contains a filter on sessionSource = google. This parameter will
/// still be populated if data loss from other row was present in the input
/// aggregate data used to generate this report.
///
/// To learn more, see [About the (other) row and data
/// sampling](<https://support.google.com/analytics/answer/13208658#reports>).
#[prost(bool, tag = "3")]
pub data_loss_from_other_row: bool,
/// Describes the schema restrictions actively enforced in creating this
/// report. To learn more, see [Access and data-restriction
/// management](<https://support.google.com/analytics/answer/10851388>).
#[prost(message, optional, tag = "4")]
pub schema_restriction_response: ::core::option::Option<
response_meta_data::SchemaRestrictionResponse,
>,
/// The currency code used in this report. Intended to be used in formatting
/// currency metrics like `purchaseRevenue` for visualization. If currency_code
/// was specified in the request, this response parameter will echo the request
/// parameter; otherwise, this response parameter is the property's current
/// currency_code.
///
/// Currency codes are string encodings of currency types from the ISO 4217
/// standard (<https://en.wikipedia.org/wiki/ISO_4217>); for example "USD",
/// "EUR", "JPY". To learn more, see
/// <https://support.google.com/analytics/answer/9796179.>
#[prost(string, optional, tag = "5")]
pub currency_code: ::core::option::Option<::prost::alloc::string::String>,
/// The property's current timezone. Intended to be used to interpret
/// time-based dimensions like `hour` and `minute`. Formatted as strings from
/// the IANA Time Zone database (<https://www.iana.org/time-zones>); for example
/// "America/New_York" or "Asia/Tokyo".
#[prost(string, optional, tag = "6")]
pub time_zone: ::core::option::Option<::prost::alloc::string::String>,
/// If empty reason is specified, the report is empty for this reason.
#[prost(string, optional, tag = "7")]
pub empty_reason: ::core::option::Option<::prost::alloc::string::String>,
/// If `subjectToThresholding` is true, this report is subject to thresholding
/// and only returns data that meets the minimum aggregation thresholds. It is
/// possible for a request to be subject to thresholding thresholding and no
/// data is absent from the report, and this happens when all data is above the
/// thresholds. To learn more, see [Data
/// thresholds](<https://support.google.com/analytics/answer/9383630>) and [About
/// Demographics and
/// Interests](<https://support.google.com/analytics/answer/2799357>).
#[prost(bool, optional, tag = "8")]
pub subject_to_thresholding: ::core::option::Option<bool>,
}
/// Nested message and enum types in `ResponseMetaData`.
pub mod response_meta_data {
/// The schema restrictions actively enforced in creating this report. To learn
/// more, see [Access and data-restriction
/// management](<https://support.google.com/analytics/answer/10851388>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SchemaRestrictionResponse {
/// All restrictions actively enforced in creating the report. For example,
/// `purchaseRevenue` always has the restriction type `REVENUE_DATA`.
/// However, this active response restriction is only populated if the user's
/// custom role disallows access to `REVENUE_DATA`.
#[prost(message, repeated, tag = "1")]
pub active_metric_restrictions: ::prost::alloc::vec::Vec<
schema_restriction_response::ActiveMetricRestriction,
>,
}
/// Nested message and enum types in `SchemaRestrictionResponse`.
pub mod schema_restriction_response {
/// A metric actively restricted in creating the report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActiveMetricRestriction {
/// The name of the restricted metric.
#[prost(string, optional, tag = "1")]
pub metric_name: ::core::option::Option<::prost::alloc::string::String>,
/// The reason for this metric's restriction.
#[prost(
enumeration = "super::super::RestrictedMetricType",
repeated,
tag = "2"
)]
pub restricted_metric_types: ::prost::alloc::vec::Vec<i32>,
}
}
}
/// Describes a dimension column in the report. Dimensions requested in a report
/// produce column entries within rows and DimensionHeaders. However, dimensions
/// used exclusively within filters or expressions do not produce columns in a
/// report; correspondingly, those dimensions do not produce headers.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DimensionHeader {
/// The dimension's name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Describes a metric column in the report. Visible metrics requested in a
/// report produce column entries within rows and MetricHeaders. However,
/// metrics used exclusively within filters or expressions do not produce columns
/// in a report; correspondingly, those metrics do not produce headers.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricHeader {
/// The metric's name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The metric's data type.
#[prost(enumeration = "MetricType", tag = "2")]
pub r#type: i32,
}
/// Report data for each row.
/// For example if RunReportRequest contains:
///
/// ```none
/// "dimensions": [
/// {
/// "name": "eventName"
/// },
/// {
/// "name": "countryId"
/// }
/// ],
/// "metrics": [
/// {
/// "name": "eventCount"
/// }
/// ]
/// ```
///
/// One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and
/// 15 as the eventCount, would be:
///
/// ```none
/// "dimensionValues": [
/// {
/// "value": "in_app_purchase"
/// },
/// {
/// "value": "JP"
/// }
/// ],
/// "metricValues": [
/// {
/// "value": "15"
/// }
/// ]
/// ```
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Row {
/// List of requested dimension values. In a PivotReport, dimension_values
/// are only listed for dimensions included in a pivot.
#[prost(message, repeated, tag = "1")]
pub dimension_values: ::prost::alloc::vec::Vec<DimensionValue>,
/// List of requested visible metric values.
#[prost(message, repeated, tag = "2")]
pub metric_values: ::prost::alloc::vec::Vec<MetricValue>,
}
/// The value of a dimension.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DimensionValue {
/// One kind of dimension value
#[prost(oneof = "dimension_value::OneValue", tags = "1")]
pub one_value: ::core::option::Option<dimension_value::OneValue>,
}
/// Nested message and enum types in `DimensionValue`.
pub mod dimension_value {
/// One kind of dimension value
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneValue {
/// Value as a string if the dimension type is a string.
#[prost(string, tag = "1")]
Value(::prost::alloc::string::String),
}
}
/// The value of a metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricValue {
/// One of metric value
#[prost(oneof = "metric_value::OneValue", tags = "4")]
pub one_value: ::core::option::Option<metric_value::OneValue>,
}
/// Nested message and enum types in `MetricValue`.
pub mod metric_value {
/// One of metric value
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneValue {
/// Measurement value. See MetricHeader for type.
#[prost(string, tag = "4")]
Value(::prost::alloc::string::String),
}
}
/// Current state of all quotas for this Analytics Property. If any quota for a
/// property is exhausted, all requests to that property will return Resource
/// Exhausted errors.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PropertyQuota {
/// Standard Analytics Properties can use up to 200,000 tokens per day;
/// Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
/// consume fewer than 10 tokens.
#[prost(message, optional, tag = "1")]
pub tokens_per_day: ::core::option::Option<QuotaStatus>,
/// Standard Analytics Properties can use up to 40,000 tokens per hour;
/// Analytics 360 Properties can use 400,000 tokens per hour. An API request
/// consumes a single number of tokens, and that number is deducted from all of
/// the hourly, daily, and per project hourly quotas.
#[prost(message, optional, tag = "2")]
pub tokens_per_hour: ::core::option::Option<QuotaStatus>,
/// Standard Analytics Properties can send up to 10 concurrent requests;
/// Analytics 360 Properties can use up to 50 concurrent requests.
#[prost(message, optional, tag = "3")]
pub concurrent_requests: ::core::option::Option<QuotaStatus>,
/// Standard Analytics Properties and cloud project pairs can have up to 10
/// server errors per hour; Analytics 360 Properties and cloud project pairs
/// can have up to 50 server errors per hour.
#[prost(message, optional, tag = "4")]
pub server_errors_per_project_per_hour: ::core::option::Option<QuotaStatus>,
/// Analytics Properties can send up to 120 requests with potentially
/// thresholded dimensions per hour. In a batch request, each report request
/// is individually counted for this quota if the request contains potentially
/// thresholded dimensions.
#[prost(message, optional, tag = "5")]
pub potentially_thresholded_requests_per_hour: ::core::option::Option<QuotaStatus>,
/// Analytics Properties can use up to 35% of their tokens per project per
/// hour. This amounts to standard Analytics Properties can use up to 14,000
/// tokens per project per hour, and Analytics 360 Properties can use 140,000
/// tokens per project per hour. An API request consumes a single number of
/// tokens, and that number is deducted from all of the hourly, daily, and per
/// project hourly quotas.
#[prost(message, optional, tag = "6")]
pub tokens_per_project_per_hour: ::core::option::Option<QuotaStatus>,
}
/// Current state for a particular quota group.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct QuotaStatus {
/// Quota consumed by this request.
#[prost(int32, tag = "1")]
pub consumed: i32,
/// Quota remaining after this request.
#[prost(int32, tag = "2")]
pub remaining: i32,
}
/// Breakdowns add a dimension to the funnel table sub report response.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelBreakdown {
/// The dimension column added to the funnel table sub report response. The
/// breakdown dimension breaks down each funnel step. A valid
/// `breakdownDimension` is required if `funnelBreakdown` is specified.
#[prost(message, optional, tag = "1")]
pub breakdown_dimension: ::core::option::Option<Dimension>,
/// The maximum number of distinct values of the breakdown dimension to return
/// in the response. A `limit` of `5` is used if limit is not specified. Limit
/// must exceed zero and cannot exceed 15.
#[prost(int64, optional, tag = "2")]
pub limit: ::core::option::Option<i64>,
}
/// Next actions state the value for a dimension after the user has achieved
/// a step but before the same user has achieved the next step. For example if
/// the `nextActionDimension` is `eventName`, then `nextActionDimension` in the
/// `i`th funnel step row will return first event after the event that qualified
/// the user into the `i`th funnel step but before the user achieved the `i+1`th
/// funnel step.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelNextAction {
/// The dimension column added to the funnel visualization sub report response.
/// The next action dimension returns the next dimension value of this
/// dimension after the user has attained the `i`th funnel step.
///
/// `nextActionDimension` currently only supports `eventName` and most Page /
/// Screen dimensions like `pageTitle` and `pagePath`. `nextActionDimension`
/// cannot be a dimension expression.
#[prost(message, optional, tag = "1")]
pub next_action_dimension: ::core::option::Option<Dimension>,
/// The maximum number of distinct values of the breakdown dimension to return
/// in the response. A `limit` of `5` is used if limit is not specified. Limit
/// must exceed zero and cannot exceed 5.
#[prost(int64, optional, tag = "2")]
pub limit: ::core::option::Option<i64>,
}
/// Configures the funnel in a funnel report request. A funnel reports on users
/// as they pass through a sequence of steps.
///
/// Funnel exploration lets you visualize the steps your users take to complete a
/// task and quickly see how well they are succeeding or failing at each step.
/// For example, how do prospects become shoppers and then become buyers? How do
/// one time buyers become repeat buyers? With this information, you can improve
/// inefficient or abandoned customer journeys.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Funnel {
/// In an open funnel, users can enter the funnel in any step, and in a closed
/// funnel, users must enter the funnel in the first step. Optional. If
/// unspecified, a closed funnel is used.
#[prost(bool, tag = "1")]
pub is_open_funnel: bool,
/// The sequential steps of this funnel.
#[prost(message, repeated, tag = "2")]
pub steps: ::prost::alloc::vec::Vec<FunnelStep>,
}
/// Steps define the user journey you want to measure. Steps contain one or
/// more conditions that your users must meet to be included in that step of
/// the funnel journey.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelStep {
/// The distinctive name for this step. If unspecified, steps will be named
/// by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
/// defines string value returned by the `funnelStepName` dimension. For
/// example, specifying `name = Purchase` in the request's third funnel step
/// will produce `3. Purchase` in the funnel report response.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If true, this step must directly follow the previous step. If false,
/// there can be events between the previous step and this step. If
/// unspecified, `isDirectlyFollowedBy` is treated as false.
#[prost(bool, tag = "2")]
pub is_directly_followed_by: bool,
/// If specified, this step must complete within this duration of the
/// completion of the prior step. `withinDurationFromPriorStep` is inclusive
/// of the endpoint at the microsecond granularity. For example a duration of
/// 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
/// microsecond.
///
/// `withinDurationFromPriorStep` is optional, and if unspecified, steps may
/// be separated by any time duration.
#[prost(message, optional, tag = "3")]
pub within_duration_from_prior_step: ::core::option::Option<::prost_types::Duration>,
/// The condition that your users must meet to be included in this step of
/// the funnel journey.
#[prost(message, optional, tag = "4")]
pub filter_expression: ::core::option::Option<FunnelFilterExpression>,
}
/// Funnel sub reports contain the dimension and metric data values. For example,
/// 12 users reached the second step of the funnel.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelSubReport {
/// Describes dimension columns. Funnel reports always include the funnel step
/// dimension in sub report responses. Additional dimensions like breakdowns,
/// dates, and next actions may be present in the response if requested.
#[prost(message, repeated, tag = "1")]
pub dimension_headers: ::prost::alloc::vec::Vec<DimensionHeader>,
/// Describes metric columns. Funnel reports always include active users in sub
/// report responses. The funnel table includes additional metrics like
/// completion rate, abandonments, and abandonments rate.
#[prost(message, repeated, tag = "2")]
pub metric_headers: ::prost::alloc::vec::Vec<MetricHeader>,
/// Rows of dimension value combinations and metric values in the report.
#[prost(message, repeated, tag = "3")]
pub rows: ::prost::alloc::vec::Vec<Row>,
/// Metadata for the funnel report.
#[prost(message, optional, tag = "4")]
pub metadata: ::core::option::Option<FunnelResponseMetadata>,
}
/// User segments are subsets of users who engaged with your site or app. For
/// example, users who have previously purchased; users who added items to their
/// shopping carts, but didn’t complete a purchase.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserSegment {
/// Defines which users are included in this segment. Optional.
#[prost(message, optional, tag = "1")]
pub user_inclusion_criteria: ::core::option::Option<UserSegmentCriteria>,
/// Defines which users are excluded in this segment. Optional.
#[prost(message, optional, tag = "2")]
pub exclusion: ::core::option::Option<UserSegmentExclusion>,
}
/// A user matches a criteria if the user's events meet the conditions in the
/// criteria.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserSegmentCriteria {
/// A user matches this criteria if the user matches each of these
/// `andConditionGroups` and each of the `andSequenceGroups`.
/// `andConditionGroups` may be empty if `andSequenceGroups` are specified.
#[prost(message, repeated, tag = "1")]
pub and_condition_groups: ::prost::alloc::vec::Vec<UserSegmentConditionGroup>,
/// A user matches this criteria if the user matches each of these
/// `andSequenceGroups` and each of the `andConditionGroups`.
/// `andSequenceGroups` may be empty if `andConditionGroups` are specified.
#[prost(message, repeated, tag = "2")]
pub and_sequence_groups: ::prost::alloc::vec::Vec<UserSegmentSequenceGroup>,
}
/// Conditions tell Analytics what data to include in or exclude from the
/// segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserSegmentConditionGroup {
/// Data is included or excluded from the segment based on if it matches
/// the condition group. This scoping defines how many events the
/// `segmentFilterExpression` is evaluated on before the condition group
/// is determined to be matched or not. For example if `conditionScoping =
/// USER_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all
/// events in a session, and then, the condition group is determined to be
/// matched or not for this user. For example if `conditionScoping =
/// USER_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a single
/// event, and then, the condition group is determined to be matched or not for
/// this user.
///
/// Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is
/// used.
#[prost(enumeration = "UserCriteriaScoping", tag = "1")]
pub condition_scoping: i32,
/// Data is included or excluded from the segment based on if it matches
/// this expression. Expressions express criteria on dimension, metrics,
/// and/or parameters.
#[prost(message, optional, tag = "2")]
pub segment_filter_expression: ::core::option::Option<SegmentFilterExpression>,
}
/// Define conditions that must occur in a specific order for the user to be
/// a member of the segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserSegmentSequenceGroup {
/// All sequence steps must be satisfied in the scoping for the user to
/// match the sequence. For example if `sequenceScoping =
/// USER_CRITERIA_WITHIN_SAME_SESSION`, all sequence steps must complete within
/// one session for the user to match the sequence. `sequenceScoping =
/// USER_CRITERIA_WITHIN_SAME_EVENT` is not supported.
///
/// Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is
/// used.
#[prost(enumeration = "UserCriteriaScoping", tag = "1")]
pub sequence_scoping: i32,
/// Defines the time period in which the whole sequence must occur; for
/// example, 30 Minutes. `sequenceMaximumDuration` is inclusive
/// of the endpoint at the microsecond granularity. For example a sequence
/// with a maximum duration of 5 seconds can be completed at 4.9 or 5.0
/// seconds, but not 5 seconds and 1 microsecond.
///
/// `sequenceMaximumDuration` is optional, and if unspecified, sequences can
/// be completed in any time duration.
#[prost(message, optional, tag = "2")]
pub sequence_maximum_duration: ::core::option::Option<::prost_types::Duration>,
/// An ordered sequence of condition steps. A user's events must complete
/// each step in order for the user to match the
/// `UserSegmentSequenceGroup`.
#[prost(message, repeated, tag = "3")]
pub user_sequence_steps: ::prost::alloc::vec::Vec<UserSequenceStep>,
}
/// A condition that must occur in the specified step order for this user
/// to match the sequence.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserSequenceStep {
/// If true, the event satisfying this step must be the very next event
/// after the event satifying the last step. If false, this step indirectly
/// follows the prior step; for example, there may be events between the
/// prior step and this step. `isDirectlyFollowedBy` must be false for
/// the first step.
#[prost(bool, tag = "1")]
pub is_directly_followed_by: bool,
/// This sequence step must be satisfied in the scoping for the user to
/// match the sequence. For example if `sequenceScoping =
/// WITHIN_SAME_SESSION`, this sequence steps must complete within one
/// session for the user to match the sequence. `stepScoping =
/// ACROSS_ALL_SESSIONS` is only allowed if the `sequenceScoping =
/// ACROSS_ALL_SESSIONS`.
///
/// Optional. If unspecified, `stepScoping` uses the same
/// `UserCriteriaScoping` as the `sequenceScoping`.
#[prost(enumeration = "UserCriteriaScoping", tag = "2")]
pub step_scoping: i32,
/// A user matches this sequence step if their events match this
/// expression. Expressions express criteria on dimension, metrics,
/// and/or parameters.
#[prost(message, optional, tag = "3")]
pub segment_filter_expression: ::core::option::Option<SegmentFilterExpression>,
}
/// Specifies which users are excluded in this segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserSegmentExclusion {
/// Specifies how long an exclusion will last if a user matches the
/// `userExclusionCriteria`.
///
/// Optional. If unspecified, `userExclusionDuration` of
/// `USER_EXCLUSION_TEMPORARY` is used.
#[prost(enumeration = "UserExclusionDuration", tag = "1")]
pub user_exclusion_duration: i32,
/// If a user meets this condition, the user is excluded from membership in
/// the segment for the `userExclusionDuration`.
#[prost(message, optional, tag = "2")]
pub user_exclusion_criteria: ::core::option::Option<UserSegmentCriteria>,
}
/// Session segments are subsets of the sessions that occurred on your site or
/// app: for example, all the sessions that originated from a particular
/// advertising campaign.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SessionSegment {
/// Defines which sessions are included in this segment. Optional.
#[prost(message, optional, tag = "1")]
pub session_inclusion_criteria: ::core::option::Option<SessionSegmentCriteria>,
/// Defines which sessions are excluded in this segment. Optional.
#[prost(message, optional, tag = "2")]
pub exclusion: ::core::option::Option<SessionSegmentExclusion>,
}
/// A session matches a criteria if the session's events meet the conditions in
/// the criteria.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SessionSegmentCriteria {
/// A session matches this criteria if the session matches each of these
/// `andConditionGroups`.
#[prost(message, repeated, tag = "1")]
pub and_condition_groups: ::prost::alloc::vec::Vec<SessionSegmentConditionGroup>,
}
/// Conditions tell Analytics what data to include in or exclude from the
/// segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SessionSegmentConditionGroup {
/// Data is included or excluded from the segment based on if it matches
/// the condition group. This scoping defines how many events the
/// `segmentFilterExpression` is evaluated on before the condition group
/// is determined to be matched or not. For example if `conditionScoping =
/// SESSION_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all
/// events in a session, and then, the condition group is determined to be
/// matched or not for this session. For example if `conditionScoping =
/// SESSION_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a
/// single event, and then, the condition group is determined to be matched or
/// not for this session.
///
/// Optional. If unspecified, a `conditionScoping` of `WITHIN_SAME_SESSION`
/// is used.
#[prost(enumeration = "SessionCriteriaScoping", tag = "1")]
pub condition_scoping: i32,
/// Data is included or excluded from the segment based on if it matches
/// this expression. Expressions express criteria on dimension, metrics,
/// and/or parameters.
#[prost(message, optional, tag = "2")]
pub segment_filter_expression: ::core::option::Option<SegmentFilterExpression>,
}
/// Specifies which sessions are excluded in this segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SessionSegmentExclusion {
/// Specifies how long an exclusion will last if a session matches the
/// `sessionExclusionCriteria`.
///
/// Optional. If unspecified, a `sessionExclusionDuration` of
/// `SESSION_EXCLUSION_TEMPORARY` is used.
#[prost(enumeration = "SessionExclusionDuration", tag = "1")]
pub session_exclusion_duration: i32,
/// If a session meets this condition, the session is excluded from
/// membership in the segment for the `sessionExclusionDuration`.
#[prost(message, optional, tag = "2")]
pub session_exclusion_criteria: ::core::option::Option<SessionSegmentCriteria>,
}
/// Event segments are subsets of events that were triggered on your site or app.
/// for example, all purchase events made in a particular location; app_exception
/// events that occurred on a specific operating system.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EventSegment {
/// Defines which events are included in this segment. Optional.
#[prost(message, optional, tag = "1")]
pub event_inclusion_criteria: ::core::option::Option<EventSegmentCriteria>,
/// Defines which events are excluded in this segment. Optional.
#[prost(message, optional, tag = "2")]
pub exclusion: ::core::option::Option<EventSegmentExclusion>,
}
/// An event matches a criteria if the event meet the conditions in the
/// criteria.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EventSegmentCriteria {
/// An event matches this criteria if the event matches each of these
/// `andConditionGroups`.
#[prost(message, repeated, tag = "1")]
pub and_condition_groups: ::prost::alloc::vec::Vec<EventSegmentConditionGroup>,
}
/// Conditions tell Analytics what data to include in or exclude from the
/// segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EventSegmentConditionGroup {
/// `conditionScoping` should always be `EVENT_CRITERIA_WITHIN_SAME_EVENT`.
///
/// Optional. If unspecified, a `conditionScoping` of
/// `EVENT_CRITERIA_WITHIN_SAME_EVENT` is used.
#[prost(enumeration = "EventCriteriaScoping", tag = "1")]
pub condition_scoping: i32,
/// Data is included or excluded from the segment based on if it matches
/// this expression. Expressions express criteria on dimension, metrics,
/// and/or parameters.
#[prost(message, optional, tag = "2")]
pub segment_filter_expression: ::core::option::Option<SegmentFilterExpression>,
}
/// Specifies which events are excluded in this segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EventSegmentExclusion {
/// `eventExclusionDuration` should always be `PERMANENTLY_EXCLUDE`.
///
/// Optional. If unspecified, an `eventExclusionDuration` of
/// `EVENT_EXCLUSION_PERMANENT` is used.
#[prost(enumeration = "EventExclusionDuration", tag = "1")]
pub event_exclusion_duration: i32,
/// If an event meets this condition, the event is excluded from membership
/// in the segment for the `eventExclusionDuration`.
#[prost(message, optional, tag = "2")]
pub event_exclusion_criteria: ::core::option::Option<EventSegmentCriteria>,
}
/// A segment is a subset of your Analytics data. For example, of your entire set
/// of users, one segment might be users from a particular country or city.
/// Another segment might be users who purchase a particular line of products or
/// who visit a specific part of your site or trigger certain events in your app.
///
/// To learn more, see [GA4 Segment
/// Builder](<https://support.google.com/analytics/answer/9304353>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Segment {
/// The name for this segment. If unspecified, segments are named "Segment".
/// This name defines string value returned by the `segment` dimension. The
/// `segment` dimension prefixes segment names by the 1-based index number of
/// the segment in the request (for example "1. Segment", "2. Segment", etc.).
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// A segment is specified in one scope.
#[prost(oneof = "segment::OneSegmentScope", tags = "2, 3, 4")]
pub one_segment_scope: ::core::option::Option<segment::OneSegmentScope>,
}
/// Nested message and enum types in `Segment`.
pub mod segment {
/// A segment is specified in one scope.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneSegmentScope {
/// User segments are subsets of users who engaged with your site or app.
#[prost(message, tag = "2")]
UserSegment(super::UserSegment),
/// Session segments are subsets of the sessions that occurred on your site
/// or app.
#[prost(message, tag = "3")]
SessionSegment(super::SessionSegment),
/// Event segments are subsets of events that were triggered on your site or
/// app.
#[prost(message, tag = "4")]
EventSegment(super::EventSegment),
}
}
/// Expresses combinations of segment filters.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentFilterExpression {
/// Specify one type of filter for `SegmentFilterExpression`.
#[prost(oneof = "segment_filter_expression::Expr", tags = "1, 2, 3, 4, 5")]
pub expr: ::core::option::Option<segment_filter_expression::Expr>,
}
/// Nested message and enum types in `SegmentFilterExpression`.
pub mod segment_filter_expression {
/// Specify one type of filter for `SegmentFilterExpression`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Expr {
/// The SegmentFilterExpression in `andGroup` have an AND relationship.
#[prost(message, tag = "1")]
AndGroup(super::SegmentFilterExpressionList),
/// The SegmentFilterExpression in `orGroup` have an OR relationship.
#[prost(message, tag = "2")]
OrGroup(super::SegmentFilterExpressionList),
/// The SegmentFilterExpression is NOT of `notExpression`.
#[prost(message, tag = "3")]
NotExpression(::prost::alloc::boxed::Box<super::SegmentFilterExpression>),
/// A primitive segment filter.
#[prost(message, tag = "4")]
SegmentFilter(super::SegmentFilter),
/// Creates a filter that matches events of a single event name. If a
/// parameter filter expression is specified, only the subset of events that
/// match both the single event name and the parameter filter expressions
/// match this event filter.
#[prost(message, tag = "5")]
SegmentEventFilter(super::SegmentEventFilter),
}
}
/// A list of segment filter expressions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentFilterExpressionList {
/// The list of segment filter expressions
#[prost(message, repeated, tag = "1")]
pub expressions: ::prost::alloc::vec::Vec<SegmentFilterExpression>,
}
/// An expression to filter dimension or metric values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentFilter {
/// The dimension name or metric name.
#[prost(string, tag = "1")]
pub field_name: ::prost::alloc::string::String,
/// Specifies the scope for the filter.
#[prost(message, optional, tag = "8")]
pub filter_scoping: ::core::option::Option<SegmentFilterScoping>,
/// Specify one type of filter for `Filter`.
#[prost(oneof = "segment_filter::OneFilter", tags = "4, 5, 6, 7")]
pub one_filter: ::core::option::Option<segment_filter::OneFilter>,
}
/// Nested message and enum types in `SegmentFilter`.
pub mod segment_filter {
/// Specify one type of filter for `Filter`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneFilter {
/// Strings related filter.
#[prost(message, tag = "4")]
StringFilter(super::StringFilter),
/// A filter for in list values.
#[prost(message, tag = "5")]
InListFilter(super::InListFilter),
/// A filter for numeric or date values.
#[prost(message, tag = "6")]
NumericFilter(super::NumericFilter),
/// A filter for between two values.
#[prost(message, tag = "7")]
BetweenFilter(super::BetweenFilter),
}
}
/// Scopings specify how the dimensions & metrics of multiple events
/// should be considered when evaluating a segment filter.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SegmentFilterScoping {
/// If `atAnyPointInTime` is true, this filter evaluates to true for all
/// events if it evaluates to true for any event in the date range of the
/// request.
///
/// This `atAnyPointInTime` parameter does not extend the date range of
/// events in the report. If `atAnyPointInTime` is true, only events within
/// the report's date range are considered when evaluating this filter.
///
/// This `atAnyPointInTime` is only able to be specified if the criteria
/// scoping is `ACROSS_ALL_SESSIONS` and is not able to be specified in
/// sequences.
///
/// If the criteria scoping is `ACROSS_ALL_SESSIONS`, `atAnyPointInTime` =
/// false is used if unspecified.
#[prost(bool, optional, tag = "1")]
pub at_any_point_in_time: ::core::option::Option<bool>,
}
/// Creates a filter that matches events of a single event name. If a parameter
/// filter expression is specified, only the subset of events that match both the
/// single event name and the parameter filter expressions match this event
/// filter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentEventFilter {
/// This filter matches events of this single event name. Event name is
/// required.
#[prost(string, optional, tag = "1")]
pub event_name: ::core::option::Option<::prost::alloc::string::String>,
/// If specified, this filter matches events that match both the single event
/// name and the parameter filter expressions.
///
/// Inside the parameter filter expression, only parameter filters are
/// available.
#[prost(message, optional, tag = "2")]
pub segment_parameter_filter_expression: ::core::option::Option<
SegmentParameterFilterExpression,
>,
}
/// Expresses combinations of segment filter on parameters.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentParameterFilterExpression {
/// Specify one type of filter for `SegmentParameterFilterExpression`.
#[prost(oneof = "segment_parameter_filter_expression::Expr", tags = "1, 2, 3, 4")]
pub expr: ::core::option::Option<segment_parameter_filter_expression::Expr>,
}
/// Nested message and enum types in `SegmentParameterFilterExpression`.
pub mod segment_parameter_filter_expression {
/// Specify one type of filter for `SegmentParameterFilterExpression`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Expr {
/// The SegmentParameterFilterExpression in `andGroup` have an AND
/// relationship.
#[prost(message, tag = "1")]
AndGroup(super::SegmentParameterFilterExpressionList),
/// The SegmentParameterFilterExpression in `orGroup` have an OR
/// relationship.
#[prost(message, tag = "2")]
OrGroup(super::SegmentParameterFilterExpressionList),
/// The SegmentParameterFilterExpression is NOT of `notExpression`.
#[prost(message, tag = "3")]
NotExpression(
::prost::alloc::boxed::Box<super::SegmentParameterFilterExpression>,
),
/// A primitive segment parameter filter.
#[prost(message, tag = "4")]
SegmentParameterFilter(super::SegmentParameterFilter),
}
}
/// A list of segment parameter filter expressions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentParameterFilterExpressionList {
/// The list of segment parameter filter expressions.
#[prost(message, repeated, tag = "1")]
pub expressions: ::prost::alloc::vec::Vec<SegmentParameterFilterExpression>,
}
/// An expression to filter parameter values in a segment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SegmentParameterFilter {
/// Specifies the scope for the filter.
#[prost(message, optional, tag = "8")]
pub filter_scoping: ::core::option::Option<SegmentParameterFilterScoping>,
/// The field that is being filtered.
#[prost(oneof = "segment_parameter_filter::OneParameter", tags = "1, 2")]
pub one_parameter: ::core::option::Option<segment_parameter_filter::OneParameter>,
/// Specify one type of filter.
#[prost(oneof = "segment_parameter_filter::OneFilter", tags = "4, 5, 6, 7")]
pub one_filter: ::core::option::Option<segment_parameter_filter::OneFilter>,
}
/// Nested message and enum types in `SegmentParameterFilter`.
pub mod segment_parameter_filter {
/// The field that is being filtered.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneParameter {
/// This filter will be evaluated on the specified event parameter. Event
/// parameters are logged as parameters of the event. Event parameters
/// include fields like "firebase_screen" & "currency".
///
/// Event parameters can only be used in segments & funnels and can only be
/// used in a descendent filter from an EventFilter. In a descendent filter
/// from an EventFilter either event or item parameters should be used.
#[prost(string, tag = "1")]
EventParameterName(::prost::alloc::string::String),
/// This filter will be evaluated on the specified item parameter. Item
/// parameters are logged as parameters in the item array. Item parameters
/// include fields like "item_name" & "item_category".
///
/// Item parameters can only be used in segments & funnels and can only be
/// used in a descendent filter from an EventFilter. In a descendent filter
/// from an EventFilter either event or item parameters should be used.
///
/// Item parameters are only available in ecommerce events. To learn more
/// about ecommerce events, see the \[Measure ecommerce\]
/// (<https://developers.google.com/analytics/devguides/collection/ga4/ecommerce>)
/// guide.
#[prost(string, tag = "2")]
ItemParameterName(::prost::alloc::string::String),
}
/// Specify one type of filter.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneFilter {
/// Strings related filter.
#[prost(message, tag = "4")]
StringFilter(super::StringFilter),
/// A filter for in list values.
#[prost(message, tag = "5")]
InListFilter(super::InListFilter),
/// A filter for numeric or date values.
#[prost(message, tag = "6")]
NumericFilter(super::NumericFilter),
/// A filter for between two values.
#[prost(message, tag = "7")]
BetweenFilter(super::BetweenFilter),
}
}
/// Scopings specify how multiple events should be considered when evaluating a
/// segment parameter filter.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SegmentParameterFilterScoping {
/// Accumulates the parameter over the specified period of days before
/// applying the filter. Only supported if criteria scoping is
/// `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the
/// parameter is `event_count`.
///
/// For example if `inAnyNDayPeriod` is 3, the event_name is "purchase",
/// the event parameter is "event_count", and the Filter's criteria is
/// greater than 5, this filter will accumulate the event count of purchase
/// events over every 3 consecutive day period in the report's date range; a
/// user will pass this Filter's criteria to be included in this segment if
/// their count of purchase events exceeds 5 in any 3 consecutive day period.
/// For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to
/// 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.
///
/// The date range is not extended for the purpose of having a full N day
/// window near the start of the date range. For example if a report is for
/// 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day
/// period will be effectively shortened because no event data outside the
/// report's date range will be read. For example, the first four periods
/// will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02,
/// 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.
///
/// `inAnyNDayPeriod` is optional. If not specified, the
/// `segmentParameterFilter` is applied to each event individually.
#[prost(int64, optional, tag = "1")]
pub in_any_n_day_period: ::core::option::Option<i64>,
}
/// Expresses combinations of funnel filters.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelFilterExpression {
/// Specify one type of filter for `FunnelFilterExpression`.
#[prost(oneof = "funnel_filter_expression::Expr", tags = "1, 2, 3, 4, 5")]
pub expr: ::core::option::Option<funnel_filter_expression::Expr>,
}
/// Nested message and enum types in `FunnelFilterExpression`.
pub mod funnel_filter_expression {
/// Specify one type of filter for `FunnelFilterExpression`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Expr {
/// The FunnelFilterExpression in `andGroup` have an AND relationship.
#[prost(message, tag = "1")]
AndGroup(super::FunnelFilterExpressionList),
/// The FunnelFilterExpression in `orGroup` have an OR relationship.
#[prost(message, tag = "2")]
OrGroup(super::FunnelFilterExpressionList),
/// The FunnelFilterExpression is NOT of `notExpression`.
#[prost(message, tag = "3")]
NotExpression(::prost::alloc::boxed::Box<super::FunnelFilterExpression>),
/// A funnel filter for a dimension or metric.
#[prost(message, tag = "4")]
FunnelFieldFilter(super::FunnelFieldFilter),
/// Creates a filter that matches events of a single event name. If a
/// parameter filter expression is specified, only the subset of events that
/// match both the single event name and the parameter filter expressions
/// match this event filter.
#[prost(message, tag = "5")]
FunnelEventFilter(super::FunnelEventFilter),
}
}
/// A list of funnel filter expressions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelFilterExpressionList {
/// The list of funnel filter expressions.
#[prost(message, repeated, tag = "1")]
pub expressions: ::prost::alloc::vec::Vec<FunnelFilterExpression>,
}
/// An expression to filter dimension or metric values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelFieldFilter {
/// The dimension name or metric name.
#[prost(string, tag = "1")]
pub field_name: ::prost::alloc::string::String,
/// Specify one type of filter.
#[prost(oneof = "funnel_field_filter::OneFilter", tags = "4, 5, 6, 7")]
pub one_filter: ::core::option::Option<funnel_field_filter::OneFilter>,
}
/// Nested message and enum types in `FunnelFieldFilter`.
pub mod funnel_field_filter {
/// Specify one type of filter.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneFilter {
/// Strings related filter.
#[prost(message, tag = "4")]
StringFilter(super::StringFilter),
/// A filter for in list values.
#[prost(message, tag = "5")]
InListFilter(super::InListFilter),
/// A filter for numeric or date values.
#[prost(message, tag = "6")]
NumericFilter(super::NumericFilter),
/// A filter for between two values.
#[prost(message, tag = "7")]
BetweenFilter(super::BetweenFilter),
}
}
/// Creates a filter that matches events of a single event name. If a parameter
/// filter expression is specified, only the subset of events that match both the
/// single event name and the parameter filter expressions match this event
/// filter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelEventFilter {
/// This filter matches events of this single event name. Event name is
/// required.
#[prost(string, optional, tag = "1")]
pub event_name: ::core::option::Option<::prost::alloc::string::String>,
/// If specified, this filter matches events that match both the single event
/// name and the parameter filter expressions.
///
/// Inside the parameter filter expression, only parameter filters are
/// available.
#[prost(message, optional, tag = "2")]
pub funnel_parameter_filter_expression: ::core::option::Option<
FunnelParameterFilterExpression,
>,
}
/// Expresses combinations of funnel filters on parameters.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelParameterFilterExpression {
/// Specify one type of filter for `FunnelParameterFilterExpression`.
#[prost(oneof = "funnel_parameter_filter_expression::Expr", tags = "1, 2, 3, 4")]
pub expr: ::core::option::Option<funnel_parameter_filter_expression::Expr>,
}
/// Nested message and enum types in `FunnelParameterFilterExpression`.
pub mod funnel_parameter_filter_expression {
/// Specify one type of filter for `FunnelParameterFilterExpression`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Expr {
/// The FunnelParameterFilterExpression in `andGroup` have an AND
/// relationship.
#[prost(message, tag = "1")]
AndGroup(super::FunnelParameterFilterExpressionList),
/// The FunnelParameterFilterExpression in `orGroup` have an OR
/// relationship.
#[prost(message, tag = "2")]
OrGroup(super::FunnelParameterFilterExpressionList),
/// The FunnelParameterFilterExpression is NOT of `notExpression`.
#[prost(message, tag = "3")]
NotExpression(
::prost::alloc::boxed::Box<super::FunnelParameterFilterExpression>,
),
/// A primitive funnel parameter filter.
#[prost(message, tag = "4")]
FunnelParameterFilter(super::FunnelParameterFilter),
}
}
/// A list of funnel parameter filter expressions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelParameterFilterExpressionList {
/// The list of funnel parameter filter expressions.
#[prost(message, repeated, tag = "1")]
pub expressions: ::prost::alloc::vec::Vec<FunnelParameterFilterExpression>,
}
/// An expression to filter parameter values in a funnel.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelParameterFilter {
/// The field that is being filtered.
#[prost(oneof = "funnel_parameter_filter::OneParameter", tags = "1, 2")]
pub one_parameter: ::core::option::Option<funnel_parameter_filter::OneParameter>,
/// Specify one type of filter.
#[prost(oneof = "funnel_parameter_filter::OneFilter", tags = "4, 5, 6, 7")]
pub one_filter: ::core::option::Option<funnel_parameter_filter::OneFilter>,
}
/// Nested message and enum types in `FunnelParameterFilter`.
pub mod funnel_parameter_filter {
/// The field that is being filtered.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneParameter {
/// This filter will be evaluated on the specified event parameter. Event
/// parameters are logged as parameters of the event. Event parameters
/// include fields like "firebase_screen" & "currency".
///
/// Event parameters can only be used in segments & funnels and can only be
/// used in a descendent filter from an EventFilter. In a descendent filter
/// from an EventFilter either event or item parameters should be used.
#[prost(string, tag = "1")]
EventParameterName(::prost::alloc::string::String),
/// This filter will be evaluated on the specified item parameter. Item
/// parameters are logged as parameters in the item array. Item parameters
/// include fields like "item_name" & "item_category".
///
/// Item parameters can only be used in segments & funnels and can only be
/// used in a descendent filter from an EventFilter. In a descendent filter
/// from an EventFilter either event or item parameters should be used.
///
/// Item parameters are only available in ecommerce events. To learn more
/// about ecommerce events, see the \[Measure ecommerce\]
/// (<https://developers.google.com/analytics/devguides/collection/ga4/ecommerce>)
/// guide.
#[prost(string, tag = "2")]
ItemParameterName(::prost::alloc::string::String),
}
/// Specify one type of filter.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneFilter {
/// Strings related filter.
#[prost(message, tag = "4")]
StringFilter(super::StringFilter),
/// A filter for in list values.
#[prost(message, tag = "5")]
InListFilter(super::InListFilter),
/// A filter for numeric or date values.
#[prost(message, tag = "6")]
NumericFilter(super::NumericFilter),
/// A filter for between two values.
#[prost(message, tag = "7")]
BetweenFilter(super::BetweenFilter),
}
}
/// The funnel report's response metadata carries additional information about
/// the funnel report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunnelResponseMetadata {
/// If funnel report results are
/// [sampled](<https://support.google.com/analytics/answer/13331292>), this
/// describes what percentage of events were used in this funnel report. One
/// `samplingMetadatas` is populated for each date range. Each
/// `samplingMetadatas` corresponds to a date range in order that date ranges
/// were specified in the request.
///
/// However if the results are not sampled, this field will not be defined.
#[prost(message, repeated, tag = "1")]
pub sampling_metadatas: ::prost::alloc::vec::Vec<SamplingMetadata>,
}
/// If funnel report results are
/// [sampled](<https://support.google.com/analytics/answer/13331292>), this
/// metadata describes what percentage of events were used in this funnel
/// report for a date range. Sampling is the practice of analyzing a subset of
/// all data in order to uncover the meaningful information in the larger data
/// set.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SamplingMetadata {
/// The total number of events read in this sampled report for a date range.
/// This is the size of the subset this property's data that was analyzed in
/// this funnel report.
#[prost(int64, tag = "1")]
pub samples_read_count: i64,
/// The total number of events present in this property's data that could
/// have been analyzed in this funnel report for a date range. Sampling
/// uncovers the meaningful information about the larger data set, and this
/// is the size of the larger data set.
///
/// To calculate the percentage of available data that was used in this
/// funnel report, compute `samplesReadCount/samplingSpaceSize`.
#[prost(int64, tag = "2")]
pub sampling_space_size: i64,
}
/// Scoping specifies which events are considered when evaluating if a user
/// meets a criteria.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum UserCriteriaScoping {
/// Unspecified criteria scoping. Do not specify.
Unspecified = 0,
/// If the criteria is satisfied within one event, the user matches the
/// criteria.
UserCriteriaWithinSameEvent = 1,
/// If the criteria is satisfied within one session, the user matches the
/// criteria.
UserCriteriaWithinSameSession = 2,
/// If the criteria is satisfied by any events for the user, the user
/// matches the criteria.
UserCriteriaAcrossAllSessions = 3,
}
impl UserCriteriaScoping {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
UserCriteriaScoping::Unspecified => "USER_CRITERIA_SCOPING_UNSPECIFIED",
UserCriteriaScoping::UserCriteriaWithinSameEvent => {
"USER_CRITERIA_WITHIN_SAME_EVENT"
}
UserCriteriaScoping::UserCriteriaWithinSameSession => {
"USER_CRITERIA_WITHIN_SAME_SESSION"
}
UserCriteriaScoping::UserCriteriaAcrossAllSessions => {
"USER_CRITERIA_ACROSS_ALL_SESSIONS"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"USER_CRITERIA_SCOPING_UNSPECIFIED" => Some(Self::Unspecified),
"USER_CRITERIA_WITHIN_SAME_EVENT" => Some(Self::UserCriteriaWithinSameEvent),
"USER_CRITERIA_WITHIN_SAME_SESSION" => {
Some(Self::UserCriteriaWithinSameSession)
}
"USER_CRITERIA_ACROSS_ALL_SESSIONS" => {
Some(Self::UserCriteriaAcrossAllSessions)
}
_ => None,
}
}
}
/// Enumerates options for how long an exclusion will last if a user matches
/// the `userExclusionCriteria`.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum UserExclusionDuration {
/// Unspecified exclusion duration. Do not specify.
Unspecified = 0,
/// Temporarily exclude users from the segment during periods when the
/// user meets the `userExclusionCriteria` condition.
UserExclusionTemporary = 1,
/// Permanently exclude users from the segment if the user ever meets the
/// `userExclusionCriteria` condition.
UserExclusionPermanent = 2,
}
impl UserExclusionDuration {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
UserExclusionDuration::Unspecified => "USER_EXCLUSION_DURATION_UNSPECIFIED",
UserExclusionDuration::UserExclusionTemporary => "USER_EXCLUSION_TEMPORARY",
UserExclusionDuration::UserExclusionPermanent => "USER_EXCLUSION_PERMANENT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"USER_EXCLUSION_DURATION_UNSPECIFIED" => Some(Self::Unspecified),
"USER_EXCLUSION_TEMPORARY" => Some(Self::UserExclusionTemporary),
"USER_EXCLUSION_PERMANENT" => Some(Self::UserExclusionPermanent),
_ => None,
}
}
}
/// Scoping specifies which events are considered when evaluating if a
/// session meets a criteria.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SessionCriteriaScoping {
/// Unspecified criteria scoping. Do not specify.
Unspecified = 0,
/// If the criteria is satisfied within one event, the session matches the
/// criteria.
SessionCriteriaWithinSameEvent = 1,
/// If the criteria is satisfied within one session, the session matches
/// the criteria.
SessionCriteriaWithinSameSession = 2,
}
impl SessionCriteriaScoping {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
SessionCriteriaScoping::Unspecified => "SESSION_CRITERIA_SCOPING_UNSPECIFIED",
SessionCriteriaScoping::SessionCriteriaWithinSameEvent => {
"SESSION_CRITERIA_WITHIN_SAME_EVENT"
}
SessionCriteriaScoping::SessionCriteriaWithinSameSession => {
"SESSION_CRITERIA_WITHIN_SAME_SESSION"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SESSION_CRITERIA_SCOPING_UNSPECIFIED" => Some(Self::Unspecified),
"SESSION_CRITERIA_WITHIN_SAME_EVENT" => {
Some(Self::SessionCriteriaWithinSameEvent)
}
"SESSION_CRITERIA_WITHIN_SAME_SESSION" => {
Some(Self::SessionCriteriaWithinSameSession)
}
_ => None,
}
}
}
/// Enumerates options for how long an exclusion will last if a session
/// matches the `sessionExclusionCriteria`.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SessionExclusionDuration {
/// Unspecified exclusion duration. Do not specify.
Unspecified = 0,
/// Temporarily exclude sessions from the segment during periods when the
/// session meets the `sessionExclusionCriteria` condition.
SessionExclusionTemporary = 1,
/// Permanently exclude sessions from the segment if the session ever meets
/// the `sessionExclusionCriteria` condition.
SessionExclusionPermanent = 2,
}
impl SessionExclusionDuration {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
SessionExclusionDuration::Unspecified => {
"SESSION_EXCLUSION_DURATION_UNSPECIFIED"
}
SessionExclusionDuration::SessionExclusionTemporary => {
"SESSION_EXCLUSION_TEMPORARY"
}
SessionExclusionDuration::SessionExclusionPermanent => {
"SESSION_EXCLUSION_PERMANENT"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SESSION_EXCLUSION_DURATION_UNSPECIFIED" => Some(Self::Unspecified),
"SESSION_EXCLUSION_TEMPORARY" => Some(Self::SessionExclusionTemporary),
"SESSION_EXCLUSION_PERMANENT" => Some(Self::SessionExclusionPermanent),
_ => None,
}
}
}
/// Scoping specifies which events are considered when evaluating if an event
/// meets a criteria.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum EventCriteriaScoping {
/// Unspecified criteria scoping. Do not specify.
Unspecified = 0,
/// If the criteria is satisfied within one event, the event matches the
/// criteria.
EventCriteriaWithinSameEvent = 1,
}
impl EventCriteriaScoping {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
EventCriteriaScoping::Unspecified => "EVENT_CRITERIA_SCOPING_UNSPECIFIED",
EventCriteriaScoping::EventCriteriaWithinSameEvent => {
"EVENT_CRITERIA_WITHIN_SAME_EVENT"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EVENT_CRITERIA_SCOPING_UNSPECIFIED" => Some(Self::Unspecified),
"EVENT_CRITERIA_WITHIN_SAME_EVENT" => {
Some(Self::EventCriteriaWithinSameEvent)
}
_ => None,
}
}
}
/// Enumerates options for how long an exclusion will last if an event
/// matches the `eventExclusionCriteria`.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum EventExclusionDuration {
/// Unspecified exclusion duration. Do not specify.
Unspecified = 0,
/// Permanently exclude events from the segment if the event ever meets
/// the `eventExclusionCriteria` condition.
EventExclusionPermanent = 1,
}
impl EventExclusionDuration {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
EventExclusionDuration::Unspecified => "EVENT_EXCLUSION_DURATION_UNSPECIFIED",
EventExclusionDuration::EventExclusionPermanent => {
"EVENT_EXCLUSION_PERMANENT"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EVENT_EXCLUSION_DURATION_UNSPECIFIED" => Some(Self::Unspecified),
"EVENT_EXCLUSION_PERMANENT" => Some(Self::EventExclusionPermanent),
_ => None,
}
}
}
/// Represents aggregation of metrics.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum MetricAggregation {
/// Unspecified operator.
Unspecified = 0,
/// SUM operator.
Total = 1,
/// Minimum operator.
Minimum = 5,
/// Maximum operator.
Maximum = 6,
/// Count operator.
Count = 4,
}
impl MetricAggregation {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
MetricAggregation::Unspecified => "METRIC_AGGREGATION_UNSPECIFIED",
MetricAggregation::Total => "TOTAL",
MetricAggregation::Minimum => "MINIMUM",
MetricAggregation::Maximum => "MAXIMUM",
MetricAggregation::Count => "COUNT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"METRIC_AGGREGATION_UNSPECIFIED" => Some(Self::Unspecified),
"TOTAL" => Some(Self::Total),
"MINIMUM" => Some(Self::Minimum),
"MAXIMUM" => Some(Self::Maximum),
"COUNT" => Some(Self::Count),
_ => None,
}
}
}
/// A metric's value type.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum MetricType {
/// Unspecified type.
Unspecified = 0,
/// Integer type.
TypeInteger = 1,
/// Floating point type.
TypeFloat = 2,
/// A duration of seconds; a special floating point type.
TypeSeconds = 4,
/// A duration in milliseconds; a special floating point type.
TypeMilliseconds = 5,
/// A duration in minutes; a special floating point type.
TypeMinutes = 6,
/// A duration in hours; a special floating point type.
TypeHours = 7,
/// A custom metric of standard type; a special floating point type.
TypeStandard = 8,
/// An amount of money; a special floating point type.
TypeCurrency = 9,
/// A length in feet; a special floating point type.
TypeFeet = 10,
/// A length in miles; a special floating point type.
TypeMiles = 11,
/// A length in meters; a special floating point type.
TypeMeters = 12,
/// A length in kilometers; a special floating point type.
TypeKilometers = 13,
}
impl MetricType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
MetricType::Unspecified => "METRIC_TYPE_UNSPECIFIED",
MetricType::TypeInteger => "TYPE_INTEGER",
MetricType::TypeFloat => "TYPE_FLOAT",
MetricType::TypeSeconds => "TYPE_SECONDS",
MetricType::TypeMilliseconds => "TYPE_MILLISECONDS",
MetricType::TypeMinutes => "TYPE_MINUTES",
MetricType::TypeHours => "TYPE_HOURS",
MetricType::TypeStandard => "TYPE_STANDARD",
MetricType::TypeCurrency => "TYPE_CURRENCY",
MetricType::TypeFeet => "TYPE_FEET",
MetricType::TypeMiles => "TYPE_MILES",
MetricType::TypeMeters => "TYPE_METERS",
MetricType::TypeKilometers => "TYPE_KILOMETERS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"METRIC_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"TYPE_INTEGER" => Some(Self::TypeInteger),
"TYPE_FLOAT" => Some(Self::TypeFloat),
"TYPE_SECONDS" => Some(Self::TypeSeconds),
"TYPE_MILLISECONDS" => Some(Self::TypeMilliseconds),
"TYPE_MINUTES" => Some(Self::TypeMinutes),
"TYPE_HOURS" => Some(Self::TypeHours),
"TYPE_STANDARD" => Some(Self::TypeStandard),
"TYPE_CURRENCY" => Some(Self::TypeCurrency),
"TYPE_FEET" => Some(Self::TypeFeet),
"TYPE_MILES" => Some(Self::TypeMiles),
"TYPE_METERS" => Some(Self::TypeMeters),
"TYPE_KILOMETERS" => Some(Self::TypeKilometers),
_ => None,
}
}
}
/// Categories of data that you may be restricted from viewing on certain GA4
/// properties.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum RestrictedMetricType {
/// Unspecified type.
Unspecified = 0,
/// Cost metrics such as `adCost`.
CostData = 1,
/// Revenue metrics such as `purchaseRevenue`.
RevenueData = 2,
}
impl RestrictedMetricType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
RestrictedMetricType::Unspecified => "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
RestrictedMetricType::CostData => "COST_DATA",
RestrictedMetricType::RevenueData => "REVENUE_DATA",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RESTRICTED_METRIC_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"COST_DATA" => Some(Self::CostData),
"REVENUE_DATA" => Some(Self::RevenueData),
_ => None,
}
}
}
/// A request to create a new recurring audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateRecurringAudienceListRequest {
/// Required. The parent resource where this recurring audience list will be
/// created. Format: `properties/{property}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The recurring audience list to create.
#[prost(message, optional, tag = "2")]
pub recurring_audience_list: ::core::option::Option<RecurringAudienceList>,
}
/// A recurring audience list produces new audience lists each day. Audience
/// lists are users in an audience at the time of the list's creation. A
/// recurring audience list ensures that you have audience list based on the most
/// recent data available for use each day.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RecurringAudienceList {
/// Output only. Identifier. The recurring audience list resource name assigned
/// during creation. This resource name identifies this
/// `RecurringAudienceList`.
///
/// Format:
/// `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The audience resource name. This resource name identifies the
/// audience being listed and is shared between the Analytics Data & Admin
/// APIs.
///
/// Format: `properties/{property}/audiences/{audience}`
#[prost(string, tag = "2")]
pub audience: ::prost::alloc::string::String,
/// Output only. The descriptive display name for this audience. For example,
/// "Purchasers".
#[prost(string, tag = "3")]
pub audience_display_name: ::prost::alloc::string::String,
/// Required. The dimensions requested and displayed in the audience list
/// response.
#[prost(message, repeated, tag = "4")]
pub dimensions: ::prost::alloc::vec::Vec<AudienceDimension>,
/// Optional. The number of remaining days that a recurring audience export
/// will produce an audience list instance. This counter decreases by one each
/// day, and when it reaches zero, no new audience lists will be created.
///
/// Recurring audience list request for Analytics 360 properties default to 180
/// days and have a maximum of 365 days. Requests for standard Analytics
/// properties default to 14 days and have a maximum of 30 days.
///
/// The minimum value allowed during creation is 1. Requests above their
/// respective maximum will be coerced to their maximum.
#[prost(int32, optional, tag = "5")]
pub active_days_remaining: ::core::option::Option<i32>,
/// Output only. Audience list resource names for audience list instances
/// created for this recurring audience list. One audience list is created for
/// each day, and the audience list will be listed here.
///
/// This list is ordered with the most recently created audience list first.
#[prost(string, repeated, tag = "6")]
pub audience_lists: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. Configures webhook notifications to be sent from the Google
/// Analytics Data API to your webhook server. Use of webhooks is optional. If
/// unused, you'll need to poll this API to determine when a recurring audience
/// list creates new audience lists. Webhooks allow a notification to be sent
/// to your servers & avoid the need for polling.
///
/// Two POST requests will be sent each time a recurring audience list creates
/// an audience list. This happens once per day until a recurring audience list
/// reaches 0 active days remaining. The first request will be sent showing a
/// newly created audience list in its CREATING state. The second request will
/// be sent after the audience list completes creation (either the ACTIVE or
/// FAILED state).
#[prost(message, optional, tag = "8")]
pub webhook_notification: ::core::option::Option<WebhookNotification>,
}
/// Configures a long-running operation resource to send a webhook notification
/// from the Google Analytics Data API to your webhook server when the resource
/// updates.
///
/// Notification configurations contain private values & are only visible to your
/// GCP project. Different GCP projects may attach different webhook
/// notifications to the same long-running operation resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WebhookNotification {
/// Optional. The web address that will receive the webhook notification. This
/// address will receive POST requests as the state of the long running
/// operation resource changes. The POST request will contain both a JSON
/// version of the long running operation resource in the body and a
/// `sentTimestamp` field. The sent timestamp will specify the unix
/// microseconds since the epoch that the request was sent; this lets you
/// identify replayed notifications.
///
/// An example URI is
/// `<https://us-central1-example-project-id.cloudfunctions.net/example-function-1`.>
///
/// The URI must use HTTPS and point to a site with a valid SSL certificate on
/// the web server. The URI must have a maximum string length of 128 characters
/// & use only the allowlisted characters from [RFC
/// 1738](<https://www.rfc-editor.org/rfc/rfc1738>).
///
/// When your webhook server receives a notification, it is expected to reply
/// with an HTTP response status code of 200 within 5 seconds.
///
/// A URI is required to use webhook notifications.
///
/// Requests to this webhook server will contain an ID token authenticating the
/// service account
/// `google-analytics-audience-export@system.gserviceaccount.com`. To learn
/// more about ID tokens, see
/// <https://cloud.google.com/docs/authentication/token-types#id.> For Google
/// Cloud Functions, this lets you configure your function to require
/// authentication. In Cloud IAM, you will need to grant the service account
/// permissions to the Cloud Run Invoker (`roles/run.invoker`) & Cloud
/// Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook
/// post request to pass Google Cloud Functions authentication. This API can
/// send webhook notifications to arbitrary URIs; for webhook servers other
/// than Google Cloud Functions, this ID token in the authorization bearer
/// header should be ignored if it is not needed.
#[prost(string, optional, tag = "1")]
pub uri: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. The channel token is an arbitrary string value and must have a
/// maximum string length of 64 characters. Channel tokens allow you to verify
/// the source of a webhook notification. This guards against the message being
/// spoofed. The channel token will be specified in the `X-Goog-Channel-Token`
/// HTTP header of the webhook POST request.
///
/// A channel token is not required to use webhook notifications.
#[prost(string, optional, tag = "2")]
pub channel_token: ::core::option::Option<::prost::alloc::string::String>,
}
/// A request to retrieve configuration metadata about a specific recurring
/// audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRecurringAudienceListRequest {
/// Required. The recurring audience list resource name.
/// Format:
/// `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A request to list all recurring audience lists for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListRecurringAudienceListsRequest {
/// Required. All recurring audience lists for this property will be listed in
/// the response. Format: `properties/{property}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The maximum number of recurring audience lists to return. The
/// service may return fewer than this value. If unspecified, at most 200
/// recurring audience lists will be returned. The maximum value is 1000
/// (higher values will be coerced to the maximum).
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. A page token, received from a previous
/// `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
/// page.
///
/// When paginating, all other parameters provided to
/// `ListRecurringAudienceLists` must match the call that provided the page
/// token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// A list of all recurring audience lists for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListRecurringAudienceListsResponse {
/// Each recurring audience list for a property.
#[prost(message, repeated, tag = "1")]
pub recurring_audience_lists: ::prost::alloc::vec::Vec<RecurringAudienceList>,
/// A token, which can be sent as `page_token` to retrieve the next page.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, optional, tag = "2")]
pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
}
/// A request to retrieve configuration metadata about a specific audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAudienceListRequest {
/// Required. The audience list resource name.
/// Format: `properties/{property}/audienceLists/{audience_list}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A request to list all audience lists for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAudienceListsRequest {
/// Required. All audience lists for this property will be listed in the
/// response. Format: `properties/{property}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The maximum number of audience lists to return. The service may
/// return fewer than this value. If unspecified, at most 200 audience lists
/// will be returned. The maximum value is 1000 (higher values will be coerced
/// to the maximum).
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. A page token, received from a previous `ListAudienceLists` call.
/// Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to `ListAudienceLists` must
/// match the call that provided the page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// A list of all audience lists for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAudienceListsResponse {
/// Each audience list for a property.
#[prost(message, repeated, tag = "1")]
pub audience_lists: ::prost::alloc::vec::Vec<AudienceList>,
/// A token, which can be sent as `page_token` to retrieve the next page.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, optional, tag = "2")]
pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
}
/// A request to create a new audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateAudienceListRequest {
/// Required. The parent resource where this audience list will be created.
/// Format: `properties/{property}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The audience list to create.
#[prost(message, optional, tag = "2")]
pub audience_list: ::core::option::Option<AudienceList>,
}
/// An audience list is a list of users in an audience at the time of the list's
/// creation. One audience may have multiple audience lists created for different
/// days.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudienceList {
/// Output only. Identifier. The audience list resource name assigned during
/// creation. This resource name identifies this `AudienceList`.
///
/// Format: `properties/{property}/audienceLists/{audience_list}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The audience resource name. This resource name identifies the
/// audience being listed and is shared between the Analytics Data & Admin
/// APIs.
///
/// Format: `properties/{property}/audiences/{audience}`
#[prost(string, tag = "2")]
pub audience: ::prost::alloc::string::String,
/// Output only. The descriptive display name for this audience. For example,
/// "Purchasers".
#[prost(string, tag = "3")]
pub audience_display_name: ::prost::alloc::string::String,
/// Required. The dimensions requested and displayed in the query response.
#[prost(message, repeated, tag = "4")]
pub dimensions: ::prost::alloc::vec::Vec<AudienceDimension>,
/// Output only. The current state for this AudienceList.
#[prost(enumeration = "audience_list::State", optional, tag = "5")]
pub state: ::core::option::Option<i32>,
/// Output only. The time when CreateAudienceList was called and the
/// AudienceList began the `CREATING` state.
#[prost(message, optional, tag = "6")]
pub begin_creating_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The total quota tokens charged during creation of the
/// AudienceList. Because this token count is based on activity from the
/// `CREATING` state, this tokens charged will be fixed once an AudienceList
/// enters the `ACTIVE` or `FAILED` states.
#[prost(int32, tag = "7")]
pub creation_quota_tokens_charged: i32,
/// Output only. The total number of rows in the AudienceList result.
#[prost(int32, optional, tag = "8")]
pub row_count: ::core::option::Option<i32>,
/// Output only. Error message is populated when an audience list fails during
/// creation. A common reason for such a failure is quota exhaustion.
#[prost(string, optional, tag = "9")]
pub error_message: ::core::option::Option<::prost::alloc::string::String>,
/// Output only. The percentage completed for this audience export ranging
/// between 0 to 100.
#[prost(double, optional, tag = "11")]
pub percentage_completed: ::core::option::Option<f64>,
/// Output only. The recurring audience list that created this audience list.
/// Recurring audience lists create audience lists daily.
///
/// If audience lists are created directly, they will have no associated
/// recurring audience list, and this field will be blank.
#[prost(string, optional, tag = "12")]
pub recurring_audience_list: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Configures webhook notifications to be sent from the Google
/// Analytics Data API to your webhook server. Use of webhooks is optional. If
/// unused, you'll need to poll this API to determine when an audience list is
/// ready to be used. Webhooks allow a notification to be sent to your servers
/// & avoid the need for polling.
///
/// Either one or two POST requests will be sent to the webhook. The first POST
/// request will be sent immediately showing the newly created audience list in
/// its CREATING state. The second POST request will be sent after the audience
/// list completes creation (either the ACTIVE or FAILED state).
///
/// If identical audience lists are requested in quick succession, the second &
/// subsequent audience lists can be served from cache. In that case, the
/// audience list create method can return an audience list is already ACTIVE.
/// In this scenario, only one POST request will be sent to the webhook.
#[prost(message, optional, tag = "13")]
pub webhook_notification: ::core::option::Option<WebhookNotification>,
}
/// Nested message and enum types in `AudienceList`.
pub mod audience_list {
/// The AudienceList currently exists in this state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified state will never be used.
Unspecified = 0,
/// The AudienceList is currently creating and will be available in the
/// future. Creating occurs immediately after the CreateAudienceList call.
Creating = 1,
/// The AudienceList is fully created and ready for querying. An AudienceList
/// is updated to active asynchronously from a request; this occurs some
/// time (for example 15 minutes) after the initial create call.
Active = 2,
/// The AudienceList failed to be created. It is possible that re-requesting
/// this audience list will succeed.
Failed = 3,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Active => "ACTIVE",
State::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"ACTIVE" => Some(Self::Active),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
}
/// This metadata is currently blank.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AudienceListMetadata {}
/// A request to list users in an audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryAudienceListRequest {
/// Required. The name of the audience list to retrieve users from.
/// Format: `properties/{property}/audienceLists/{audience_list}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The row count of the start row. The first row is counted as row
/// 0.
///
/// When paging, the first request does not specify offset; or equivalently,
/// sets offset to 0; the first request returns the first `limit` of rows. The
/// second request sets offset to the `limit` of the first request; the second
/// request returns the second `limit` of rows.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "2")]
pub offset: i64,
/// Optional. The number of rows to return. If unspecified, 10,000 rows are
/// returned. The API returns a maximum of 250,000 rows per request, no matter
/// how many you ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
/// aren't as many dimension values as the `limit`.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "3")]
pub limit: i64,
}
/// A list of users in an audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryAudienceListResponse {
/// Configuration data about AudienceList being queried. Returned to help
/// interpret the audience rows in this response. For example, the dimensions
/// in this AudienceList correspond to the columns in the AudienceRows.
#[prost(message, optional, tag = "1")]
pub audience_list: ::core::option::Option<AudienceList>,
/// Rows for each user in an audience list. The number of rows in this
/// response will be less than or equal to request's page size.
#[prost(message, repeated, tag = "2")]
pub audience_rows: ::prost::alloc::vec::Vec<AudienceRow>,
/// The total number of rows in the AudienceList result. `rowCount` is
/// independent of the number of rows returned in the response, the `limit`
/// request parameter, and the `offset` request parameter. For example if a
/// query returns 175 rows and includes `limit` of 50 in the API request, the
/// response will contain `rowCount` of 175 but only 50 rows.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int32, optional, tag = "3")]
pub row_count: ::core::option::Option<i32>,
}
/// A request to export users in an audience list to a Google Sheet.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SheetExportAudienceListRequest {
/// Required. The name of the audience list to retrieve users from.
/// Format: `properties/{property}/audienceLists/{audience_list}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The row count of the start row. The first row is counted as row
/// 0.
///
/// When paging, the first request does not specify offset; or equivalently,
/// sets offset to 0; the first request returns the first `limit` of rows. The
/// second request sets offset to the `limit` of the first request; the second
/// request returns the second `limit` of rows.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "2")]
pub offset: i64,
/// Optional. The number of rows to return. If unspecified, 10,000 rows are
/// returned. The API returns a maximum of 250,000 rows per request, no matter
/// how many you ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
/// aren't as many dimension values as the `limit`.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "3")]
pub limit: i64,
}
/// The created Google Sheet with the list of users in an audience list.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SheetExportAudienceListResponse {
/// A uri for you to visit in your browser to view the Google Sheet.
#[prost(string, optional, tag = "1")]
pub spreadsheet_uri: ::core::option::Option<::prost::alloc::string::String>,
/// An ID that identifies the created Google Sheet resource.
#[prost(string, optional, tag = "2")]
pub spreadsheet_id: ::core::option::Option<::prost::alloc::string::String>,
/// The total number of rows in the AudienceList result. `rowCount` is
/// independent of the number of rows returned in the response, the `limit`
/// request parameter, and the `offset` request parameter. For example if a
/// query returns 175 rows and includes `limit` of 50 in the API request, the
/// response will contain `rowCount` of 175 but only 50 rows.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int32, optional, tag = "3")]
pub row_count: ::core::option::Option<i32>,
/// Configuration data about AudienceList being exported. Returned to help
/// interpret the AudienceList in the Google Sheet of this response.
///
/// For example, the AudienceList may have more rows than are present in the
/// Google Sheet, and in that case, you may want to send an additional sheet
/// export request with a different `offset` value to retrieve the next page of
/// rows in an additional Google Sheet.
#[prost(message, optional, tag = "4")]
pub audience_list: ::core::option::Option<AudienceList>,
}
/// Dimension value attributes for the audience user row.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudienceRow {
/// Each dimension value attribute for an audience user. One dimension value
/// will be added for each dimension column requested.
#[prost(message, repeated, tag = "1")]
pub dimension_values: ::prost::alloc::vec::Vec<AudienceDimensionValue>,
}
/// An audience dimension is a user attribute. Specific user attributed are
/// requested and then later returned in the `QueryAudienceListResponse`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudienceDimension {
/// Optional. The API name of the dimension. See the [API
/// Dimensions](<https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions>)
/// for the list of dimension names.
#[prost(string, tag = "1")]
pub dimension_name: ::prost::alloc::string::String,
}
/// The value of a dimension.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudienceDimensionValue {
/// One kind of dimension value.
#[prost(oneof = "audience_dimension_value::OneValue", tags = "1")]
pub one_value: ::core::option::Option<audience_dimension_value::OneValue>,
}
/// Nested message and enum types in `AudienceDimensionValue`.
pub mod audience_dimension_value {
/// One kind of dimension value.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneValue {
/// Value as a string if the dimension type is a string.
#[prost(string, tag = "1")]
Value(::prost::alloc::string::String),
}
}
/// The request for a funnel report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunFunnelReportRequest {
/// Optional. A Google Analytics GA4 property identifier whose events are
/// tracked. Specified in the URL path and not the body. To learn more, see
/// [where to find your Property
/// ID](<https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>).
/// Within a batch request, this property should either be unspecified or
/// consistent with the batch-level property.
///
/// Example: properties/1234
#[prost(string, tag = "1")]
pub property: ::prost::alloc::string::String,
/// Optional. Date ranges of data to read. If multiple date ranges are
/// requested, each response row will contain a zero based date range index. If
/// two date ranges overlap, the event data for the overlapping days is
/// included in the response rows for both date ranges.
#[prost(message, repeated, tag = "2")]
pub date_ranges: ::prost::alloc::vec::Vec<DateRange>,
/// Optional. The configuration of this request's funnel. This funnel
/// configuration is required.
#[prost(message, optional, tag = "3")]
pub funnel: ::core::option::Option<Funnel>,
/// Optional. If specified, this breakdown adds a dimension to the funnel table
/// sub report response. This breakdown dimension expands each funnel step to
/// the unique values of the breakdown dimension. For example, a breakdown by
/// the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
/// `desktop`, and the total.
#[prost(message, optional, tag = "4")]
pub funnel_breakdown: ::core::option::Option<FunnelBreakdown>,
/// Optional. If specified, next action adds a dimension to the funnel
/// visualization sub report response. This next action dimension expands each
/// funnel step to the unique values of the next action. For example a next
/// action of the `eventName` dimension will create rows for several events
/// (for example `session_start` & `click`) and the total.
///
/// Next action only supports `eventName` and most Page / Screen dimensions
/// like `pageTitle` and `pagePath`.
#[prost(message, optional, tag = "5")]
pub funnel_next_action: ::core::option::Option<FunnelNextAction>,
/// Optional. The funnel visualization type controls the dimensions present in
/// the funnel visualization sub report response. If not specified,
/// `STANDARD_FUNNEL` is used.
#[prost(
enumeration = "run_funnel_report_request::FunnelVisualizationType",
tag = "6"
)]
pub funnel_visualization_type: i32,
/// Optional. The configurations of segments. Segments are subsets of a
/// property's data. In a funnel report with segments, the funnel is evaluated
/// in each segment.
///
/// Each segment specified in this request
/// produces a separate row in the response; in the response, each segment
/// identified by its name.
///
/// The segments parameter is optional. Requests are limited to 4 segments.
#[prost(message, repeated, tag = "7")]
pub segments: ::prost::alloc::vec::Vec<Segment>,
/// Optional. The number of rows to return. If unspecified, 10,000 rows are
/// returned. The API returns a maximum of 250,000 rows per request, no matter
/// how many you ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
/// aren't as many dimension values as the `limit`.
#[prost(int64, tag = "9")]
pub limit: i64,
/// Optional. Dimension filters allow you to ask for only specific dimension
/// values in the report. To learn more, see [Creating a Report: Dimension
/// Filters](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>)
/// for examples. Metrics cannot be used in this filter.
#[prost(message, optional, tag = "10")]
pub dimension_filter: ::core::option::Option<FilterExpression>,
/// Optional. Toggles whether to return the current state of this Analytics
/// Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
#[prost(bool, tag = "12")]
pub return_property_quota: bool,
}
/// Nested message and enum types in `RunFunnelReportRequest`.
pub mod run_funnel_report_request {
/// Controls the dimensions present in the funnel visualization sub report
/// response.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum FunnelVisualizationType {
/// Unspecified type.
Unspecified = 0,
/// A standard (stepped) funnel. The funnel visualization sub report in the
/// response will not contain date.
StandardFunnel = 1,
/// A trended (line chart) funnel. The funnel visualization sub report in the
/// response will contain the date dimension.
TrendedFunnel = 2,
}
impl FunnelVisualizationType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
FunnelVisualizationType::Unspecified => {
"FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED"
}
FunnelVisualizationType::StandardFunnel => "STANDARD_FUNNEL",
FunnelVisualizationType::TrendedFunnel => "TRENDED_FUNNEL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"STANDARD_FUNNEL" => Some(Self::StandardFunnel),
"TRENDED_FUNNEL" => Some(Self::TrendedFunnel),
_ => None,
}
}
}
}
/// The funnel report response contains two sub reports. The two sub reports are
/// different combinations of dimensions and metrics.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunFunnelReportResponse {
/// The funnel table is a report with the funnel step, segment, breakdown
/// dimension, active users, completion rate, abandonments, and abandonments
/// rate.
///
/// The segment dimension is only present in this response if a segment was
/// requested. The breakdown dimension is only present in this response if it
/// was requested.
#[prost(message, optional, tag = "1")]
pub funnel_table: ::core::option::Option<FunnelSubReport>,
/// The funnel visualization is a report with the funnel step, segment, date,
/// next action dimension, and active users.
///
/// The segment dimension is only present in this response if a segment was
/// requested. The date dimension is only present in this response if it was
/// requested through the `TRENDED_FUNNEL` funnel type. The next action
/// dimension is only present in the response if it was requested.
#[prost(message, optional, tag = "2")]
pub funnel_visualization: ::core::option::Option<FunnelSubReport>,
/// This Analytics Property's quota state including this request.
#[prost(message, optional, tag = "3")]
pub property_quota: ::core::option::Option<PropertyQuota>,
/// Identifies what kind of resource this message is. This `kind` is always the
/// fixed string "analyticsData#runFunnelReport". Useful to distinguish between
/// response types in JSON.
#[prost(string, tag = "4")]
pub kind: ::prost::alloc::string::String,
}
/// A specific report task configuration.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportTask {
/// Output only. Identifier. The report task resource name assigned during
/// creation. Format: `properties/{property}/reportTasks/{report_task}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. A report definition to fetch report data, which describes the
/// structure of a report. It typically includes the fields that will be
/// included in the report and the criteria that will be used to filter the
/// data.
#[prost(message, optional, tag = "2")]
pub report_definition: ::core::option::Option<report_task::ReportDefinition>,
/// Output only. The report metadata for a specific report task, which provides
/// information about a report. It typically includes the following
/// information: the resource name of the report, the state of the report, the
/// timestamp the report was created, etc,
#[prost(message, optional, tag = "3")]
pub report_metadata: ::core::option::Option<report_task::ReportMetadata>,
}
/// Nested message and enum types in `ReportTask`.
pub mod report_task {
/// The definition of how a report should be run.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportDefinition {
/// Optional. The dimensions requested and displayed.
#[prost(message, repeated, tag = "2")]
pub dimensions: ::prost::alloc::vec::Vec<super::Dimension>,
/// Optional. The metrics requested and displayed.
#[prost(message, repeated, tag = "3")]
pub metrics: ::prost::alloc::vec::Vec<super::Metric>,
/// Optional. Date ranges of data to read. If multiple date ranges are
/// requested, each response row will contain a zero based date range index.
/// If two date ranges overlap, the event data for the overlapping days is
/// included in the response rows for both date ranges. In a cohort request,
/// this `dateRanges` must be unspecified.
#[prost(message, repeated, tag = "4")]
pub date_ranges: ::prost::alloc::vec::Vec<super::DateRange>,
/// Optional. Dimension filters let you ask for only specific dimension
/// values in the report. To learn more, see [Fundamentals of Dimension
/// Filters](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>)
/// for examples. Metrics cannot be used in this filter.
#[prost(message, optional, tag = "5")]
pub dimension_filter: ::core::option::Option<super::FilterExpression>,
/// Optional. The filter clause of metrics. Applied after aggregating the
/// report's rows, similar to SQL having-clause. Dimensions cannot be used in
/// this filter.
#[prost(message, optional, tag = "6")]
pub metric_filter: ::core::option::Option<super::FilterExpression>,
/// Optional. The row count of the start row from Google Analytics Storage.
/// The first row is counted as row 0.
///
/// When creating a report task, the `offset` and `limit` parameters define
/// the subset of data rows from Google Analytics storage to be included in
/// the generated report. For example, if there are a total of 300,000 rows
/// in Google Analytics storage, the initial report task may have the
/// first 10,000 rows with a limit of 10,000 and an offset of 0.
/// Subsequently, another report task could cover the next 10,000 rows with a
/// limit of 10,000 and an offset of 10,000.
#[prost(int64, tag = "7")]
pub offset: i64,
/// Optional. The number of rows to return in the Report. If unspecified,
/// 10,000 rows are returned. The API returns a maximum of 250,000 rows per
/// request, no matter how many you ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
/// aren't as many dimension values as the `limit`. For instance, there are
/// fewer than 300 possible values for the dimension `country`, so when
/// reporting on only `country`, you can't get more than 300 rows, even if
/// you set `limit` to a higher value.
#[prost(int64, tag = "8")]
pub limit: i64,
/// Optional. Aggregation of metrics. Aggregated metric values will be shown
/// in rows where the dimension_values are set to
/// "RESERVED_(MetricAggregation)".
#[prost(
enumeration = "super::MetricAggregation",
repeated,
packed = "false",
tag = "9"
)]
pub metric_aggregations: ::prost::alloc::vec::Vec<i32>,
/// Optional. Specifies how rows are ordered in the response.
#[prost(message, repeated, tag = "10")]
pub order_bys: ::prost::alloc::vec::Vec<super::OrderBy>,
/// Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY".
/// If the field is empty, the report uses the property's default currency.
#[prost(string, tag = "11")]
pub currency_code: ::prost::alloc::string::String,
/// Optional. Cohort group associated with this request. If there is a cohort
/// group in the request the 'cohort' dimension must be present.
#[prost(message, optional, tag = "12")]
pub cohort_spec: ::core::option::Option<super::CohortSpec>,
/// Optional. If false or unspecified, each row with all metrics equal to 0
/// will not be returned. If true, these rows will be returned if they are
/// not separately removed by a filter.
///
/// Regardless of this `keep_empty_rows` setting, only data recorded by the
/// Google Analytics (GA4) property can be displayed in a report.
///
/// For example if a property never logs a `purchase` event, then a query for
/// the `eventName` dimension and `eventCount` metric will not have a row
/// containing eventName: "purchase" and eventCount: 0.
#[prost(bool, tag = "13")]
pub keep_empty_rows: bool,
}
/// The report metadata for a specific report task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportMetadata {
/// Output only. The current state for this report task.
#[prost(enumeration = "report_metadata::State", optional, tag = "1")]
pub state: ::core::option::Option<i32>,
/// Output only. The time when `CreateReportTask` was called and the report
/// began the `CREATING` state.
#[prost(message, optional, tag = "2")]
pub begin_creating_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The total quota tokens charged during creation of the
/// report. Because this token count is based on activity from the `CREATING`
/// state, this tokens charge will be fixed once a report task enters the
/// `ACTIVE` or `FAILED` state.
#[prost(int32, tag = "3")]
pub creation_quota_tokens_charged: i32,
/// Output only. The total number of rows in the report result. This field
/// will be populated when the state is active. You can utilize
/// `task_row_count` for pagination within the confines of their existing
/// report.
#[prost(int32, optional, tag = "4")]
pub task_row_count: ::core::option::Option<i32>,
/// Output only. Error message is populated if a report task fails during
/// creation.
#[prost(string, optional, tag = "5")]
pub error_message: ::core::option::Option<::prost::alloc::string::String>,
/// Output only. The total number of rows in Google Analytics storage. If you
/// want to query additional data rows beyond the current report, they can
/// initiate a new report task based on the `total_row_count`.
///
/// The `task_row_count` represents the number of rows specifically
/// pertaining to the current report, whereas `total_row_count` encompasses
/// the total count of rows across all data retrieved from Google
/// Analytics storage.
///
/// For example, suppose the current report's `task_row_count` is 20,
/// displaying the data from the first 20 rows. Simultaneously, the
/// `total_row_count` is 30, indicating the presence of data for all 30 rows.
/// The `task_row_count` can be utilizated to paginate through the initial 20
/// rows. To expand the report and include data from all 30 rows, a new
/// report task can be created using the total_row_count to access the full
/// set of 30 rows' worth of data.
#[prost(int32, optional, tag = "6")]
pub total_row_count: ::core::option::Option<i32>,
}
/// Nested message and enum types in `ReportMetadata`.
pub mod report_metadata {
/// The processing state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified state will never be used.
Unspecified = 0,
/// The report is currently creating and will be available in the
/// future. Creating occurs immediately after the CreateReport call.
Creating = 1,
/// The report is fully created and ready for querying.
Active = 2,
/// The report failed to be created.
Failed = 3,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Active => "ACTIVE",
State::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"ACTIVE" => Some(Self::Active),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
}
}
/// A request to create a report task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateReportTaskRequest {
/// Required. The parent resource where this report task will be created.
/// Format: `properties/{propertyId}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The report task configuration to create.
#[prost(message, optional, tag = "2")]
pub report_task: ::core::option::Option<ReportTask>,
}
/// Represents the metadata of a long-running operation. Currently, this metadata
/// is blank.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReportTaskMetadata {}
/// A request to fetch the report content for a report task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryReportTaskRequest {
/// Required. The report source name.
/// Format: `properties/{property}/reportTasks/{report}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The row count of the start row in the report. The first row is
/// counted as row 0.
///
/// When paging, the first request does not specify offset; or equivalently,
/// sets offset to 0; the first request returns the first `limit` of rows. The
/// second request sets offset to the `limit` of the first request; the second
/// request returns the second `limit` of rows.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "2")]
pub offset: i64,
/// Optional. The number of rows to return from the report. If unspecified,
/// 10,000 rows are returned. The API returns a maximum of 250,000 rows per
/// request, no matter how many you ask for. `limit` must be positive.
///
/// The API can also return fewer rows than the requested `limit`, if there
/// aren't as many dimension values as the `limit`. The number of rows
/// available to a QueryReportTaskRequest is further limited by the limit of
/// the associated ReportTask. A query can retrieve at most ReportTask.limit
/// rows. For example, if the ReportTask has a limit of 1,000, then a
/// QueryReportTask request with offset=900 and limit=500 will return at most
/// 100 rows.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "3")]
pub limit: i64,
}
/// The report content corresponding to a report task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryReportTaskResponse {
/// Describes dimension columns. The number of DimensionHeaders and ordering of
/// DimensionHeaders matches the dimensions present in rows.
#[prost(message, repeated, tag = "1")]
pub dimension_headers: ::prost::alloc::vec::Vec<DimensionHeader>,
/// Describes metric columns. The number of MetricHeaders and ordering of
/// MetricHeaders matches the metrics present in rows.
#[prost(message, repeated, tag = "2")]
pub metric_headers: ::prost::alloc::vec::Vec<MetricHeader>,
/// Rows of dimension value combinations and metric values in the report.
#[prost(message, repeated, tag = "3")]
pub rows: ::prost::alloc::vec::Vec<Row>,
/// If requested, the totaled values of metrics.
#[prost(message, repeated, tag = "4")]
pub totals: ::prost::alloc::vec::Vec<Row>,
/// If requested, the maximum values of metrics.
#[prost(message, repeated, tag = "5")]
pub maximums: ::prost::alloc::vec::Vec<Row>,
/// If requested, the minimum values of metrics.
#[prost(message, repeated, tag = "6")]
pub minimums: ::prost::alloc::vec::Vec<Row>,
/// The total number of rows in the query result.
#[prost(int32, tag = "7")]
pub row_count: i32,
/// Metadata for the report.
#[prost(message, optional, tag = "8")]
pub metadata: ::core::option::Option<ResponseMetaData>,
}
/// A request to retrieve configuration metadata about a specific report task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetReportTaskRequest {
/// Required. The report task resource name.
/// Format: `properties/{property}/reportTasks/{report_task}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A request to list all report tasks for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListReportTasksRequest {
/// Required. All report tasks for this property will be listed in the
/// response. Format: `properties/{property}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The maximum number of report tasks to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. A page token, received from a previous `ListReportTasks` call.
/// Provide this to retrieve the subsequent page.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// A list of all report tasks for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListReportTasksResponse {
/// Each report task for a property.
#[prost(message, repeated, tag = "1")]
pub report_tasks: ::prost::alloc::vec::Vec<ReportTask>,
/// A token, which can be sent as `page_token` to retrieve the next page.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, optional, tag = "2")]
pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
}
/// Generated client implementations.
pub mod alpha_analytics_data_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Google Analytics reporting data service.
#[derive(Debug, Clone)]
pub struct AlphaAnalyticsDataClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> AlphaAnalyticsDataClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> AlphaAnalyticsDataClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
AlphaAnalyticsDataClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Returns a customized funnel report of your Google Analytics event data. The
/// data returned from the API is as a table with columns for the requested
/// dimensions and metrics.
///
/// Funnel exploration lets you visualize the steps your users take to complete
/// a task and quickly see how well they are succeeding or failing at each
/// step. For example, how do prospects become shoppers and then become buyers?
/// How do one time buyers become repeat buyers? With this information, you can
/// improve inefficient or abandoned customer journeys. To learn more, see [GA4
/// Funnel Explorations](https://support.google.com/analytics/answer/9327974).
///
/// This method is introduced at alpha stability with the intention of
/// gathering feedback on syntax and capabilities before entering beta. To give
/// your feedback on this API, complete the [Google Analytics Data API Funnel
/// Reporting
/// Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform).
pub async fn run_funnel_report(
&mut self,
request: impl tonic::IntoRequest<super::RunFunnelReportRequest>,
) -> std::result::Result<
tonic::Response<super::RunFunnelReportResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/RunFunnelReport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"RunFunnelReport",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an audience list for later retrieval. This method quickly returns
/// the audience list's resource name and initiates a long running asynchronous
/// request to form an audience list. To list the users in an audience list,
/// first create the audience list through this method and then send the
/// audience resource name to the `QueryAudienceList` method.
///
/// See [Creating an Audience
/// List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Lists with examples.
///
/// An audience list is a snapshot of the users currently in the audience at
/// the time of audience list creation. Creating audience lists for one
/// audience on different days will return different results as users enter and
/// exit the audience.
///
/// Audiences in Google Analytics 4 allow you to segment your users in the ways
/// that are important to your business. To learn more, see
/// https://support.google.com/analytics/answer/9267572. Audience lists contain
/// the users in each audience.
///
/// This method is available at beta stability at
/// [audienceExports.create](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/create).
/// To give your feedback on this API, complete the [Google Analytics Audience
/// Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn create_audience_list(
&mut self,
request: impl tonic::IntoRequest<super::CreateAudienceListRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/CreateAudienceList",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"CreateAudienceList",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves an audience list of users. After creating an audience, the users
/// are not immediately available for listing. First, a request to
/// `CreateAudienceList` is necessary to create an audience list of users, and
/// then second, this method is used to retrieve the users in the audience
/// list.
///
/// See [Creating an Audience
/// List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Lists with examples.
///
/// Audiences in Google Analytics 4 allow you to segment your users in the ways
/// that are important to your business. To learn more, see
/// https://support.google.com/analytics/answer/9267572.
///
/// This method is available at beta stability at
/// [audienceExports.query](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/query).
/// To give your feedback on this API, complete the [Google Analytics Audience
/// Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn query_audience_list(
&mut self,
request: impl tonic::IntoRequest<super::QueryAudienceListRequest>,
) -> std::result::Result<
tonic::Response<super::QueryAudienceListResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/QueryAudienceList",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"QueryAudienceList",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports an audience list of users to a Google Sheet. After creating an
/// audience, the users are not immediately available for listing. First, a
/// request to `CreateAudienceList` is necessary to create an audience list of
/// users, and then second, this method is used to export those users in the
/// audience list to a Google Sheet.
///
/// See [Creating an Audience
/// List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Lists with examples.
///
/// Audiences in Google Analytics 4 allow you to segment your users in the ways
/// that are important to your business. To learn more, see
/// https://support.google.com/analytics/answer/9267572.
///
/// This method is introduced at alpha stability with the intention of
/// gathering feedback on syntax and capabilities before entering beta. To give
/// your feedback on this API, complete the
/// [Google Analytics Audience Export API
/// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn sheet_export_audience_list(
&mut self,
request: impl tonic::IntoRequest<super::SheetExportAudienceListRequest>,
) -> std::result::Result<
tonic::Response<super::SheetExportAudienceListResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/SheetExportAudienceList",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"SheetExportAudienceList",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets configuration metadata about a specific audience list. This method
/// can be used to understand an audience list after it has been created.
///
/// See [Creating an Audience
/// List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Lists with examples.
///
/// This method is available at beta stability at
/// [audienceExports.get](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/get).
/// To give your feedback on this API, complete the
/// [Google Analytics Audience Export API
/// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn get_audience_list(
&mut self,
request: impl tonic::IntoRequest<super::GetAudienceListRequest>,
) -> std::result::Result<tonic::Response<super::AudienceList>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/GetAudienceList",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"GetAudienceList",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all audience lists for a property. This method can be used for you to
/// find and reuse existing audience lists rather than creating unnecessary new
/// audience lists. The same audience can have multiple audience lists that
/// represent the list of users that were in an audience on different days.
///
/// See [Creating an Audience
/// List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Lists with examples.
///
/// This method is available at beta stability at
/// [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list).
/// To give your feedback on this API, complete the
/// [Google Analytics Audience Export API
/// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn list_audience_lists(
&mut self,
request: impl tonic::IntoRequest<super::ListAudienceListsRequest>,
) -> std::result::Result<
tonic::Response<super::ListAudienceListsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/ListAudienceLists",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"ListAudienceLists",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a recurring audience list. Recurring audience lists produces new
/// audience lists each day. Audience lists are users in an audience at the
/// time of the list's creation.
///
/// A recurring audience list ensures that you have audience list based on the
/// most recent data available for use each day. If you manually create
/// audience list, you don't know when an audience list based on an additional
/// day's data is available. This recurring audience list automates the
/// creation of an audience list when an additional day's data is available.
/// You will consume fewer quota tokens by using recurring audience list versus
/// manually creating audience list at various times of day trying to guess
/// when an additional day's data is ready.
///
/// This method is introduced at alpha stability with the intention of
/// gathering feedback on syntax and capabilities before entering beta. To give
/// your feedback on this API, complete the
/// [Google Analytics Audience Export API
/// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn create_recurring_audience_list(
&mut self,
request: impl tonic::IntoRequest<super::CreateRecurringAudienceListRequest>,
) -> std::result::Result<
tonic::Response<super::RecurringAudienceList>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/CreateRecurringAudienceList",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"CreateRecurringAudienceList",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets configuration metadata about a specific recurring audience list. This
/// method can be used to understand a recurring audience list's state after it
/// has been created. For example, a recurring audience list resource will
/// generate audience list instances for each day, and this method can be used
/// to get the resource name of the most recent audience list instance.
///
/// This method is introduced at alpha stability with the intention of
/// gathering feedback on syntax and capabilities before entering beta. To give
/// your feedback on this API, complete the
/// [Google Analytics Audience Export API
/// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn get_recurring_audience_list(
&mut self,
request: impl tonic::IntoRequest<super::GetRecurringAudienceListRequest>,
) -> std::result::Result<
tonic::Response<super::RecurringAudienceList>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/GetRecurringAudienceList",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"GetRecurringAudienceList",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all recurring audience lists for a property. This method can be used
/// for you to find and reuse existing recurring audience lists rather than
/// creating unnecessary new recurring audience lists. The same audience can
/// have multiple recurring audience lists that represent different dimension
/// combinations; for example, just the dimension `deviceId` or both the
/// dimensions `deviceId` and `userId`.
///
/// This method is introduced at alpha stability with the intention of
/// gathering feedback on syntax and capabilities before entering beta. To give
/// your feedback on this API, complete the
/// [Google Analytics Audience Export API
/// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
pub async fn list_recurring_audience_lists(
&mut self,
request: impl tonic::IntoRequest<super::ListRecurringAudienceListsRequest>,
) -> std::result::Result<
tonic::Response<super::ListRecurringAudienceListsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/ListRecurringAudienceLists",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"ListRecurringAudienceLists",
),
);
self.inner.unary(req, path, codec).await
}
/// Initiates the creation of a report task. This method quickly
/// returns a report task and initiates a long running
/// asynchronous request to form a customized report of your Google Analytics
/// event data.
pub async fn create_report_task(
&mut self,
request: impl tonic::IntoRequest<super::CreateReportTaskRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/CreateReportTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"CreateReportTask",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a report task's content. After requesting the `CreateReportTask`,
/// you are able to retrieve the report content once the report is
/// ACTIVE. This method will return an error if the report task's state is not
/// `ACTIVE`. A query response will return the tabular row & column values of
/// the report.
pub async fn query_report_task(
&mut self,
request: impl tonic::IntoRequest<super::QueryReportTaskRequest>,
) -> std::result::Result<
tonic::Response<super::QueryReportTaskResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/QueryReportTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"QueryReportTask",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets report metadata about a specific report task. After creating a report
/// task, use this method to check its processing state or inspect its
/// report definition.
pub async fn get_report_task(
&mut self,
request: impl tonic::IntoRequest<super::GetReportTaskRequest>,
) -> std::result::Result<tonic::Response<super::ReportTask>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/GetReportTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"GetReportTask",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all report tasks for a property.
pub async fn list_report_tasks(
&mut self,
request: impl tonic::IntoRequest<super::ListReportTasksRequest>,
) -> std::result::Result<
tonic::Response<super::ListReportTasksResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.analytics.data.v1alpha.AlphaAnalyticsData/ListReportTasks",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1alpha.AlphaAnalyticsData",
"ListReportTasks",
),
);
self.inner.unary(req, path, codec).await
}
}
}