OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/analytics.readonly": { | 5 "https://www.googleapis.com/auth/analytics.readonly": { |
6 "description": "View your Google Analytics data" | 6 "description": "View your Google Analytics data" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/analytics": { | 8 "https://www.googleapis.com/auth/analytics": { |
9 "description": "View and manage your Google Analytics data" | 9 "description": "View and manage your Google Analytics data" |
10 } | 10 } |
(...skipping 10 matching lines...) Expand all Loading... |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "analyticsreporting:v4", | 25 "id": "analyticsreporting:v4", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "analyticsreporting", | 27 "name": "analyticsreporting", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "bearer_token": { | |
32 "description": "OAuth bearer token.", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "oauth_token": { | |
37 "description": "OAuth 2.0 token for the current user.", | |
38 "location": "query", | |
39 "type": "string" | |
40 }, | |
41 "upload_protocol": { | 31 "upload_protocol": { |
42 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
43 "location": "query", | 33 "location": "query", |
44 "type": "string" | 34 "type": "string" |
45 }, | 35 }, |
46 "prettyPrint": { | 36 "prettyPrint": { |
47 "default": "true", | 37 "default": "true", |
48 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
49 "location": "query", | 39 "location": "query", |
50 "type": "boolean" | 40 "type": "boolean" |
51 }, | 41 }, |
52 "uploadType": { | 42 "uploadType": { |
53 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 43 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
54 "location": "query", | 44 "location": "query", |
55 "type": "string" | 45 "type": "string" |
56 }, | 46 }, |
57 "fields": { | 47 "fields": { |
58 "description": "Selector specifying which fields to include in a par
tial response.", | 48 "description": "Selector specifying which fields to include in a par
tial response.", |
59 "location": "query", | 49 "location": "query", |
60 "type": "string" | 50 "type": "string" |
61 }, | 51 }, |
| 52 "callback": { |
| 53 "description": "JSONP", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
62 "$.xgafv": { | 57 "$.xgafv": { |
63 "description": "V1 error format.", | 58 "description": "V1 error format.", |
64 "enum": [ | 59 "enum": [ |
65 "1", | 60 "1", |
66 "2" | 61 "2" |
67 ], | 62 ], |
68 "enumDescriptions": [ | 63 "enumDescriptions": [ |
69 "v1 error format", | 64 "v1 error format", |
70 "v2 error format" | 65 "v2 error format" |
71 ], | 66 ], |
72 "location": "query", | 67 "location": "query", |
73 "type": "string" | 68 "type": "string" |
74 }, | 69 }, |
75 "callback": { | |
76 "description": "JSONP", | |
77 "location": "query", | |
78 "type": "string" | |
79 }, | |
80 "alt": { | 70 "alt": { |
81 "default": "json", | 71 "default": "json", |
82 "description": "Data format for response.", | 72 "description": "Data format for response.", |
83 "enum": [ | 73 "enum": [ |
84 "json", | 74 "json", |
85 "media", | 75 "media", |
86 "proto" | 76 "proto" |
87 ], | 77 ], |
88 "enumDescriptions": [ | 78 "enumDescriptions": [ |
89 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
(...skipping 16 matching lines...) Expand all Loading... |
106 "quotaUser": { | 96 "quotaUser": { |
107 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 97 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
108 "location": "query", | 98 "location": "query", |
109 "type": "string" | 99 "type": "string" |
110 }, | 100 }, |
111 "pp": { | 101 "pp": { |
112 "default": "true", | 102 "default": "true", |
113 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
114 "location": "query", | 104 "location": "query", |
115 "type": "boolean" | 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 112 "bearer_token": { |
| 113 "description": "OAuth bearer token.", |
| 114 "location": "query", |
| 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "reports": { | 120 "reports": { |
121 "methods": { | 121 "methods": { |
122 "batchGet": { | 122 "batchGet": { |
123 "description": "Returns the Analytics data.", | 123 "description": "Returns the Analytics data.", |
124 "httpMethod": "POST", | 124 "httpMethod": "POST", |
125 "id": "analyticsreporting.reports.batchGet", | 125 "id": "analyticsreporting.reports.batchGet", |
(...skipping 10 matching lines...) Expand all Loading... |
136 "https://www.googleapis.com/auth/analytics", | 136 "https://www.googleapis.com/auth/analytics", |
137 "https://www.googleapis.com/auth/analytics.readonly" | 137 "https://www.googleapis.com/auth/analytics.readonly" |
138 ] | 138 ] |
139 } | 139 } |
140 } | 140 } |
141 } | 141 } |
142 }, | 142 }, |
143 "revision": "20170705", | 143 "revision": "20170705", |
144 "rootUrl": "https://analyticsreporting.googleapis.com/", | 144 "rootUrl": "https://analyticsreporting.googleapis.com/", |
145 "schemas": { | 145 "schemas": { |
| 146 "OrFiltersForSegment": { |
| 147 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", |
| 148 "id": "OrFiltersForSegment", |
| 149 "properties": { |
| 150 "segmentFilterClauses": { |
| 151 "description": "List of segment filters to be combined with
a `OR` operator.", |
| 152 "items": { |
| 153 "$ref": "SegmentFilterClause" |
| 154 }, |
| 155 "type": "array" |
| 156 } |
| 157 }, |
| 158 "type": "object" |
| 159 }, |
| 160 "MetricHeader": { |
| 161 "description": "The headers for the metrics.", |
| 162 "id": "MetricHeader", |
| 163 "properties": { |
| 164 "pivotHeaders": { |
| 165 "description": "Headers for the pivots in the response.", |
| 166 "items": { |
| 167 "$ref": "PivotHeader" |
| 168 }, |
| 169 "type": "array" |
| 170 }, |
| 171 "metricHeaderEntries": { |
| 172 "description": "Headers for the metrics in the response.", |
| 173 "items": { |
| 174 "$ref": "MetricHeaderEntry" |
| 175 }, |
| 176 "type": "array" |
| 177 } |
| 178 }, |
| 179 "type": "object" |
| 180 }, |
| 181 "DimensionFilterClause": { |
| 182 "description": "A group of dimension filters. Set the operator value
to specify how\nthe filters are logically combined.", |
| 183 "id": "DimensionFilterClause", |
| 184 "properties": { |
| 185 "filters": { |
| 186 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", |
| 187 "items": { |
| 188 "$ref": "DimensionFilter" |
| 189 }, |
| 190 "type": "array" |
| 191 }, |
| 192 "operator": { |
| 193 "description": "The operator for combining multiple dimensio
n filters. If unspecified, it\nis treated as an `OR`.", |
| 194 "enum": [ |
| 195 "OPERATOR_UNSPECIFIED", |
| 196 "OR", |
| 197 "AND" |
| 198 ], |
| 199 "enumDescriptions": [ |
| 200 "Unspecified operator. It is treated as an `OR`.", |
| 201 "The logical `OR` operator.", |
| 202 "The logical `AND` operator." |
| 203 ], |
| 204 "type": "string" |
| 205 } |
| 206 }, |
| 207 "type": "object" |
| 208 }, |
| 209 "GetReportsResponse": { |
| 210 "description": "The main response class which holds the reports from
the Reporting API\n`batchGet` call.", |
| 211 "id": "GetReportsResponse", |
| 212 "properties": { |
| 213 "reports": { |
| 214 "description": "Responses corresponding to each of the reque
st.", |
| 215 "items": { |
| 216 "$ref": "Report" |
| 217 }, |
| 218 "type": "array" |
| 219 } |
| 220 }, |
| 221 "type": "object" |
| 222 }, |
| 223 "SequenceSegment": { |
| 224 "description": "Sequence conditions consist of one or more steps, wh
ere each step is defined\nby one or more dimension/metric conditions. Multiple s
teps can be combined\nwith special sequence operators.", |
| 225 "id": "SequenceSegment", |
| 226 "properties": { |
| 227 "firstStepShouldMatchFirstHit": { |
| 228 "description": "If set, first step condition must match the
first hit of the visitor (in\nthe date range).", |
| 229 "type": "boolean" |
| 230 }, |
| 231 "segmentSequenceSteps": { |
| 232 "description": "The list of steps in the sequence.", |
| 233 "items": { |
| 234 "$ref": "SegmentSequenceStep" |
| 235 }, |
| 236 "type": "array" |
| 237 } |
| 238 }, |
| 239 "type": "object" |
| 240 }, |
| 241 "SegmentMetricFilter": { |
| 242 "description": "Metric filter to be used in a segment filter clause.
", |
| 243 "id": "SegmentMetricFilter", |
| 244 "properties": { |
| 245 "metricName": { |
| 246 "description": "The metric that will be filtered on. A `metr
icFilter` must contain a\nmetric name.", |
| 247 "type": "string" |
| 248 }, |
| 249 "scope": { |
| 250 "description": "Scope for a metric defines the level at whic
h that metric is defined. The\nspecified metric scope must be equal to or great
er than its primary scope\nas defined in the data model. The primary scope is de
fined by if the\nsegment is selecting users or sessions.", |
| 251 "enum": [ |
| 252 "UNSPECIFIED_SCOPE", |
| 253 "PRODUCT", |
| 254 "HIT", |
| 255 "SESSION", |
| 256 "USER" |
| 257 ], |
| 258 "enumDescriptions": [ |
| 259 "If the scope is unspecified, it defaults to the conditi
on scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\n
users or sessions.", |
| 260 "Product scope.", |
| 261 "Hit scope.", |
| 262 "Session scope.", |
| 263 "User scope." |
| 264 ], |
| 265 "type": "string" |
| 266 }, |
| 267 "maxComparisonValue": { |
| 268 "description": "Max comparison value is only used for `BETWE
EN` operator.", |
| 269 "type": "string" |
| 270 }, |
| 271 "comparisonValue": { |
| 272 "description": "The value to compare against. If the operato
r is `BETWEEN`, this value is\ntreated as minimum comparison value.", |
| 273 "type": "string" |
| 274 }, |
| 275 "operator": { |
| 276 "description": "Specifies is the operation to perform to com
pare the metric. The default\nis `EQUAL`.", |
| 277 "enum": [ |
| 278 "UNSPECIFIED_OPERATOR", |
| 279 "LESS_THAN", |
| 280 "GREATER_THAN", |
| 281 "EQUAL", |
| 282 "BETWEEN" |
| 283 ], |
| 284 "enumDescriptions": [ |
| 285 "Unspecified operator is treated as `LESS_THAN` operator
.", |
| 286 "Checks if the metric value is less than comparison valu
e.", |
| 287 "Checks if the metric value is greater than comparison v
alue.", |
| 288 "Equals operator.", |
| 289 "For between operator, both the minimum and maximum are
exclusive.\nWe will use `LT` and `GT` for comparison." |
| 290 ], |
| 291 "type": "string" |
| 292 } |
| 293 }, |
| 294 "type": "object" |
| 295 }, |
| 296 "DateRangeValues": { |
| 297 "description": "Used to return a list of metrics for a single DateRa
nge / dimension\ncombination", |
| 298 "id": "DateRangeValues", |
| 299 "properties": { |
| 300 "values": { |
| 301 "description": "Each value corresponds to each Metric in the
request.", |
| 302 "items": { |
| 303 "type": "string" |
| 304 }, |
| 305 "type": "array" |
| 306 }, |
| 307 "pivotValueRegions": { |
| 308 "description": "The values of each pivot region.", |
| 309 "items": { |
| 310 "$ref": "PivotValueRegion" |
| 311 }, |
| 312 "type": "array" |
| 313 } |
| 314 }, |
| 315 "type": "object" |
| 316 }, |
| 317 "CohortGroup": { |
| 318 "description": "Defines a cohort group.\nFor example:\n\n \"cohor
tGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"t
ype\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-
01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n
\"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\"
: \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }", |
| 319 "id": "CohortGroup", |
| 320 "properties": { |
| 321 "cohorts": { |
| 322 "description": "The definition for the cohort.", |
| 323 "items": { |
| 324 "$ref": "Cohort" |
| 325 }, |
| 326 "type": "array" |
| 327 }, |
| 328 "lifetimeValue": { |
| 329 "description": "Enable Life Time Value (LTV). LTV measures
lifetime value for users\nacquired through different channels.\nPlease see:\n[Co
hort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifeti
me Value](https://support.google.com/analytics/answer/6182550)\nIf the value of
lifetimeValue is false:\n\n- The metric values are similar to the values in the
web interface cohort\n report.\n- The cohort definition date ranges must be ali
gned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek`
the `startDate` in\n the cohort definition should be a Sunday and the `endDate
` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDa
te`\n should be the 1st of the month and `endDate` should be the last day\n of
the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will corre
spond to the values in the web interface\n LifeTime value report.\n- The Lifeti
me Value report shows you how user value (Revenue) and\n engagement (Appviews,
Goal Completions, Sessions, and Session Duration)\n grow during the 90 days aft
er a user is acquired.\n- The metrics are calculated as a cumulative average per
user per the time\n increment.\n- The cohort definition date ranges need not b
e aligned to the calendar\n week and month boundaries.\n- The `viewId` must be
an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersu
sAppViews)", |
| 330 "type": "boolean" |
| 331 } |
| 332 }, |
| 333 "type": "object" |
| 334 }, |
| 335 "GetReportsRequest": { |
| 336 "description": "The batch request containing multiple report request
.", |
| 337 "id": "GetReportsRequest", |
| 338 "properties": { |
| 339 "reportRequests": { |
| 340 "description": "Requests, each request will have a separate
response.\nThere can be a maximum of 5 requests. All requests should have the sa
me\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.", |
| 341 "items": { |
| 342 "$ref": "ReportRequest" |
| 343 }, |
| 344 "type": "array" |
| 345 } |
| 346 }, |
| 347 "type": "object" |
| 348 }, |
| 349 "Pivot": { |
| 350 "description": "The Pivot describes the pivot section in the request
.\nThe Pivot helps rearrange the information in the table for certain reports\nb
y pivoting your data on a second dimension.", |
| 351 "id": "Pivot", |
| 352 "properties": { |
| 353 "maxGroupCount": { |
| 354 "description": "Specifies the maximum number of groups to re
turn.\nThe default value is 10, also the maximum value is 1,000.", |
| 355 "format": "int32", |
| 356 "type": "integer" |
| 357 }, |
| 358 "startGroup": { |
| 359 "description": "If k metrics were requested, then the respon
se will contain some\ndata-dependent multiple of k columns in the report. E.g.,
if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Fi
refox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of t
he groups\nof columns is determined by descending order of \"total\" for the fir
st of\nthe k values. Ties are broken by lexicographic ordering of the first\npi
vot dimension, then lexicographic ordering of the second pivot\ndimension, and s
o on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were
8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nT
he following let you choose which of the groups of k columns are\nincluded in th
e response.", |
| 360 "format": "int32", |
| 361 "type": "integer" |
| 362 }, |
| 363 "metrics": { |
| 364 "description": "The pivot metrics. Pivot metrics are part of
the\nrestriction on total number of metrics allowed in the request.", |
| 365 "items": { |
| 366 "$ref": "Metric" |
| 367 }, |
| 368 "type": "array" |
| 369 }, |
| 370 "dimensionFilterClauses": { |
| 371 "description": "DimensionFilterClauses are logically combine
d with an `AND` operator: only\ndata that is included by all these DimensionFilt
erClauses contributes to\nthe values in this pivot region. Dimension filters can
be used to restrict\nthe columns shown in the pivot region. For example if you
have\n`ga:browser` as the requested dimension in the pivot region, and you\nspec
ify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen on
ly those two browsers would show up as columns.", |
| 372 "items": { |
| 373 "$ref": "DimensionFilterClause" |
| 374 }, |
| 375 "type": "array" |
| 376 }, |
| 377 "dimensions": { |
| 378 "description": "A list of dimensions to show as pivot column
s. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the
restriction on the\ntotal number of dimensions allowed in the request.", |
| 379 "items": { |
| 380 "$ref": "Dimension" |
| 381 }, |
| 382 "type": "array" |
| 383 } |
| 384 }, |
| 385 "type": "object" |
| 386 }, |
| 387 "PivotHeaderEntry": { |
| 388 "description": "The headers for the each of the metric column corres
ponding to the metrics\nrequested in the pivots section of the response.", |
| 389 "id": "PivotHeaderEntry", |
| 390 "properties": { |
| 391 "metric": { |
| 392 "$ref": "MetricHeaderEntry", |
| 393 "description": "The metric header for the metric in the pivo
t." |
| 394 }, |
| 395 "dimensionNames": { |
| 396 "description": "The name of the dimensions in the pivot resp
onse.", |
| 397 "items": { |
| 398 "type": "string" |
| 399 }, |
| 400 "type": "array" |
| 401 }, |
| 402 "dimensionValues": { |
| 403 "description": "The values for the dimensions in the pivot."
, |
| 404 "items": { |
| 405 "type": "string" |
| 406 }, |
| 407 "type": "array" |
| 408 } |
| 409 }, |
| 410 "type": "object" |
| 411 }, |
| 412 "SegmentFilter": { |
| 413 "description": "SegmentFilter defines the segment to be either a sim
ple or a sequence\nsegment. A simple segment condition contains dimension and me
tric conditions\nto select the sessions or users. A sequence segment condition c
an be used to\nselect users or sessions based on sequential conditions.", |
| 414 "id": "SegmentFilter", |
| 415 "properties": { |
| 416 "sequenceSegment": { |
| 417 "$ref": "SequenceSegment", |
| 418 "description": "Sequence conditions consist of one or more s
teps, where each step is\ndefined by one or more dimension/metric conditions. Mu
ltiple steps can\nbe combined with special sequence operators." |
| 419 }, |
| 420 "not": { |
| 421 "description": "If true, match the complement of simple or s
equence segment.\nFor example, to match all visits not from \"New York\", we can
define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segme
ntFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegme
nt\": [{\n \"segmentFilterClauses\":[{\n \"dimension
Filter\": {\n \"dimensionName\": \"ga:city\",\n
\"expressions\": [\"New York\"]\n }\n }]\n
}]\n },\n \"not\": \"True\"\n }]\n },", |
| 422 "type": "boolean" |
| 423 }, |
| 424 "simpleSegment": { |
| 425 "$ref": "SimpleSegment", |
| 426 "description": "A Simple segment conditions consist of one o
r more dimension/metric\nconditions that can be combined" |
| 427 } |
| 428 }, |
| 429 "type": "object" |
| 430 }, |
| 431 "SegmentDefinition": { |
| 432 "description": "SegmentDefinition defines the segment to be a set of
SegmentFilters which\nare combined together with a logical `AND` operation.", |
| 433 "id": "SegmentDefinition", |
| 434 "properties": { |
| 435 "segmentFilters": { |
| 436 "description": "A segment is defined by a set of segment fil
ters which are combined\ntogether with a logical `AND` operation.", |
| 437 "items": { |
| 438 "$ref": "SegmentFilter" |
| 439 }, |
| 440 "type": "array" |
| 441 } |
| 442 }, |
| 443 "type": "object" |
| 444 }, |
| 445 "MetricHeaderEntry": { |
| 446 "description": "Header for the metrics.", |
| 447 "id": "MetricHeaderEntry", |
| 448 "properties": { |
| 449 "name": { |
| 450 "description": "The name of the header.", |
| 451 "type": "string" |
| 452 }, |
| 453 "type": { |
| 454 "description": "The type of the metric, for example `INTEGER
`.", |
| 455 "enum": [ |
| 456 "METRIC_TYPE_UNSPECIFIED", |
| 457 "INTEGER", |
| 458 "FLOAT", |
| 459 "CURRENCY", |
| 460 "PERCENT", |
| 461 "TIME" |
| 462 ], |
| 463 "enumDescriptions": [ |
| 464 "Metric type is unspecified.", |
| 465 "Integer metric.", |
| 466 "Float metric.", |
| 467 "Currency metric.", |
| 468 "Percentage metric.", |
| 469 "Time metric in `HH:MM:SS` format." |
| 470 ], |
| 471 "type": "string" |
| 472 } |
| 473 }, |
| 474 "type": "object" |
| 475 }, |
| 476 "ReportData": { |
| 477 "description": "The data part of the report.", |
| 478 "id": "ReportData", |
| 479 "properties": { |
| 480 "samplingSpaceSizes": { |
| 481 "description": "If the results are\n[sampled](https://suppor
t.google.com/analytics/answer/2637192),\nthis returns the total number of\nsampl
es present, one entry per date range. If the results are not sampled\nthis field
will not be defined. See\n[developer guide](/analytics/devguides/reporting/core
/v4/basics#sampling)\nfor details.", |
| 482 "items": { |
| 483 "format": "int64", |
| 484 "type": "string" |
| 485 }, |
| 486 "type": "array" |
| 487 }, |
| 488 "minimums": { |
| 489 "description": "Minimum and maximum values seen over all mat
ching rows. These are both\nempty when `hideValueRanges` in the request is false
, or when\nrowCount is zero.", |
| 490 "items": { |
| 491 "$ref": "DateRangeValues" |
| 492 }, |
| 493 "type": "array" |
| 494 }, |
| 495 "totals": { |
| 496 "description": "For each requested date range, for the set o
f all rows that match\nthe query, every requested value format gets a total. The
total\nfor a value format is computed by first totaling the metrics\nmentioned
in the value format and then evaluating the value\nformat as a scalar expression
. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of a
ll relevant ga:sessions) + 2)`.\nTotals are computed before pagination.", |
| 497 "items": { |
| 498 "$ref": "DateRangeValues" |
| 499 }, |
| 500 "type": "array" |
| 501 }, |
| 502 "samplesReadCounts": { |
| 503 "description": "If the results are\n[sampled](https://suppor
t.google.com/analytics/answer/2637192),\nthis returns the total number of sample
s read, one entry per date range.\nIf the results are not sampled this field wil
l not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/
basics#sampling)\nfor details.", |
| 504 "items": { |
| 505 "format": "int64", |
| 506 "type": "string" |
| 507 }, |
| 508 "type": "array" |
| 509 }, |
| 510 "isDataGolden": { |
| 511 "description": "Indicates if response to this request is gol
den or not. Data is\ngolden when the exact same request will not produce any new
results if\nasked at a later point in time.", |
| 512 "type": "boolean" |
| 513 }, |
| 514 "rows": { |
| 515 "description": "There's one ReportRow for every unique combi
nation of dimensions.", |
| 516 "items": { |
| 517 "$ref": "ReportRow" |
| 518 }, |
| 519 "type": "array" |
| 520 }, |
| 521 "rowCount": { |
| 522 "description": "Total number of matching rows for this query
.", |
| 523 "format": "int32", |
| 524 "type": "integer" |
| 525 }, |
| 526 "dataLastRefreshed": { |
| 527 "description": "The last time the data in the report was ref
reshed. All the hits received\nbefore this timestamp are included in the calcula
tion of the report.", |
| 528 "format": "google-datetime", |
| 529 "type": "string" |
| 530 }, |
| 531 "maximums": { |
| 532 "description": "Minimum and maximum values seen over all mat
ching rows. These are both\nempty when `hideValueRanges` in the request is false
, or when\nrowCount is zero.", |
| 533 "items": { |
| 534 "$ref": "DateRangeValues" |
| 535 }, |
| 536 "type": "array" |
| 537 } |
| 538 }, |
| 539 "type": "object" |
| 540 }, |
146 "DimensionFilter": { | 541 "DimensionFilter": { |
147 "description": "Dimension filter specifies the filtering options on
a dimension.", | 542 "description": "Dimension filter specifies the filtering options on
a dimension.", |
148 "id": "DimensionFilter", | 543 "id": "DimensionFilter", |
149 "properties": { | 544 "properties": { |
150 "caseSensitive": { | 545 "caseSensitive": { |
151 "description": "Should the match be case sensitive? Default
is false.", | 546 "description": "Should the match be case sensitive? Default
is false.", |
152 "type": "boolean" | 547 "type": "boolean" |
153 }, | 548 }, |
154 "operator": { | 549 "operator": { |
155 "description": "How to match the dimension to the expression
. The default is REGEXP.", | 550 "description": "How to match the dimension to the expression
. The default is REGEXP.", |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
190 }, | 585 }, |
191 "type": "array" | 586 "type": "array" |
192 }, | 587 }, |
193 "not": { | 588 "not": { |
194 "description": "Logical `NOT` operator. If this boolean is s
et to true, then the matching\ndimension values will be excluded in the report.
The default is false.", | 589 "description": "Logical `NOT` operator. If this boolean is s
et to true, then the matching\ndimension values will be excluded in the report.
The default is false.", |
195 "type": "boolean" | 590 "type": "boolean" |
196 } | 591 } |
197 }, | 592 }, |
198 "type": "object" | 593 "type": "object" |
199 }, | 594 }, |
| 595 "Segment": { |
| 596 "description": "The segment definition, if the report needs to be se
gmented.\nA Segment is a subset of the Analytics data. For example, of the entir
e\nset of users, one Segment might be users from a particular country or city.", |
| 597 "id": "Segment", |
| 598 "properties": { |
| 599 "segmentId": { |
| 600 "description": "The segment ID of a built-in or custom segme
nt, for example `gaid::-3`.", |
| 601 "type": "string" |
| 602 }, |
| 603 "dynamicSegment": { |
| 604 "$ref": "DynamicSegment", |
| 605 "description": "A dynamic segment definition in the request.
" |
| 606 } |
| 607 }, |
| 608 "type": "object" |
| 609 }, |
| 610 "OrderBy": { |
| 611 "description": "Specifies the sorting options.", |
| 612 "id": "OrderBy", |
| 613 "properties": { |
| 614 "orderType": { |
| 615 "description": "The order type. The default orderType is `VA
LUE`.", |
| 616 "enum": [ |
| 617 "ORDER_TYPE_UNSPECIFIED", |
| 618 "VALUE", |
| 619 "DELTA", |
| 620 "SMART", |
| 621 "HISTOGRAM_BUCKET", |
| 622 "DIMENSION_AS_INTEGER" |
| 623 ], |
| 624 "enumDescriptions": [ |
| 625 "Unspecified order type will be treated as sort based on
value.", |
| 626 "The sort order is based on the value of the chosen colu
mn; looks only at\nthe first date range.", |
| 627 "The sort order is based on the difference of the values
of the chosen\ncolumn between the first two date ranges. Usable only if there
are\nexactly two date ranges.", |
| 628 "The sort order is based on weighted value of the chosen
column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe
`(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios."
, |
| 629 "Histogram order type is applicable only to dimension co
lumns with\nnon-empty histogram-buckets.", |
| 630 "If the dimensions are fixed length numbers, ordinary so
rt would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions a
re\nvariable length numbers." |
| 631 ], |
| 632 "type": "string" |
| 633 }, |
| 634 "fieldName": { |
| 635 "description": "The field which to sort by. The default sort
order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify on
e field for sort here. For example,\n`ga:browser, ga:city` is not valid.", |
| 636 "type": "string" |
| 637 }, |
| 638 "sortOrder": { |
| 639 "description": "The sorting order for the field.", |
| 640 "enum": [ |
| 641 "SORT_ORDER_UNSPECIFIED", |
| 642 "ASCENDING", |
| 643 "DESCENDING" |
| 644 ], |
| 645 "enumDescriptions": [ |
| 646 "If the sort order is unspecified, the default is ascend
ing.", |
| 647 "Ascending sort. The field will be sorted in an ascendin
g manner.", |
| 648 "Descending sort. The field will be sorted in a descendi
ng manner." |
| 649 ], |
| 650 "type": "string" |
| 651 } |
| 652 }, |
| 653 "type": "object" |
| 654 }, |
200 "SegmentDimensionFilter": { | 655 "SegmentDimensionFilter": { |
201 "description": "Dimension filter specifies the filtering options on
a dimension.", | 656 "description": "Dimension filter specifies the filtering options on
a dimension.", |
202 "id": "SegmentDimensionFilter", | 657 "id": "SegmentDimensionFilter", |
203 "properties": { | 658 "properties": { |
204 "minComparisonValue": { | |
205 "description": "Minimum comparison values for `BETWEEN` matc
h type.", | |
206 "type": "string" | |
207 }, | |
208 "maxComparisonValue": { | 659 "maxComparisonValue": { |
209 "description": "Maximum comparison values for `BETWEEN` matc
h type.", | 660 "description": "Maximum comparison values for `BETWEEN` matc
h type.", |
210 "type": "string" | 661 "type": "string" |
211 }, | 662 }, |
| 663 "dimensionName": { |
| 664 "description": "Name of the dimension for which the filter i
s being applied.", |
| 665 "type": "string" |
| 666 }, |
212 "operator": { | 667 "operator": { |
213 "description": "The operator to use to match the dimension w
ith the expressions.", | 668 "description": "The operator to use to match the dimension w
ith the expressions.", |
214 "enum": [ | 669 "enum": [ |
215 "OPERATOR_UNSPECIFIED", | 670 "OPERATOR_UNSPECIFIED", |
216 "REGEXP", | 671 "REGEXP", |
217 "BEGINS_WITH", | 672 "BEGINS_WITH", |
218 "ENDS_WITH", | 673 "ENDS_WITH", |
219 "PARTIAL", | 674 "PARTIAL", |
220 "EXACT", | 675 "EXACT", |
221 "IN_LIST", | 676 "IN_LIST", |
222 "NUMERIC_LESS_THAN", | 677 "NUMERIC_LESS_THAN", |
223 "NUMERIC_GREATER_THAN", | 678 "NUMERIC_GREATER_THAN", |
224 "NUMERIC_BETWEEN" | 679 "NUMERIC_BETWEEN" |
225 ], | 680 ], |
226 "enumDescriptions": [ | 681 "enumDescriptions": [ |
227 "If the match type is unspecified, it is treated as a RE
GEXP.", | 682 "If the match type is unspecified, it is treated as a RE
GEXP.", |
228 "The match expression is treated as a regular expression
. All other match\ntypes are not treated as regular expressions.", | 683 "The match expression is treated as a regular expression
. All other match\ntypes are not treated as regular expressions.", |
229 "Matches the values which begin with the match expressio
n provided.", | 684 "Matches the values which begin with the match expressio
n provided.", |
230 "Matches the values which end with the match expression
provided.", | 685 "Matches the values which end with the match expression
provided.", |
231 "Substring match.", | 686 "Substring match.", |
232 "The value should match the match expression entirely.", | 687 "The value should match the match expression entirely.", |
233 "This option is used to specify a dimension filter whose
expression can\ntake any value from a selected list of values. This helps avoid
ing\nevaluating multiple exact match dimension filters which are OR'ed for\never
y single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\
nAny response row whose dimension has it is value as A, B or C, matches\nthis Di
mensionFilter.", | 688 "This option is used to specify a dimension filter whose
expression can\ntake any value from a selected list of values. This helps avoid
ing\nevaluating multiple exact match dimension filters which are OR'ed for\never
y single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\
nAny response row whose dimension has it is value as A, B or C, matches\nthis Di
mensionFilter.", |
234 "Integer comparison filters.\ncase sensitivity is ignore
d for these and the expression\nis assumed to be a string representing an intege
r.\nFailure conditions:\n\n- if expression is not a valid int64, the client shou
ld expect\n an error.\n- input dimensions that are not valid int64 values will
never match the\n filter.\n\nChecks if the dimension is numerically less than t
he match expression.", | 689 "Integer comparison filters.\ncase sensitivity is ignore
d for these and the expression\nis assumed to be a string representing an intege
r.\nFailure conditions:\n\n- if expression is not a valid int64, the client shou
ld expect\n an error.\n- input dimensions that are not valid int64 values will
never match the\n filter.\n\nChecks if the dimension is numerically less than t
he match expression.", |
235 "Checks if the dimension is numerically greater than the
match\nexpression.", | 690 "Checks if the dimension is numerically greater than the
match\nexpression.", |
236 "Checks if the dimension is numerically between the mini
mum and maximum\nof the match expression, boundaries excluded." | 691 "Checks if the dimension is numerically between the mini
mum and maximum\nof the match expression, boundaries excluded." |
237 ], | 692 ], |
238 "type": "string" | 693 "type": "string" |
239 }, | 694 }, |
240 "dimensionName": { | |
241 "description": "Name of the dimension for which the filter i
s being applied.", | |
242 "type": "string" | |
243 }, | |
244 "expressions": { | 695 "expressions": { |
245 "description": "The list of expressions, only the first elem
ent is used for all operators", | 696 "description": "The list of expressions, only the first elem
ent is used for all operators", |
246 "items": { | 697 "items": { |
247 "type": "string" | 698 "type": "string" |
248 }, | 699 }, |
249 "type": "array" | 700 "type": "array" |
250 }, | 701 }, |
251 "caseSensitive": { | 702 "caseSensitive": { |
252 "description": "Should the match be case sensitive, ignored
for `IN_LIST` operator.", | 703 "description": "Should the match be case sensitive, ignored
for `IN_LIST` operator.", |
253 "type": "boolean" | 704 "type": "boolean" |
254 } | 705 }, |
255 }, | 706 "minComparisonValue": { |
256 "type": "object" | 707 "description": "Minimum comparison values for `BETWEEN` matc
h type.", |
257 }, | |
258 "OrderBy": { | |
259 "description": "Specifies the sorting options.", | |
260 "id": "OrderBy", | |
261 "properties": { | |
262 "orderType": { | |
263 "description": "The order type. The default orderType is `VA
LUE`.", | |
264 "enum": [ | |
265 "ORDER_TYPE_UNSPECIFIED", | |
266 "VALUE", | |
267 "DELTA", | |
268 "SMART", | |
269 "HISTOGRAM_BUCKET", | |
270 "DIMENSION_AS_INTEGER" | |
271 ], | |
272 "enumDescriptions": [ | |
273 "Unspecified order type will be treated as sort based on
value.", | |
274 "The sort order is based on the value of the chosen colu
mn; looks only at\nthe first date range.", | |
275 "The sort order is based on the difference of the values
of the chosen\ncolumn between the first two date ranges. Usable only if there
are\nexactly two date ranges.", | |
276 "The sort order is based on weighted value of the chosen
column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe
`(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios."
, | |
277 "Histogram order type is applicable only to dimension co
lumns with\nnon-empty histogram-buckets.", | |
278 "If the dimensions are fixed length numbers, ordinary so
rt would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions a
re\nvariable length numbers." | |
279 ], | |
280 "type": "string" | |
281 }, | |
282 "fieldName": { | |
283 "description": "The field which to sort by. The default sort
order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify on
e field for sort here. For example,\n`ga:browser, ga:city` is not valid.", | |
284 "type": "string" | |
285 }, | |
286 "sortOrder": { | |
287 "description": "The sorting order for the field.", | |
288 "enum": [ | |
289 "SORT_ORDER_UNSPECIFIED", | |
290 "ASCENDING", | |
291 "DESCENDING" | |
292 ], | |
293 "enumDescriptions": [ | |
294 "If the sort order is unspecified, the default is ascend
ing.", | |
295 "Ascending sort. The field will be sorted in an ascendin
g manner.", | |
296 "Descending sort. The field will be sorted in a descendi
ng manner." | |
297 ], | |
298 "type": "string" | |
299 } | |
300 }, | |
301 "type": "object" | |
302 }, | |
303 "Segment": { | |
304 "description": "The segment definition, if the report needs to be se
gmented.\nA Segment is a subset of the Analytics data. For example, of the entir
e\nset of users, one Segment might be users from a particular country or city.", | |
305 "id": "Segment", | |
306 "properties": { | |
307 "dynamicSegment": { | |
308 "$ref": "DynamicSegment", | |
309 "description": "A dynamic segment definition in the request.
" | |
310 }, | |
311 "segmentId": { | |
312 "description": "The segment ID of a built-in or custom segme
nt, for example `gaid::-3`.", | |
313 "type": "string" | 708 "type": "string" |
314 } | 709 } |
315 }, | 710 }, |
316 "type": "object" | 711 "type": "object" |
317 }, | 712 }, |
318 "SegmentSequenceStep": { | 713 "SegmentSequenceStep": { |
319 "description": "A segment sequence definition.", | 714 "description": "A segment sequence definition.", |
320 "id": "SegmentSequenceStep", | 715 "id": "SegmentSequenceStep", |
321 "properties": { | 716 "properties": { |
| 717 "orFiltersForSegment": { |
| 718 "description": "A sequence is specified with a list of Or gr
ouped filters which are\ncombined with `AND` operator.", |
| 719 "items": { |
| 720 "$ref": "OrFiltersForSegment" |
| 721 }, |
| 722 "type": "array" |
| 723 }, |
322 "matchType": { | 724 "matchType": { |
323 "description": "Specifies if the step immediately precedes o
r can be any time before the\nnext step.", | 725 "description": "Specifies if the step immediately precedes o
r can be any time before the\nnext step.", |
324 "enum": [ | 726 "enum": [ |
325 "UNSPECIFIED_MATCH_TYPE", | 727 "UNSPECIFIED_MATCH_TYPE", |
326 "PRECEDES", | 728 "PRECEDES", |
327 "IMMEDIATELY_PRECEDES" | 729 "IMMEDIATELY_PRECEDES" |
328 ], | 730 ], |
329 "enumDescriptions": [ | 731 "enumDescriptions": [ |
330 "Unspecified match type is treated as precedes.", | 732 "Unspecified match type is treated as precedes.", |
331 "Operator indicates that the previous step precedes the
next step.", | 733 "Operator indicates that the previous step precedes the
next step.", |
332 "Operator indicates that the previous step immediately p
recedes the next\nstep." | 734 "Operator indicates that the previous step immediately p
recedes the next\nstep." |
333 ], | 735 ], |
334 "type": "string" | 736 "type": "string" |
335 }, | |
336 "orFiltersForSegment": { | |
337 "description": "A sequence is specified with a list of Or gr
ouped filters which are\ncombined with `AND` operator.", | |
338 "items": { | |
339 "$ref": "OrFiltersForSegment" | |
340 }, | |
341 "type": "array" | |
342 } | 737 } |
343 }, | 738 }, |
344 "type": "object" | 739 "type": "object" |
345 }, | 740 }, |
346 "Metric": { | 741 "Metric": { |
347 "description": "[Metrics](https://support.google.com/analytics/answe
r/1033861)\nare the quantitative measurements. For example, the metric `ga:users
`\nindicates the total number of users for the requested time period.", | 742 "description": "[Metrics](https://support.google.com/analytics/answe
r/1033861)\nare the quantitative measurements. For example, the metric `ga:users
`\nindicates the total number of users for the requested time period.", |
348 "id": "Metric", | 743 "id": "Metric", |
349 "properties": { | 744 "properties": { |
350 "expression": { | 745 "expression": { |
351 "description": "A metric expression in the request. An expre
ssion is constructed from one\nor more metrics and numbers. Accepted operators i
nclude: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by
(*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is
limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases t
he\nmetric expression is just a single metric name like `ga:users`.\nAdding mixe
d `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpec
ted results.", | 746 "description": "A metric expression in the request. An expre
ssion is constructed from one\nor more metrics and numbers. Accepted operators i
nclude: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by
(*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is
limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases t
he\nmetric expression is just a single metric name like `ga:users`.\nAdding mixe
d `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpec
ted results.", |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
389 }, | 784 }, |
390 "type": "array" | 785 "type": "array" |
391 } | 786 } |
392 }, | 787 }, |
393 "type": "object" | 788 "type": "object" |
394 }, | 789 }, |
395 "Report": { | 790 "Report": { |
396 "description": "The data response corresponding to the request.", | 791 "description": "The data response corresponding to the request.", |
397 "id": "Report", | 792 "id": "Report", |
398 "properties": { | 793 "properties": { |
| 794 "nextPageToken": { |
| 795 "description": "Page token to retrieve the next page of resu
lts in the list.", |
| 796 "type": "string" |
| 797 }, |
| 798 "data": { |
| 799 "$ref": "ReportData", |
| 800 "description": "Response data." |
| 801 }, |
399 "columnHeader": { | 802 "columnHeader": { |
400 "$ref": "ColumnHeader", | 803 "$ref": "ColumnHeader", |
401 "description": "The column headers." | 804 "description": "The column headers." |
402 }, | |
403 "nextPageToken": { | |
404 "description": "Page token to retrieve the next page of resu
lts in the list.", | |
405 "type": "string" | |
406 }, | |
407 "data": { | |
408 "$ref": "ReportData", | |
409 "description": "Response data." | |
410 } | 805 } |
411 }, | 806 }, |
412 "type": "object" | 807 "type": "object" |
413 }, | 808 }, |
414 "PivotHeader": { | 809 "PivotHeader": { |
415 "description": "The headers for each of the pivot sections defined i
n the request.", | 810 "description": "The headers for each of the pivot sections defined i
n the request.", |
416 "id": "PivotHeader", | 811 "id": "PivotHeader", |
417 "properties": { | 812 "properties": { |
| 813 "pivotHeaderEntries": { |
| 814 "description": "A single pivot section header.", |
| 815 "items": { |
| 816 "$ref": "PivotHeaderEntry" |
| 817 }, |
| 818 "type": "array" |
| 819 }, |
418 "totalPivotGroupsCount": { | 820 "totalPivotGroupsCount": { |
419 "description": "The total number of groups for this pivot.", | 821 "description": "The total number of groups for this pivot.", |
420 "format": "int32", | 822 "format": "int32", |
421 "type": "integer" | 823 "type": "integer" |
422 }, | |
423 "pivotHeaderEntries": { | |
424 "description": "A single pivot section header.", | |
425 "items": { | |
426 "$ref": "PivotHeaderEntry" | |
427 }, | |
428 "type": "array" | |
429 } | 824 } |
430 }, | 825 }, |
431 "type": "object" | 826 "type": "object" |
432 }, | 827 }, |
433 "DateRange": { | 828 "DateRange": { |
434 "description": "A contiguous set of days: startDate, startDate + 1 d
ay, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://e
n.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.", | 829 "description": "A contiguous set of days: startDate, startDate + 1 d
ay, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://e
n.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.", |
435 "id": "DateRange", | 830 "id": "DateRange", |
436 "properties": { | 831 "properties": { |
| 832 "startDate": { |
| 833 "description": "The start date for the query in the format `
YYYY-MM-DD`.", |
| 834 "type": "string" |
| 835 }, |
437 "endDate": { | 836 "endDate": { |
438 "description": "The end date for the query in the format `YY
YY-MM-DD`.", | 837 "description": "The end date for the query in the format `YY
YY-MM-DD`.", |
439 "type": "string" | 838 "type": "string" |
440 }, | |
441 "startDate": { | |
442 "description": "The start date for the query in the format `
YYYY-MM-DD`.", | |
443 "type": "string" | |
444 } | 839 } |
445 }, | 840 }, |
446 "type": "object" | 841 "type": "object" |
447 }, | 842 }, |
448 "MetricFilter": { | 843 "MetricFilter": { |
449 "description": "MetricFilter specifies the filter on a metric.", | 844 "description": "MetricFilter specifies the filter on a metric.", |
450 "id": "MetricFilter", | 845 "id": "MetricFilter", |
451 "properties": { | 846 "properties": { |
452 "comparisonValue": { | 847 "comparisonValue": { |
453 "description": "The value to compare against.", | 848 "description": "The value to compare against.", |
(...skipping 25 matching lines...) Expand all Loading... |
479 "description": "The metric that will be filtered on. A metri
cFilter must contain a metric\nname. A metric name can be an alias earlier defin
ed as a metric or it can\nalso be a metric expression.", | 874 "description": "The metric that will be filtered on. A metri
cFilter must contain a metric\nname. A metric name can be an alias earlier defin
ed as a metric or it can\nalso be a metric expression.", |
480 "type": "string" | 875 "type": "string" |
481 } | 876 } |
482 }, | 877 }, |
483 "type": "object" | 878 "type": "object" |
484 }, | 879 }, |
485 "ReportRequest": { | 880 "ReportRequest": { |
486 "description": "The main request class which specifies the Reporting
API request.", | 881 "description": "The main request class which specifies the Reporting
API request.", |
487 "id": "ReportRequest", | 882 "id": "ReportRequest", |
488 "properties": { | 883 "properties": { |
| 884 "metricFilterClauses": { |
| 885 "description": "The metric filter clauses. They are logicall
y combined with the `AND`\noperator. Metric filters look at only the first date
range and not the\ncomparing date range. Note that filtering on metrics occurs
after the\nmetrics are aggregated.", |
| 886 "items": { |
| 887 "$ref": "MetricFilterClause" |
| 888 }, |
| 889 "type": "array" |
| 890 }, |
| 891 "pageSize": { |
| 892 "description": "Page size is for paging and specifies the ma
ximum number of returned rows.\nPage size should be >= 0. A query returns the de
fault of 1,000 rows.\nThe Analytics Core Reporting API returns a maximum of 10,0
00 rows per\nrequest, no matter how many you ask for. It can also return fewer r
ows\nthan requested, if there aren't as many dimension segments as you expect.\n
For instance, there are fewer than 300 possible values for `ga:country`,\nso whe
n segmenting only by country, you can't get more than 300 rows,\neven if you set
`pageSize` to a higher value.", |
| 893 "format": "int32", |
| 894 "type": "integer" |
| 895 }, |
| 896 "hideValueRanges": { |
| 897 "description": "If set to true, hides the minimum and maximu
m across all matching rows.\nThe default is false and the value ranges are retur
ned.", |
| 898 "type": "boolean" |
| 899 }, |
| 900 "hideTotals": { |
| 901 "description": "If set to true, hides the total of all metri
cs for all the matching rows,\nfor every date range. The default false and will
return the totals.", |
| 902 "type": "boolean" |
| 903 }, |
| 904 "cohortGroup": { |
| 905 "$ref": "CohortGroup", |
| 906 "description": "Cohort group associated with this request. I
f there is a cohort group\nin the request the `ga:cohort` dimension must be pres
ent.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncon
tain the same `cohortGroup` definition." |
| 907 }, |
| 908 "filtersExpression": { |
| 909 "description": "Dimension or metric filters that restrict th
e data returned for your\nrequest. To use the `filtersExpression`, supply a dime
nsion or metric on\nwhich to filter, followed by the filter expression. For exam
ple, the\nfollowing expression selects `ga:browser` dimension which starts with\
nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric
filters, see\n[Filters reference](https://developers.google.com/analytics/devgu
ides/reporting/core/v3/reference#filters).", |
| 910 "type": "string" |
| 911 }, |
| 912 "viewId": { |
| 913 "description": "The Analytics\n[view ID](https://support.goo
gle.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportReq
uest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`
.", |
| 914 "type": "string" |
| 915 }, |
489 "metrics": { | 916 "metrics": { |
490 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", | 917 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", |
491 "items": { | 918 "items": { |
492 "$ref": "Metric" | 919 "$ref": "Metric" |
493 }, | 920 }, |
494 "type": "array" | 921 "type": "array" |
495 }, | 922 }, |
496 "dimensionFilterClauses": { | 923 "dimensionFilterClauses": { |
497 "description": "The dimension filter clauses for filtering D
imension Values. They are\nlogically combined with the `AND` operator. Note that
filtering occurs\nbefore any dimensions are aggregated, so that the returned me
trics\nrepresent the total for only the relevant dimensions.", | 924 "description": "The dimension filter clauses for filtering D
imension Values. They are\nlogically combined with the `AND` operator. Note that
filtering occurs\nbefore any dimensions are aggregated, so that the returned me
trics\nrepresent the total for only the relevant dimensions.", |
498 "items": { | 925 "items": { |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
530 ], | 957 ], |
531 "type": "string" | 958 "type": "string" |
532 }, | 959 }, |
533 "dimensions": { | 960 "dimensions": { |
534 "description": "The dimensions requested.\nRequests can have
a total of 7 dimensions.", | 961 "description": "The dimensions requested.\nRequests can have
a total of 7 dimensions.", |
535 "items": { | 962 "items": { |
536 "$ref": "Dimension" | 963 "$ref": "Dimension" |
537 }, | 964 }, |
538 "type": "array" | 965 "type": "array" |
539 }, | 966 }, |
| 967 "pageToken": { |
| 968 "description": "A continuation token to get the next page of
the results. Adding this to\nthe request will return the rows after the pageTok
en. The pageToken should\nbe the value returned in the nextPageToken parameter i
n the response to\nthe GetReports request.", |
| 969 "type": "string" |
| 970 }, |
540 "dateRanges": { | 971 "dateRanges": { |
541 "description": "Date ranges in the request. The request can
have a maximum of 2 date\nranges. The response will contain a set of metric valu
es for each\ncombination of the dimensions for each date range in the request. S
o, if\nthere are two date ranges, there will be two set of metric values, one fo
r\nthe original date range and one for the second date range.\nThe `reportReques
t.dateRanges` field should not be specified for cohorts\nor Lifetime value reque
sts.\nIf a date range is not provided, the default date range is (startDate:\ncu
rrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#Rep
ortRequest) within a `batchGet` method must\ncontain the same `dateRanges` defin
ition.", | 972 "description": "Date ranges in the request. The request can
have a maximum of 2 date\nranges. The response will contain a set of metric valu
es for each\ncombination of the dimensions for each date range in the request. S
o, if\nthere are two date ranges, there will be two set of metric values, one fo
r\nthe original date range and one for the second date range.\nThe `reportReques
t.dateRanges` field should not be specified for cohorts\nor Lifetime value reque
sts.\nIf a date range is not provided, the default date range is (startDate:\ncu
rrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#Rep
ortRequest) within a `batchGet` method must\ncontain the same `dateRanges` defin
ition.", |
542 "items": { | 973 "items": { |
543 "$ref": "DateRange" | 974 "$ref": "DateRange" |
544 }, | 975 }, |
545 "type": "array" | 976 "type": "array" |
546 }, | 977 }, |
547 "pageToken": { | |
548 "description": "A continuation token to get the next page of
the results. Adding this to\nthe request will return the rows after the pageTok
en. The pageToken should\nbe the value returned in the nextPageToken parameter i
n the response to\nthe GetReports request.", | |
549 "type": "string" | |
550 }, | |
551 "pivots": { | 978 "pivots": { |
552 "description": "The pivot definitions. Requests can have a m
aximum of 2 pivots.", | 979 "description": "The pivot definitions. Requests can have a m
aximum of 2 pivots.", |
553 "items": { | 980 "items": { |
554 "$ref": "Pivot" | 981 "$ref": "Pivot" |
555 }, | 982 }, |
556 "type": "array" | 983 "type": "array" |
557 }, | 984 }, |
558 "includeEmptyRows": { | 985 "includeEmptyRows": { |
559 "description": "If set to false, the response does not inclu
de rows if all the retrieved\nmetrics are equal to zero. The default is false wh
ich will exclude these\nrows.", | 986 "description": "If set to false, the response does not inclu
de rows if all the retrieved\nmetrics are equal to zero. The default is false wh
ich will exclude these\nrows.", |
560 "type": "boolean" | 987 "type": "boolean" |
561 }, | |
562 "metricFilterClauses": { | |
563 "description": "The metric filter clauses. They are logicall
y combined with the `AND`\noperator. Metric filters look at only the first date
range and not the\ncomparing date range. Note that filtering on metrics occurs
after the\nmetrics are aggregated.", | |
564 "items": { | |
565 "$ref": "MetricFilterClause" | |
566 }, | |
567 "type": "array" | |
568 }, | |
569 "pageSize": { | |
570 "description": "Page size is for paging and specifies the ma
ximum number of returned rows.\nPage size should be >= 0. A query returns the de
fault of 1,000 rows.\nThe Analytics Core Reporting API returns a maximum of 10,0
00 rows per\nrequest, no matter how many you ask for. It can also return fewer r
ows\nthan requested, if there aren't as many dimension segments as you expect.\n
For instance, there are fewer than 300 possible values for `ga:country`,\nso whe
n segmenting only by country, you can't get more than 300 rows,\neven if you set
`pageSize` to a higher value.", | |
571 "format": "int32", | |
572 "type": "integer" | |
573 }, | |
574 "hideValueRanges": { | |
575 "description": "If set to true, hides the minimum and maximu
m across all matching rows.\nThe default is false and the value ranges are retur
ned.", | |
576 "type": "boolean" | |
577 }, | |
578 "hideTotals": { | |
579 "description": "If set to true, hides the total of all metri
cs for all the matching rows,\nfor every date range. The default false and will
return the totals.", | |
580 "type": "boolean" | |
581 }, | |
582 "filtersExpression": { | |
583 "description": "Dimension or metric filters that restrict th
e data returned for your\nrequest. To use the `filtersExpression`, supply a dime
nsion or metric on\nwhich to filter, followed by the filter expression. For exam
ple, the\nfollowing expression selects `ga:browser` dimension which starts with\
nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric
filters, see\n[Filters reference](https://developers.google.com/analytics/devgu
ides/reporting/core/v3/reference#filters).", | |
584 "type": "string" | |
585 }, | |
586 "cohortGroup": { | |
587 "$ref": "CohortGroup", | |
588 "description": "Cohort group associated with this request. I
f there is a cohort group\nin the request the `ga:cohort` dimension must be pres
ent.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncon
tain the same `cohortGroup` definition." | |
589 }, | |
590 "viewId": { | |
591 "description": "The Analytics\n[view ID](https://support.goo
gle.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportReq
uest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`
.", | |
592 "type": "string" | |
593 } | 988 } |
594 }, | 989 }, |
595 "type": "object" | 990 "type": "object" |
596 }, | 991 }, |
597 "Dimension": { | 992 "Dimension": { |
598 "description": "[Dimensions](https://support.google.com/analytics/an
swer/1033861)\nare attributes of your data. For example, the dimension `ga:city`
\nindicates the city, for example, \"Paris\" or \"New York\", from which\na sess
ion originates.", | 993 "description": "[Dimensions](https://support.google.com/analytics/an
swer/1033861)\nare attributes of your data. For example, the dimension `ga:city`
\nindicates the city, for example, \"Paris\" or \"New York\", from which\na sess
ion originates.", |
599 "id": "Dimension", | 994 "id": "Dimension", |
600 "properties": { | 995 "properties": { |
601 "histogramBuckets": { | 996 "histogramBuckets": { |
602 "description": "If non-empty, we place dimension values into
buckets after string to\nint64. Dimension values that are not the string repres
entation of an\nintegral value will be converted to zero. The bucket values hav
e to be in\nincreasing order. Each bucket is closed on the lower end, and open
on the\nupper end. The \"first\" bucket includes all values less than the first\
nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nva
lues that fall in a bucket get transformed to a new dimension value. For\nexampl
e, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing bucke
ts:\n\n- bucket #1: values < 0, dimension value \"<0\"\n- bucket #2: values in [
0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2
\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in
[4,7), dimension value \"4-6\"\n- bucket #6: values >= 7, dimension value \"7+\"
\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nth
at dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for
that purpose. Without that the dimension values\nwill be sorted according to di
ctionary\n(lexicographic) order. For example the ascending dictionary order is:\
n\n \"<50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGR
AM_BUCKET` order is:\n\n \"<50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe c
lient has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a his
togram-mutated dimension.", | 997 "description": "If non-empty, we place dimension values into
buckets after string to\nint64. Dimension values that are not the string repres
entation of an\nintegral value will be converted to zero. The bucket values hav
e to be in\nincreasing order. Each bucket is closed on the lower end, and open
on the\nupper end. The \"first\" bucket includes all values less than the first\
nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nva
lues that fall in a bucket get transformed to a new dimension value. For\nexampl
e, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing bucke
ts:\n\n- bucket #1: values < 0, dimension value \"<0\"\n- bucket #2: values in [
0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2
\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in
[4,7), dimension value \"4-6\"\n- bucket #6: values >= 7, dimension value \"7+\"
\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nth
at dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for
that purpose. Without that the dimension values\nwill be sorted according to di
ctionary\n(lexicographic) order. For example the ascending dictionary order is:\
n\n \"<50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGR
AM_BUCKET` order is:\n\n \"<50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe c
lient has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a his
togram-mutated dimension.", |
603 "items": { | 998 "items": { |
604 "format": "int64", | 999 "format": "int64", |
605 "type": "string" | 1000 "type": "string" |
606 }, | 1001 }, |
607 "type": "array" | 1002 "type": "array" |
608 }, | 1003 }, |
609 "name": { | 1004 "name": { |
610 "description": "Name of the dimension to fetch, for example
`ga:browser`.", | 1005 "description": "Name of the dimension to fetch, for example
`ga:browser`.", |
611 "type": "string" | 1006 "type": "string" |
612 } | 1007 } |
613 }, | 1008 }, |
614 "type": "object" | 1009 "type": "object" |
615 }, | 1010 }, |
| 1011 "DynamicSegment": { |
| 1012 "description": "Dynamic segment definition for defining the segment
within the request.\nA segment can select users, sessions or both.", |
| 1013 "id": "DynamicSegment", |
| 1014 "properties": { |
| 1015 "userSegment": { |
| 1016 "$ref": "SegmentDefinition", |
| 1017 "description": "User Segment to select users to include in t
he segment." |
| 1018 }, |
| 1019 "sessionSegment": { |
| 1020 "$ref": "SegmentDefinition", |
| 1021 "description": "Session Segment to select sessions to includ
e in the segment." |
| 1022 }, |
| 1023 "name": { |
| 1024 "description": "The name of the dynamic segment.", |
| 1025 "type": "string" |
| 1026 } |
| 1027 }, |
| 1028 "type": "object" |
| 1029 }, |
616 "SimpleSegment": { | 1030 "SimpleSegment": { |
617 "description": "A Simple segment conditions consist of one or more d
imension/metric\nconditions that can be combined.", | 1031 "description": "A Simple segment conditions consist of one or more d
imension/metric\nconditions that can be combined.", |
618 "id": "SimpleSegment", | 1032 "id": "SimpleSegment", |
619 "properties": { | 1033 "properties": { |
620 "orFiltersForSegment": { | 1034 "orFiltersForSegment": { |
621 "description": "A list of segment filters groups which are c
ombined with logical `AND`\noperator.", | 1035 "description": "A list of segment filters groups which are c
ombined with logical `AND`\noperator.", |
622 "items": { | 1036 "items": { |
623 "$ref": "OrFiltersForSegment" | 1037 "$ref": "OrFiltersForSegment" |
624 }, | 1038 }, |
625 "type": "array" | 1039 "type": "array" |
626 } | 1040 } |
627 }, | 1041 }, |
628 "type": "object" | 1042 "type": "object" |
629 }, | 1043 }, |
630 "DynamicSegment": { | |
631 "description": "Dynamic segment definition for defining the segment
within the request.\nA segment can select users, sessions or both.", | |
632 "id": "DynamicSegment", | |
633 "properties": { | |
634 "userSegment": { | |
635 "$ref": "SegmentDefinition", | |
636 "description": "User Segment to select users to include in t
he segment." | |
637 }, | |
638 "sessionSegment": { | |
639 "$ref": "SegmentDefinition", | |
640 "description": "Session Segment to select sessions to includ
e in the segment." | |
641 }, | |
642 "name": { | |
643 "description": "The name of the dynamic segment.", | |
644 "type": "string" | |
645 } | |
646 }, | |
647 "type": "object" | |
648 }, | |
649 "ColumnHeader": { | 1044 "ColumnHeader": { |
650 "description": "Column headers.", | 1045 "description": "Column headers.", |
651 "id": "ColumnHeader", | 1046 "id": "ColumnHeader", |
652 "properties": { | 1047 "properties": { |
653 "dimensions": { | |
654 "description": "The dimension names in the response.", | |
655 "items": { | |
656 "type": "string" | |
657 }, | |
658 "type": "array" | |
659 }, | |
660 "metricHeader": { | 1048 "metricHeader": { |
661 "$ref": "MetricHeader", | 1049 "$ref": "MetricHeader", |
662 "description": "Metric headers for the metrics in the respon
se." | 1050 "description": "Metric headers for the metrics in the respon
se." |
663 } | |
664 }, | |
665 "type": "object" | |
666 }, | |
667 "SegmentFilterClause": { | |
668 "description": "Filter Clause to be used in a segment definition, ca
n be wither a metric or\na dimension filter.", | |
669 "id": "SegmentFilterClause", | |
670 "properties": { | |
671 "not": { | |
672 "description": "Matches the complement (`!`) of the filter."
, | |
673 "type": "boolean" | |
674 }, | |
675 "dimensionFilter": { | |
676 "$ref": "SegmentDimensionFilter", | |
677 "description": "Dimension Filter for the segment definition.
" | |
678 }, | |
679 "metricFilter": { | |
680 "$ref": "SegmentMetricFilter", | |
681 "description": "Metric Filter for the segment definition." | |
682 } | |
683 }, | |
684 "type": "object" | |
685 }, | |
686 "ReportRow": { | |
687 "description": "A row in the report.", | |
688 "id": "ReportRow", | |
689 "properties": { | |
690 "metrics": { | |
691 "description": "List of metrics for each requested DateRange
.", | |
692 "items": { | |
693 "$ref": "DateRangeValues" | |
694 }, | |
695 "type": "array" | |
696 }, | 1051 }, |
697 "dimensions": { | 1052 "dimensions": { |
698 "description": "List of requested dimensions.", | 1053 "description": "The dimension names in the response.", |
699 "items": { | 1054 "items": { |
700 "type": "string" | 1055 "type": "string" |
701 }, | 1056 }, |
702 "type": "array" | |
703 } | |
704 }, | |
705 "type": "object" | |
706 }, | |
707 "Cohort": { | |
708 "description": "Defines a cohort. A cohort is a group of users who s
hare a common\ncharacteristic. For example, all users with the same acquisition
date\nbelong to the same cohort.", | |
709 "id": "Cohort", | |
710 "properties": { | |
711 "type": { | |
712 "description": "Type of the cohort. The only supported type
as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is tre
ated\nas `FIRST_VISIT_DATE` type cohort.", | |
713 "enum": [ | |
714 "UNSPECIFIED_COHORT_TYPE", | |
715 "FIRST_VISIT_DATE" | |
716 ], | |
717 "enumDescriptions": [ | |
718 "If unspecified it's treated as `FIRST_VISIT_DATE`.", | |
719 "Cohorts that are selected based on first visit date." | |
720 ], | |
721 "type": "string" | |
722 }, | |
723 "dateRange": { | |
724 "$ref": "DateRange", | |
725 "description": "This is used for `FIRST_VISIT_DATE` cohort,
the cohort selects users\nwhose first visit date is between start date and end d
ate defined in the\nDateRange. The date ranges should be aligned for cohort requ
ests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day lo
ng,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\n
at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshou
ld be aligned to the month (starting at the first and ending on the\nlast day of
the month).\nFor LTV requests there are no such restrictions.\nYou do not need
to supply a date range for the\n`reportsRequest.dateRanges` field." | |
726 }, | |
727 "name": { | |
728 "description": "A unique name for the cohort. If not defined
name will be auto-generated\nwith values cohort_[1234...].", | |
729 "type": "string" | |
730 } | |
731 }, | |
732 "type": "object" | |
733 }, | |
734 "MetricFilterClause": { | |
735 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", | |
736 "id": "MetricFilterClause", | |
737 "properties": { | |
738 "filters": { | |
739 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", | |
740 "items": { | |
741 "$ref": "MetricFilter" | |
742 }, | |
743 "type": "array" | |
744 }, | |
745 "operator": { | |
746 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", | |
747 "enum": [ | |
748 "OPERATOR_UNSPECIFIED", | |
749 "OR", | |
750 "AND" | |
751 ], | |
752 "enumDescriptions": [ | |
753 "Unspecified operator. It is treated as an `OR`.", | |
754 "The logical `OR` operator.", | |
755 "The logical `AND` operator." | |
756 ], | |
757 "type": "string" | |
758 } | |
759 }, | |
760 "type": "object" | |
761 }, | |
762 "OrFiltersForSegment": { | |
763 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", | |
764 "id": "OrFiltersForSegment", | |
765 "properties": { | |
766 "segmentFilterClauses": { | |
767 "description": "List of segment filters to be combined with
a `OR` operator.", | |
768 "items": { | |
769 "$ref": "SegmentFilterClause" | |
770 }, | |
771 "type": "array" | |
772 } | |
773 }, | |
774 "type": "object" | |
775 }, | |
776 "MetricHeader": { | |
777 "description": "The headers for the metrics.", | |
778 "id": "MetricHeader", | |
779 "properties": { | |
780 "pivotHeaders": { | |
781 "description": "Headers for the pivots in the response.", | |
782 "items": { | |
783 "$ref": "PivotHeader" | |
784 }, | |
785 "type": "array" | |
786 }, | |
787 "metricHeaderEntries": { | |
788 "description": "Headers for the metrics in the response.", | |
789 "items": { | |
790 "$ref": "MetricHeaderEntry" | |
791 }, | |
792 "type": "array" | |
793 } | |
794 }, | |
795 "type": "object" | |
796 }, | |
797 "DimensionFilterClause": { | |
798 "description": "A group of dimension filters. Set the operator value
to specify how\nthe filters are logically combined.", | |
799 "id": "DimensionFilterClause", | |
800 "properties": { | |
801 "filters": { | |
802 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", | |
803 "items": { | |
804 "$ref": "DimensionFilter" | |
805 }, | |
806 "type": "array" | |
807 }, | |
808 "operator": { | |
809 "description": "The operator for combining multiple dimensio
n filters. If unspecified, it\nis treated as an `OR`.", | |
810 "enum": [ | |
811 "OPERATOR_UNSPECIFIED", | |
812 "OR", | |
813 "AND" | |
814 ], | |
815 "enumDescriptions": [ | |
816 "Unspecified operator. It is treated as an `OR`.", | |
817 "The logical `OR` operator.", | |
818 "The logical `AND` operator." | |
819 ], | |
820 "type": "string" | |
821 } | |
822 }, | |
823 "type": "object" | |
824 }, | |
825 "GetReportsResponse": { | |
826 "description": "The main response class which holds the reports from
the Reporting API\n`batchGet` call.", | |
827 "id": "GetReportsResponse", | |
828 "properties": { | |
829 "reports": { | |
830 "description": "Responses corresponding to each of the reque
st.", | |
831 "items": { | |
832 "$ref": "Report" | |
833 }, | |
834 "type": "array" | |
835 } | |
836 }, | |
837 "type": "object" | |
838 }, | |
839 "SequenceSegment": { | |
840 "description": "Sequence conditions consist of one or more steps, wh
ere each step is defined\nby one or more dimension/metric conditions. Multiple s
teps can be combined\nwith special sequence operators.", | |
841 "id": "SequenceSegment", | |
842 "properties": { | |
843 "segmentSequenceSteps": { | |
844 "description": "The list of steps in the sequence.", | |
845 "items": { | |
846 "$ref": "SegmentSequenceStep" | |
847 }, | |
848 "type": "array" | |
849 }, | |
850 "firstStepShouldMatchFirstHit": { | |
851 "description": "If set, first step condition must match the
first hit of the visitor (in\nthe date range).", | |
852 "type": "boolean" | |
853 } | |
854 }, | |
855 "type": "object" | |
856 }, | |
857 "SegmentMetricFilter": { | |
858 "description": "Metric filter to be used in a segment filter clause.
", | |
859 "id": "SegmentMetricFilter", | |
860 "properties": { | |
861 "maxComparisonValue": { | |
862 "description": "Max comparison value is only used for `BETWE
EN` operator.", | |
863 "type": "string" | |
864 }, | |
865 "comparisonValue": { | |
866 "description": "The value to compare against. If the operato
r is `BETWEEN`, this value is\ntreated as minimum comparison value.", | |
867 "type": "string" | |
868 }, | |
869 "operator": { | |
870 "description": "Specifies is the operation to perform to com
pare the metric. The default\nis `EQUAL`.", | |
871 "enum": [ | |
872 "UNSPECIFIED_OPERATOR", | |
873 "LESS_THAN", | |
874 "GREATER_THAN", | |
875 "EQUAL", | |
876 "BETWEEN" | |
877 ], | |
878 "enumDescriptions": [ | |
879 "Unspecified operator is treated as `LESS_THAN` operator
.", | |
880 "Checks if the metric value is less than comparison valu
e.", | |
881 "Checks if the metric value is greater than comparison v
alue.", | |
882 "Equals operator.", | |
883 "For between operator, both the minimum and maximum are
exclusive.\nWe will use `LT` and `GT` for comparison." | |
884 ], | |
885 "type": "string" | |
886 }, | |
887 "metricName": { | |
888 "description": "The metric that will be filtered on. A `metr
icFilter` must contain a\nmetric name.", | |
889 "type": "string" | |
890 }, | |
891 "scope": { | |
892 "description": "Scope for a metric defines the level at whic
h that metric is defined. The\nspecified metric scope must be equal to or great
er than its primary scope\nas defined in the data model. The primary scope is de
fined by if the\nsegment is selecting users or sessions.", | |
893 "enum": [ | |
894 "UNSPECIFIED_SCOPE", | |
895 "PRODUCT", | |
896 "HIT", | |
897 "SESSION", | |
898 "USER" | |
899 ], | |
900 "enumDescriptions": [ | |
901 "If the scope is unspecified, it defaults to the conditi
on scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\n
users or sessions.", | |
902 "Product scope.", | |
903 "Hit scope.", | |
904 "Session scope.", | |
905 "User scope." | |
906 ], | |
907 "type": "string" | |
908 } | |
909 }, | |
910 "type": "object" | |
911 }, | |
912 "DateRangeValues": { | |
913 "description": "Used to return a list of metrics for a single DateRa
nge / dimension\ncombination", | |
914 "id": "DateRangeValues", | |
915 "properties": { | |
916 "values": { | |
917 "description": "Each value corresponds to each Metric in the
request.", | |
918 "items": { | |
919 "type": "string" | |
920 }, | |
921 "type": "array" | |
922 }, | |
923 "pivotValueRegions": { | |
924 "description": "The values of each pivot region.", | |
925 "items": { | |
926 "$ref": "PivotValueRegion" | |
927 }, | |
928 "type": "array" | |
929 } | |
930 }, | |
931 "type": "object" | |
932 }, | |
933 "CohortGroup": { | |
934 "description": "Defines a cohort group.\nFor example:\n\n \"cohor
tGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"t
ype\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-
01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n
\"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\"
: \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }", | |
935 "id": "CohortGroup", | |
936 "properties": { | |
937 "cohorts": { | |
938 "description": "The definition for the cohort.", | |
939 "items": { | |
940 "$ref": "Cohort" | |
941 }, | |
942 "type": "array" | |
943 }, | |
944 "lifetimeValue": { | |
945 "description": "Enable Life Time Value (LTV). LTV measures
lifetime value for users\nacquired through different channels.\nPlease see:\n[Co
hort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifeti
me Value](https://support.google.com/analytics/answer/6182550)\nIf the value of
lifetimeValue is false:\n\n- The metric values are similar to the values in the
web interface cohort\n report.\n- The cohort definition date ranges must be ali
gned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek`
the `startDate` in\n the cohort definition should be a Sunday and the `endDate
` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDa
te`\n should be the 1st of the month and `endDate` should be the last day\n of
the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will corre
spond to the values in the web interface\n LifeTime value report.\n- The Lifeti
me Value report shows you how user value (Revenue) and\n engagement (Appviews,
Goal Completions, Sessions, and Session Duration)\n grow during the 90 days aft
er a user is acquired.\n- The metrics are calculated as a cumulative average per
user per the time\n increment.\n- The cohort definition date ranges need not b
e aligned to the calendar\n week and month boundaries.\n- The `viewId` must be
an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersu
sAppViews)", | |
946 "type": "boolean" | |
947 } | |
948 }, | |
949 "type": "object" | |
950 }, | |
951 "GetReportsRequest": { | |
952 "description": "The batch request containing multiple report request
.", | |
953 "id": "GetReportsRequest", | |
954 "properties": { | |
955 "reportRequests": { | |
956 "description": "Requests, each request will have a separate
response.\nThere can be a maximum of 5 requests. All requests should have the sa
me\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.", | |
957 "items": { | |
958 "$ref": "ReportRequest" | |
959 }, | |
960 "type": "array" | |
961 } | |
962 }, | |
963 "type": "object" | |
964 }, | |
965 "Pivot": { | |
966 "description": "The Pivot describes the pivot section in the request
.\nThe Pivot helps rearrange the information in the table for certain reports\nb
y pivoting your data on a second dimension.", | |
967 "id": "Pivot", | |
968 "properties": { | |
969 "maxGroupCount": { | |
970 "description": "Specifies the maximum number of groups to re
turn.\nThe default value is 10, also the maximum value is 1,000.", | |
971 "format": "int32", | |
972 "type": "integer" | |
973 }, | |
974 "startGroup": { | |
975 "description": "If k metrics were requested, then the respon
se will contain some\ndata-dependent multiple of k columns in the report. E.g.,
if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Fi
refox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of t
he groups\nof columns is determined by descending order of \"total\" for the fir
st of\nthe k values. Ties are broken by lexicographic ordering of the first\npi
vot dimension, then lexicographic ordering of the second pivot\ndimension, and s
o on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were
8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nT
he following let you choose which of the groups of k columns are\nincluded in th
e response.", | |
976 "format": "int32", | |
977 "type": "integer" | |
978 }, | |
979 "metrics": { | |
980 "description": "The pivot metrics. Pivot metrics are part of
the\nrestriction on total number of metrics allowed in the request.", | |
981 "items": { | |
982 "$ref": "Metric" | |
983 }, | |
984 "type": "array" | |
985 }, | |
986 "dimensionFilterClauses": { | |
987 "description": "DimensionFilterClauses are logically combine
d with an `AND` operator: only\ndata that is included by all these DimensionFilt
erClauses contributes to\nthe values in this pivot region. Dimension filters can
be used to restrict\nthe columns shown in the pivot region. For example if you
have\n`ga:browser` as the requested dimension in the pivot region, and you\nspec
ify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen on
ly those two browsers would show up as columns.", | |
988 "items": { | |
989 "$ref": "DimensionFilterClause" | |
990 }, | |
991 "type": "array" | |
992 }, | |
993 "dimensions": { | |
994 "description": "A list of dimensions to show as pivot column
s. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the
restriction on the\ntotal number of dimensions allowed in the request.", | |
995 "items": { | |
996 "$ref": "Dimension" | |
997 }, | |
998 "type": "array" | |
999 } | |
1000 }, | |
1001 "type": "object" | |
1002 }, | |
1003 "PivotHeaderEntry": { | |
1004 "description": "The headers for the each of the metric column corres
ponding to the metrics\nrequested in the pivots section of the response.", | |
1005 "id": "PivotHeaderEntry", | |
1006 "properties": { | |
1007 "dimensionValues": { | |
1008 "description": "The values for the dimensions in the pivot."
, | |
1009 "items": { | |
1010 "type": "string" | |
1011 }, | |
1012 "type": "array" | |
1013 }, | |
1014 "metric": { | |
1015 "$ref": "MetricHeaderEntry", | |
1016 "description": "The metric header for the metric in the pivo
t." | |
1017 }, | |
1018 "dimensionNames": { | |
1019 "description": "The name of the dimensions in the pivot resp
onse.", | |
1020 "items": { | |
1021 "type": "string" | |
1022 }, | |
1023 "type": "array" | 1057 "type": "array" |
1024 } | 1058 } |
1025 }, | 1059 }, |
1026 "type": "object" | 1060 "type": "object" |
1027 }, | 1061 }, |
1028 "SegmentFilter": { | 1062 "SegmentFilterClause": { |
1029 "description": "SegmentFilter defines the segment to be either a sim
ple or a sequence\nsegment. A simple segment condition contains dimension and me
tric conditions\nto select the sessions or users. A sequence segment condition c
an be used to\nselect users or sessions based on sequential conditions.", | 1063 "description": "Filter Clause to be used in a segment definition, ca
n be wither a metric or\na dimension filter.", |
1030 "id": "SegmentFilter", | 1064 "id": "SegmentFilterClause", |
1031 "properties": { | 1065 "properties": { |
| 1066 "metricFilter": { |
| 1067 "$ref": "SegmentMetricFilter", |
| 1068 "description": "Metric Filter for the segment definition." |
| 1069 }, |
1032 "not": { | 1070 "not": { |
1033 "description": "If true, match the complement of simple or s
equence segment.\nFor example, to match all visits not from \"New York\", we can
define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segme
ntFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegme
nt\": [{\n \"segmentFilterClauses\":[{\n \"dimension
Filter\": {\n \"dimensionName\": \"ga:city\",\n
\"expressions\": [\"New York\"]\n }\n }]\n
}]\n },\n \"not\": \"True\"\n }]\n },", | 1071 "description": "Matches the complement (`!`) of the filter."
, |
1034 "type": "boolean" | 1072 "type": "boolean" |
1035 }, | 1073 }, |
1036 "simpleSegment": { | 1074 "dimensionFilter": { |
1037 "$ref": "SimpleSegment", | 1075 "$ref": "SegmentDimensionFilter", |
1038 "description": "A Simple segment conditions consist of one o
r more dimension/metric\nconditions that can be combined" | 1076 "description": "Dimension Filter for the segment definition.
" |
1039 }, | |
1040 "sequenceSegment": { | |
1041 "$ref": "SequenceSegment", | |
1042 "description": "Sequence conditions consist of one or more s
teps, where each step is\ndefined by one or more dimension/metric conditions. Mu
ltiple steps can\nbe combined with special sequence operators." | |
1043 } | 1077 } |
1044 }, | 1078 }, |
1045 "type": "object" | 1079 "type": "object" |
1046 }, | 1080 }, |
1047 "SegmentDefinition": { | 1081 "MetricFilterClause": { |
1048 "description": "SegmentDefinition defines the segment to be a set of
SegmentFilters which\nare combined together with a logical `AND` operation.", | 1082 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", |
1049 "id": "SegmentDefinition", | 1083 "id": "MetricFilterClause", |
1050 "properties": { | 1084 "properties": { |
1051 "segmentFilters": { | 1085 "filters": { |
1052 "description": "A segment is defined by a set of segment fil
ters which are combined\ntogether with a logical `AND` operation.", | 1086 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", |
1053 "items": { | 1087 "items": { |
1054 "$ref": "SegmentFilter" | 1088 "$ref": "MetricFilter" |
1055 }, | 1089 }, |
1056 "type": "array" | 1090 "type": "array" |
1057 } | |
1058 }, | |
1059 "type": "object" | |
1060 }, | |
1061 "MetricHeaderEntry": { | |
1062 "description": "Header for the metrics.", | |
1063 "id": "MetricHeaderEntry", | |
1064 "properties": { | |
1065 "name": { | |
1066 "description": "The name of the header.", | |
1067 "type": "string" | |
1068 }, | 1091 }, |
1069 "type": { | 1092 "operator": { |
1070 "description": "The type of the metric, for example `INTEGER
`.", | 1093 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", |
1071 "enum": [ | 1094 "enum": [ |
1072 "METRIC_TYPE_UNSPECIFIED", | 1095 "OPERATOR_UNSPECIFIED", |
1073 "INTEGER", | 1096 "OR", |
1074 "FLOAT", | 1097 "AND" |
1075 "CURRENCY", | |
1076 "PERCENT", | |
1077 "TIME" | |
1078 ], | 1098 ], |
1079 "enumDescriptions": [ | 1099 "enumDescriptions": [ |
1080 "Metric type is unspecified.", | 1100 "Unspecified operator. It is treated as an `OR`.", |
1081 "Integer metric.", | 1101 "The logical `OR` operator.", |
1082 "Float metric.", | 1102 "The logical `AND` operator." |
1083 "Currency metric.", | |
1084 "Percentage metric.", | |
1085 "Time metric in `HH:MM:SS` format." | |
1086 ], | 1103 ], |
1087 "type": "string" | 1104 "type": "string" |
1088 } | 1105 } |
1089 }, | 1106 }, |
1090 "type": "object" | 1107 "type": "object" |
1091 }, | 1108 }, |
1092 "ReportData": { | 1109 "Cohort": { |
1093 "description": "The data part of the report.", | 1110 "description": "Defines a cohort. A cohort is a group of users who s
hare a common\ncharacteristic. For example, all users with the same acquisition
date\nbelong to the same cohort.", |
1094 "id": "ReportData", | 1111 "id": "Cohort", |
1095 "properties": { | 1112 "properties": { |
1096 "isDataGolden": { | 1113 "type": { |
1097 "description": "Indicates if response to this request is gol
den or not. Data is\ngolden when the exact same request will not produce any new
results if\nasked at a later point in time.", | 1114 "description": "Type of the cohort. The only supported type
as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is tre
ated\nas `FIRST_VISIT_DATE` type cohort.", |
1098 "type": "boolean" | 1115 "enum": [ |
1099 }, | 1116 "UNSPECIFIED_COHORT_TYPE", |
1100 "rows": { | 1117 "FIRST_VISIT_DATE" |
1101 "description": "There's one ReportRow for every unique combi
nation of dimensions.", | 1118 ], |
1102 "items": { | 1119 "enumDescriptions": [ |
1103 "$ref": "ReportRow" | 1120 "If unspecified it's treated as `FIRST_VISIT_DATE`.", |
1104 }, | 1121 "Cohorts that are selected based on first visit date." |
1105 "type": "array" | 1122 ], |
1106 }, | |
1107 "rowCount": { | |
1108 "description": "Total number of matching rows for this query
.", | |
1109 "format": "int32", | |
1110 "type": "integer" | |
1111 }, | |
1112 "dataLastRefreshed": { | |
1113 "description": "The last time the data in the report was ref
reshed. All the hits received\nbefore this timestamp are included in the calcula
tion of the report.", | |
1114 "format": "google-datetime", | |
1115 "type": "string" | 1123 "type": "string" |
1116 }, | 1124 }, |
1117 "maximums": { | 1125 "dateRange": { |
1118 "description": "Minimum and maximum values seen over all mat
ching rows. These are both\nempty when `hideValueRanges` in the request is false
, or when\nrowCount is zero.", | 1126 "$ref": "DateRange", |
| 1127 "description": "This is used for `FIRST_VISIT_DATE` cohort,
the cohort selects users\nwhose first visit date is between start date and end d
ate defined in the\nDateRange. The date ranges should be aligned for cohort requ
ests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day lo
ng,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\n
at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshou
ld be aligned to the month (starting at the first and ending on the\nlast day of
the month).\nFor LTV requests there are no such restrictions.\nYou do not need
to supply a date range for the\n`reportsRequest.dateRanges` field." |
| 1128 }, |
| 1129 "name": { |
| 1130 "description": "A unique name for the cohort. If not defined
name will be auto-generated\nwith values cohort_[1234...].", |
| 1131 "type": "string" |
| 1132 } |
| 1133 }, |
| 1134 "type": "object" |
| 1135 }, |
| 1136 "ReportRow": { |
| 1137 "description": "A row in the report.", |
| 1138 "id": "ReportRow", |
| 1139 "properties": { |
| 1140 "metrics": { |
| 1141 "description": "List of metrics for each requested DateRange
.", |
1119 "items": { | 1142 "items": { |
1120 "$ref": "DateRangeValues" | 1143 "$ref": "DateRangeValues" |
1121 }, | 1144 }, |
1122 "type": "array" | 1145 "type": "array" |
1123 }, | 1146 }, |
1124 "samplingSpaceSizes": { | 1147 "dimensions": { |
1125 "description": "If the results are\n[sampled](https://suppor
t.google.com/analytics/answer/2637192),\nthis returns the total number of\nsampl
es present, one entry per date range. If the results are not sampled\nthis field
will not be defined. See\n[developer guide](/analytics/devguides/reporting/core
/v4/basics#sampling)\nfor details.", | 1148 "description": "List of requested dimensions.", |
1126 "items": { | 1149 "items": { |
1127 "format": "int64", | |
1128 "type": "string" | 1150 "type": "string" |
1129 }, | 1151 }, |
1130 "type": "array" | 1152 "type": "array" |
1131 }, | |
1132 "minimums": { | |
1133 "description": "Minimum and maximum values seen over all mat
ching rows. These are both\nempty when `hideValueRanges` in the request is false
, or when\nrowCount is zero.", | |
1134 "items": { | |
1135 "$ref": "DateRangeValues" | |
1136 }, | |
1137 "type": "array" | |
1138 }, | |
1139 "totals": { | |
1140 "description": "For each requested date range, for the set o
f all rows that match\nthe query, every requested value format gets a total. The
total\nfor a value format is computed by first totaling the metrics\nmentioned
in the value format and then evaluating the value\nformat as a scalar expression
. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of a
ll relevant ga:sessions) + 2)`.\nTotals are computed before pagination.", | |
1141 "items": { | |
1142 "$ref": "DateRangeValues" | |
1143 }, | |
1144 "type": "array" | |
1145 }, | |
1146 "samplesReadCounts": { | |
1147 "description": "If the results are\n[sampled](https://suppor
t.google.com/analytics/answer/2637192),\nthis returns the total number of sample
s read, one entry per date range.\nIf the results are not sampled this field wil
l not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/
basics#sampling)\nfor details.", | |
1148 "items": { | |
1149 "format": "int64", | |
1150 "type": "string" | |
1151 }, | |
1152 "type": "array" | |
1153 } | 1153 } |
1154 }, | 1154 }, |
1155 "type": "object" | 1155 "type": "object" |
1156 } | 1156 } |
1157 }, | 1157 }, |
1158 "servicePath": "", | 1158 "servicePath": "", |
1159 "title": "Google Analytics Reporting API", | 1159 "title": "Google Analytics Reporting API", |
1160 "version": "v4" | 1160 "version": "v4" |
1161 } | 1161 } |
OLD | NEW |