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 "access_token": { |
| 32 "description": "OAuth access token.", |
| 33 "location": "query", |
| 34 "type": "string" |
| 35 }, |
| 36 "key": { |
| 37 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 38 "location": "query", |
| 39 "type": "string" |
| 40 }, |
| 41 "quotaUser": { |
| 42 "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.", |
| 43 "location": "query", |
| 44 "type": "string" |
| 45 }, |
| 46 "pp": { |
| 47 "default": "true", |
| 48 "description": "Pretty-print response.", |
| 49 "location": "query", |
| 50 "type": "boolean" |
| 51 }, |
| 52 "bearer_token": { |
| 53 "description": "OAuth bearer token.", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
| 57 "oauth_token": { |
| 58 "description": "OAuth 2.0 token for the current user.", |
| 59 "location": "query", |
| 60 "type": "string" |
| 61 }, |
31 "upload_protocol": { | 62 "upload_protocol": { |
32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 64 "location": "query", |
34 "type": "string" | 65 "type": "string" |
35 }, | 66 }, |
36 "prettyPrint": { | 67 "prettyPrint": { |
37 "default": "true", | 68 "default": "true", |
38 "description": "Returns response with indentations and line breaks."
, | 69 "description": "Returns response with indentations and line breaks."
, |
39 "location": "query", | 70 "location": "query", |
40 "type": "boolean" | 71 "type": "boolean" |
41 }, | 72 }, |
| 73 "uploadType": { |
| 74 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 75 "location": "query", |
| 76 "type": "string" |
| 77 }, |
42 "fields": { | 78 "fields": { |
43 "description": "Selector specifying which fields to include in a par
tial response.", | 79 "description": "Selector specifying which fields to include in a par
tial response.", |
44 "location": "query", | 80 "location": "query", |
45 "type": "string" | 81 "type": "string" |
46 }, | 82 }, |
47 "uploadType": { | |
48 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
49 "location": "query", | |
50 "type": "string" | |
51 }, | |
52 "$.xgafv": { | 83 "$.xgafv": { |
53 "description": "V1 error format.", | 84 "description": "V1 error format.", |
54 "enum": [ | 85 "enum": [ |
55 "1", | 86 "1", |
56 "2" | 87 "2" |
57 ], | 88 ], |
58 "enumDescriptions": [ | 89 "enumDescriptions": [ |
59 "v1 error format", | 90 "v1 error format", |
60 "v2 error format" | 91 "v2 error format" |
61 ], | 92 ], |
(...skipping 13 matching lines...) Expand all Loading... |
75 "media", | 106 "media", |
76 "proto" | 107 "proto" |
77 ], | 108 ], |
78 "enumDescriptions": [ | 109 "enumDescriptions": [ |
79 "Responses with Content-Type of application/json", | 110 "Responses with Content-Type of application/json", |
80 "Media download with context-dependent Content-Type", | 111 "Media download with context-dependent Content-Type", |
81 "Responses with Content-Type of application/x-protobuf" | 112 "Responses with Content-Type of application/x-protobuf" |
82 ], | 113 ], |
83 "location": "query", | 114 "location": "query", |
84 "type": "string" | 115 "type": "string" |
85 }, | |
86 "access_token": { | |
87 "description": "OAuth access token.", | |
88 "location": "query", | |
89 "type": "string" | |
90 }, | |
91 "key": { | |
92 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
93 "location": "query", | |
94 "type": "string" | |
95 }, | |
96 "quotaUser": { | |
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.", | |
98 "location": "query", | |
99 "type": "string" | |
100 }, | |
101 "pp": { | |
102 "default": "true", | |
103 "description": "Pretty-print response.", | |
104 "location": "query", | |
105 "type": "boolean" | |
106 }, | |
107 "bearer_token": { | |
108 "description": "OAuth bearer token.", | |
109 "location": "query", | |
110 "type": "string" | |
111 }, | |
112 "oauth_token": { | |
113 "description": "OAuth 2.0 token for the current user.", | |
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 "PivotHeaderEntry": { | |
147 "description": "The headers for the each of the metric column corres
ponding to the metrics\nrequested in the pivots section of the response.", | |
148 "id": "PivotHeaderEntry", | |
149 "properties": { | |
150 "dimensionValues": { | |
151 "description": "The values for the dimensions in the pivot."
, | |
152 "items": { | |
153 "type": "string" | |
154 }, | |
155 "type": "array" | |
156 }, | |
157 "metric": { | |
158 "$ref": "MetricHeaderEntry", | |
159 "description": "The metric header for the metric in the pivo
t." | |
160 }, | |
161 "dimensionNames": { | |
162 "description": "The name of the dimensions in the pivot resp
onse.", | |
163 "items": { | |
164 "type": "string" | |
165 }, | |
166 "type": "array" | |
167 } | |
168 }, | |
169 "type": "object" | |
170 }, | |
171 "SegmentFilter": { | |
172 "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.", | |
173 "id": "SegmentFilter", | |
174 "properties": { | |
175 "sequenceSegment": { | |
176 "$ref": "SequenceSegment", | |
177 "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." | |
178 }, | |
179 "not": { | |
180 "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 },", | |
181 "type": "boolean" | |
182 }, | |
183 "simpleSegment": { | |
184 "$ref": "SimpleSegment", | |
185 "description": "A Simple segment conditions consist of one o
r more dimension/metric\nconditions that can be combined" | |
186 } | |
187 }, | |
188 "type": "object" | |
189 }, | |
190 "SegmentDefinition": { | |
191 "description": "SegmentDefinition defines the segment to be a set of
SegmentFilters which\nare combined together with a logical `AND` operation.", | |
192 "id": "SegmentDefinition", | |
193 "properties": { | |
194 "segmentFilters": { | |
195 "description": "A segment is defined by a set of segment fil
ters which are combined\ntogether with a logical `AND` operation.", | |
196 "items": { | |
197 "$ref": "SegmentFilter" | |
198 }, | |
199 "type": "array" | |
200 } | |
201 }, | |
202 "type": "object" | |
203 }, | |
204 "MetricHeaderEntry": { | |
205 "description": "Header for the metrics.", | |
206 "id": "MetricHeaderEntry", | |
207 "properties": { | |
208 "name": { | |
209 "description": "The name of the header.", | |
210 "type": "string" | |
211 }, | |
212 "type": { | |
213 "description": "The type of the metric, for example `INTEGER
`.", | |
214 "enum": [ | |
215 "METRIC_TYPE_UNSPECIFIED", | |
216 "INTEGER", | |
217 "FLOAT", | |
218 "CURRENCY", | |
219 "PERCENT", | |
220 "TIME" | |
221 ], | |
222 "enumDescriptions": [ | |
223 "Metric type is unspecified.", | |
224 "Integer metric.", | |
225 "Float metric.", | |
226 "Currency metric.", | |
227 "Percentage metric.", | |
228 "Time metric in `HH:MM:SS` format." | |
229 ], | |
230 "type": "string" | |
231 } | |
232 }, | |
233 "type": "object" | |
234 }, | |
235 "ReportData": { | |
236 "description": "The data part of the report.", | |
237 "id": "ReportData", | |
238 "properties": { | |
239 "totals": { | |
240 "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.", | |
241 "items": { | |
242 "$ref": "DateRangeValues" | |
243 }, | |
244 "type": "array" | |
245 }, | |
246 "samplesReadCounts": { | |
247 "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.", | |
248 "items": { | |
249 "format": "int64", | |
250 "type": "string" | |
251 }, | |
252 "type": "array" | |
253 }, | |
254 "rowCount": { | |
255 "description": "Total number of matching rows for this query
.", | |
256 "format": "int32", | |
257 "type": "integer" | |
258 }, | |
259 "rows": { | |
260 "description": "There's one ReportRow for every unique combi
nation of dimensions.", | |
261 "items": { | |
262 "$ref": "ReportRow" | |
263 }, | |
264 "type": "array" | |
265 }, | |
266 "isDataGolden": { | |
267 "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.", | |
268 "type": "boolean" | |
269 }, | |
270 "dataLastRefreshed": { | |
271 "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.", | |
272 "format": "google-datetime", | |
273 "type": "string" | |
274 }, | |
275 "maximums": { | |
276 "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.", | |
277 "items": { | |
278 "$ref": "DateRangeValues" | |
279 }, | |
280 "type": "array" | |
281 }, | |
282 "minimums": { | |
283 "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.", | |
284 "items": { | |
285 "$ref": "DateRangeValues" | |
286 }, | |
287 "type": "array" | |
288 }, | |
289 "samplingSpaceSizes": { | |
290 "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.", | |
291 "items": { | |
292 "format": "int64", | |
293 "type": "string" | |
294 }, | |
295 "type": "array" | |
296 } | |
297 }, | |
298 "type": "object" | |
299 }, | |
300 "DimensionFilter": { | |
301 "description": "Dimension filter specifies the filtering options on
a dimension.", | |
302 "id": "DimensionFilter", | |
303 "properties": { | |
304 "operator": { | |
305 "description": "How to match the dimension to the expression
. The default is REGEXP.", | |
306 "enum": [ | |
307 "OPERATOR_UNSPECIFIED", | |
308 "REGEXP", | |
309 "BEGINS_WITH", | |
310 "ENDS_WITH", | |
311 "PARTIAL", | |
312 "EXACT", | |
313 "NUMERIC_EQUAL", | |
314 "NUMERIC_GREATER_THAN", | |
315 "NUMERIC_LESS_THAN", | |
316 "IN_LIST" | |
317 ], | |
318 "enumDescriptions": [ | |
319 "If the match type is unspecified, it is treated as a `R
EGEXP`.", | |
320 "The match expression is treated as a regular expression
. All match types\nare not treated as regular expressions.", | |
321 "Matches the value which begin with the match expression
provided.", | |
322 "Matches the values which end with the match expression
provided.", | |
323 "Substring match.", | |
324 "The value should match the match expression entirely.", | |
325 "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.", | |
326 "Checks if the dimension is numerically greater than the
match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions."
, | |
327 "Checks if the dimension is numerically less than the ma
tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.", | |
328 "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." | |
329 ], | |
330 "type": "string" | |
331 }, | |
332 "dimensionName": { | |
333 "description": "The dimension to filter on. A DimensionFilte
r must contain a dimension.", | |
334 "type": "string" | |
335 }, | |
336 "expressions": { | |
337 "description": "Strings or regular expression to match again
st. Only the first value of\nthe list is used for comparison unless the operator
is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter th
e\ndimensions as explained in the description of the `IN_LIST` operator.", | |
338 "items": { | |
339 "type": "string" | |
340 }, | |
341 "type": "array" | |
342 }, | |
343 "not": { | |
344 "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.", | |
345 "type": "boolean" | |
346 }, | |
347 "caseSensitive": { | |
348 "description": "Should the match be case sensitive? Default
is false.", | |
349 "type": "boolean" | |
350 } | |
351 }, | |
352 "type": "object" | |
353 }, | |
354 "SegmentDimensionFilter": { | 146 "SegmentDimensionFilter": { |
355 "description": "Dimension filter specifies the filtering options on
a dimension.", | 147 "description": "Dimension filter specifies the filtering options on
a dimension.", |
356 "id": "SegmentDimensionFilter", | 148 "id": "SegmentDimensionFilter", |
357 "properties": { | 149 "properties": { |
358 "caseSensitive": { | |
359 "description": "Should the match be case sensitive, ignored
for `IN_LIST` operator.", | |
360 "type": "boolean" | |
361 }, | |
362 "minComparisonValue": { | 150 "minComparisonValue": { |
363 "description": "Minimum comparison values for `BETWEEN` matc
h type.", | 151 "description": "Minimum comparison values for `BETWEEN` matc
h type.", |
364 "type": "string" | 152 "type": "string" |
365 }, | 153 }, |
366 "maxComparisonValue": { | 154 "maxComparisonValue": { |
367 "description": "Maximum comparison values for `BETWEEN` matc
h type.", | 155 "description": "Maximum comparison values for `BETWEEN` matc
h type.", |
368 "type": "string" | 156 "type": "string" |
369 }, | 157 }, |
370 "dimensionName": { | 158 "dimensionName": { |
371 "description": "Name of the dimension for which the filter i
s being applied.", | 159 "description": "Name of the dimension for which the filter i
s being applied.", |
(...skipping 26 matching lines...) Expand all Loading... |
398 "Checks if the dimension is numerically between the mini
mum and maximum\nof the match expression, boundaries excluded." | 186 "Checks if the dimension is numerically between the mini
mum and maximum\nof the match expression, boundaries excluded." |
399 ], | 187 ], |
400 "type": "string" | 188 "type": "string" |
401 }, | 189 }, |
402 "expressions": { | 190 "expressions": { |
403 "description": "The list of expressions, only the first elem
ent is used for all operators", | 191 "description": "The list of expressions, only the first elem
ent is used for all operators", |
404 "items": { | 192 "items": { |
405 "type": "string" | 193 "type": "string" |
406 }, | 194 }, |
407 "type": "array" | 195 "type": "array" |
| 196 }, |
| 197 "caseSensitive": { |
| 198 "description": "Should the match be case sensitive, ignored
for `IN_LIST` operator.", |
| 199 "type": "boolean" |
408 } | 200 } |
409 }, | 201 }, |
410 "type": "object" | 202 "type": "object" |
411 }, | 203 }, |
412 "OrderBy": { | 204 "OrderBy": { |
413 "description": "Specifies the sorting options.", | 205 "description": "Specifies the sorting options.", |
414 "id": "OrderBy", | 206 "id": "OrderBy", |
415 "properties": { | 207 "properties": { |
416 "orderType": { | 208 "orderType": { |
417 "description": "The order type. The default orderType is `VA
LUE`.", | 209 "description": "The order type. The default orderType is `VA
LUE`.", |
(...skipping 125 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
543 }, | 335 }, |
544 "type": "array" | 336 "type": "array" |
545 } | 337 } |
546 }, | 338 }, |
547 "type": "object" | 339 "type": "object" |
548 }, | 340 }, |
549 "Report": { | 341 "Report": { |
550 "description": "The data response corresponding to the request.", | 342 "description": "The data response corresponding to the request.", |
551 "id": "Report", | 343 "id": "Report", |
552 "properties": { | 344 "properties": { |
553 "columnHeader": { | |
554 "$ref": "ColumnHeader", | |
555 "description": "The column headers." | |
556 }, | |
557 "nextPageToken": { | 345 "nextPageToken": { |
558 "description": "Page token to retrieve the next page of resu
lts in the list.", | 346 "description": "Page token to retrieve the next page of resu
lts in the list.", |
559 "type": "string" | 347 "type": "string" |
560 }, | 348 }, |
561 "data": { | 349 "data": { |
562 "$ref": "ReportData", | 350 "$ref": "ReportData", |
563 "description": "Response data." | 351 "description": "Response data." |
| 352 }, |
| 353 "columnHeader": { |
| 354 "$ref": "ColumnHeader", |
| 355 "description": "The column headers." |
564 } | 356 } |
565 }, | 357 }, |
566 "type": "object" | 358 "type": "object" |
567 }, | 359 }, |
568 "PivotHeader": { | 360 "PivotHeader": { |
569 "description": "The headers for each of the pivot sections defined i
n the request.", | 361 "description": "The headers for each of the pivot sections defined i
n the request.", |
570 "id": "PivotHeader", | 362 "id": "PivotHeader", |
571 "properties": { | 363 "properties": { |
572 "pivotHeaderEntries": { | 364 "pivotHeaderEntries": { |
573 "description": "A single pivot section header.", | 365 "description": "A single pivot section header.", |
574 "items": { | 366 "items": { |
575 "$ref": "PivotHeaderEntry" | 367 "$ref": "PivotHeaderEntry" |
576 }, | 368 }, |
577 "type": "array" | 369 "type": "array" |
578 }, | 370 }, |
579 "totalPivotGroupsCount": { | 371 "totalPivotGroupsCount": { |
580 "description": "The total number of groups for this pivot.", | 372 "description": "The total number of groups for this pivot.", |
581 "format": "int32", | 373 "format": "int32", |
582 "type": "integer" | 374 "type": "integer" |
583 } | 375 } |
584 }, | 376 }, |
585 "type": "object" | 377 "type": "object" |
586 }, | 378 }, |
587 "DateRange": { | 379 "DateRange": { |
588 "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`.", | 380 "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`.", |
589 "id": "DateRange", | 381 "id": "DateRange", |
590 "properties": { | 382 "properties": { |
| 383 "startDate": { |
| 384 "description": "The start date for the query in the format `
YYYY-MM-DD`.", |
| 385 "type": "string" |
| 386 }, |
591 "endDate": { | 387 "endDate": { |
592 "description": "The end date for the query in the format `YY
YY-MM-DD`.", | 388 "description": "The end date for the query in the format `YY
YY-MM-DD`.", |
593 "type": "string" | 389 "type": "string" |
594 }, | |
595 "startDate": { | |
596 "description": "The start date for the query in the format `
YYYY-MM-DD`.", | |
597 "type": "string" | |
598 } | 390 } |
599 }, | 391 }, |
600 "type": "object" | 392 "type": "object" |
601 }, | 393 }, |
602 "ReportRequest": { | 394 "ReportRequest": { |
603 "description": "The main request class which specifies the Reporting
API request.", | 395 "description": "The main request class which specifies the Reporting
API request.", |
604 "id": "ReportRequest", | 396 "id": "ReportRequest", |
605 "properties": { | 397 "properties": { |
| 398 "cohortGroup": { |
| 399 "$ref": "CohortGroup", |
| 400 "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." |
| 401 }, |
| 402 "filtersExpression": { |
| 403 "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).", |
| 404 "type": "string" |
| 405 }, |
| 406 "viewId": { |
| 407 "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`
.", |
| 408 "type": "string" |
| 409 }, |
| 410 "metrics": { |
| 411 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", |
| 412 "items": { |
| 413 "$ref": "Metric" |
| 414 }, |
| 415 "type": "array" |
| 416 }, |
| 417 "dimensionFilterClauses": { |
| 418 "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.", |
| 419 "items": { |
| 420 "$ref": "DimensionFilterClause" |
| 421 }, |
| 422 "type": "array" |
| 423 }, |
606 "orderBys": { | 424 "orderBys": { |
607 "description": "Sort order on output rows. To compare two ro
ws, the elements of the\nfollowing are applied in order until a difference is fo
und. All date\nranges in the output get the same row order.", | 425 "description": "Sort order on output rows. To compare two ro
ws, the elements of the\nfollowing are applied in order until a difference is fo
und. All date\nranges in the output get the same row order.", |
608 "items": { | 426 "items": { |
609 "$ref": "OrderBy" | 427 "$ref": "OrderBy" |
610 }, | 428 }, |
611 "type": "array" | 429 "type": "array" |
612 }, | 430 }, |
613 "segments": { | 431 "segments": { |
614 "description": "Segment the data returned for the request. A
segment definition helps look\nat a subset of the segment request. A request ca
n contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n
`batchGet` method must contain the same `segments` definition. Requests\nwith se
gments must have the `ga:segment` dimension.", | 432 "description": "Segment the data returned for the request. A
segment definition helps look\nat a subset of the segment request. A request ca
n contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n
`batchGet` method must contain the same `segments` definition. Requests\nwith se
gments must have the `ga:segment` dimension.", |
615 "items": { | 433 "items": { |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
674 "format": "int32", | 492 "format": "int32", |
675 "type": "integer" | 493 "type": "integer" |
676 }, | 494 }, |
677 "hideTotals": { | 495 "hideTotals": { |
678 "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.", | 496 "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.", |
679 "type": "boolean" | 497 "type": "boolean" |
680 }, | 498 }, |
681 "hideValueRanges": { | 499 "hideValueRanges": { |
682 "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.", | 500 "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.", |
683 "type": "boolean" | 501 "type": "boolean" |
684 }, | |
685 "filtersExpression": { | |
686 "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).", | |
687 "type": "string" | |
688 }, | |
689 "cohortGroup": { | |
690 "$ref": "CohortGroup", | |
691 "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." | |
692 }, | |
693 "viewId": { | |
694 "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`
.", | |
695 "type": "string" | |
696 }, | |
697 "metrics": { | |
698 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", | |
699 "items": { | |
700 "$ref": "Metric" | |
701 }, | |
702 "type": "array" | |
703 }, | |
704 "dimensionFilterClauses": { | |
705 "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.", | |
706 "items": { | |
707 "$ref": "DimensionFilterClause" | |
708 }, | |
709 "type": "array" | |
710 } | 502 } |
711 }, | 503 }, |
712 "type": "object" | 504 "type": "object" |
713 }, | 505 }, |
714 "MetricFilter": { | 506 "MetricFilter": { |
715 "description": "MetricFilter specifies the filter on a metric.", | 507 "description": "MetricFilter specifies the filter on a metric.", |
716 "id": "MetricFilter", | 508 "id": "MetricFilter", |
717 "properties": { | 509 "properties": { |
718 "comparisonValue": { | |
719 "description": "The value to compare against.", | |
720 "type": "string" | |
721 }, | |
722 "operator": { | 510 "operator": { |
723 "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREAT
ER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_M
ISSING`, checks if the metric is missing and would ignore the\ncomparisonValue."
, | 511 "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREAT
ER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_M
ISSING`, checks if the metric is missing and would ignore the\ncomparisonValue."
, |
724 "enum": [ | 512 "enum": [ |
725 "OPERATOR_UNSPECIFIED", | 513 "OPERATOR_UNSPECIFIED", |
726 "EQUAL", | 514 "EQUAL", |
727 "LESS_THAN", | 515 "LESS_THAN", |
728 "GREATER_THAN", | 516 "GREATER_THAN", |
729 "IS_MISSING" | 517 "IS_MISSING" |
730 ], | 518 ], |
731 "enumDescriptions": [ | 519 "enumDescriptions": [ |
732 "If the operator is not specified, it is treated as `EQU
AL`.", | 520 "If the operator is not specified, it is treated as `EQU
AL`.", |
733 "Should the value of the metric be exactly equal to the
comparison value.", | 521 "Should the value of the metric be exactly equal to the
comparison value.", |
734 "Should the value of the metric be less than to the comp
arison value.", | 522 "Should the value of the metric be less than to the comp
arison value.", |
735 "Should the value of the metric be greater than to the c
omparison value.", | 523 "Should the value of the metric be greater than to the c
omparison value.", |
736 "Validates if the metric is missing.\nDoesn't take compa
risonValue into account." | 524 "Validates if the metric is missing.\nDoesn't take compa
risonValue into account." |
737 ], | 525 ], |
738 "type": "string" | 526 "type": "string" |
739 }, | 527 }, |
740 "not": { | 528 "not": { |
741 "description": "Logical `NOT` operator. If this boolean is s
et to true, then the matching\nmetric values will be excluded in the report. The
default is false.", | 529 "description": "Logical `NOT` operator. If this boolean is s
et to true, then the matching\nmetric values will be excluded in the report. The
default is false.", |
742 "type": "boolean" | 530 "type": "boolean" |
743 }, | 531 }, |
744 "metricName": { | 532 "metricName": { |
745 "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.", | 533 "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.", |
746 "type": "string" | 534 "type": "string" |
| 535 }, |
| 536 "comparisonValue": { |
| 537 "description": "The value to compare against.", |
| 538 "type": "string" |
747 } | 539 } |
748 }, | 540 }, |
749 "type": "object" | 541 "type": "object" |
750 }, | 542 }, |
751 "Dimension": { | 543 "Dimension": { |
752 "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.", | 544 "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.", |
753 "id": "Dimension", | 545 "id": "Dimension", |
754 "properties": { | 546 "properties": { |
755 "histogramBuckets": { | 547 "histogramBuckets": { |
756 "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.", | 548 "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.", |
757 "items": { | 549 "items": { |
758 "format": "int64", | 550 "format": "int64", |
759 "type": "string" | 551 "type": "string" |
760 }, | 552 }, |
761 "type": "array" | 553 "type": "array" |
762 }, | 554 }, |
763 "name": { | 555 "name": { |
764 "description": "Name of the dimension to fetch, for example
`ga:browser`.", | 556 "description": "Name of the dimension to fetch, for example
`ga:browser`.", |
765 "type": "string" | 557 "type": "string" |
766 } | 558 } |
767 }, | 559 }, |
768 "type": "object" | 560 "type": "object" |
769 }, | 561 }, |
770 "SimpleSegment": { | |
771 "description": "A Simple segment conditions consist of one or more d
imension/metric\nconditions that can be combined.", | |
772 "id": "SimpleSegment", | |
773 "properties": { | |
774 "orFiltersForSegment": { | |
775 "description": "A list of segment filters groups which are c
ombined with logical `AND`\noperator.", | |
776 "items": { | |
777 "$ref": "OrFiltersForSegment" | |
778 }, | |
779 "type": "array" | |
780 } | |
781 }, | |
782 "type": "object" | |
783 }, | |
784 "DynamicSegment": { | 562 "DynamicSegment": { |
785 "description": "Dynamic segment definition for defining the segment
within the request.\nA segment can select users, sessions or both.", | 563 "description": "Dynamic segment definition for defining the segment
within the request.\nA segment can select users, sessions or both.", |
786 "id": "DynamicSegment", | 564 "id": "DynamicSegment", |
787 "properties": { | 565 "properties": { |
788 "sessionSegment": { | 566 "sessionSegment": { |
789 "$ref": "SegmentDefinition", | 567 "$ref": "SegmentDefinition", |
790 "description": "Session Segment to select sessions to includ
e in the segment." | 568 "description": "Session Segment to select sessions to includ
e in the segment." |
791 }, | 569 }, |
792 "name": { | 570 "name": { |
793 "description": "The name of the dynamic segment.", | 571 "description": "The name of the dynamic segment.", |
794 "type": "string" | 572 "type": "string" |
795 }, | 573 }, |
796 "userSegment": { | 574 "userSegment": { |
797 "$ref": "SegmentDefinition", | 575 "$ref": "SegmentDefinition", |
798 "description": "User Segment to select users to include in t
he segment." | 576 "description": "User Segment to select users to include in t
he segment." |
799 } | 577 } |
800 }, | 578 }, |
801 "type": "object" | 579 "type": "object" |
802 }, | 580 }, |
| 581 "SimpleSegment": { |
| 582 "description": "A Simple segment conditions consist of one or more d
imension/metric\nconditions that can be combined.", |
| 583 "id": "SimpleSegment", |
| 584 "properties": { |
| 585 "orFiltersForSegment": { |
| 586 "description": "A list of segment filters groups which are c
ombined with logical `AND`\noperator.", |
| 587 "items": { |
| 588 "$ref": "OrFiltersForSegment" |
| 589 }, |
| 590 "type": "array" |
| 591 } |
| 592 }, |
| 593 "type": "object" |
| 594 }, |
803 "ColumnHeader": { | 595 "ColumnHeader": { |
804 "description": "Column headers.", | 596 "description": "Column headers.", |
805 "id": "ColumnHeader", | 597 "id": "ColumnHeader", |
806 "properties": { | 598 "properties": { |
807 "dimensions": { | 599 "dimensions": { |
808 "description": "The dimension names in the response.", | 600 "description": "The dimension names in the response.", |
809 "items": { | 601 "items": { |
810 "type": "string" | 602 "type": "string" |
811 }, | 603 }, |
812 "type": "array" | 604 "type": "array" |
(...skipping 17 matching lines...) Expand all Loading... |
830 "description": "Matches the complement (`!`) of the filter."
, | 622 "description": "Matches the complement (`!`) of the filter."
, |
831 "type": "boolean" | 623 "type": "boolean" |
832 }, | 624 }, |
833 "dimensionFilter": { | 625 "dimensionFilter": { |
834 "$ref": "SegmentDimensionFilter", | 626 "$ref": "SegmentDimensionFilter", |
835 "description": "Dimension Filter for the segment definition.
" | 627 "description": "Dimension Filter for the segment definition.
" |
836 } | 628 } |
837 }, | 629 }, |
838 "type": "object" | 630 "type": "object" |
839 }, | 631 }, |
| 632 "MetricFilterClause": { |
| 633 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", |
| 634 "id": "MetricFilterClause", |
| 635 "properties": { |
| 636 "filters": { |
| 637 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", |
| 638 "items": { |
| 639 "$ref": "MetricFilter" |
| 640 }, |
| 641 "type": "array" |
| 642 }, |
| 643 "operator": { |
| 644 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", |
| 645 "enum": [ |
| 646 "OPERATOR_UNSPECIFIED", |
| 647 "OR", |
| 648 "AND" |
| 649 ], |
| 650 "enumDescriptions": [ |
| 651 "Unspecified operator. It is treated as an `OR`.", |
| 652 "The logical `OR` operator.", |
| 653 "The logical `AND` operator." |
| 654 ], |
| 655 "type": "string" |
| 656 } |
| 657 }, |
| 658 "type": "object" |
| 659 }, |
840 "Cohort": { | 660 "Cohort": { |
841 "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.", | 661 "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.", |
842 "id": "Cohort", | 662 "id": "Cohort", |
843 "properties": { | 663 "properties": { |
844 "dateRange": { | 664 "dateRange": { |
845 "$ref": "DateRange", | 665 "$ref": "DateRange", |
846 "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." | 666 "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." |
847 }, | 667 }, |
848 "name": { | 668 "name": { |
849 "description": "A unique name for the cohort. If not defined
name will be auto-generated\nwith values cohort_[1234...].", | 669 "description": "A unique name for the cohort. If not defined
name will be auto-generated\nwith values cohort_[1234...].", |
(...skipping 27 matching lines...) Expand all Loading... |
877 }, | 697 }, |
878 "dimensions": { | 698 "dimensions": { |
879 "description": "List of requested dimensions.", | 699 "description": "List of requested dimensions.", |
880 "items": { | 700 "items": { |
881 "type": "string" | 701 "type": "string" |
882 }, | 702 }, |
883 "type": "array" | 703 "type": "array" |
884 } | 704 } |
885 }, | 705 }, |
886 "type": "object" | 706 "type": "object" |
887 }, | |
888 "MetricFilterClause": { | |
889 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", | |
890 "id": "MetricFilterClause", | |
891 "properties": { | |
892 "filters": { | |
893 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", | |
894 "items": { | |
895 "$ref": "MetricFilter" | |
896 }, | |
897 "type": "array" | |
898 }, | |
899 "operator": { | |
900 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", | |
901 "enum": [ | |
902 "OPERATOR_UNSPECIFIED", | |
903 "OR", | |
904 "AND" | |
905 ], | |
906 "enumDescriptions": [ | |
907 "Unspecified operator. It is treated as an `OR`.", | |
908 "The logical `OR` operator.", | |
909 "The logical `AND` operator." | |
910 ], | |
911 "type": "string" | |
912 } | |
913 }, | |
914 "type": "object" | |
915 }, | 707 }, |
916 "OrFiltersForSegment": { | 708 "OrFiltersForSegment": { |
917 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", | 709 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", |
918 "id": "OrFiltersForSegment", | 710 "id": "OrFiltersForSegment", |
919 "properties": { | 711 "properties": { |
920 "segmentFilterClauses": { | 712 "segmentFilterClauses": { |
921 "description": "List of segment filters to be combined with
a `OR` operator.", | 713 "description": "List of segment filters to be combined with
a `OR` operator.", |
922 "items": { | 714 "items": { |
923 "$ref": "SegmentFilterClause" | 715 "$ref": "SegmentFilterClause" |
924 }, | 716 }, |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
987 }, | 779 }, |
988 "type": "array" | 780 "type": "array" |
989 } | 781 } |
990 }, | 782 }, |
991 "type": "object" | 783 "type": "object" |
992 }, | 784 }, |
993 "SequenceSegment": { | 785 "SequenceSegment": { |
994 "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.", | 786 "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.", |
995 "id": "SequenceSegment", | 787 "id": "SequenceSegment", |
996 "properties": { | 788 "properties": { |
| 789 "firstStepShouldMatchFirstHit": { |
| 790 "description": "If set, first step condition must match the
first hit of the visitor (in\nthe date range).", |
| 791 "type": "boolean" |
| 792 }, |
997 "segmentSequenceSteps": { | 793 "segmentSequenceSteps": { |
998 "description": "The list of steps in the sequence.", | 794 "description": "The list of steps in the sequence.", |
999 "items": { | 795 "items": { |
1000 "$ref": "SegmentSequenceStep" | 796 "$ref": "SegmentSequenceStep" |
1001 }, | 797 }, |
1002 "type": "array" | 798 "type": "array" |
1003 }, | |
1004 "firstStepShouldMatchFirstHit": { | |
1005 "description": "If set, first step condition must match the
first hit of the visitor (in\nthe date range).", | |
1006 "type": "boolean" | |
1007 } | 799 } |
1008 }, | 800 }, |
1009 "type": "object" | 801 "type": "object" |
1010 }, | 802 }, |
1011 "SegmentMetricFilter": { | 803 "SegmentMetricFilter": { |
1012 "description": "Metric filter to be used in a segment filter clause.
", | 804 "description": "Metric filter to be used in a segment filter clause.
", |
1013 "id": "SegmentMetricFilter", | 805 "id": "SegmentMetricFilter", |
1014 "properties": { | 806 "properties": { |
1015 "operator": { | 807 "operator": { |
1016 "description": "Specifies is the operation to perform to com
pare the metric. The default\nis `EQUAL`.", | 808 "description": "Specifies is the operation to perform to com
pare the metric. The default\nis `EQUAL`.", |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1060 "description": "The value to compare against. If the operato
r is `BETWEEN`, this value is\ntreated as minimum comparison value.", | 852 "description": "The value to compare against. If the operato
r is `BETWEEN`, this value is\ntreated as minimum comparison value.", |
1061 "type": "string" | 853 "type": "string" |
1062 } | 854 } |
1063 }, | 855 }, |
1064 "type": "object" | 856 "type": "object" |
1065 }, | 857 }, |
1066 "DateRangeValues": { | 858 "DateRangeValues": { |
1067 "description": "Used to return a list of metrics for a single DateRa
nge / dimension\ncombination", | 859 "description": "Used to return a list of metrics for a single DateRa
nge / dimension\ncombination", |
1068 "id": "DateRangeValues", | 860 "id": "DateRangeValues", |
1069 "properties": { | 861 "properties": { |
| 862 "values": { |
| 863 "description": "Each value corresponds to each Metric in the
request.", |
| 864 "items": { |
| 865 "type": "string" |
| 866 }, |
| 867 "type": "array" |
| 868 }, |
1070 "pivotValueRegions": { | 869 "pivotValueRegions": { |
1071 "description": "The values of each pivot region.", | 870 "description": "The values of each pivot region.", |
1072 "items": { | 871 "items": { |
1073 "$ref": "PivotValueRegion" | 872 "$ref": "PivotValueRegion" |
1074 }, | 873 }, |
1075 "type": "array" | 874 "type": "array" |
1076 }, | |
1077 "values": { | |
1078 "description": "Each value corresponds to each Metric in the
request.", | |
1079 "items": { | |
1080 "type": "string" | |
1081 }, | |
1082 "type": "array" | |
1083 } | 875 } |
1084 }, | 876 }, |
1085 "type": "object" | 877 "type": "object" |
1086 }, | 878 }, |
1087 "CohortGroup": { | 879 "CohortGroup": { |
1088 "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 }", | 880 "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 }", |
1089 "id": "CohortGroup", | 881 "id": "CohortGroup", |
1090 "properties": { | 882 "properties": { |
1091 "cohorts": { | 883 "cohorts": { |
1092 "description": "The definition for the cohort.", | 884 "description": "The definition for the cohort.", |
(...skipping 20 matching lines...) Expand all Loading... |
1113 }, | 905 }, |
1114 "type": "array" | 906 "type": "array" |
1115 } | 907 } |
1116 }, | 908 }, |
1117 "type": "object" | 909 "type": "object" |
1118 }, | 910 }, |
1119 "Pivot": { | 911 "Pivot": { |
1120 "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.", | 912 "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.", |
1121 "id": "Pivot", | 913 "id": "Pivot", |
1122 "properties": { | 914 "properties": { |
| 915 "startGroup": { |
| 916 "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.", |
| 917 "format": "int32", |
| 918 "type": "integer" |
| 919 }, |
| 920 "metrics": { |
| 921 "description": "The pivot metrics. Pivot metrics are part of
the\nrestriction on total number of metrics allowed in the request.", |
| 922 "items": { |
| 923 "$ref": "Metric" |
| 924 }, |
| 925 "type": "array" |
| 926 }, |
1123 "dimensionFilterClauses": { | 927 "dimensionFilterClauses": { |
1124 "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.", | 928 "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.", |
1125 "items": { | 929 "items": { |
1126 "$ref": "DimensionFilterClause" | 930 "$ref": "DimensionFilterClause" |
1127 }, | 931 }, |
1128 "type": "array" | 932 "type": "array" |
1129 }, | 933 }, |
1130 "dimensions": { | 934 "dimensions": { |
1131 "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.", | 935 "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.", |
1132 "items": { | 936 "items": { |
1133 "$ref": "Dimension" | 937 "$ref": "Dimension" |
1134 }, | 938 }, |
1135 "type": "array" | 939 "type": "array" |
1136 }, | 940 }, |
1137 "maxGroupCount": { | 941 "maxGroupCount": { |
1138 "description": "Specifies the maximum number of groups to re
turn.\nThe default value is 10, also the maximum value is 1,000.", | 942 "description": "Specifies the maximum number of groups to re
turn.\nThe default value is 10, also the maximum value is 1,000.", |
1139 "format": "int32", | 943 "format": "int32", |
1140 "type": "integer" | 944 "type": "integer" |
1141 }, | 945 } |
1142 "startGroup": { | 946 }, |
1143 "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.", | 947 "type": "object" |
| 948 }, |
| 949 "PivotHeaderEntry": { |
| 950 "description": "The headers for the each of the metric column corres
ponding to the metrics\nrequested in the pivots section of the response.", |
| 951 "id": "PivotHeaderEntry", |
| 952 "properties": { |
| 953 "dimensionValues": { |
| 954 "description": "The values for the dimensions in the pivot."
, |
| 955 "items": { |
| 956 "type": "string" |
| 957 }, |
| 958 "type": "array" |
| 959 }, |
| 960 "metric": { |
| 961 "$ref": "MetricHeaderEntry", |
| 962 "description": "The metric header for the metric in the pivo
t." |
| 963 }, |
| 964 "dimensionNames": { |
| 965 "description": "The name of the dimensions in the pivot resp
onse.", |
| 966 "items": { |
| 967 "type": "string" |
| 968 }, |
| 969 "type": "array" |
| 970 } |
| 971 }, |
| 972 "type": "object" |
| 973 }, |
| 974 "SegmentFilter": { |
| 975 "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.", |
| 976 "id": "SegmentFilter", |
| 977 "properties": { |
| 978 "not": { |
| 979 "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 },", |
| 980 "type": "boolean" |
| 981 }, |
| 982 "simpleSegment": { |
| 983 "$ref": "SimpleSegment", |
| 984 "description": "A Simple segment conditions consist of one o
r more dimension/metric\nconditions that can be combined" |
| 985 }, |
| 986 "sequenceSegment": { |
| 987 "$ref": "SequenceSegment", |
| 988 "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." |
| 989 } |
| 990 }, |
| 991 "type": "object" |
| 992 }, |
| 993 "SegmentDefinition": { |
| 994 "description": "SegmentDefinition defines the segment to be a set of
SegmentFilters which\nare combined together with a logical `AND` operation.", |
| 995 "id": "SegmentDefinition", |
| 996 "properties": { |
| 997 "segmentFilters": { |
| 998 "description": "A segment is defined by a set of segment fil
ters which are combined\ntogether with a logical `AND` operation.", |
| 999 "items": { |
| 1000 "$ref": "SegmentFilter" |
| 1001 }, |
| 1002 "type": "array" |
| 1003 } |
| 1004 }, |
| 1005 "type": "object" |
| 1006 }, |
| 1007 "MetricHeaderEntry": { |
| 1008 "description": "Header for the metrics.", |
| 1009 "id": "MetricHeaderEntry", |
| 1010 "properties": { |
| 1011 "name": { |
| 1012 "description": "The name of the header.", |
| 1013 "type": "string" |
| 1014 }, |
| 1015 "type": { |
| 1016 "description": "The type of the metric, for example `INTEGER
`.", |
| 1017 "enum": [ |
| 1018 "METRIC_TYPE_UNSPECIFIED", |
| 1019 "INTEGER", |
| 1020 "FLOAT", |
| 1021 "CURRENCY", |
| 1022 "PERCENT", |
| 1023 "TIME" |
| 1024 ], |
| 1025 "enumDescriptions": [ |
| 1026 "Metric type is unspecified.", |
| 1027 "Integer metric.", |
| 1028 "Float metric.", |
| 1029 "Currency metric.", |
| 1030 "Percentage metric.", |
| 1031 "Time metric in `HH:MM:SS` format." |
| 1032 ], |
| 1033 "type": "string" |
| 1034 } |
| 1035 }, |
| 1036 "type": "object" |
| 1037 }, |
| 1038 "ReportData": { |
| 1039 "description": "The data part of the report.", |
| 1040 "id": "ReportData", |
| 1041 "properties": { |
| 1042 "samplingSpaceSizes": { |
| 1043 "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.", |
| 1044 "items": { |
| 1045 "format": "int64", |
| 1046 "type": "string" |
| 1047 }, |
| 1048 "type": "array" |
| 1049 }, |
| 1050 "minimums": { |
| 1051 "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.", |
| 1052 "items": { |
| 1053 "$ref": "DateRangeValues" |
| 1054 }, |
| 1055 "type": "array" |
| 1056 }, |
| 1057 "totals": { |
| 1058 "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.", |
| 1059 "items": { |
| 1060 "$ref": "DateRangeValues" |
| 1061 }, |
| 1062 "type": "array" |
| 1063 }, |
| 1064 "samplesReadCounts": { |
| 1065 "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.", |
| 1066 "items": { |
| 1067 "format": "int64", |
| 1068 "type": "string" |
| 1069 }, |
| 1070 "type": "array" |
| 1071 }, |
| 1072 "isDataGolden": { |
| 1073 "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.", |
| 1074 "type": "boolean" |
| 1075 }, |
| 1076 "rows": { |
| 1077 "description": "There's one ReportRow for every unique combi
nation of dimensions.", |
| 1078 "items": { |
| 1079 "$ref": "ReportRow" |
| 1080 }, |
| 1081 "type": "array" |
| 1082 }, |
| 1083 "rowCount": { |
| 1084 "description": "Total number of matching rows for this query
.", |
1144 "format": "int32", | 1085 "format": "int32", |
1145 "type": "integer" | 1086 "type": "integer" |
1146 }, | 1087 }, |
1147 "metrics": { | 1088 "dataLastRefreshed": { |
1148 "description": "The pivot metrics. Pivot metrics are part of
the\nrestriction on total number of metrics allowed in the request.", | 1089 "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.", |
1149 "items": { | 1090 "format": "google-datetime", |
1150 "$ref": "Metric" | 1091 "type": "string" |
1151 }, | 1092 }, |
1152 "type": "array" | 1093 "maximums": { |
1153 } | 1094 "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.", |
1154 }, | 1095 "items": { |
1155 "type": "object" | 1096 "$ref": "DateRangeValues" |
| 1097 }, |
| 1098 "type": "array" |
| 1099 } |
| 1100 }, |
| 1101 "type": "object" |
| 1102 }, |
| 1103 "DimensionFilter": { |
| 1104 "description": "Dimension filter specifies the filtering options on
a dimension.", |
| 1105 "id": "DimensionFilter", |
| 1106 "properties": { |
| 1107 "operator": { |
| 1108 "description": "How to match the dimension to the expression
. The default is REGEXP.", |
| 1109 "enum": [ |
| 1110 "OPERATOR_UNSPECIFIED", |
| 1111 "REGEXP", |
| 1112 "BEGINS_WITH", |
| 1113 "ENDS_WITH", |
| 1114 "PARTIAL", |
| 1115 "EXACT", |
| 1116 "NUMERIC_EQUAL", |
| 1117 "NUMERIC_GREATER_THAN", |
| 1118 "NUMERIC_LESS_THAN", |
| 1119 "IN_LIST" |
| 1120 ], |
| 1121 "enumDescriptions": [ |
| 1122 "If the match type is unspecified, it is treated as a `R
EGEXP`.", |
| 1123 "The match expression is treated as a regular expression
. All match types\nare not treated as regular expressions.", |
| 1124 "Matches the value which begin with the match expression
provided.", |
| 1125 "Matches the values which end with the match expression
provided.", |
| 1126 "Substring match.", |
| 1127 "The value should match the match expression entirely.", |
| 1128 "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.", |
| 1129 "Checks if the dimension is numerically greater than the
match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions."
, |
| 1130 "Checks if the dimension is numerically less than the ma
tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.", |
| 1131 "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." |
| 1132 ], |
| 1133 "type": "string" |
| 1134 }, |
| 1135 "dimensionName": { |
| 1136 "description": "The dimension to filter on. A DimensionFilte
r must contain a dimension.", |
| 1137 "type": "string" |
| 1138 }, |
| 1139 "expressions": { |
| 1140 "description": "Strings or regular expression to match again
st. Only the first value of\nthe list is used for comparison unless the operator
is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter th
e\ndimensions as explained in the description of the `IN_LIST` operator.", |
| 1141 "items": { |
| 1142 "type": "string" |
| 1143 }, |
| 1144 "type": "array" |
| 1145 }, |
| 1146 "not": { |
| 1147 "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.", |
| 1148 "type": "boolean" |
| 1149 }, |
| 1150 "caseSensitive": { |
| 1151 "description": "Should the match be case sensitive? Default
is false.", |
| 1152 "type": "boolean" |
| 1153 } |
| 1154 }, |
| 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 |