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
use std::collections::HashMap;
use std::cell::RefCell;
use std::default::Default;
use std::collections::BTreeSet;
use std::error::Error as StdError;
use serde_json as json;
use std::io;
use std::fs;
use std::mem;
use hyper::client::connect;
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::time::sleep;
use tower_service;
use serde::{Serialize, Deserialize};
use crate::{client, client::GetToken, client::serde_with};
// ##############
// UTILITIES ###
// ############
/// Identifies the an OAuth2 authorization scope.
/// A scope is needed when requesting an
/// [authorization token](https://developers.google.com/youtube/v3/guides/authentication).
#[derive(PartialEq, Eq, Ord, PartialOrd, Hash, Debug, Clone, Copy)]
pub enum Scope {
/// View and manage your Google Analytics data
Analytic,
/// See and download your Google Analytics data
AnalyticReadonly,
}
impl AsRef<str> for Scope {
fn as_ref(&self) -> &str {
match *self {
Scope::Analytic => "https://www.googleapis.com/auth/analytics",
Scope::AnalyticReadonly => "https://www.googleapis.com/auth/analytics.readonly",
}
}
}
impl Default for Scope {
fn default() -> Scope {
Scope::AnalyticReadonly
}
}
// ########
// HUB ###
// ######
/// Central instance to access all AnalyticsReporting related resource activities
///
/// # Examples
///
/// Instantiate a new hub
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_analyticsreporting4 as analyticsreporting4;
/// use analyticsreporting4::api::SearchUserActivityRequest;
/// use analyticsreporting4::{Result, Error};
/// # async fn dox() {
/// use std::default::Default;
/// use analyticsreporting4::{AnalyticsReporting, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// // Get an ApplicationSecret instance by some means. It contains the `client_id` and
/// // `client_secret`, among other things.
/// let secret: oauth2::ApplicationSecret = Default::default();
/// // Instantiate the authenticator. It will choose a suitable authentication flow for you,
/// // unless you replace `None` with the desired Flow.
/// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
/// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
/// // retrieve them from storage.
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = AnalyticsReporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // As the method needs a request, you would usually fill it with the desired information
/// // into the respective structure. Some of the parts shown here might not be applicable !
/// // Values shown here are possibly random and not representative !
/// let mut req = SearchUserActivityRequest::default();
///
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.user_activity().search(req)
/// .doit().await;
///
/// match result {
/// Err(e) => match e {
/// // The Error enum provides details about what exactly happened.
/// // You can also just use its `Debug`, `Display` or `Error` traits
/// Error::HttpError(_)
/// |Error::Io(_)
/// |Error::MissingAPIKey
/// |Error::MissingToken(_)
/// |Error::Cancelled
/// |Error::UploadSizeLimitExceeded(_, _)
/// |Error::Failure(_)
/// |Error::BadRequest(_)
/// |Error::FieldClash(_)
/// |Error::JsonDecodeError(_, _) => println!("{}", e),
/// },
/// Ok(res) => println!("Success: {:?}", res),
/// }
/// # }
/// ```
#[derive(Clone)]
pub struct AnalyticsReporting<S> {
pub client: hyper::Client<S, hyper::body::Body>,
pub auth: Box<dyn client::GetToken>,
_user_agent: String,
_base_url: String,
_root_url: String,
}
impl<'a, S> client::Hub for AnalyticsReporting<S> {}
impl<'a, S> AnalyticsReporting<S> {
pub fn new<A: 'static + client::GetToken>(client: hyper::Client<S, hyper::body::Body>, auth: A) -> AnalyticsReporting<S> {
AnalyticsReporting {
client,
auth: Box::new(auth),
_user_agent: "google-api-rust-client/5.0.4".to_string(),
_base_url: "https://analyticsreporting.googleapis.com/".to_string(),
_root_url: "https://analyticsreporting.googleapis.com/".to_string(),
}
}
pub fn reports(&'a self) -> ReportMethods<'a, S> {
ReportMethods { hub: &self }
}
pub fn user_activity(&'a self) -> UserActivityMethods<'a, S> {
UserActivityMethods { hub: &self }
}
/// Set the user-agent header field to use in all requests to the server.
/// It defaults to `google-api-rust-client/5.0.4`.
///
/// Returns the previously set user-agent.
pub fn user_agent(&mut self, agent_name: String) -> String {
mem::replace(&mut self._user_agent, agent_name)
}
/// Set the base url to use in all requests to the server.
/// It defaults to `https://analyticsreporting.googleapis.com/`.
///
/// Returns the previously set base url.
pub fn base_url(&mut self, new_base_url: String) -> String {
mem::replace(&mut self._base_url, new_base_url)
}
/// Set the root url to use in all requests to the server.
/// It defaults to `https://analyticsreporting.googleapis.com/`.
///
/// Returns the previously set root url.
pub fn root_url(&mut self, new_root_url: String) -> String {
mem::replace(&mut self._root_url, new_root_url)
}
}
// ############
// SCHEMAS ###
// ##########
/// An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Activity {
/// Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two sessions.
#[serde(rename="activityTime")]
pub activity_time: Option<client::chrono::DateTime<client::chrono::offset::Utc>>,
/// Type of this activity.
#[serde(rename="activityType")]
pub activity_type: Option<String>,
/// This will be set if `activity_type` equals `SCREEN_VIEW`.
pub appview: Option<ScreenviewData>,
/// For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for the property. If you use neither, its value is (not set).
pub campaign: Option<String>,
/// The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings).
#[serde(rename="channelGrouping")]
pub channel_grouping: Option<String>,
/// A list of all custom dimensions associated with this activity.
#[serde(rename="customDimension")]
pub custom_dimension: Option<Vec<CustomDimension>>,
/// This will be set if `activity_type` equals `ECOMMERCE`.
pub ecommerce: Option<EcommerceData>,
/// This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`.
pub event: Option<EventData>,
/// This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`.
pub goals: Option<GoalSetData>,
/// The hostname from which the tracking request was made.
pub hostname: Option<String>,
/// For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set).
pub keyword: Option<String>,
/// The first page in users' sessions, or the landing page.
#[serde(rename="landingPagePath")]
pub landing_page_path: Option<String>,
/// The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, its value is (none).
pub medium: Option<String>,
/// This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited.
pub pageview: Option<PageviewData>,
/// The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct).
pub source: Option<String>,
}
impl client::Part for Activity {}
/// Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Cohort {
/// This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field.
#[serde(rename="dateRange")]
pub date_range: Option<DateRange>,
/// A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].
pub name: Option<String>,
/// Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort.
#[serde(rename="type")]
pub type_: Option<String>,
}
impl client::Part for Cohort {}
/// Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" } },{ "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" } }] }
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct CohortGroup {
/// The definition for the cohort.
pub cohorts: Option<Vec<Cohort>>,
/// Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)
#[serde(rename="lifetimeValue")]
pub lifetime_value: Option<bool>,
}
impl client::Part for CohortGroup {}
/// Column headers.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ColumnHeader {
/// The dimension names in the response.
pub dimensions: Option<Vec<String>>,
/// Metric headers for the metrics in the response.
#[serde(rename="metricHeader")]
pub metric_header: Option<MetricHeader>,
}
impl client::Part for ColumnHeader {}
/// Custom dimension.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct CustomDimension {
/// Slot number of custom dimension.
pub index: Option<i32>,
/// Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value.
pub value: Option<String>,
}
impl client::Part for CustomDimension {}
/// A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DateRange {
/// The end date for the query in the format `YYYY-MM-DD`.
#[serde(rename="endDate")]
pub end_date: Option<String>,
/// The start date for the query in the format `YYYY-MM-DD`.
#[serde(rename="startDate")]
pub start_date: Option<String>,
}
impl client::Part for DateRange {}
/// Used to return a list of metrics for a single DateRange / dimension combination
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DateRangeValues {
/// The values of each pivot region.
#[serde(rename="pivotValueRegions")]
pub pivot_value_regions: Option<Vec<PivotValueRegion>>,
/// Each value corresponds to each Metric in the request.
pub values: Option<Vec<String>>,
}
impl client::Part for DateRangeValues {}
/// [Dimensions](https://support.google.com/analytics/answer/1033861) are attributes of your data. For example, the dimension `ga:city` indicates the city, for example, "Paris" or "New York", from which a session originates.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Dimension {
/// If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of "0, 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4), dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - bucket #6: values >= 7, dimension value "7+" NOTE: If you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: "<50", "1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "<50", "50-120", "121-1000", "1001+" The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension.
#[serde(rename="histogramBuckets")]
#[serde_as(as = "Option<Vec<::client::serde_with::DisplayFromStr>>")]
pub histogram_buckets: Option<Vec<i64>>,
/// Name of the dimension to fetch, for example `ga:browser`.
pub name: Option<String>,
}
impl client::Part for Dimension {}
/// Dimension filter specifies the filtering options on a dimension.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DimensionFilter {
/// Should the match be case sensitive? Default is false.
#[serde(rename="caseSensitive")]
pub case_sensitive: Option<bool>,
/// The dimension to filter on. A DimensionFilter must contain a dimension.
#[serde(rename="dimensionName")]
pub dimension_name: Option<String>,
/// Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator.
pub expressions: Option<Vec<String>>,
/// Logical `NOT` operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false.
pub not: Option<bool>,
/// How to match the dimension to the expression. The default is REGEXP.
pub operator: Option<String>,
}
impl client::Part for DimensionFilter {}
/// A group of dimension filters. Set the operator value to specify how the filters are logically combined.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DimensionFilterClause {
/// The repeated set of filters. They are logically combined based on the operator specified.
pub filters: Option<Vec<DimensionFilter>>,
/// The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`.
pub operator: Option<String>,
}
impl client::Part for DimensionFilterClause {}
/// Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct DynamicSegment {
/// The name of the dynamic segment.
pub name: Option<String>,
/// Session Segment to select sessions to include in the segment.
#[serde(rename="sessionSegment")]
pub session_segment: Option<SegmentDefinition>,
/// User Segment to select users to include in the segment.
#[serde(rename="userSegment")]
pub user_segment: Option<SegmentDefinition>,
}
impl client::Part for DynamicSegment {}
/// E-commerce details associated with the user activity.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct EcommerceData {
/// Action associated with this e-commerce action.
#[serde(rename="actionType")]
pub action_type: Option<String>,
/// The type of this e-commerce activity.
#[serde(rename="ecommerceType")]
pub ecommerce_type: Option<String>,
/// Details of the products in this transaction.
pub products: Option<Vec<ProductData>>,
/// Transaction details of this e-commerce action.
pub transaction: Option<TransactionData>,
}
impl client::Part for EcommerceData {}
/// Represents all the details pertaining to an event.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct EventData {
/// Type of interaction with the object. Eg: 'play'.
#[serde(rename="eventAction")]
pub event_action: Option<String>,
/// The object on the page that was interacted with. Eg: 'Video'.
#[serde(rename="eventCategory")]
pub event_category: Option<String>,
/// Number of such events in this activity.
#[serde(rename="eventCount")]
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
pub event_count: Option<i64>,
/// Label attached with the event.
#[serde(rename="eventLabel")]
pub event_label: Option<String>,
/// Numeric value associated with the event.
#[serde(rename="eventValue")]
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
pub event_value: Option<i64>,
}
impl client::Part for EventData {}
/// The batch request containing multiple report request.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [batch get reports](ReportBatchGetCall) (request)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct GetReportsRequest {
/// Requests, each request will have a separate response. There can be a maximum of 5 requests. All requests should have the same `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
#[serde(rename="reportRequests")]
pub report_requests: Option<Vec<ReportRequest>>,
/// Enables [resource based quotas](https://developers.google.com/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is set to `True` the per view (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and quotas documentation](https://developers.google.com/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.
#[serde(rename="useResourceQuotas")]
pub use_resource_quotas: Option<bool>,
}
impl client::RequestValue for GetReportsRequest {}
/// The main response class which holds the reports from the Reporting API `batchGet` call.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [batch get reports](ReportBatchGetCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct GetReportsResponse {
/// The amount of resource quota tokens deducted to execute the query. Includes all responses.
#[serde(rename="queryCost")]
pub query_cost: Option<i32>,
/// Responses corresponding to each of the request.
pub reports: Option<Vec<Report>>,
/// The amount of resource quota remaining for the property.
#[serde(rename="resourceQuotasRemaining")]
pub resource_quotas_remaining: Option<ResourceQuotasRemaining>,
}
impl client::ResponseResult for GetReportsResponse {}
/// Represents all the details pertaining to a goal.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct GoalData {
/// URL of the page where this goal was completed.
#[serde(rename="goalCompletionLocation")]
pub goal_completion_location: Option<String>,
/// Total number of goal completions in this activity.
#[serde(rename="goalCompletions")]
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
pub goal_completions: Option<i64>,
/// This identifies the goal as configured for the profile.
#[serde(rename="goalIndex")]
pub goal_index: Option<i32>,
/// Name of the goal.
#[serde(rename="goalName")]
pub goal_name: Option<String>,
/// URL of the page one step prior to the goal completion.
#[serde(rename="goalPreviousStep1")]
pub goal_previous_step1: Option<String>,
/// URL of the page two steps prior to the goal completion.
#[serde(rename="goalPreviousStep2")]
pub goal_previous_step2: Option<String>,
/// URL of the page three steps prior to the goal completion.
#[serde(rename="goalPreviousStep3")]
pub goal_previous_step3: Option<String>,
/// Value in this goal.
#[serde(rename="goalValue")]
pub goal_value: Option<f64>,
}
impl client::Part for GoalData {}
/// Represents a set of goals that were reached in an activity.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct GoalSetData {
/// All the goals that were reached in the current activity.
pub goals: Option<Vec<GoalData>>,
}
impl client::Part for GoalSetData {}
/// [Metrics](https://support.google.com/analytics/answer/1033861) are the quantitative measurements. For example, the metric `ga:users` indicates the total number of users for the requested time period.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Metric {
/// An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header.
pub alias: Option<String>,
/// A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results.
pub expression: Option<String>,
/// Specifies how the metric expression should be formatted, for example `INTEGER`.
#[serde(rename="formattingType")]
pub formatting_type: Option<String>,
}
impl client::Part for Metric {}
/// MetricFilter specifies the filter on a metric.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct MetricFilter {
/// The value to compare against.
#[serde(rename="comparisonValue")]
pub comparison_value: Option<String>,
/// The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.
#[serde(rename="metricName")]
pub metric_name: Option<String>,
/// Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.
pub not: Option<bool>,
/// Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue.
pub operator: Option<String>,
}
impl client::Part for MetricFilter {}
/// Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct MetricFilterClause {
/// The repeated set of filters. They are logically combined based on the operator specified.
pub filters: Option<Vec<MetricFilter>>,
/// The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`.
pub operator: Option<String>,
}
impl client::Part for MetricFilterClause {}
/// The headers for the metrics.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct MetricHeader {
/// Headers for the metrics in the response.
#[serde(rename="metricHeaderEntries")]
pub metric_header_entries: Option<Vec<MetricHeaderEntry>>,
/// Headers for the pivots in the response.
#[serde(rename="pivotHeaders")]
pub pivot_headers: Option<Vec<PivotHeader>>,
}
impl client::Part for MetricHeader {}
/// Header for the metrics.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct MetricHeaderEntry {
/// The name of the header.
pub name: Option<String>,
/// The type of the metric, for example `INTEGER`.
#[serde(rename="type")]
pub type_: Option<String>,
}
impl client::Part for MetricHeaderEntry {}
/// A list of segment filters in the `OR` group are combined with the logical OR operator.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct OrFiltersForSegment {
/// List of segment filters to be combined with a `OR` operator.
#[serde(rename="segmentFilterClauses")]
pub segment_filter_clauses: Option<Vec<SegmentFilterClause>>,
}
impl client::Part for OrFiltersForSegment {}
/// Specifies the sorting options.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct OrderBy {
/// The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid.
#[serde(rename="fieldName")]
pub field_name: Option<String>,
/// The order type. The default orderType is `VALUE`.
#[serde(rename="orderType")]
pub order_type: Option<String>,
/// The sorting order for the field.
#[serde(rename="sortOrder")]
pub sort_order: Option<String>,
}
impl client::Part for OrderBy {}
/// Represents details collected when the visitor views a page.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PageviewData {
/// The URL of the page that the visitor viewed.
#[serde(rename="pagePath")]
pub page_path: Option<String>,
/// The title of the page that the visitor viewed.
#[serde(rename="pageTitle")]
pub page_title: Option<String>,
}
impl client::Part for PageviewData {}
/// The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Pivot {
/// DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns.
#[serde(rename="dimensionFilterClauses")]
pub dimension_filter_clauses: Option<Vec<DimensionFilterClause>>,
/// A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.
pub dimensions: Option<Vec<Dimension>>,
/// Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.
#[serde(rename="maxGroupCount")]
pub max_group_count: Option<i32>,
/// The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.
pub metrics: Option<Vec<Metric>>,
/// If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response.
#[serde(rename="startGroup")]
pub start_group: Option<i32>,
}
impl client::Part for Pivot {}
/// The headers for each of the pivot sections defined in the request.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PivotHeader {
/// A single pivot section header.
#[serde(rename="pivotHeaderEntries")]
pub pivot_header_entries: Option<Vec<PivotHeaderEntry>>,
/// The total number of groups for this pivot.
#[serde(rename="totalPivotGroupsCount")]
pub total_pivot_groups_count: Option<i32>,
}
impl client::Part for PivotHeader {}
/// The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PivotHeaderEntry {
/// The name of the dimensions in the pivot response.
#[serde(rename="dimensionNames")]
pub dimension_names: Option<Vec<String>>,
/// The values for the dimensions in the pivot.
#[serde(rename="dimensionValues")]
pub dimension_values: Option<Vec<String>>,
/// The metric header for the metric in the pivot.
pub metric: Option<MetricHeaderEntry>,
}
impl client::Part for PivotHeaderEntry {}
/// The metric values in the pivot region.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct PivotValueRegion {
/// The values of the metrics in each of the pivot regions.
pub values: Option<Vec<String>>,
}
impl client::Part for PivotValueRegion {}
/// Details of the products in an e-commerce transaction.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ProductData {
/// The total revenue from purchased product items.
#[serde(rename="itemRevenue")]
pub item_revenue: Option<f64>,
/// The product name, supplied by the e-commerce tracking application, for the purchased items.
#[serde(rename="productName")]
pub product_name: Option<String>,
/// Total number of this product units in the transaction.
#[serde(rename="productQuantity")]
#[serde_as(as = "Option<::client::serde_with::DisplayFromStr>")]
pub product_quantity: Option<i64>,
/// Unique code that represents the product.
#[serde(rename="productSku")]
pub product_sku: Option<String>,
}
impl client::Part for ProductData {}
/// The data response corresponding to the request.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [batch get reports](ReportBatchGetCall) (none)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Report {
/// The column headers.
#[serde(rename="columnHeader")]
pub column_header: Option<ColumnHeader>,
/// Response data.
pub data: Option<ReportData>,
/// Page token to retrieve the next page of results in the list.
#[serde(rename="nextPageToken")]
pub next_page_token: Option<String>,
}
impl client::Resource for Report {}
/// The data part of the report.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ReportData {
/// The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.
#[serde(rename="dataLastRefreshed")]
pub data_last_refreshed: Option<client::chrono::DateTime<client::chrono::offset::Utc>>,
/// If empty reason is specified, the report is empty for this reason.
#[serde(rename="emptyReason")]
pub empty_reason: Option<String>,
/// Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time.
#[serde(rename="isDataGolden")]
pub is_data_golden: Option<bool>,
/// Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.
pub maximums: Option<Vec<DateRangeValues>>,
/// Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.
pub minimums: Option<Vec<DateRangeValues>>,
/// Total number of matching rows for this query.
#[serde(rename="rowCount")]
pub row_count: Option<i32>,
/// There's one ReportRow for every unique combination of dimensions.
pub rows: Option<Vec<ReportRow>>,
/// If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](https://developers.google.com/analytics/devguides/reporting/core/v4/basics#sampling) for details.
#[serde(rename="samplesReadCounts")]
#[serde_as(as = "Option<Vec<::client::serde_with::DisplayFromStr>>")]
pub samples_read_counts: Option<Vec<i64>>,
/// If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](https://developers.google.com/analytics/devguides/reporting/core/v4/basics#sampling) for details.
#[serde(rename="samplingSpaceSizes")]
#[serde_as(as = "Option<Vec<::client::serde_with::DisplayFromStr>>")]
pub sampling_space_sizes: Option<Vec<i64>>,
/// For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination.
pub totals: Option<Vec<DateRangeValues>>,
}
impl client::Part for ReportData {}
/// The main request class which specifies the Reporting API request.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ReportRequest {
/// Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition.
#[serde(rename="cohortGroup")]
pub cohort_group: Option<CohortGroup>,
/// Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition.
#[serde(rename="dateRanges")]
pub date_ranges: Option<Vec<DateRange>>,
/// The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
#[serde(rename="dimensionFilterClauses")]
pub dimension_filter_clauses: Option<Vec<DimensionFilterClause>>,
/// The dimensions requested. Requests can have a total of 9 dimensions.
pub dimensions: Option<Vec<Dimension>>,
/// Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
#[serde(rename="filtersExpression")]
pub filters_expression: Option<String>,
/// If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
#[serde(rename="hideTotals")]
pub hide_totals: Option<bool>,
/// If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
#[serde(rename="hideValueRanges")]
pub hide_value_ranges: Option<bool>,
/// If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
#[serde(rename="includeEmptyRows")]
pub include_empty_rows: Option<bool>,
/// The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
#[serde(rename="metricFilterClauses")]
pub metric_filter_clauses: Option<Vec<MetricFilterClause>>,
/// The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
pub metrics: Option<Vec<Metric>>,
/// Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
#[serde(rename="orderBys")]
pub order_bys: Option<Vec<OrderBy>>,
/// Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
#[serde(rename="pageSize")]
pub page_size: Option<i32>,
/// A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
#[serde(rename="pageToken")]
pub page_token: Option<String>,
/// The pivot definitions. Requests can have a maximum of 2 pivots.
pub pivots: Option<Vec<Pivot>>,
/// The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](https://developers.google.com/analytics/devguides/reporting/core/v4/basics#sampling) for details.
#[serde(rename="samplingLevel")]
pub sampling_level: Option<String>,
/// Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension.
pub segments: Option<Vec<Segment>>,
/// The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`.
#[serde(rename="viewId")]
pub view_id: Option<String>,
}
impl client::Part for ReportRequest {}
/// A row in the report.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ReportRow {
/// List of requested dimensions.
pub dimensions: Option<Vec<String>>,
/// List of metrics for each requested DateRange.
pub metrics: Option<Vec<DateRangeValues>>,
}
impl client::Part for ReportRow {}
/// The resource quota tokens remaining for the property after the request is completed.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ResourceQuotasRemaining {
/// Daily resource quota remaining remaining.
#[serde(rename="dailyQuotaTokensRemaining")]
pub daily_quota_tokens_remaining: Option<i32>,
/// Hourly resource quota tokens remaining.
#[serde(rename="hourlyQuotaTokensRemaining")]
pub hourly_quota_tokens_remaining: Option<i32>,
}
impl client::Part for ResourceQuotasRemaining {}
/// There is no detailed description.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct ScreenviewData {
/// The application name.
#[serde(rename="appName")]
pub app_name: Option<String>,
/// Mobile manufacturer or branded name. Eg: "Google", "Apple" etc.
#[serde(rename="mobileDeviceBranding")]
pub mobile_device_branding: Option<String>,
/// Mobile device model. Eg: "Pixel", "iPhone" etc.
#[serde(rename="mobileDeviceModel")]
pub mobile_device_model: Option<String>,
/// The name of the screen.
#[serde(rename="screenName")]
pub screen_name: Option<String>,
}
impl client::Part for ScreenviewData {}
/// The request to fetch User Report from Reporting API `userActivity:get` call.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [search user activity](UserActivitySearchCall) (request)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SearchUserActivityRequest {
/// Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned.
#[serde(rename="activityTypes")]
pub activity_types: Option<Vec<String>>,
/// Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day).
#[serde(rename="dateRange")]
pub date_range: Option<DateRange>,
/// Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the default of 1000 rows per page.
#[serde(rename="pageSize")]
pub page_size: Option<i32>,
/// A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request.
#[serde(rename="pageToken")]
pub page_token: Option<String>,
/// Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field.
pub user: Option<User>,
/// Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the `viewId`.
#[serde(rename="viewId")]
pub view_id: Option<String>,
}
impl client::RequestValue for SearchUserActivityRequest {}
/// The response from `userActivity:get` call.
///
/// # Activities
///
/// This type is used in activities, which are methods you may call on this type or where this type is involved in.
/// The list links the activity name, along with information about where it is used (one of *request* and *response*).
///
/// * [search user activity](UserActivitySearchCall) (response)
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SearchUserActivityResponse {
/// This token should be passed to [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the next page.
#[serde(rename="nextPageToken")]
pub next_page_token: Option<String>,
/// This field represents the [sampling rate](https://support.google.com/analytics/answer/2637192) for the given request and is a number between 0.0 to 1.0. See [developer guide](https://developers.google.com/analytics/devguides/reporting/core/v4/basics#sampling) for details.
#[serde(rename="sampleRate")]
pub sample_rate: Option<f64>,
/// Each record represents a session (device details, duration, etc).
pub sessions: Option<Vec<UserActivitySession>>,
/// Total rows returned by this query (across different pages).
#[serde(rename="totalRows")]
pub total_rows: Option<i32>,
}
impl client::ResponseResult for SearchUserActivityResponse {}
/// The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct Segment {
/// A dynamic segment definition in the request.
#[serde(rename="dynamicSegment")]
pub dynamic_segment: Option<DynamicSegment>,
/// The segment ID of a built-in or custom segment, for example `gaid::-3`.
#[serde(rename="segmentId")]
pub segment_id: Option<String>,
}
impl client::Part for Segment {}
/// SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical `AND` operation.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SegmentDefinition {
/// A segment is defined by a set of segment filters which are combined together with a logical `AND` operation.
#[serde(rename="segmentFilters")]
pub segment_filters: Option<Vec<SegmentFilter>>,
}
impl client::Part for SegmentDefinition {}
/// Dimension filter specifies the filtering options on a dimension.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SegmentDimensionFilter {
/// Should the match be case sensitive, ignored for `IN_LIST` operator.
#[serde(rename="caseSensitive")]
pub case_sensitive: Option<bool>,
/// Name of the dimension for which the filter is being applied.
#[serde(rename="dimensionName")]
pub dimension_name: Option<String>,
/// The list of expressions, only the first element is used for all operators
pub expressions: Option<Vec<String>>,
/// Maximum comparison values for `BETWEEN` match type.
#[serde(rename="maxComparisonValue")]
pub max_comparison_value: Option<String>,
/// Minimum comparison values for `BETWEEN` match type.
#[serde(rename="minComparisonValue")]
pub min_comparison_value: Option<String>,
/// The operator to use to match the dimension with the expressions.
pub operator: Option<String>,
}
impl client::Part for SegmentDimensionFilter {}
/// SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SegmentFilter {
/// If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, "not": "True" }] },
pub not: Option<bool>,
/// Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.
#[serde(rename="sequenceSegment")]
pub sequence_segment: Option<SequenceSegment>,
/// A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
#[serde(rename="simpleSegment")]
pub simple_segment: Option<SimpleSegment>,
}
impl client::Part for SegmentFilter {}
/// Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SegmentFilterClause {
/// Dimension Filter for the segment definition.
#[serde(rename="dimensionFilter")]
pub dimension_filter: Option<SegmentDimensionFilter>,
/// Metric Filter for the segment definition.
#[serde(rename="metricFilter")]
pub metric_filter: Option<SegmentMetricFilter>,
/// Matches the complement (`!`) of the filter.
pub not: Option<bool>,
}
impl client::Part for SegmentFilterClause {}
/// Metric filter to be used in a segment filter clause.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SegmentMetricFilter {
/// The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.
#[serde(rename="comparisonValue")]
pub comparison_value: Option<String>,
/// Max comparison value is only used for `BETWEEN` operator.
#[serde(rename="maxComparisonValue")]
pub max_comparison_value: Option<String>,
/// The metric that will be filtered on. A `metricFilter` must contain a metric name.
#[serde(rename="metricName")]
pub metric_name: Option<String>,
/// Specifies is the operation to perform to compare the metric. The default is `EQUAL`.
pub operator: Option<String>,
/// Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions.
pub scope: Option<String>,
}
impl client::Part for SegmentMetricFilter {}
/// A segment sequence definition.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SegmentSequenceStep {
/// Specifies if the step immediately precedes or can be any time before the next step.
#[serde(rename="matchType")]
pub match_type: Option<String>,
/// A sequence is specified with a list of Or grouped filters which are combined with `AND` operator.
#[serde(rename="orFiltersForSegment")]
pub or_filters_for_segment: Option<Vec<OrFiltersForSegment>>,
}
impl client::Part for SegmentSequenceStep {}
/// Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SequenceSegment {
/// If set, first step condition must match the first hit of the visitor (in the date range).
#[serde(rename="firstStepShouldMatchFirstHit")]
pub first_step_should_match_first_hit: Option<bool>,
/// The list of steps in the sequence.
#[serde(rename="segmentSequenceSteps")]
pub segment_sequence_steps: Option<Vec<SegmentSequenceStep>>,
}
impl client::Part for SequenceSegment {}
/// A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct SimpleSegment {
/// A list of segment filters groups which are combined with logical `AND` operator.
#[serde(rename="orFiltersForSegment")]
pub or_filters_for_segment: Option<Vec<OrFiltersForSegment>>,
}
impl client::Part for SimpleSegment {}
/// Represents details collected when the visitor performs a transaction on the page.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct TransactionData {
/// The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart.
#[serde(rename="transactionId")]
pub transaction_id: Option<String>,
/// The total sale revenue (excluding shipping and tax) of the transaction.
#[serde(rename="transactionRevenue")]
pub transaction_revenue: Option<f64>,
/// Total cost of shipping.
#[serde(rename="transactionShipping")]
pub transaction_shipping: Option<f64>,
/// Total tax for the transaction.
#[serde(rename="transactionTax")]
pub transaction_tax: Option<f64>,
}
impl client::Part for TransactionData {}
/// Contains information to identify a particular user uniquely.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct User {
/// Type of the user in the request. The field `userId` is associated with this type.
#[serde(rename="type")]
pub type_: Option<String>,
/// Unique Id of the user for which the data is being requested.
#[serde(rename="userId")]
pub user_id: Option<String>,
}
impl client::Part for User {}
/// This represents a user session performed on a specific device at a certain time over a period of time.
///
/// This type is not used in any activity, and only used as *part* of another schema.
///
#[serde_with::serde_as(crate = "::client::serde_with")]
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
pub struct UserActivitySession {
/// Represents a detailed view into each of the activity in this session.
pub activities: Option<Vec<Activity>>,
/// The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in the Measurement Protocol.
#[serde(rename="dataSource")]
pub data_source: Option<String>,
/// The type of device used: "mobile", "tablet" etc.
#[serde(rename="deviceCategory")]
pub device_category: Option<String>,
/// Platform on which the activity happened: "android", "ios" etc.
pub platform: Option<String>,
/// Date of this session in ISO-8601 format.
#[serde(rename="sessionDate")]
pub session_date: Option<String>,
/// Unique ID of the session.
#[serde(rename="sessionId")]
pub session_id: Option<String>,
}
impl client::Part for UserActivitySession {}
// ###################
// MethodBuilders ###
// #################
/// A builder providing access to all methods supported on *report* resources.
/// It is not used directly, but through the [`AnalyticsReporting`] hub.
///
/// # Example
///
/// Instantiate a resource builder
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_analyticsreporting4 as analyticsreporting4;
///
/// # async fn dox() {
/// use std::default::Default;
/// use analyticsreporting4::{AnalyticsReporting, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// let secret: oauth2::ApplicationSecret = Default::default();
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = AnalyticsReporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
/// // like `batch_get(...)`
/// // to build up your call.
/// let rb = hub.reports();
/// # }
/// ```
pub struct ReportMethods<'a, S>
where S: 'a {
hub: &'a AnalyticsReporting<S>,
}
impl<'a, S> client::MethodsBuilder for ReportMethods<'a, S> {}
impl<'a, S> ReportMethods<'a, S> {
/// Create a builder to help you perform the following task:
///
/// Returns the Analytics data.
///
/// # Arguments
///
/// * `request` - No description provided.
pub fn batch_get(&self, request: GetReportsRequest) -> ReportBatchGetCall<'a, S> {
ReportBatchGetCall {
hub: self.hub,
_request: request,
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
}
/// A builder providing access to all methods supported on *userActivity* resources.
/// It is not used directly, but through the [`AnalyticsReporting`] hub.
///
/// # Example
///
/// Instantiate a resource builder
///
/// ```test_harness,no_run
/// extern crate hyper;
/// extern crate hyper_rustls;
/// extern crate google_analyticsreporting4 as analyticsreporting4;
///
/// # async fn dox() {
/// use std::default::Default;
/// use analyticsreporting4::{AnalyticsReporting, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// let secret: oauth2::ApplicationSecret = Default::default();
/// let auth = oauth2::InstalledFlowAuthenticator::builder(
/// secret,
/// oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// ).build().await.unwrap();
/// let mut hub = AnalyticsReporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
/// // like `search(...)`
/// // to build up your call.
/// let rb = hub.user_activity();
/// # }
/// ```
pub struct UserActivityMethods<'a, S>
where S: 'a {
hub: &'a AnalyticsReporting<S>,
}
impl<'a, S> client::MethodsBuilder for UserActivityMethods<'a, S> {}
impl<'a, S> UserActivityMethods<'a, S> {
/// Create a builder to help you perform the following task:
///
/// Returns User Activity data.
///
/// # Arguments
///
/// * `request` - No description provided.
pub fn search(&self, request: SearchUserActivityRequest) -> UserActivitySearchCall<'a, S> {
UserActivitySearchCall {
hub: self.hub,
_request: request,
_delegate: Default::default(),
_additional_params: Default::default(),
_scopes: Default::default(),
}
}
}
// ###################
// CallBuilders ###
// #################
/// Returns the Analytics data.
///
/// A builder for the *batchGet* method supported by a *report* resource.
/// It is not used directly, but through a [`ReportMethods`] instance.
///
/// # Example
///
/// Instantiate a resource method builder
///
/// ```test_harness,no_run
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_analyticsreporting4 as analyticsreporting4;
/// use analyticsreporting4::api::GetReportsRequest;
/// # async fn dox() {
/// # use std::default::Default;
/// # use analyticsreporting4::{AnalyticsReporting, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// # let secret: oauth2::ApplicationSecret = Default::default();
/// # let auth = oauth2::InstalledFlowAuthenticator::builder(
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = AnalyticsReporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // As the method needs a request, you would usually fill it with the desired information
/// // into the respective structure. Some of the parts shown here might not be applicable !
/// // Values shown here are possibly random and not representative !
/// let mut req = GetReportsRequest::default();
///
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.reports().batch_get(req)
/// .doit().await;
/// # }
/// ```
pub struct ReportBatchGetCall<'a, S>
where S: 'a {
hub: &'a AnalyticsReporting<S>,
_request: GetReportsRequest,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for ReportBatchGetCall<'a, S> {}
impl<'a, S> ReportBatchGetCall<'a, S>
where
S: tower_service::Service<http::Uri> + Clone + Send + Sync + 'static,
S::Response: hyper::client::connect::Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
{
/// Perform the operation you have build so far.
pub async fn doit(mut self) -> client::Result<(hyper::Response<hyper::body::Body>, GetReportsResponse)> {
use std::io::{Read, Seek};
use hyper::header::{CONTENT_TYPE, CONTENT_LENGTH, AUTHORIZATION, USER_AGENT, LOCATION};
use client::{ToParts, url::Params};
use std::borrow::Cow;
let mut dd = client::DefaultDelegate;
let mut dlg: &mut dyn client::Delegate = self._delegate.unwrap_or(&mut dd);
dlg.begin(client::MethodInfo { id: "analyticsreporting.reports.batchGet",
http_method: hyper::Method::POST });
for &field in ["alt"].iter() {
if self._additional_params.contains_key(field) {
dlg.finished(false);
return Err(client::Error::FieldClash(field));
}
}
let mut params = Params::with_capacity(3 + self._additional_params.len());
params.extend(self._additional_params.iter());
params.push("alt", "json");
let mut url = self.hub._base_url.clone() + "v4/reports:batchGet";
if self._scopes.is_empty() {
self._scopes.insert(Scope::Analytic.as_ref().to_string());
}
let url = params.parse_with_url(&url);
let mut json_mime_type = mime::APPLICATION_JSON;
let mut request_value_reader =
{
let mut value = json::value::to_value(&self._request).expect("serde to work");
client::remove_json_null_values(&mut value);
let mut dst = io::Cursor::new(Vec::with_capacity(128));
json::to_writer(&mut dst, &value).unwrap();
dst
};
let request_size = request_value_reader.seek(io::SeekFrom::End(0)).unwrap();
request_value_reader.seek(io::SeekFrom::Start(0)).unwrap();
loop {
let token = match self.hub.auth.get_token(&self._scopes.iter().map(String::as_str).collect::<Vec<_>>()[..]).await {
Ok(token) => token,
Err(e) => {
match dlg.token(e) {
Ok(token) => token,
Err(e) => {
dlg.finished(false);
return Err(client::Error::MissingToken(e));
}
}
}
};
request_value_reader.seek(io::SeekFrom::Start(0)).unwrap();
let mut req_result = {
let client = &self.hub.client;
dlg.pre_request();
let mut req_builder = hyper::Request::builder()
.method(hyper::Method::POST)
.uri(url.as_str())
.header(USER_AGENT, self.hub._user_agent.clone());
if let Some(token) = token.as_ref() {
req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token));
}
let request = req_builder
.header(CONTENT_TYPE, json_mime_type.to_string())
.header(CONTENT_LENGTH, request_size as u64)
.body(hyper::body::Body::from(request_value_reader.get_ref().clone()));
client.request(request.unwrap()).await
};
match req_result {
Err(err) => {
if let client::Retry::After(d) = dlg.http_error(&err) {
sleep(d).await;
continue;
}
dlg.finished(false);
return Err(client::Error::HttpError(err))
}
Ok(mut res) => {
if !res.status().is_success() {
let res_body_string = client::get_body_as_string(res.body_mut()).await;
let (parts, _) = res.into_parts();
let body = hyper::Body::from(res_body_string.clone());
let restored_response = hyper::Response::from_parts(parts, body);
let server_response = json::from_str::<serde_json::Value>(&res_body_string).ok();
if let client::Retry::After(d) = dlg.http_failure(&restored_response, server_response.clone()) {
sleep(d).await;
continue;
}
dlg.finished(false);
return match server_response {
Some(error_value) => Err(client::Error::BadRequest(error_value)),
None => Err(client::Error::Failure(restored_response)),
}
}
let result_value = {
let res_body_string = client::get_body_as_string(res.body_mut()).await;
match json::from_str(&res_body_string) {
Ok(decoded) => (res, decoded),
Err(err) => {
dlg.response_json_decode_error(&res_body_string, &err);
return Err(client::Error::JsonDecodeError(res_body_string, err));
}
}
};
dlg.finished(true);
return Ok(result_value)
}
}
}
}
///
/// Sets the *request* property to the given value.
///
/// Even though the property as already been set when instantiating this call,
/// we provide this method for API completeness.
pub fn request(mut self, new_value: GetReportsRequest) -> ReportBatchGetCall<'a, S> {
self._request = new_value;
self
}
/// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong
/// while executing the actual API request.
///
/// ````text
/// It should be used to handle progress information, and to implement a certain level of resilience.
/// ````
///
/// Sets the *delegate* property to the given value.
pub fn delegate(mut self, new_value: &'a mut dyn client::Delegate) -> ReportBatchGetCall<'a, S> {
self._delegate = Some(new_value);
self
}
/// Set any additional parameter of the query string used in the request.
/// It should be used to set parameters which are not yet available through their own
/// setters.
///
/// Please note that this method must not be used to set any of the known parameters
/// which have their own setter method. If done anyway, the request will fail.
///
/// # Additional Parameters
///
/// * *$.xgafv* (query-string) - V1 error format.
/// * *access_token* (query-string) - OAuth access token.
/// * *alt* (query-string) - Data format for response.
/// * *callback* (query-string) - JSONP
/// * *fields* (query-string) - Selector specifying which fields to include in a partial response.
/// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
/// * *oauth_token* (query-string) - OAuth 2.0 token for the current user.
/// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks.
/// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
/// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
/// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart").
pub fn param<T>(mut self, name: T, value: T) -> ReportBatchGetCall<'a, S>
where T: AsRef<str> {
self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string());
self
}
/// Identifies the authorization scope for the method you are building.
///
/// Use this method to actively specify which scope should be used, instead of the default [`Scope`] variant
/// [`Scope::Analytic`].
///
/// The `scope` will be added to a set of scopes. This is important as one can maintain access
/// tokens for more than one scope.
///
/// Usually there is more than one suitable scope to authorize an operation, some of which may
/// encompass more rights than others. For example, for listing resources, a *read-only* scope will be
/// sufficient, a read-write scope will do as well.
pub fn add_scope<St>(mut self, scope: St) -> ReportBatchGetCall<'a, S>
where St: AsRef<str> {
self._scopes.insert(String::from(scope.as_ref()));
self
}
/// Identifies the authorization scope(s) for the method you are building.
///
/// See [`Self::add_scope()`] for details.
pub fn add_scopes<I, St>(mut self, scopes: I) -> ReportBatchGetCall<'a, S>
where I: IntoIterator<Item = St>,
St: AsRef<str> {
self._scopes
.extend(scopes.into_iter().map(|s| String::from(s.as_ref())));
self
}
/// Removes all scopes, and no default scope will be used either.
/// In this case, you have to specify your API-key using the `key` parameter (see [`Self::param()`]
/// for details).
pub fn clear_scopes(mut self) -> ReportBatchGetCall<'a, S> {
self._scopes.clear();
self
}
}
/// Returns User Activity data.
///
/// A builder for the *search* method supported by a *userActivity* resource.
/// It is not used directly, but through a [`UserActivityMethods`] instance.
///
/// # Example
///
/// Instantiate a resource method builder
///
/// ```test_harness,no_run
/// # extern crate hyper;
/// # extern crate hyper_rustls;
/// # extern crate google_analyticsreporting4 as analyticsreporting4;
/// use analyticsreporting4::api::SearchUserActivityRequest;
/// # async fn dox() {
/// # use std::default::Default;
/// # use analyticsreporting4::{AnalyticsReporting, oauth2, hyper, hyper_rustls, chrono, FieldMask};
///
/// # let secret: oauth2::ApplicationSecret = Default::default();
/// # let auth = oauth2::InstalledFlowAuthenticator::builder(
/// # secret,
/// # oauth2::InstalledFlowReturnMethod::HTTPRedirect,
/// # ).build().await.unwrap();
/// # let mut hub = AnalyticsReporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
/// // As the method needs a request, you would usually fill it with the desired information
/// // into the respective structure. Some of the parts shown here might not be applicable !
/// // Values shown here are possibly random and not representative !
/// let mut req = SearchUserActivityRequest::default();
///
/// // You can configure optional parameters by calling the respective setters at will, and
/// // execute the final call using `doit()`.
/// // Values shown here are possibly random and not representative !
/// let result = hub.user_activity().search(req)
/// .doit().await;
/// # }
/// ```
pub struct UserActivitySearchCall<'a, S>
where S: 'a {
hub: &'a AnalyticsReporting<S>,
_request: SearchUserActivityRequest,
_delegate: Option<&'a mut dyn client::Delegate>,
_additional_params: HashMap<String, String>,
_scopes: BTreeSet<String>
}
impl<'a, S> client::CallBuilder for UserActivitySearchCall<'a, S> {}
impl<'a, S> UserActivitySearchCall<'a, S>
where
S: tower_service::Service<http::Uri> + Clone + Send + Sync + 'static,
S::Response: hyper::client::connect::Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
{
/// Perform the operation you have build so far.
pub async fn doit(mut self) -> client::Result<(hyper::Response<hyper::body::Body>, SearchUserActivityResponse)> {
use std::io::{Read, Seek};
use hyper::header::{CONTENT_TYPE, CONTENT_LENGTH, AUTHORIZATION, USER_AGENT, LOCATION};
use client::{ToParts, url::Params};
use std::borrow::Cow;
let mut dd = client::DefaultDelegate;
let mut dlg: &mut dyn client::Delegate = self._delegate.unwrap_or(&mut dd);
dlg.begin(client::MethodInfo { id: "analyticsreporting.userActivity.search",
http_method: hyper::Method::POST });
for &field in ["alt"].iter() {
if self._additional_params.contains_key(field) {
dlg.finished(false);
return Err(client::Error::FieldClash(field));
}
}
let mut params = Params::with_capacity(3 + self._additional_params.len());
params.extend(self._additional_params.iter());
params.push("alt", "json");
let mut url = self.hub._base_url.clone() + "v4/userActivity:search";
if self._scopes.is_empty() {
self._scopes.insert(Scope::Analytic.as_ref().to_string());
}
let url = params.parse_with_url(&url);
let mut json_mime_type = mime::APPLICATION_JSON;
let mut request_value_reader =
{
let mut value = json::value::to_value(&self._request).expect("serde to work");
client::remove_json_null_values(&mut value);
let mut dst = io::Cursor::new(Vec::with_capacity(128));
json::to_writer(&mut dst, &value).unwrap();
dst
};
let request_size = request_value_reader.seek(io::SeekFrom::End(0)).unwrap();
request_value_reader.seek(io::SeekFrom::Start(0)).unwrap();
loop {
let token = match self.hub.auth.get_token(&self._scopes.iter().map(String::as_str).collect::<Vec<_>>()[..]).await {
Ok(token) => token,
Err(e) => {
match dlg.token(e) {
Ok(token) => token,
Err(e) => {
dlg.finished(false);
return Err(client::Error::MissingToken(e));
}
}
}
};
request_value_reader.seek(io::SeekFrom::Start(0)).unwrap();
let mut req_result = {
let client = &self.hub.client;
dlg.pre_request();
let mut req_builder = hyper::Request::builder()
.method(hyper::Method::POST)
.uri(url.as_str())
.header(USER_AGENT, self.hub._user_agent.clone());
if let Some(token) = token.as_ref() {
req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token));
}
let request = req_builder
.header(CONTENT_TYPE, json_mime_type.to_string())
.header(CONTENT_LENGTH, request_size as u64)
.body(hyper::body::Body::from(request_value_reader.get_ref().clone()));
client.request(request.unwrap()).await
};
match req_result {
Err(err) => {
if let client::Retry::After(d) = dlg.http_error(&err) {
sleep(d).await;
continue;
}
dlg.finished(false);
return Err(client::Error::HttpError(err))
}
Ok(mut res) => {
if !res.status().is_success() {
let res_body_string = client::get_body_as_string(res.body_mut()).await;
let (parts, _) = res.into_parts();
let body = hyper::Body::from(res_body_string.clone());
let restored_response = hyper::Response::from_parts(parts, body);
let server_response = json::from_str::<serde_json::Value>(&res_body_string).ok();
if let client::Retry::After(d) = dlg.http_failure(&restored_response, server_response.clone()) {
sleep(d).await;
continue;
}
dlg.finished(false);
return match server_response {
Some(error_value) => Err(client::Error::BadRequest(error_value)),
None => Err(client::Error::Failure(restored_response)),
}
}
let result_value = {
let res_body_string = client::get_body_as_string(res.body_mut()).await;
match json::from_str(&res_body_string) {
Ok(decoded) => (res, decoded),
Err(err) => {
dlg.response_json_decode_error(&res_body_string, &err);
return Err(client::Error::JsonDecodeError(res_body_string, err));
}
}
};
dlg.finished(true);
return Ok(result_value)
}
}
}
}
///
/// Sets the *request* property to the given value.
///
/// Even though the property as already been set when instantiating this call,
/// we provide this method for API completeness.
pub fn request(mut self, new_value: SearchUserActivityRequest) -> UserActivitySearchCall<'a, S> {
self._request = new_value;
self
}
/// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong
/// while executing the actual API request.
///
/// ````text
/// It should be used to handle progress information, and to implement a certain level of resilience.
/// ````
///
/// Sets the *delegate* property to the given value.
pub fn delegate(mut self, new_value: &'a mut dyn client::Delegate) -> UserActivitySearchCall<'a, S> {
self._delegate = Some(new_value);
self
}
/// Set any additional parameter of the query string used in the request.
/// It should be used to set parameters which are not yet available through their own
/// setters.
///
/// Please note that this method must not be used to set any of the known parameters
/// which have their own setter method. If done anyway, the request will fail.
///
/// # Additional Parameters
///
/// * *$.xgafv* (query-string) - V1 error format.
/// * *access_token* (query-string) - OAuth access token.
/// * *alt* (query-string) - Data format for response.
/// * *callback* (query-string) - JSONP
/// * *fields* (query-string) - Selector specifying which fields to include in a partial response.
/// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
/// * *oauth_token* (query-string) - OAuth 2.0 token for the current user.
/// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks.
/// * *quotaUser* (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
/// * *uploadType* (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
/// * *upload_protocol* (query-string) - Upload protocol for media (e.g. "raw", "multipart").
pub fn param<T>(mut self, name: T, value: T) -> UserActivitySearchCall<'a, S>
where T: AsRef<str> {
self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string());
self
}
/// Identifies the authorization scope for the method you are building.
///
/// Use this method to actively specify which scope should be used, instead of the default [`Scope`] variant
/// [`Scope::Analytic`].
///
/// The `scope` will be added to a set of scopes. This is important as one can maintain access
/// tokens for more than one scope.
///
/// Usually there is more than one suitable scope to authorize an operation, some of which may
/// encompass more rights than others. For example, for listing resources, a *read-only* scope will be
/// sufficient, a read-write scope will do as well.
pub fn add_scope<St>(mut self, scope: St) -> UserActivitySearchCall<'a, S>
where St: AsRef<str> {
self._scopes.insert(String::from(scope.as_ref()));
self
}
/// Identifies the authorization scope(s) for the method you are building.
///
/// See [`Self::add_scope()`] for details.
pub fn add_scopes<I, St>(mut self, scopes: I) -> UserActivitySearchCall<'a, S>
where I: IntoIterator<Item = St>,
St: AsRef<str> {
self._scopes
.extend(scopes.into_iter().map(|s| String::from(s.as_ref())));
self
}
/// Removes all scopes, and no default scope will be used either.
/// In this case, you have to specify your API-key using the `key` parameter (see [`Self::param()`]
/// for details).
pub fn clear_scopes(mut self) -> UserActivitySearchCall<'a, S> {
self._scopes.clear();
self
}
}