1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
|
// Package analyticsreporting provides access to the Analytics Reporting API.
//
// See https://developers.google.com/analytics/devguides/reporting/core/v4/
//
// Usage example:
//
// import "google.golang.org/api/analyticsreporting/v4"
// ...
// analyticsreportingService, err := analyticsreporting.New(oauthHttpClient)
package analyticsreporting // import "google.golang.org/api/analyticsreporting/v4"
import (
"bytes"
"encoding/json"
"errors"
"fmt"
context "golang.org/x/net/context"
ctxhttp "golang.org/x/net/context/ctxhttp"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
"io"
"net/http"
"net/url"
"strconv"
"strings"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = ctxhttp.Do
const apiId = "analyticsreporting:v4"
const apiName = "analyticsreporting"
const apiVersion = "v4"
const basePath = "https://analyticsreporting.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your Google Analytics data
AnalyticsScope = "https://www.googleapis.com/auth/analytics"
// View your Google Analytics data
AnalyticsReadonlyScope = "https://www.googleapis.com/auth/analytics.readonly"
)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Reports = NewReportsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Reports *ReportsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewReportsService(s *Service) *ReportsService {
rs := &ReportsService{s: s}
return rs
}
type ReportsService struct {
s *Service
}
// Cohort: 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.
type Cohort struct {
// DateRange: 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.
DateRange *DateRange `json:"dateRange,omitempty"`
// Name: A unique name for the cohort. If not defined name will be
// auto-generated
// with values cohort_[1234...].
Name string `json:"name,omitempty"`
// Type: 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.
//
// Possible values:
// "UNSPECIFIED_COHORT_TYPE" - If unspecified it's treated as
// `FIRST_VISIT_DATE`.
// "FIRST_VISIT_DATE" - Cohorts that are selected based on first visit
// date.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "DateRange") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DateRange") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Cohort) MarshalJSON() ([]byte, error) {
type NoMethod Cohort
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CohortGroup: 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" }
// }]
// }
type CohortGroup struct {
// Cohorts: The definition for the cohort.
Cohorts []*Cohort `json:"cohorts,omitempty"`
// LifetimeValue: 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#WebVersusAppVi
// ews)
LifetimeValue bool `json:"lifetimeValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "Cohorts") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Cohorts") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CohortGroup) MarshalJSON() ([]byte, error) {
type NoMethod CohortGroup
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ColumnHeader: Column headers.
type ColumnHeader struct {
// Dimensions: The dimension names in the response.
Dimensions []string `json:"dimensions,omitempty"`
// MetricHeader: Metric headers for the metrics in the response.
MetricHeader *MetricHeader `json:"metricHeader,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimensions") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimensions") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ColumnHeader) MarshalJSON() ([]byte, error) {
type NoMethod ColumnHeader
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DateRange: 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`.
type DateRange struct {
// EndDate: The end date for the query in the format `YYYY-MM-DD`.
EndDate string `json:"endDate,omitempty"`
// StartDate: The start date for the query in the format `YYYY-MM-DD`.
StartDate string `json:"startDate,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndDate") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndDate") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DateRange) MarshalJSON() ([]byte, error) {
type NoMethod DateRange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DateRangeValues: Used to return a list of metrics for a single
// DateRange / dimension
// combination
type DateRangeValues struct {
// PivotValueRegions: The values of each pivot region.
PivotValueRegions []*PivotValueRegion `json:"pivotValueRegions,omitempty"`
// Values: Each value corresponds to each Metric in the request.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "PivotValueRegions")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PivotValueRegions") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DateRangeValues) MarshalJSON() ([]byte, error) {
type NoMethod DateRangeValues
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Dimension:
// [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.
type Dimension struct {
// HistogramBuckets: 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.
HistogramBuckets googleapi.Int64s `json:"histogramBuckets,omitempty"`
// Name: Name of the dimension to fetch, for example `ga:browser`.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "HistogramBuckets") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "HistogramBuckets") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *Dimension) MarshalJSON() ([]byte, error) {
type NoMethod Dimension
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DimensionFilter: Dimension filter specifies the filtering options on
// a dimension.
type DimensionFilter struct {
// CaseSensitive: Should the match be case sensitive? Default is false.
CaseSensitive bool `json:"caseSensitive,omitempty"`
// DimensionName: The dimension to filter on. A DimensionFilter must
// contain a dimension.
DimensionName string `json:"dimensionName,omitempty"`
// Expressions: 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.
Expressions []string `json:"expressions,omitempty"`
// Not: 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.
Not bool `json:"not,omitempty"`
// Operator: How to match the dimension to the expression. The default
// is REGEXP.
//
// Possible values:
// "OPERATOR_UNSPECIFIED" - If the match type is unspecified, it is
// treated as a `REGEXP`.
// "REGEXP" - The match expression is treated as a regular expression.
// All match types
// are not treated as regular expressions.
// "BEGINS_WITH" - Matches the value which begin with the match
// expression provided.
// "ENDS_WITH" - Matches the values which end with the match
// expression provided.
// "PARTIAL" - Substring match.
// "EXACT" - The value should match the match expression entirely.
// "NUMERIC_EQUAL" - Integer comparison filters.
// case sensitivity is ignored for these and the expression
// is assumed to be a string representing an integer.
// Failure conditions:
//
// - If expression is not a valid int64, the client should expect
// an error.
// - Input dimensions that are not valid int64 values will never match
// the
// filter.
// "NUMERIC_GREATER_THAN" - Checks if the dimension is numerically
// greater than the match
// expression. Read the description for `NUMERIC_EQUALS` for
// restrictions.
// "NUMERIC_LESS_THAN" - Checks if the dimension is numerically less
// than the match expression.
// Read the description for `NUMERIC_EQUALS` for restrictions.
// "IN_LIST" - This option is used to specify a dimension filter whose
// expression can
// take any value from a selected list of values. This helps
// avoiding
// evaluating multiple exact match dimension filters which are OR'ed
// for
// every single response row. For example:
//
// expressions: ["A", "B", "C"]
//
// Any response row whose dimension has it is value as A, B or C,
// matches
// this DimensionFilter.
Operator string `json:"operator,omitempty"`
// ForceSendFields is a list of field names (e.g. "CaseSensitive") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CaseSensitive") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DimensionFilter) MarshalJSON() ([]byte, error) {
type NoMethod DimensionFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DimensionFilterClause: A group of dimension filters. Set the operator
// value to specify how
// the filters are logically combined.
type DimensionFilterClause struct {
// Filters: The repeated set of filters. They are logically combined
// based on the
// operator specified.
Filters []*DimensionFilter `json:"filters,omitempty"`
// Operator: The operator for combining multiple dimension filters. If
// unspecified, it
// is treated as an `OR`.
//
// Possible values:
// "OPERATOR_UNSPECIFIED" - Unspecified operator. It is treated as an
// `OR`.
// "OR" - The logical `OR` operator.
// "AND" - The logical `AND` operator.
Operator string `json:"operator,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filters") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Filters") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DimensionFilterClause) MarshalJSON() ([]byte, error) {
type NoMethod DimensionFilterClause
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DynamicSegment: Dynamic segment definition for defining the segment
// within the request.
// A segment can select users, sessions or both.
type DynamicSegment struct {
// Name: The name of the dynamic segment.
Name string `json:"name,omitempty"`
// SessionSegment: Session Segment to select sessions to include in the
// segment.
SessionSegment *SegmentDefinition `json:"sessionSegment,omitempty"`
// UserSegment: User Segment to select users to include in the segment.
UserSegment *SegmentDefinition `json:"userSegment,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DynamicSegment) MarshalJSON() ([]byte, error) {
type NoMethod DynamicSegment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GetReportsRequest: The batch request containing multiple report
// request.
type GetReportsRequest struct {
// ReportRequests: 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`.
ReportRequests []*ReportRequest `json:"reportRequests,omitempty"`
// UseResourceQuotas: Enables
// [resource based
// quotas](/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](/analytics/devguides/reporting/core/v4/limits-quotas#an
// alytics_reporting_api_v4) for details.
UseResourceQuotas bool `json:"useResourceQuotas,omitempty"`
// ForceSendFields is a list of field names (e.g. "ReportRequests") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ReportRequests") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *GetReportsRequest) MarshalJSON() ([]byte, error) {
type NoMethod GetReportsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GetReportsResponse: The main response class which holds the reports
// from the Reporting API
// `batchGet` call.
type GetReportsResponse struct {
// QueryCost: The amount of resource quota tokens deducted to execute
// the query. Includes
// all responses.
QueryCost int64 `json:"queryCost,omitempty"`
// Reports: Responses corresponding to each of the request.
Reports []*Report `json:"reports,omitempty"`
// ResourceQuotasRemaining: The amount of resource quota remaining for
// the property.
ResourceQuotasRemaining *ResourceQuotasRemaining `json:"resourceQuotasRemaining,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "QueryCost") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "QueryCost") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetReportsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetReportsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Metric:
// [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.
type Metric struct {
// Alias: 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.
Alias string `json:"alias,omitempty"`
// Expression: 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.
Expression string `json:"expression,omitempty"`
// FormattingType: Specifies how the metric expression should be
// formatted, for example
// `INTEGER`.
//
// Possible values:
// "METRIC_TYPE_UNSPECIFIED" - Metric type is unspecified.
// "INTEGER" - Integer metric.
// "FLOAT" - Float metric.
// "CURRENCY" - Currency metric.
// "PERCENT" - Percentage metric.
// "TIME" - Time metric in `HH:MM:SS` format.
FormattingType string `json:"formattingType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Alias") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Alias") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Metric) MarshalJSON() ([]byte, error) {
type NoMethod Metric
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MetricFilter: MetricFilter specifies the filter on a metric.
type MetricFilter struct {
// ComparisonValue: The value to compare against.
ComparisonValue string `json:"comparisonValue,omitempty"`
// MetricName: 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.
MetricName string `json:"metricName,omitempty"`
// Not: 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.
Not bool `json:"not,omitempty"`
// Operator: 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.
//
// Possible values:
// "OPERATOR_UNSPECIFIED" - If the operator is not specified, it is
// treated as `EQUAL`.
// "EQUAL" - Should the value of the metric be exactly equal to the
// comparison value.
// "LESS_THAN" - Should the value of the metric be less than to the
// comparison value.
// "GREATER_THAN" - Should the value of the metric be greater than to
// the comparison value.
// "IS_MISSING" - Validates if the metric is missing.
// Doesn't take comparisonValue into account.
Operator string `json:"operator,omitempty"`
// ForceSendFields is a list of field names (e.g. "ComparisonValue") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ComparisonValue") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *MetricFilter) MarshalJSON() ([]byte, error) {
type NoMethod MetricFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MetricFilterClause: Represents a group of metric filters.
// Set the operator value to specify how the filters are logically
// combined.
type MetricFilterClause struct {
// Filters: The repeated set of filters. They are logically combined
// based on the
// operator specified.
Filters []*MetricFilter `json:"filters,omitempty"`
// Operator: The operator for combining multiple metric filters. If
// unspecified, it is
// treated as an `OR`.
//
// Possible values:
// "OPERATOR_UNSPECIFIED" - Unspecified operator. It is treated as an
// `OR`.
// "OR" - The logical `OR` operator.
// "AND" - The logical `AND` operator.
Operator string `json:"operator,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filters") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Filters") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MetricFilterClause) MarshalJSON() ([]byte, error) {
type NoMethod MetricFilterClause
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MetricHeader: The headers for the metrics.
type MetricHeader struct {
// MetricHeaderEntries: Headers for the metrics in the response.
MetricHeaderEntries []*MetricHeaderEntry `json:"metricHeaderEntries,omitempty"`
// PivotHeaders: Headers for the pivots in the response.
PivotHeaders []*PivotHeader `json:"pivotHeaders,omitempty"`
// ForceSendFields is a list of field names (e.g. "MetricHeaderEntries")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MetricHeaderEntries") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *MetricHeader) MarshalJSON() ([]byte, error) {
type NoMethod MetricHeader
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MetricHeaderEntry: Header for the metrics.
type MetricHeaderEntry struct {
// Name: The name of the header.
Name string `json:"name,omitempty"`
// Type: The type of the metric, for example `INTEGER`.
//
// Possible values:
// "METRIC_TYPE_UNSPECIFIED" - Metric type is unspecified.
// "INTEGER" - Integer metric.
// "FLOAT" - Float metric.
// "CURRENCY" - Currency metric.
// "PERCENT" - Percentage metric.
// "TIME" - Time metric in `HH:MM:SS` format.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MetricHeaderEntry) MarshalJSON() ([]byte, error) {
type NoMethod MetricHeaderEntry
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// OrFiltersForSegment: A list of segment filters in the `OR` group are
// combined with the logical OR
// operator.
type OrFiltersForSegment struct {
// SegmentFilterClauses: List of segment filters to be combined with a
// `OR` operator.
SegmentFilterClauses []*SegmentFilterClause `json:"segmentFilterClauses,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "SegmentFilterClauses") to unconditionally include in API requests.
// By default, fields with empty values are omitted from API requests.
// However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SegmentFilterClauses") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *OrFiltersForSegment) MarshalJSON() ([]byte, error) {
type NoMethod OrFiltersForSegment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// OrderBy: Specifies the sorting options.
type OrderBy struct {
// FieldName: 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.
FieldName string `json:"fieldName,omitempty"`
// OrderType: The order type. The default orderType is `VALUE`.
//
// Possible values:
// "ORDER_TYPE_UNSPECIFIED" - Unspecified order type will be treated
// as sort based on value.
// "VALUE" - The sort order is based on the value of the chosen
// column; looks only at
// the first date range.
// "DELTA" - The sort order is based on the difference of the values
// of the chosen
// column between the first two date ranges. Usable only if there
// are
// exactly two date ranges.
// "SMART" - The sort order is based on weighted value of the chosen
// column. If
// column has n/d format, then weighted value of this ratio will
// be `(n + totals.n)/(d + totals.d)` Usable only for metrics
// that
// represent ratios.
// "HISTOGRAM_BUCKET" - Histogram order type is applicable only to
// dimension columns with
// non-empty histogram-buckets.
// "DIMENSION_AS_INTEGER" - If the dimensions are fixed length
// numbers, ordinary sort would just
// work fine. `DIMENSION_AS_INTEGER` can be used if the dimensions
// are
// variable length numbers.
OrderType string `json:"orderType,omitempty"`
// SortOrder: The sorting order for the field.
//
// Possible values:
// "SORT_ORDER_UNSPECIFIED" - If the sort order is unspecified, the
// default is ascending.
// "ASCENDING" - Ascending sort. The field will be sorted in an
// ascending manner.
// "DESCENDING" - Descending sort. The field will be sorted in a
// descending manner.
SortOrder string `json:"sortOrder,omitempty"`
// ForceSendFields is a list of field names (e.g. "FieldName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FieldName") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *OrderBy) MarshalJSON() ([]byte, error) {
type NoMethod OrderBy
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Pivot: 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.
type Pivot struct {
// DimensionFilterClauses: 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.
DimensionFilterClauses []*DimensionFilterClause `json:"dimensionFilterClauses,omitempty"`
// Dimensions: 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.
Dimensions []*Dimension `json:"dimensions,omitempty"`
// MaxGroupCount: Specifies the maximum number of groups to return.
// The default value is 10, also the maximum value is 1,000.
MaxGroupCount int64 `json:"maxGroupCount,omitempty"`
// Metrics: The pivot metrics. Pivot metrics are part of the
// restriction on total number of metrics allowed in the request.
Metrics []*Metric `json:"metrics,omitempty"`
// StartGroup: 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.
StartGroup int64 `json:"startGroup,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "DimensionFilterClauses") to unconditionally include in API requests.
// By default, fields with empty values are omitted from API requests.
// However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DimensionFilterClauses")
// to include in API requests with the JSON null value. By default,
// fields with empty values are omitted from API requests. However, any
// field with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *Pivot) MarshalJSON() ([]byte, error) {
type NoMethod Pivot
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PivotHeader: The headers for each of the pivot sections defined in
// the request.
type PivotHeader struct {
// PivotHeaderEntries: A single pivot section header.
PivotHeaderEntries []*PivotHeaderEntry `json:"pivotHeaderEntries,omitempty"`
// TotalPivotGroupsCount: The total number of groups for this pivot.
TotalPivotGroupsCount int64 `json:"totalPivotGroupsCount,omitempty"`
// ForceSendFields is a list of field names (e.g. "PivotHeaderEntries")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PivotHeaderEntries") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *PivotHeader) MarshalJSON() ([]byte, error) {
type NoMethod PivotHeader
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PivotHeaderEntry: The headers for the each of the metric column
// corresponding to the metrics
// requested in the pivots section of the response.
type PivotHeaderEntry struct {
// DimensionNames: The name of the dimensions in the pivot response.
DimensionNames []string `json:"dimensionNames,omitempty"`
// DimensionValues: The values for the dimensions in the pivot.
DimensionValues []string `json:"dimensionValues,omitempty"`
// Metric: The metric header for the metric in the pivot.
Metric *MetricHeaderEntry `json:"metric,omitempty"`
// ForceSendFields is a list of field names (e.g. "DimensionNames") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DimensionNames") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *PivotHeaderEntry) MarshalJSON() ([]byte, error) {
type NoMethod PivotHeaderEntry
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// PivotValueRegion: The metric values in the pivot region.
type PivotValueRegion struct {
// Values: The values of the metrics in each of the pivot regions.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *PivotValueRegion) MarshalJSON() ([]byte, error) {
type NoMethod PivotValueRegion
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Report: The data response corresponding to the request.
type Report struct {
// ColumnHeader: The column headers.
ColumnHeader *ColumnHeader `json:"columnHeader,omitempty"`
// Data: Response data.
Data *ReportData `json:"data,omitempty"`
// NextPageToken: Page token to retrieve the next page of results in the
// list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "ColumnHeader") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ColumnHeader") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Report) MarshalJSON() ([]byte, error) {
type NoMethod Report
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ReportData: The data part of the report.
type ReportData struct {
// DataLastRefreshed: 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.
DataLastRefreshed string `json:"dataLastRefreshed,omitempty"`
// IsDataGolden: 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.
IsDataGolden bool `json:"isDataGolden,omitempty"`
// Maximums: 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.
Maximums []*DateRangeValues `json:"maximums,omitempty"`
// Minimums: 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.
Minimums []*DateRangeValues `json:"minimums,omitempty"`
// RowCount: Total number of matching rows for this query.
RowCount int64 `json:"rowCount,omitempty"`
// Rows: There's one ReportRow for every unique combination of
// dimensions.
Rows []*ReportRow `json:"rows,omitempty"`
// SamplesReadCounts: If the results
// are
// [sampled](https://support.google.com/analytics/answer/2637192),
// th
// is 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](/analytics/devguides/reporting/core/v4/basics#sampling)
// for details.
SamplesReadCounts googleapi.Int64s `json:"samplesReadCounts,omitempty"`
// SamplingSpaceSizes: If the results
// are
// [sampled](https://support.google.com/analytics/answer/2637192),
// th
// is 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](/analytics/devguides/reporting/core/v4/basics#sampling)
// for details.
SamplingSpaceSizes googleapi.Int64s `json:"samplingSpaceSizes,omitempty"`
// Totals: 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.
Totals []*DateRangeValues `json:"totals,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataLastRefreshed")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataLastRefreshed") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *ReportData) MarshalJSON() ([]byte, error) {
type NoMethod ReportData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ReportRequest: The main request class which specifies the Reporting
// API request.
type ReportRequest struct {
// CohortGroup: 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.
CohortGroup *CohortGroup `json:"cohortGroup,omitempty"`
// DateRanges: 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.
DateRanges []*DateRange `json:"dateRanges,omitempty"`
// DimensionFilterClauses: 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.
DimensionFilterClauses []*DimensionFilterClause `json:"dimensionFilterClauses,omitempty"`
// Dimensions: The dimensions requested.
// Requests can have a total of 7 dimensions.
Dimensions []*Dimension `json:"dimensions,omitempty"`
// FiltersExpression: 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).
FiltersExpression string `json:"filtersExpression,omitempty"`
// HideTotals: 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.
HideTotals bool `json:"hideTotals,omitempty"`
// HideValueRanges: If set to true, hides the minimum and maximum across
// all matching rows.
// The default is false and the value ranges are returned.
HideValueRanges bool `json:"hideValueRanges,omitempty"`
// IncludeEmptyRows: 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.
IncludeEmptyRows bool `json:"includeEmptyRows,omitempty"`
// MetricFilterClauses: 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.
MetricFilterClauses []*MetricFilterClause `json:"metricFilterClauses,omitempty"`
// Metrics: The metrics requested.
// Requests must specify at least one metric. Requests can have a
// total of 10 metrics.
Metrics []*Metric `json:"metrics,omitempty"`
// OrderBys: 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.
OrderBys []*OrderBy `json:"orderBys,omitempty"`
// PageSize: 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.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: 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.
PageToken string `json:"pageToken,omitempty"`
// Pivots: The pivot definitions. Requests can have a maximum of 2
// pivots.
Pivots []*Pivot `json:"pivots,omitempty"`
// SamplingLevel: 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](/analytics/devguides/reporting/core/v4/basics#sampling)
// for details.
//
// Possible values:
// "SAMPLING_UNSPECIFIED" - If the `samplingLevel` field is
// unspecified the `DEFAULT` sampling level
// is used.
// "DEFAULT" - Returns response with a sample size that balances speed
// and
// accuracy.
// "SMALL" - It returns a fast response with a smaller sampling size.
// "LARGE" - Returns a more accurate response using a large sampling
// size. But this
// may result in response being slower.
SamplingLevel string `json:"samplingLevel,omitempty"`
// Segments: 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.
Segments []*Segment `json:"segments,omitempty"`
// ViewId: 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`.
ViewId string `json:"viewId,omitempty"`
// ForceSendFields is a list of field names (e.g. "CohortGroup") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CohortGroup") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ReportRequest) MarshalJSON() ([]byte, error) {
type NoMethod ReportRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ReportRow: A row in the report.
type ReportRow struct {
// Dimensions: List of requested dimensions.
Dimensions []string `json:"dimensions,omitempty"`
// Metrics: List of metrics for each requested DateRange.
Metrics []*DateRangeValues `json:"metrics,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dimensions") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dimensions") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ReportRow) MarshalJSON() ([]byte, error) {
type NoMethod ReportRow
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ResourceQuotasRemaining: The resource quota tokens remaining for the
// property after the request is
// completed.
type ResourceQuotasRemaining struct {
// DailyQuotaTokensRemaining: Daily resource quota remaining remaining.
DailyQuotaTokensRemaining int64 `json:"dailyQuotaTokensRemaining,omitempty"`
// HourlyQuotaTokensRemaining: Hourly resource quota tokens remaining.
HourlyQuotaTokensRemaining int64 `json:"hourlyQuotaTokensRemaining,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "DailyQuotaTokensRemaining") to unconditionally include in API
// requests. By default, fields with empty values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g.
// "DailyQuotaTokensRemaining") to include in API requests with the JSON
// null value. By default, fields with empty values are omitted from API
// requests. However, any field with an empty value appearing in
// NullFields will be sent to the server as null. It is an error if a
// field in this list has a non-empty value. This may be used to include
// null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ResourceQuotasRemaining) MarshalJSON() ([]byte, error) {
type NoMethod ResourceQuotasRemaining
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Segment: 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.
type Segment struct {
// DynamicSegment: A dynamic segment definition in the request.
DynamicSegment *DynamicSegment `json:"dynamicSegment,omitempty"`
// SegmentId: The segment ID of a built-in or custom segment, for
// example `gaid::-3`.
SegmentId string `json:"segmentId,omitempty"`
// ForceSendFields is a list of field names (e.g. "DynamicSegment") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DynamicSegment") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *Segment) MarshalJSON() ([]byte, error) {
type NoMethod Segment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SegmentDefinition: SegmentDefinition defines the segment to be a set
// of SegmentFilters which
// are combined together with a logical `AND` operation.
type SegmentDefinition struct {
// SegmentFilters: A segment is defined by a set of segment filters
// which are combined
// together with a logical `AND` operation.
SegmentFilters []*SegmentFilter `json:"segmentFilters,omitempty"`
// ForceSendFields is a list of field names (e.g. "SegmentFilters") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SegmentFilters") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *SegmentDefinition) MarshalJSON() ([]byte, error) {
type NoMethod SegmentDefinition
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SegmentDimensionFilter: Dimension filter specifies the filtering
// options on a dimension.
type SegmentDimensionFilter struct {
// CaseSensitive: Should the match be case sensitive, ignored for
// `IN_LIST` operator.
CaseSensitive bool `json:"caseSensitive,omitempty"`
// DimensionName: Name of the dimension for which the filter is being
// applied.
DimensionName string `json:"dimensionName,omitempty"`
// Expressions: The list of expressions, only the first element is used
// for all operators
Expressions []string `json:"expressions,omitempty"`
// MaxComparisonValue: Maximum comparison values for `BETWEEN` match
// type.
MaxComparisonValue string `json:"maxComparisonValue,omitempty"`
// MinComparisonValue: Minimum comparison values for `BETWEEN` match
// type.
MinComparisonValue string `json:"minComparisonValue,omitempty"`
// Operator: The operator to use to match the dimension with the
// expressions.
//
// Possible values:
// "OPERATOR_UNSPECIFIED" - If the match type is unspecified, it is
// treated as a REGEXP.
// "REGEXP" - The match expression is treated as a regular expression.
// All other match
// types are not treated as regular expressions.
// "BEGINS_WITH" - Matches the values which begin with the match
// expression provided.
// "ENDS_WITH" - Matches the values which end with the match
// expression provided.
// "PARTIAL" - Substring match.
// "EXACT" - The value should match the match expression entirely.
// "IN_LIST" - This option is used to specify a dimension filter whose
// expression can
// take any value from a selected list of values. This helps
// avoiding
// evaluating multiple exact match dimension filters which are OR'ed
// for
// every single response row. For example:
//
// expressions: ["A", "B", "C"]
//
// Any response row whose dimension has it is value as A, B or C,
// matches
// this DimensionFilter.
// "NUMERIC_LESS_THAN" - Integer comparison filters.
// case sensitivity is ignored for these and the expression
// is assumed to be a string representing an integer.
// Failure conditions:
//
// - if expression is not a valid int64, the client should expect
// an error.
// - input dimensions that are not valid int64 values will never match
// the
// filter.
//
// Checks if the dimension is numerically less than the match
// expression.
// "NUMERIC_GREATER_THAN" - Checks if the dimension is numerically
// greater than the match
// expression.
// "NUMERIC_BETWEEN" - Checks if the dimension is numerically between
// the minimum and maximum
// of the match expression, boundaries excluded.
Operator string `json:"operator,omitempty"`
// ForceSendFields is a list of field names (e.g. "CaseSensitive") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CaseSensitive") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *SegmentDimensionFilter) MarshalJSON() ([]byte, error) {
type NoMethod SegmentDimensionFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SegmentFilter: 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.
type SegmentFilter struct {
// Not: 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"
// }]
// },
Not bool `json:"not,omitempty"`
// SequenceSegment: 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.
SequenceSegment *SequenceSegment `json:"sequenceSegment,omitempty"`
// SimpleSegment: A Simple segment conditions consist of one or more
// dimension/metric
// conditions that can be combined
SimpleSegment *SimpleSegment `json:"simpleSegment,omitempty"`
// ForceSendFields is a list of field names (e.g. "Not") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Not") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *SegmentFilter) MarshalJSON() ([]byte, error) {
type NoMethod SegmentFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SegmentFilterClause: Filter Clause to be used in a segment
// definition, can be wither a metric or
// a dimension filter.
type SegmentFilterClause struct {
// DimensionFilter: Dimension Filter for the segment definition.
DimensionFilter *SegmentDimensionFilter `json:"dimensionFilter,omitempty"`
// MetricFilter: Metric Filter for the segment definition.
MetricFilter *SegmentMetricFilter `json:"metricFilter,omitempty"`
// Not: Matches the complement (`!`) of the filter.
Not bool `json:"not,omitempty"`
// ForceSendFields is a list of field names (e.g. "DimensionFilter") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DimensionFilter") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *SegmentFilterClause) MarshalJSON() ([]byte, error) {
type NoMethod SegmentFilterClause
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SegmentMetricFilter: Metric filter to be used in a segment filter
// clause.
type SegmentMetricFilter struct {
// ComparisonValue: The value to compare against. If the operator is
// `BETWEEN`, this value is
// treated as minimum comparison value.
ComparisonValue string `json:"comparisonValue,omitempty"`
// MaxComparisonValue: Max comparison value is only used for `BETWEEN`
// operator.
MaxComparisonValue string `json:"maxComparisonValue,omitempty"`
// MetricName: The metric that will be filtered on. A `metricFilter`
// must contain a
// metric name.
MetricName string `json:"metricName,omitempty"`
// Operator: Specifies is the operation to perform to compare the
// metric. The default
// is `EQUAL`.
//
// Possible values:
// "UNSPECIFIED_OPERATOR" - Unspecified operator is treated as
// `LESS_THAN` operator.
// "LESS_THAN" - Checks if the metric value is less than comparison
// value.
// "GREATER_THAN" - Checks if the metric value is greater than
// comparison value.
// "EQUAL" - Equals operator.
// "BETWEEN" - For between operator, both the minimum and maximum are
// exclusive.
// We will use `LT` and `GT` for comparison.
Operator string `json:"operator,omitempty"`
// Scope: 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.
//
// Possible values:
// "UNSPECIFIED_SCOPE" - If the scope is unspecified, it defaults to
// the condition scope,
// `USER` or `SESSION` depending on if the segment is trying to
// choose
// users or sessions.
// "PRODUCT" - Product scope.
// "HIT" - Hit scope.
// "SESSION" - Session scope.
// "USER" - User scope.
Scope string `json:"scope,omitempty"`
// ForceSendFields is a list of field names (e.g. "ComparisonValue") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ComparisonValue") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *SegmentMetricFilter) MarshalJSON() ([]byte, error) {
type NoMethod SegmentMetricFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SegmentSequenceStep: A segment sequence definition.
type SegmentSequenceStep struct {
// MatchType: Specifies if the step immediately precedes or can be any
// time before the
// next step.
//
// Possible values:
// "UNSPECIFIED_MATCH_TYPE" - Unspecified match type is treated as
// precedes.
// "PRECEDES" - Operator indicates that the previous step precedes the
// next step.
// "IMMEDIATELY_PRECEDES" - Operator indicates that the previous step
// immediately precedes the next
// step.
MatchType string `json:"matchType,omitempty"`
// OrFiltersForSegment: A sequence is specified with a list of Or
// grouped filters which are
// combined with `AND` operator.
OrFiltersForSegment []*OrFiltersForSegment `json:"orFiltersForSegment,omitempty"`
// ForceSendFields is a list of field names (e.g. "MatchType") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MatchType") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *SegmentSequenceStep) MarshalJSON() ([]byte, error) {
type NoMethod SegmentSequenceStep
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SequenceSegment: 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.
type SequenceSegment struct {
// FirstStepShouldMatchFirstHit: If set, first step condition must match
// the first hit of the visitor (in
// the date range).
FirstStepShouldMatchFirstHit bool `json:"firstStepShouldMatchFirstHit,omitempty"`
// SegmentSequenceSteps: The list of steps in the sequence.
SegmentSequenceSteps []*SegmentSequenceStep `json:"segmentSequenceSteps,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "FirstStepShouldMatchFirstHit") to unconditionally include in API
// requests. By default, fields with empty values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g.
// "FirstStepShouldMatchFirstHit") to include in API requests with the
// JSON null value. By default, fields with empty values are omitted
// from API requests. However, any field with an empty value appearing
// in NullFields will be sent to the server as null. It is an error if a
// field in this list has a non-empty value. This may be used to include
// null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *SequenceSegment) MarshalJSON() ([]byte, error) {
type NoMethod SequenceSegment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SimpleSegment: A Simple segment conditions consist of one or more
// dimension/metric
// conditions that can be combined.
type SimpleSegment struct {
// OrFiltersForSegment: A list of segment filters groups which are
// combined with logical `AND`
// operator.
OrFiltersForSegment []*OrFiltersForSegment `json:"orFiltersForSegment,omitempty"`
// ForceSendFields is a list of field names (e.g. "OrFiltersForSegment")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OrFiltersForSegment") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *SimpleSegment) MarshalJSON() ([]byte, error) {
type NoMethod SimpleSegment
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// method id "analyticsreporting.reports.batchGet":
type ReportsBatchGetCall struct {
s *Service
getreportsrequest *GetReportsRequest
urlParams_ gensupport.URLParams
ctx_ context.Context
header_ http.Header
}
// BatchGet: Returns the Analytics data.
func (r *ReportsService) BatchGet(getreportsrequest *GetReportsRequest) *ReportsBatchGetCall {
c := &ReportsBatchGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.getreportsrequest = getreportsrequest
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ReportsBatchGetCall) Fields(s ...googleapi.Field) *ReportsBatchGetCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method. Any
// pending HTTP request will be aborted if the provided context is
// canceled.
func (c *ReportsBatchGetCall) Context(ctx context.Context) *ReportsBatchGetCall {
c.ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func (c *ReportsBatchGetCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *ReportsBatchGetCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
for k, v := range c.header_ {
reqHeaders[k] = v
}
reqHeaders.Set("User-Agent", c.s.userAgent())
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.getreportsrequest)
if err != nil {
return nil, err
}
reqHeaders.Set("Content-Type", "application/json")
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v4/reports:batchGet")
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "analyticsreporting.reports.batchGet" call.
// Exactly one of *GetReportsResponse or error will be non-nil. Any
// non-2xx status code is an error. Response headers are in either
// *GetReportsResponse.ServerResponse.Header or (if a response was
// returned at all) in error.(*googleapi.Error).Header. Use
// googleapi.IsNotModified to check whether the returned error was
// because http.StatusNotModified was returned.
func (c *ReportsBatchGetCall) Do(opts ...googleapi.CallOption) (*GetReportsResponse, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, &googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
}
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
ret := &GetReportsResponse{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Returns the Analytics data.",
// "flatPath": "v4/reports:batchGet",
// "httpMethod": "POST",
// "id": "analyticsreporting.reports.batchGet",
// "parameterOrder": [],
// "parameters": {},
// "path": "v4/reports:batchGet",
// "request": {
// "$ref": "GetReportsRequest"
// },
// "response": {
// "$ref": "GetReportsResponse"
// },
// "scopes": [
// "https://www.googleapis.com/auth/analytics",
// "https://www.googleapis.com/auth/analytics.readonly"
// ]
// }
}
|