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
// 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,
}
/// A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
/// `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MinuteRange {
/// The inclusive start minute for the query as a number of minutes before now.
/// For example, `"startMinutesAgo": 29` specifies the report should include
/// event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`.
///
/// If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
/// properties can request up to the last 30 minutes of event data
/// (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
/// the last 60 minutes of event data (`startMinutesAgo <= 59`).
#[prost(int32, optional, tag = "1")]
pub start_minutes_ago: ::core::option::Option<i32>,
/// The inclusive end minute for the query as a number of minutes before now.
/// Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
/// specifies the report should include event data from prior to 15 minutes
/// ago.
///
/// If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
/// properties can request any minute in the last 30 minutes of event data
/// (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
/// minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
#[prost(int32, optional, tag = "2")]
pub end_minutes_ago: ::core::option::Option<i32>,
/// Assigns a name to this minute 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, minute 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".
/// Requests are allowed up to 9 dimensions.
#[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,
}
/// Defines an individual comparison. Most requests will include multiple
/// comparisons so that the report compares between the comparisons.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Comparison {
/// Each comparison produces separate rows in the response. In the response,
/// this comparison is identified by this name. If name is unspecified, we will
/// use the saved comparisons display name.
#[prost(string, optional, tag = "1")]
pub name: ::core::option::Option<::prost::alloc::string::String>,
/// One kind of comparison value
#[prost(oneof = "comparison::OneComparison", tags = "2, 3")]
pub one_comparison: ::core::option::Option<comparison::OneComparison>,
}
/// Nested message and enum types in `Comparison`.
pub mod comparison {
/// One kind of comparison value
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneComparison {
/// A basic comparison.
#[prost(message, tag = "2")]
DimensionFilter(super::FilterExpression),
/// A saved comparison identified by the comparison's resource name.
/// For example, 'comparisons/1234'.
#[prost(string, tag = "3")]
Comparison(::prost::alloc::string::String),
}
}
/// 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.
///
/// In most methods, dimensions & metrics can be used for the first time in
/// this field. However in a RunPivotReportRequest, this field must be
/// additionally specified by name in the RunPivotReportRequest's 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 = "3, 4, 5, 6")]
pub one_filter: ::core::option::Option<filter::OneFilter>,
}
/// Nested message and enum types in `Filter`.
pub mod filter {
/// 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<super::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,
}
}
}
}
/// 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<super::NumericValue>,
/// Ends with this number.
#[prost(message, optional, tag = "2")]
pub to_value: ::core::option::Option<super::NumericValue>,
}
/// Specify one type of filter for `Filter`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OneFilter {
/// Strings related filter.
#[prost(message, tag = "3")]
StringFilter(StringFilter),
/// A filter for in list values.
#[prost(message, tag = "4")]
InListFilter(InListFilter),
/// A filter for numeric or date values.
#[prost(message, tag = "5")]
NumericFilter(NumericFilter),
/// A filter for two values.
#[prost(message, tag = "6")]
BetweenFilter(BetweenFilter),
}
}
/// 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, 3")]
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,
}
}
}
}
/// Sorts by a pivot column group.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PivotOrderBy {
/// In the response to order by, order rows by this column. Must be a metric
/// name from the request.
#[prost(string, tag = "1")]
pub metric_name: ::prost::alloc::string::String,
/// Used to select a dimension name and value pivot. If multiple pivot
/// selections are given, the sort occurs on rows where all pivot selection
/// dimension name and value pairs match the row's dimension name and value
/// pair.
#[prost(message, repeated, tag = "2")]
pub pivot_selections: ::prost::alloc::vec::Vec<pivot_order_by::PivotSelection>,
}
/// Nested message and enum types in `PivotOrderBy`.
pub mod pivot_order_by {
/// A pair of dimension names and values. Rows with this dimension pivot pair
/// are ordered by the metric's value.
///
/// For example if pivots = {{"browser", "Chrome"}} and
/// metric_name = "Sessions",
/// then the rows will be sorted based on Sessions in Chrome.
///
/// ---------|----------|----------------|----------|----------------
/// | Chrome | Chrome | Safari | Safari
/// ---------|----------|----------------|----------|----------------
/// Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions
/// ---------|----------|----------------|----------|----------------
/// US | 2 | 2 | 3 | 1
/// ---------|----------|----------------|----------|----------------
/// Canada | 3 | 1 | 4 | 1
/// ---------|----------|----------------|----------|----------------
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PivotSelection {
/// Must be a dimension name from the request.
#[prost(string, tag = "1")]
pub dimension_name: ::prost::alloc::string::String,
/// Order by only when the named dimension is this value.
#[prost(string, tag = "2")]
pub dimension_value: ::prost::alloc::string::String,
}
}
/// 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),
/// Sorts results by a metric's values within a pivot column group.
#[prost(message, tag = "3")]
Pivot(PivotOrderBy),
}
}
/// Describes the visible dimension columns and rows in the report response.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Pivot {
/// Dimension names for visible columns in the report response. Including
/// "dateRange" produces a date range column; for each row in the response,
/// dimension values in the date range column will indicate the corresponding
/// date range from the request.
#[prost(string, repeated, tag = "1")]
pub field_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Specifies how dimensions are ordered in the pivot. In the first Pivot, the
/// OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
/// Pivots, the OrderBys determine only PivotDimensionHeader ordering.
/// Dimensions specified in these OrderBys must be a subset of
/// Pivot.field_names.
#[prost(message, repeated, tag = "2")]
pub order_bys: ::prost::alloc::vec::Vec<OrderBy>,
/// The row count of the start row. The first row is counted as row 0.
#[prost(int64, tag = "3")]
pub offset: i64,
/// The number of unique combinations of dimension values to return in this
/// pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
/// single pivot requests.
///
/// The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
/// must not exceed 250,000. For example, a two pivot request with `limit:
/// 1000` in each pivot will fail because the product is `1,000,000`.
#[prost(int64, tag = "4")]
pub limit: i64,
/// Aggregate the metrics by dimensions in this pivot using the specified
/// metric_aggregations.
#[prost(enumeration = "MetricAggregation", repeated, tag = "5")]
pub metric_aggregations: ::prost::alloc::vec::Vec<i32>,
}
/// 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>).
#[prost(bool, optional, tag = "8")]
pub subject_to_thresholding: ::core::option::Option<bool>,
/// If this report results is
/// [sampled](<https://support.google.com/analytics/answer/13331292>), this
/// describes the percentage of events used in this 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 = "9")]
pub sampling_metadatas: ::prost::alloc::vec::Vec<SamplingMetadata>,
}
/// 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>,
}
}
}
/// If this report results is
/// [sampled](<https://support.google.com/analytics/answer/13331292>), this
/// describes the percentage of events used in this report. 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 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 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
/// report, compute `samplesReadCount/samplingSpaceSize`.
#[prost(int64, tag = "2")]
pub sampling_space_size: i64,
}
/// 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,
}
/// Dimensions' values in a single pivot.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PivotHeader {
/// The size is the same as the cardinality of the corresponding dimension
/// combinations.
#[prost(message, repeated, tag = "1")]
pub pivot_dimension_headers: ::prost::alloc::vec::Vec<PivotDimensionHeader>,
/// The cardinality of the pivot. The total number of rows for this pivot's
/// fields regardless of how the parameters `offset` and `limit` are specified
/// in the request.
#[prost(int32, tag = "2")]
pub row_count: i32,
}
/// Summarizes dimension values from a row for this pivot.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PivotDimensionHeader {
/// Values of multiple dimensions in a pivot.
#[prost(message, repeated, tag = "1")]
pub dimension_values: ::prost::alloc::vec::Vec<DimensionValue>,
}
/// 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),
}
}
/// 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),
}
}
/// 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, optional, tag = "1")]
pub consumed: ::core::option::Option<i32>,
/// Quota remaining after this request.
#[prost(int32, optional, tag = "2")]
pub remaining: ::core::option::Option<i32>,
}
/// Explains a dimension.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DimensionMetadata {
/// This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
/// example, `eventName`.
#[prost(string, tag = "1")]
pub api_name: ::prost::alloc::string::String,
/// This dimension's name within the Google Analytics user interface. For
/// example, `Event name`.
#[prost(string, tag = "2")]
pub ui_name: ::prost::alloc::string::String,
/// Description of how this dimension is used and calculated.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Still usable but deprecated names for this dimension. If populated, this
/// dimension is available by either `apiName` or one of `deprecatedApiNames`
/// for a period of time. After the deprecation period, the dimension will be
/// available only by `apiName`.
#[prost(string, repeated, tag = "4")]
pub deprecated_api_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// True if the dimension is custom to this property. This includes user,
/// event, & item scoped custom dimensions; to learn more about custom
/// dimensions, see <https://support.google.com/analytics/answer/14240153.> This
/// also include custom channel groups; to learn more about custom channel
/// groups, see <https://support.google.com/analytics/answer/13051316.>
#[prost(bool, tag = "5")]
pub custom_definition: bool,
/// The display name of the category that this dimension belongs to. Similar
/// dimensions and metrics are categorized together.
#[prost(string, tag = "7")]
pub category: ::prost::alloc::string::String,
}
/// Explains a metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricMetadata {
/// A metric name. Useable in [Metric](#Metric)'s `name`. For example,
/// `eventCount`.
#[prost(string, tag = "1")]
pub api_name: ::prost::alloc::string::String,
/// This metric's name within the Google Analytics user interface. For example,
/// `Event count`.
#[prost(string, tag = "2")]
pub ui_name: ::prost::alloc::string::String,
/// Description of how this metric is used and calculated.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Still usable but deprecated names for this metric. If populated, this
/// metric is available by either `apiName` or one of `deprecatedApiNames`
/// for a period of time. After the deprecation period, the metric will be
/// available only by `apiName`.
#[prost(string, repeated, tag = "4")]
pub deprecated_api_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The type of this metric.
#[prost(enumeration = "MetricType", tag = "5")]
pub r#type: i32,
/// The mathematical expression for this derived metric. Can be used in
/// [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
/// are not expressions, and for non-expressions, this field is empty.
#[prost(string, tag = "6")]
pub expression: ::prost::alloc::string::String,
/// True if the metric is a custom metric for this property.
#[prost(bool, tag = "7")]
pub custom_definition: bool,
/// If reasons are specified, your access is blocked to this metric for this
/// property. API requests from you to this property for this metric will
/// succeed; however, the report will contain only zeros for this metric. API
/// requests with metric filters on blocked metrics will fail. If reasons are
/// empty, you have access to this metric.
///
/// To learn more, see [Access and data-restriction
/// management](<https://support.google.com/analytics/answer/10851388>).
#[prost(enumeration = "metric_metadata::BlockedReason", repeated, tag = "8")]
pub blocked_reasons: ::prost::alloc::vec::Vec<i32>,
/// The display name of the category that this metrics belongs to. Similar
/// dimensions and metrics are categorized together.
#[prost(string, tag = "10")]
pub category: ::prost::alloc::string::String,
}
/// Nested message and enum types in `MetricMetadata`.
pub mod metric_metadata {
/// Justifications for why this metric is blocked.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum BlockedReason {
/// Will never be specified in API response.
Unspecified = 0,
/// If present, your access is blocked to revenue related metrics for this
/// property, and this metric is revenue related.
NoRevenueMetrics = 1,
/// If present, your access is blocked to cost related metrics for this
/// property, and this metric is cost related.
NoCostMetrics = 2,
}
impl BlockedReason {
/// 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 {
BlockedReason::Unspecified => "BLOCKED_REASON_UNSPECIFIED",
BlockedReason::NoRevenueMetrics => "NO_REVENUE_METRICS",
BlockedReason::NoCostMetrics => "NO_COST_METRICS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"BLOCKED_REASON_UNSPECIFIED" => Some(Self::Unspecified),
"NO_REVENUE_METRICS" => Some(Self::NoRevenueMetrics),
"NO_COST_METRICS" => Some(Self::NoCostMetrics),
_ => None,
}
}
}
}
/// The metadata for a single comparison.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ComparisonMetadata {
/// This comparison's resource name. Useable in [Comparison](#Comparison)'s
/// `comparison` field. For example, 'comparisons/1234'.
#[prost(string, tag = "1")]
pub api_name: ::prost::alloc::string::String,
/// This comparison's name within the Google Analytics user interface.
#[prost(string, tag = "2")]
pub ui_name: ::prost::alloc::string::String,
/// This comparison's description.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
}
/// The compatibility for a single dimension.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DimensionCompatibility {
/// The dimension metadata contains the API name for this compatibility
/// information. The dimension metadata also contains other helpful information
/// like the UI name and description.
#[prost(message, optional, tag = "1")]
pub dimension_metadata: ::core::option::Option<DimensionMetadata>,
/// The compatibility of this dimension. If the compatibility is COMPATIBLE,
/// this dimension can be successfully added to the report.
#[prost(enumeration = "Compatibility", optional, tag = "2")]
pub compatibility: ::core::option::Option<i32>,
}
/// The compatibility for a single metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricCompatibility {
/// The metric metadata contains the API name for this compatibility
/// information. The metric metadata also contains other helpful information
/// like the UI name and description.
#[prost(message, optional, tag = "1")]
pub metric_metadata: ::core::option::Option<MetricMetadata>,
/// The compatibility of this metric. If the compatibility is COMPATIBLE,
/// this metric can be successfully added to the report.
#[prost(enumeration = "Compatibility", optional, tag = "2")]
pub compatibility: ::core::option::Option<i32>,
}
/// 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,
}
}
}
/// The compatibility types for a single dimension or metric.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Compatibility {
/// Unspecified compatibility.
Unspecified = 0,
/// The dimension or metric is compatible. This dimension or metric can be
/// successfully added to a report.
Compatible = 1,
/// The dimension or metric is incompatible. This dimension or metric cannot be
/// successfully added to a report.
Incompatible = 2,
}
impl Compatibility {
/// 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 {
Compatibility::Unspecified => "COMPATIBILITY_UNSPECIFIED",
Compatibility::Compatible => "COMPATIBLE",
Compatibility::Incompatible => "INCOMPATIBLE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"COMPATIBILITY_UNSPECIFIED" => Some(Self::Unspecified),
"COMPATIBLE" => Some(Self::Compatible),
"INCOMPATIBLE" => Some(Self::Incompatible),
_ => None,
}
}
}
/// The request for compatibility information for a report's dimensions and
/// metrics. Check compatibility provides a preview of the compatibility of a
/// report; fields shared with the `runReport` request should be the same values
/// as in your `runReport` request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckCompatibilityRequest {
/// A Google Analytics GA4 property identifier whose events are tracked. To
/// learn more, see [where to find your Property
/// ID](<https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>).
/// `property` should be the same value as in your `runReport` request.
///
/// Example: properties/1234
#[prost(string, tag = "1")]
pub property: ::prost::alloc::string::String,
/// The dimensions in this report. `dimensions` should be the same value as in
/// your `runReport` request.
#[prost(message, repeated, tag = "2")]
pub dimensions: ::prost::alloc::vec::Vec<Dimension>,
/// The metrics in this report. `metrics` should be the same value as in your
/// `runReport` request.
#[prost(message, repeated, tag = "3")]
pub metrics: ::prost::alloc::vec::Vec<Metric>,
/// The filter clause of dimensions. `dimensionFilter` should be the same value
/// as in your `runReport` request.
#[prost(message, optional, tag = "4")]
pub dimension_filter: ::core::option::Option<FilterExpression>,
/// The filter clause of metrics. `metricFilter` should be the same value as in
/// your `runReport` request
#[prost(message, optional, tag = "5")]
pub metric_filter: ::core::option::Option<FilterExpression>,
/// Filters the dimensions and metrics in the response to just this
/// compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”`
/// to only return compatible dimensions & metrics.
#[prost(enumeration = "Compatibility", tag = "6")]
pub compatibility_filter: i32,
}
/// The compatibility response with the compatibility of each dimension & metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckCompatibilityResponse {
/// The compatibility of each dimension.
#[prost(message, repeated, tag = "1")]
pub dimension_compatibilities: ::prost::alloc::vec::Vec<DimensionCompatibility>,
/// The compatibility of each metric.
#[prost(message, repeated, tag = "2")]
pub metric_compatibilities: ::prost::alloc::vec::Vec<MetricCompatibility>,
}
/// The dimensions, metrics and comparisons currently accepted in reporting
/// methods.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Metadata {
/// Resource name of this metadata.
#[prost(string, tag = "3")]
pub name: ::prost::alloc::string::String,
/// The dimension descriptions.
#[prost(message, repeated, tag = "1")]
pub dimensions: ::prost::alloc::vec::Vec<DimensionMetadata>,
/// The metric descriptions.
#[prost(message, repeated, tag = "2")]
pub metrics: ::prost::alloc::vec::Vec<MetricMetadata>,
/// The comparison descriptions.
#[prost(message, repeated, tag = "4")]
pub comparisons: ::prost::alloc::vec::Vec<ComparisonMetadata>,
}
/// The request to generate a report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunReportRequest {
/// 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,
/// The dimensions requested and displayed.
#[prost(message, repeated, tag = "2")]
pub dimensions: ::prost::alloc::vec::Vec<Dimension>,
/// The metrics requested and displayed.
#[prost(message, repeated, tag = "3")]
pub metrics: ::prost::alloc::vec::Vec<Metric>,
/// 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<DateRange>,
/// 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<FilterExpression>,
/// 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<FilterExpression>,
/// 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 = "7")]
pub offset: i64,
/// 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`. 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.
///
/// To learn more about this pagination parameter, see
/// [Pagination](<https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>).
#[prost(int64, tag = "8")]
pub limit: i64,
/// Aggregation of metrics. Aggregated metric values will be shown in rows
/// where the dimension_values are set to "RESERVED_(MetricAggregation)".
#[prost(enumeration = "MetricAggregation", repeated, tag = "9")]
pub metric_aggregations: ::prost::alloc::vec::Vec<i32>,
/// Specifies how rows are ordered in the response.
#[prost(message, repeated, tag = "10")]
pub order_bys: ::prost::alloc::vec::Vec<OrderBy>,
/// 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,
/// 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<CohortSpec>,
/// 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
/// eventName: "purchase" and eventCount: 0.
#[prost(bool, tag = "13")]
pub keep_empty_rows: bool,
/// Toggles whether to return the current state of this Analytics Property's
/// quota. Quota is returned in [PropertyQuota](#PropertyQuota).
#[prost(bool, tag = "14")]
pub return_property_quota: bool,
/// Optional. The configuration of comparisons requested and displayed. The
/// request only requires a comparisons field in order to receive a comparison
/// column in the response.
#[prost(message, repeated, tag = "15")]
pub comparisons: ::prost::alloc::vec::Vec<Comparison>,
}
/// The response report table corresponding to a request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunReportResponse {
/// 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. `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, tag = "7")]
pub row_count: i32,
/// Metadata for the report.
#[prost(message, optional, tag = "8")]
pub metadata: ::core::option::Option<ResponseMetaData>,
/// This Analytics Property's quota state including this request.
#[prost(message, optional, tag = "9")]
pub property_quota: ::core::option::Option<PropertyQuota>,
/// Identifies what kind of resource this message is. This `kind` is always the
/// fixed string "analyticsData#runReport". Useful to distinguish between
/// response types in JSON.
#[prost(string, tag = "10")]
pub kind: ::prost::alloc::string::String,
}
/// The request to generate a pivot report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunPivotReportRequest {
/// 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,
/// The dimensions requested. All defined dimensions must be used by one of the
/// following: dimension_expression, dimension_filter, pivots, order_bys.
#[prost(message, repeated, tag = "2")]
pub dimensions: ::prost::alloc::vec::Vec<Dimension>,
/// The metrics requested, at least one metric needs to be specified. All
/// defined metrics must be used by one of the following: metric_expression,
/// metric_filter, order_bys.
#[prost(message, repeated, tag = "3")]
pub metrics: ::prost::alloc::vec::Vec<Metric>,
/// The date range to retrieve event data for the report. If multiple date
/// ranges are specified, event data from each date range is used in the
/// report. A special dimension with field name "dateRange" can be included in
/// a Pivot's field names; if included, the report compares between date
/// ranges. In a cohort request, this `dateRanges` must be unspecified.
#[prost(message, repeated, tag = "4")]
pub date_ranges: ::prost::alloc::vec::Vec<DateRange>,
/// Describes the visual format of the report's dimensions in columns or rows.
/// The union of the fieldNames (dimension names) in all pivots must be a
/// subset of dimension names defined in Dimensions. No two pivots can share a
/// dimension. A dimension is only visible if it appears in a pivot.
#[prost(message, repeated, tag = "5")]
pub pivots: ::prost::alloc::vec::Vec<Pivot>,
/// The filter clause of dimensions. Dimensions must be requested to be used in
/// this filter. Metrics cannot be used in this filter.
#[prost(message, optional, tag = "6")]
pub dimension_filter: ::core::option::Option<FilterExpression>,
/// The filter clause of metrics. Applied at post aggregation phase, similar to
/// SQL having-clause. Metrics must be requested to be used in this filter.
/// Dimensions cannot be used in this filter.
#[prost(message, optional, tag = "7")]
pub metric_filter: ::core::option::Option<FilterExpression>,
/// 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 = "8")]
pub currency_code: ::prost::alloc::string::String,
/// 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 = "9")]
pub cohort_spec: ::core::option::Option<CohortSpec>,
/// 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
/// eventName: "purchase" and eventCount: 0.
#[prost(bool, tag = "10")]
pub keep_empty_rows: bool,
/// Toggles whether to return the current state of this Analytics Property's
/// quota. Quota is returned in [PropertyQuota](#PropertyQuota).
#[prost(bool, tag = "11")]
pub return_property_quota: bool,
/// Optional. The configuration of comparisons requested and displayed. The
/// request requires both a comparisons field and a comparisons dimension to
/// receive a comparison column in the response.
#[prost(message, repeated, tag = "12")]
pub comparisons: ::prost::alloc::vec::Vec<Comparison>,
}
/// The response pivot report table corresponding to a pivot request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunPivotReportResponse {
/// Summarizes the columns and rows created by a pivot. Each pivot in the
/// request produces one header in the response. If we have a request like
/// this:
///
/// "pivots": [{
/// "fieldNames": ["country",
/// "city"]
/// },
/// {
/// "fieldNames": "eventName"
/// }]
///
/// We will have the following `pivotHeaders` in the response:
///
/// "pivotHeaders" : [{
/// "dimensionHeaders": [{
/// "dimensionValues": [
/// { "value": "United Kingdom" },
/// { "value": "London" }
/// ]
/// },
/// {
/// "dimensionValues": [
/// { "value": "Japan" },
/// { "value": "Osaka" }
/// ]
/// }]
/// },
/// {
/// "dimensionHeaders": [{
/// "dimensionValues": \[{ "value": "session_start" }\]
/// },
/// {
/// "dimensionValues": \[{ "value": "scroll" }\]
/// }]
/// }]
#[prost(message, repeated, tag = "1")]
pub pivot_headers: ::prost::alloc::vec::Vec<PivotHeader>,
/// Describes dimension columns. The number of DimensionHeaders and ordering of
/// DimensionHeaders matches the dimensions present in rows.
#[prost(message, repeated, tag = "2")]
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 = "3")]
pub metric_headers: ::prost::alloc::vec::Vec<MetricHeader>,
/// Rows of dimension value combinations and metric values in the report.
#[prost(message, repeated, tag = "4")]
pub rows: ::prost::alloc::vec::Vec<Row>,
/// Aggregation of metric values. Can be totals, minimums, or maximums. The
/// returned aggregations are controlled by the metric_aggregations in the
/// pivot. The type of aggregation returned in each row is shown by the
/// dimension_values which are set to "RESERVED_<MetricAggregation>".
#[prost(message, repeated, tag = "5")]
pub aggregates: ::prost::alloc::vec::Vec<Row>,
/// Metadata for the report.
#[prost(message, optional, tag = "6")]
pub metadata: ::core::option::Option<ResponseMetaData>,
/// This Analytics Property's quota state including this request.
#[prost(message, optional, tag = "7")]
pub property_quota: ::core::option::Option<PropertyQuota>,
/// Identifies what kind of resource this message is. This `kind` is always the
/// fixed string "analyticsData#runPivotReport". Useful to distinguish between
/// response types in JSON.
#[prost(string, tag = "8")]
pub kind: ::prost::alloc::string::String,
}
/// The batch request containing multiple report requests.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchRunReportsRequest {
/// 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>).
/// This property must be specified for the batch. The property within
/// RunReportRequest may either be unspecified or consistent with this
/// property.
///
/// Example: properties/1234
#[prost(string, tag = "1")]
pub property: ::prost::alloc::string::String,
/// Individual requests. Each request has a separate report response. Each
/// batch request is allowed up to 5 requests.
#[prost(message, repeated, tag = "2")]
pub requests: ::prost::alloc::vec::Vec<RunReportRequest>,
}
/// The batch response containing multiple reports.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchRunReportsResponse {
/// Individual responses. Each response has a separate report request.
#[prost(message, repeated, tag = "1")]
pub reports: ::prost::alloc::vec::Vec<RunReportResponse>,
/// Identifies what kind of resource this message is. This `kind` is always the
/// fixed string "analyticsData#batchRunReports". Useful to distinguish between
/// response types in JSON.
#[prost(string, tag = "2")]
pub kind: ::prost::alloc::string::String,
}
/// The batch request containing multiple pivot report requests.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchRunPivotReportsRequest {
/// 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>).
/// This property must be specified for the batch. The property within
/// RunPivotReportRequest may either be unspecified or consistent with this
/// property.
///
/// Example: properties/1234
#[prost(string, tag = "1")]
pub property: ::prost::alloc::string::String,
/// Individual requests. Each request has a separate pivot report response.
/// Each batch request is allowed up to 5 requests.
#[prost(message, repeated, tag = "2")]
pub requests: ::prost::alloc::vec::Vec<RunPivotReportRequest>,
}
/// The batch response containing multiple pivot reports.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchRunPivotReportsResponse {
/// Individual responses. Each response has a separate pivot report request.
#[prost(message, repeated, tag = "1")]
pub pivot_reports: ::prost::alloc::vec::Vec<RunPivotReportResponse>,
/// Identifies what kind of resource this message is. This `kind` is always the
/// fixed string "analyticsData#batchRunPivotReports". Useful to distinguish
/// between response types in JSON.
#[prost(string, tag = "2")]
pub kind: ::prost::alloc::string::String,
}
/// Request for a property's dimension and metric metadata.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetMetadataRequest {
/// Required. The resource name of the metadata to retrieve. This name field is
/// specified in the URL path and not URL parameters. Property is a numeric
/// Google Analytics GA4 Property identifier. To learn more, see [where to find
/// your Property
/// ID](<https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>).
///
/// Example: properties/1234/metadata
///
/// Set the Property ID to 0 for dimensions and metrics common to all
/// properties. In this special mode, this method will not return custom
/// dimensions and metrics.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request to generate a realtime report.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunRealtimeReportRequest {
/// 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>).
///
/// Example: properties/1234
#[prost(string, tag = "1")]
pub property: ::prost::alloc::string::String,
/// The dimensions requested and displayed.
#[prost(message, repeated, tag = "2")]
pub dimensions: ::prost::alloc::vec::Vec<Dimension>,
/// The metrics requested and displayed.
#[prost(message, repeated, tag = "3")]
pub metrics: ::prost::alloc::vec::Vec<Metric>,
/// The filter clause of dimensions. Metrics cannot be used in this filter.
#[prost(message, optional, tag = "4")]
pub dimension_filter: ::core::option::Option<FilterExpression>,
/// The filter clause of metrics. Applied at post aggregation phase, similar to
/// SQL having-clause. Dimensions cannot be used in this filter.
#[prost(message, optional, tag = "5")]
pub metric_filter: ::core::option::Option<FilterExpression>,
/// 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`. 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 = "6")]
pub limit: i64,
/// Aggregation of metrics. Aggregated metric values will be shown in rows
/// where the dimension_values are set to "RESERVED_(MetricAggregation)".
#[prost(enumeration = "MetricAggregation", repeated, tag = "7")]
pub metric_aggregations: ::prost::alloc::vec::Vec<i32>,
/// Specifies how rows are ordered in the response.
#[prost(message, repeated, tag = "8")]
pub order_bys: ::prost::alloc::vec::Vec<OrderBy>,
/// Toggles whether to return the current state of this Analytics Property's
/// Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
#[prost(bool, tag = "9")]
pub return_property_quota: bool,
/// The minute ranges of event data to read. If unspecified, one minute range
/// for the last 30 minutes will be used. If multiple minute ranges are
/// requested, each response row will contain a zero based minute range index.
/// If two minute ranges overlap, the event data for the overlapping minutes is
/// included in the response rows for both minute ranges.
#[prost(message, repeated, tag = "10")]
pub minute_ranges: ::prost::alloc::vec::Vec<MinuteRange>,
}
/// The response realtime report table corresponding to a request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunRealtimeReportResponse {
/// 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. `rowCount` is independent of
/// the number of rows returned in the response and the `limit` 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.
#[prost(int32, tag = "7")]
pub row_count: i32,
/// This Analytics Property's Realtime quota state including this request.
#[prost(message, optional, tag = "8")]
pub property_quota: ::core::option::Option<PropertyQuota>,
/// Identifies what kind of resource this message is. This `kind` is always the
/// fixed string "analyticsData#runRealtimeReport". Useful to distinguish
/// between response types in JSON.
#[prost(string, tag = "9")]
pub kind: ::prost::alloc::string::String,
}
/// A request to retrieve configuration metadata about a specific audience
/// export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAudienceExportRequest {
/// Required. The audience export resource name.
/// Format: `properties/{property}/audienceExports/{audience_export}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A request to list all audience exports for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAudienceExportsRequest {
/// Required. All audience exports 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 exports to return. The service may
/// return fewer than this value. If unspecified, at most 200 audience exports
/// 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 `ListAudienceExports`
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to `ListAudienceExports`
/// 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 exports for a property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAudienceExportsResponse {
/// Each audience export for a property.
#[prost(message, repeated, tag = "1")]
pub audience_exports: ::prost::alloc::vec::Vec<AudienceExport>,
/// 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 export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateAudienceExportRequest {
/// Required. The parent resource where this audience export will be created.
/// Format: `properties/{property}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The audience export to create.
#[prost(message, optional, tag = "2")]
pub audience_export: ::core::option::Option<AudienceExport>,
}
/// An audience export is a list of users in an audience at the time of the
/// list's creation. One audience may have multiple audience exports created for
/// different days.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudienceExport {
/// Output only. Identifier. The audience export resource name assigned during
/// creation. This resource name identifies this `AudienceExport`.
///
/// Format: `properties/{property}/audienceExports/{audience_export}`
#[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 AudienceExport.
#[prost(enumeration = "audience_export::State", optional, tag = "5")]
pub state: ::core::option::Option<i32>,
/// Output only. The time when CreateAudienceExport was called and the
/// AudienceExport 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
/// AudienceExport. Because this token count is based on activity from the
/// `CREATING` state, this tokens charged will be fixed once an AudienceExport
/// 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 AudienceExport result.
#[prost(int32, optional, tag = "8")]
pub row_count: ::core::option::Option<i32>,
/// Output only. Error message is populated when an audience export 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 = "10")]
pub percentage_completed: ::core::option::Option<f64>,
}
/// Nested message and enum types in `AudienceExport`.
pub mod audience_export {
/// The AudienceExport 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 AudienceExport is currently creating and will be available in the
/// future. Creating occurs immediately after the CreateAudienceExport call.
Creating = 1,
/// The AudienceExport is fully created and ready for querying. An
/// AudienceExport is updated to active asynchronously from a request; this
/// occurs some time (for example 15 minutes) after the initial create call.
Active = 2,
/// The AudienceExport failed to be created. It is possible that
/// re-requesting this audience export 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 AudienceExportMetadata {}
/// A request to list users in an audience export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryAudienceExportRequest {
/// Required. The name of the audience export to retrieve users from.
/// Format: `properties/{property}/audienceExports/{audience_export}`
#[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 export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryAudienceExportResponse {
/// Configuration data about AudienceExport being queried. Returned to help
/// interpret the audience rows in this response. For example, the dimensions
/// in this AudienceExport correspond to the columns in the AudienceRows.
#[prost(message, optional, tag = "1")]
pub audience_export: ::core::option::Option<AudienceExport>,
/// Rows for each user in an audience export. 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 AudienceExport 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>,
}
/// 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 `QueryAudienceExportResponse`.
#[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),
}
}
/// Generated client implementations.
pub mod beta_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 BetaAnalyticsDataClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> BetaAnalyticsDataClient<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,
) -> BetaAnalyticsDataClient<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,
{
BetaAnalyticsDataClient::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 report of your Google Analytics event data. Reports
/// contain statistics derived from data collected by the Google Analytics
/// tracking code. The data returned from the API is as a table with columns
/// for the requested dimensions and metrics. Metrics are individual
/// measurements of user activity on your property, such as active users or
/// event count. Dimensions break down metrics across some common criteria,
/// such as country or event name.
///
/// For a guide to constructing requests & understanding responses, see
/// [Creating a
/// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).
pub async fn run_report(
&mut self,
request: impl tonic::IntoRequest<super::RunReportRequest>,
) -> std::result::Result<
tonic::Response<super::RunReportResponse>,
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.v1beta.BetaAnalyticsData/RunReport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"RunReport",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns a customized pivot report of your Google Analytics event data.
/// Pivot reports are more advanced and expressive formats than regular
/// reports. In a pivot report, dimensions are only visible if they are
/// included in a pivot. Multiple pivots can be specified to further dissect
/// your data.
pub async fn run_pivot_report(
&mut self,
request: impl tonic::IntoRequest<super::RunPivotReportRequest>,
) -> std::result::Result<
tonic::Response<super::RunPivotReportResponse>,
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.v1beta.BetaAnalyticsData/RunPivotReport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"RunPivotReport",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns multiple reports in a batch. All reports must be for the same
/// GA4 Property.
pub async fn batch_run_reports(
&mut self,
request: impl tonic::IntoRequest<super::BatchRunReportsRequest>,
) -> std::result::Result<
tonic::Response<super::BatchRunReportsResponse>,
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.v1beta.BetaAnalyticsData/BatchRunReports",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"BatchRunReports",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns multiple pivot reports in a batch. All reports must be for the same
/// GA4 Property.
pub async fn batch_run_pivot_reports(
&mut self,
request: impl tonic::IntoRequest<super::BatchRunPivotReportsRequest>,
) -> std::result::Result<
tonic::Response<super::BatchRunPivotReportsResponse>,
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.v1beta.BetaAnalyticsData/BatchRunPivotReports",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"BatchRunPivotReports",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns metadata for dimensions and metrics available in reporting methods.
/// Used to explore the dimensions and metrics. In this method, a Google
/// Analytics GA4 Property Identifier is specified in the request, and
/// the metadata response includes Custom dimensions and metrics as well as
/// Universal metadata.
///
/// For example if a custom metric with parameter name `levels_unlocked` is
/// registered to a property, the Metadata response will contain
/// `customEvent:levels_unlocked`. Universal metadata are dimensions and
/// metrics applicable to any property such as `country` and `totalUsers`.
pub async fn get_metadata(
&mut self,
request: impl tonic::IntoRequest<super::GetMetadataRequest>,
) -> std::result::Result<tonic::Response<super::Metadata>, 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.v1beta.BetaAnalyticsData/GetMetadata",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"GetMetadata",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns a customized report of realtime event data for your property.
/// Events appear in realtime reports seconds after they have been sent to
/// the Google Analytics. Realtime reports show events and usage data for the
/// periods of time ranging from the present moment to 30 minutes ago (up to
/// 60 minutes for Google Analytics 360 properties).
///
/// For a guide to constructing realtime requests & understanding responses,
/// see [Creating a Realtime
/// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
pub async fn run_realtime_report(
&mut self,
request: impl tonic::IntoRequest<super::RunRealtimeReportRequest>,
) -> std::result::Result<
tonic::Response<super::RunRealtimeReportResponse>,
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.v1beta.BetaAnalyticsData/RunRealtimeReport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"RunRealtimeReport",
),
);
self.inner.unary(req, path, codec).await
}
/// This compatibility method lists dimensions and metrics that can be added to
/// a report request and maintain compatibility. This method fails if the
/// request's dimensions and metrics are incompatible.
///
/// In Google Analytics, reports fail if they request incompatible dimensions
/// and/or metrics; in that case, you will need to remove dimensions and/or
/// metrics from the incompatible report until the report is compatible.
///
/// The Realtime and Core reports have different compatibility rules. This
/// method checks compatibility for Core reports.
pub async fn check_compatibility(
&mut self,
request: impl tonic::IntoRequest<super::CheckCompatibilityRequest>,
) -> std::result::Result<
tonic::Response<super::CheckCompatibilityResponse>,
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.v1beta.BetaAnalyticsData/CheckCompatibility",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"CheckCompatibility",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an audience export for later retrieval. This method quickly returns
/// the audience export's resource name and initiates a long running
/// asynchronous request to form an audience export. To export the users in an
/// audience export, first create the audience export through this method and
/// then send the audience resource name to the `QueryAudienceExport` method.
///
/// See [Creating an Audience
/// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Exports with examples.
///
/// An audience export is a snapshot of the users currently in the audience at
/// the time of audience export creation. Creating audience exports 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 exports
/// contain the users in each audience.
///
/// Audience Export APIs have some methods at alpha and other methods at beta
/// stability. The intention is to advance methods to beta stability after some
/// feedback and adoption. 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_export(
&mut self,
request: impl tonic::IntoRequest<super::CreateAudienceExportRequest>,
) -> 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.v1beta.BetaAnalyticsData/CreateAudienceExport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"CreateAudienceExport",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves an audience export of users. After creating an audience, the
/// users are not immediately available for exporting. First, a request to
/// `CreateAudienceExport` is necessary to create an audience export of users,
/// and then second, this method is used to retrieve the users in the audience
/// export.
///
/// See [Creating an Audience
/// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Exports 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.
///
/// Audience Export APIs have some methods at alpha and other methods at beta
/// stability. The intention is to advance methods to beta stability after some
/// feedback and adoption. 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_export(
&mut self,
request: impl tonic::IntoRequest<super::QueryAudienceExportRequest>,
) -> std::result::Result<
tonic::Response<super::QueryAudienceExportResponse>,
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.v1beta.BetaAnalyticsData/QueryAudienceExport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"QueryAudienceExport",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets configuration metadata about a specific audience export. This method
/// can be used to understand an audience export after it has been created.
///
/// See [Creating an Audience
/// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Exports with examples.
///
/// Audience Export APIs have some methods at alpha and other methods at beta
/// stability. The intention is to advance methods to beta stability after some
/// feedback and adoption. 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_export(
&mut self,
request: impl tonic::IntoRequest<super::GetAudienceExportRequest>,
) -> std::result::Result<tonic::Response<super::AudienceExport>, 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.v1beta.BetaAnalyticsData/GetAudienceExport",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"GetAudienceExport",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all audience exports for a property. This method can be used for you
/// to find and reuse existing audience exports rather than creating
/// unnecessary new audience exports. The same audience can have multiple
/// audience exports that represent the export of users that were in an
/// audience on different days.
///
/// See [Creating an Audience
/// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
/// for an introduction to Audience Exports with examples.
///
/// Audience Export APIs have some methods at alpha and other methods at beta
/// stability. The intention is to advance methods to beta stability after some
/// feedback and adoption. 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_exports(
&mut self,
request: impl tonic::IntoRequest<super::ListAudienceExportsRequest>,
) -> std::result::Result<
tonic::Response<super::ListAudienceExportsResponse>,
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.v1beta.BetaAnalyticsData/ListAudienceExports",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.analytics.data.v1beta.BetaAnalyticsData",
"ListAudienceExports",
),
);
self.inner.unary(req, path, codec).await
}
}
}