Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(159)

Side by Side Diff: discovery/googleapis/analyticsreporting__v4.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
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
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": { 31 "bearer_token": {
53 "description": "OAuth bearer token.", 32 "description": "OAuth bearer token.",
54 "location": "query", 33 "location": "query",
55 "type": "string" 34 "type": "string"
56 }, 35 },
57 "oauth_token": { 36 "oauth_token": {
58 "description": "OAuth 2.0 token for the current user.", 37 "description": "OAuth 2.0 token for the current user.",
59 "location": "query", 38 "location": "query",
60 "type": "string" 39 "type": "string"
61 }, 40 },
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
106 "media", 85 "media",
107 "proto" 86 "proto"
108 ], 87 ],
109 "enumDescriptions": [ 88 "enumDescriptions": [
110 "Responses with Content-Type of application/json", 89 "Responses with Content-Type of application/json",
111 "Media download with context-dependent Content-Type", 90 "Media download with context-dependent Content-Type",
112 "Responses with Content-Type of application/x-protobuf" 91 "Responses with Content-Type of application/x-protobuf"
113 ], 92 ],
114 "location": "query", 93 "location": "query",
115 "type": "string" 94 "type": "string"
95 },
96 "access_token": {
97 "description": "OAuth access token.",
98 "location": "query",
99 "type": "string"
100 },
101 "key": {
102 "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.",
103 "location": "query",
104 "type": "string"
105 },
106 "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.",
108 "location": "query",
109 "type": "string"
110 },
111 "pp": {
112 "default": "true",
113 "description": "Pretty-print response.",
114 "location": "query",
115 "type": "boolean"
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
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 "DimensionFilter": {
147 "description": "Dimension filter specifies the filtering options on a dimension.",
148 "id": "DimensionFilter",
149 "properties": {
150 "caseSensitive": {
151 "description": "Should the match be case sensitive? Default is false.",
152 "type": "boolean"
153 },
154 "operator": {
155 "description": "How to match the dimension to the expression . The default is REGEXP.",
156 "enum": [
157 "OPERATOR_UNSPECIFIED",
158 "REGEXP",
159 "BEGINS_WITH",
160 "ENDS_WITH",
161 "PARTIAL",
162 "EXACT",
163 "NUMERIC_EQUAL",
164 "NUMERIC_GREATER_THAN",
165 "NUMERIC_LESS_THAN",
166 "IN_LIST"
167 ],
168 "enumDescriptions": [
169 "If the match type is unspecified, it is treated as a `R EGEXP`.",
170 "The match expression is treated as a regular expression . All match types\nare not treated as regular expressions.",
171 "Matches the value which begin with the match expression provided.",
172 "Matches the values which end with the match expression provided.",
173 "Substring match.",
174 "The value should match the match expression entirely.",
175 "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.",
176 "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions." ,
177 "Checks if the dimension is numerically less than the ma tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
178 "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."
179 ],
180 "type": "string"
181 },
182 "dimensionName": {
183 "description": "The dimension to filter on. A DimensionFilte r must contain a dimension.",
184 "type": "string"
185 },
186 "expressions": {
187 "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.",
188 "items": {
189 "type": "string"
190 },
191 "type": "array"
192 },
193 "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.",
195 "type": "boolean"
196 }
197 },
198 "type": "object"
199 },
146 "SegmentDimensionFilter": { 200 "SegmentDimensionFilter": {
147 "description": "Dimension filter specifies the filtering options on a dimension.", 201 "description": "Dimension filter specifies the filtering options on a dimension.",
148 "id": "SegmentDimensionFilter", 202 "id": "SegmentDimensionFilter",
149 "properties": { 203 "properties": {
150 "minComparisonValue": { 204 "minComparisonValue": {
151 "description": "Minimum comparison values for `BETWEEN` matc h type.", 205 "description": "Minimum comparison values for `BETWEEN` matc h type.",
152 "type": "string" 206 "type": "string"
153 }, 207 },
154 "maxComparisonValue": { 208 "maxComparisonValue": {
155 "description": "Maximum comparison values for `BETWEEN` matc h type.", 209 "description": "Maximum comparison values for `BETWEEN` matc h type.",
156 "type": "string" 210 "type": "string"
157 }, 211 },
158 "dimensionName": {
159 "description": "Name of the dimension for which the filter i s being applied.",
160 "type": "string"
161 },
162 "operator": { 212 "operator": {
163 "description": "The operator to use to match the dimension w ith the expressions.", 213 "description": "The operator to use to match the dimension w ith the expressions.",
164 "enum": [ 214 "enum": [
165 "OPERATOR_UNSPECIFIED", 215 "OPERATOR_UNSPECIFIED",
166 "REGEXP", 216 "REGEXP",
167 "BEGINS_WITH", 217 "BEGINS_WITH",
168 "ENDS_WITH", 218 "ENDS_WITH",
169 "PARTIAL", 219 "PARTIAL",
170 "EXACT", 220 "EXACT",
171 "IN_LIST", 221 "IN_LIST",
172 "NUMERIC_LESS_THAN", 222 "NUMERIC_LESS_THAN",
173 "NUMERIC_GREATER_THAN", 223 "NUMERIC_GREATER_THAN",
174 "NUMERIC_BETWEEN" 224 "NUMERIC_BETWEEN"
175 ], 225 ],
176 "enumDescriptions": [ 226 "enumDescriptions": [
177 "If the match type is unspecified, it is treated as a RE GEXP.", 227 "If the match type is unspecified, it is treated as a RE GEXP.",
178 "The match expression is treated as a regular expression . All other match\ntypes are not treated as regular expressions.", 228 "The match expression is treated as a regular expression . All other match\ntypes are not treated as regular expressions.",
179 "Matches the values which begin with the match expressio n provided.", 229 "Matches the values which begin with the match expressio n provided.",
180 "Matches the values which end with the match expression provided.", 230 "Matches the values which end with the match expression provided.",
181 "Substring match.", 231 "Substring match.",
182 "The value should match the match expression entirely.", 232 "The value should match the match expression entirely.",
183 "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.", 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.",
184 "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.", 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.",
185 "Checks if the dimension is numerically greater than the match\nexpression.", 235 "Checks if the dimension is numerically greater than the match\nexpression.",
186 "Checks if the dimension is numerically between the mini mum and maximum\nof the match expression, boundaries excluded." 236 "Checks if the dimension is numerically between the mini mum and maximum\nof the match expression, boundaries excluded."
187 ], 237 ],
188 "type": "string" 238 "type": "string"
189 }, 239 },
240 "dimensionName": {
241 "description": "Name of the dimension for which the filter i s being applied.",
242 "type": "string"
243 },
190 "expressions": { 244 "expressions": {
191 "description": "The list of expressions, only the first elem ent is used for all operators", 245 "description": "The list of expressions, only the first elem ent is used for all operators",
192 "items": { 246 "items": {
193 "type": "string" 247 "type": "string"
194 }, 248 },
195 "type": "array" 249 "type": "array"
196 }, 250 },
197 "caseSensitive": { 251 "caseSensitive": {
198 "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.", 252 "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
199 "type": "boolean" 253 "type": "boolean"
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
258 "description": "The segment ID of a built-in or custom segme nt, for example `gaid::-3`.", 312 "description": "The segment ID of a built-in or custom segme nt, for example `gaid::-3`.",
259 "type": "string" 313 "type": "string"
260 } 314 }
261 }, 315 },
262 "type": "object" 316 "type": "object"
263 }, 317 },
264 "SegmentSequenceStep": { 318 "SegmentSequenceStep": {
265 "description": "A segment sequence definition.", 319 "description": "A segment sequence definition.",
266 "id": "SegmentSequenceStep", 320 "id": "SegmentSequenceStep",
267 "properties": { 321 "properties": {
268 "orFiltersForSegment": {
269 "description": "A sequence is specified with a list of Or gr ouped filters which are\ncombined with `AND` operator.",
270 "items": {
271 "$ref": "OrFiltersForSegment"
272 },
273 "type": "array"
274 },
275 "matchType": { 322 "matchType": {
276 "description": "Specifies if the step immediately precedes o r can be any time before the\nnext step.", 323 "description": "Specifies if the step immediately precedes o r can be any time before the\nnext step.",
277 "enum": [ 324 "enum": [
278 "UNSPECIFIED_MATCH_TYPE", 325 "UNSPECIFIED_MATCH_TYPE",
279 "PRECEDES", 326 "PRECEDES",
280 "IMMEDIATELY_PRECEDES" 327 "IMMEDIATELY_PRECEDES"
281 ], 328 ],
282 "enumDescriptions": [ 329 "enumDescriptions": [
283 "Unspecified match type is treated as precedes.", 330 "Unspecified match type is treated as precedes.",
284 "Operator indicates that the previous step precedes the next step.", 331 "Operator indicates that the previous step precedes the next step.",
285 "Operator indicates that the previous step immediately p recedes the next\nstep." 332 "Operator indicates that the previous step immediately p recedes the next\nstep."
286 ], 333 ],
287 "type": "string" 334 "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"
288 } 342 }
289 }, 343 },
290 "type": "object" 344 "type": "object"
291 }, 345 },
292 "Metric": { 346 "Metric": {
293 "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.", 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.",
294 "id": "Metric", 348 "id": "Metric",
295 "properties": { 349 "properties": {
350 "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.",
352 "type": "string"
353 },
296 "formattingType": { 354 "formattingType": {
297 "description": "Specifies how the metric expression should b e formatted, for example\n`INTEGER`.", 355 "description": "Specifies how the metric expression should b e formatted, for example\n`INTEGER`.",
298 "enum": [ 356 "enum": [
299 "METRIC_TYPE_UNSPECIFIED", 357 "METRIC_TYPE_UNSPECIFIED",
300 "INTEGER", 358 "INTEGER",
301 "FLOAT", 359 "FLOAT",
302 "CURRENCY", 360 "CURRENCY",
303 "PERCENT", 361 "PERCENT",
304 "TIME" 362 "TIME"
305 ], 363 ],
306 "enumDescriptions": [ 364 "enumDescriptions": [
307 "Metric type is unspecified.", 365 "Metric type is unspecified.",
308 "Integer metric.", 366 "Integer metric.",
309 "Float metric.", 367 "Float metric.",
310 "Currency metric.", 368 "Currency metric.",
311 "Percentage metric.", 369 "Percentage metric.",
312 "Time metric in `HH:MM:SS` format." 370 "Time metric in `HH:MM:SS` format."
313 ], 371 ],
314 "type": "string" 372 "type": "string"
315 }, 373 },
316 "alias": { 374 "alias": {
317 "description": "An alias for the metric expression is an alt ernate name for the\nexpression. The alias can be used for filtering and sorting . This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe a lias is also used in the response column header.", 375 "description": "An alias for the metric expression is an alt ernate name for the\nexpression. The alias can be used for filtering and sorting . This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe a lias is also used in the response column header.",
318 "type": "string" 376 "type": "string"
319 },
320 "expression": {
321 "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.",
322 "type": "string"
323 } 377 }
324 }, 378 },
325 "type": "object" 379 "type": "object"
326 }, 380 },
327 "PivotValueRegion": { 381 "PivotValueRegion": {
328 "description": "The metric values in the pivot region.", 382 "description": "The metric values in the pivot region.",
329 "id": "PivotValueRegion", 383 "id": "PivotValueRegion",
330 "properties": { 384 "properties": {
331 "values": { 385 "values": {
332 "description": "The values of the metrics in each of the piv ot regions.", 386 "description": "The values of the metrics in each of the piv ot regions.",
333 "items": { 387 "items": {
334 "type": "string" 388 "type": "string"
335 }, 389 },
336 "type": "array" 390 "type": "array"
337 } 391 }
338 }, 392 },
339 "type": "object" 393 "type": "object"
340 }, 394 },
341 "Report": { 395 "Report": {
342 "description": "The data response corresponding to the request.", 396 "description": "The data response corresponding to the request.",
343 "id": "Report", 397 "id": "Report",
344 "properties": { 398 "properties": {
399 "columnHeader": {
400 "$ref": "ColumnHeader",
401 "description": "The column headers."
402 },
345 "nextPageToken": { 403 "nextPageToken": {
346 "description": "Page token to retrieve the next page of resu lts in the list.", 404 "description": "Page token to retrieve the next page of resu lts in the list.",
347 "type": "string" 405 "type": "string"
348 }, 406 },
349 "data": { 407 "data": {
350 "$ref": "ReportData", 408 "$ref": "ReportData",
351 "description": "Response data." 409 "description": "Response data."
352 },
353 "columnHeader": {
354 "$ref": "ColumnHeader",
355 "description": "The column headers."
356 } 410 }
357 }, 411 },
358 "type": "object" 412 "type": "object"
359 }, 413 },
360 "PivotHeader": { 414 "PivotHeader": {
361 "description": "The headers for each of the pivot sections defined i n the request.", 415 "description": "The headers for each of the pivot sections defined i n the request.",
362 "id": "PivotHeader", 416 "id": "PivotHeader",
363 "properties": { 417 "properties": {
418 "totalPivotGroupsCount": {
419 "description": "The total number of groups for this pivot.",
420 "format": "int32",
421 "type": "integer"
422 },
364 "pivotHeaderEntries": { 423 "pivotHeaderEntries": {
365 "description": "A single pivot section header.", 424 "description": "A single pivot section header.",
366 "items": { 425 "items": {
367 "$ref": "PivotHeaderEntry" 426 "$ref": "PivotHeaderEntry"
368 }, 427 },
369 "type": "array" 428 "type": "array"
370 },
371 "totalPivotGroupsCount": {
372 "description": "The total number of groups for this pivot.",
373 "format": "int32",
374 "type": "integer"
375 } 429 }
376 }, 430 },
377 "type": "object" 431 "type": "object"
378 }, 432 },
379 "DateRange": { 433 "DateRange": {
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`.", 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`.",
381 "id": "DateRange", 435 "id": "DateRange",
382 "properties": { 436 "properties": {
437 "endDate": {
438 "description": "The end date for the query in the format `YY YY-MM-DD`.",
439 "type": "string"
440 },
383 "startDate": { 441 "startDate": {
384 "description": "The start date for the query in the format ` YYYY-MM-DD`.", 442 "description": "The start date for the query in the format ` YYYY-MM-DD`.",
385 "type": "string" 443 "type": "string"
444 }
445 },
446 "type": "object"
447 },
448 "MetricFilter": {
449 "description": "MetricFilter specifies the filter on a metric.",
450 "id": "MetricFilter",
451 "properties": {
452 "comparisonValue": {
453 "description": "The value to compare against.",
454 "type": "string"
386 }, 455 },
387 "endDate": { 456 "operator": {
388 "description": "The end date for the query in the format `YY YY-MM-DD`.", 457 "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." ,
458 "enum": [
459 "OPERATOR_UNSPECIFIED",
460 "EQUAL",
461 "LESS_THAN",
462 "GREATER_THAN",
463 "IS_MISSING"
464 ],
465 "enumDescriptions": [
466 "If the operator is not specified, it is treated as `EQU AL`.",
467 "Should the value of the metric be exactly equal to the comparison value.",
468 "Should the value of the metric be less than to the comp arison value.",
469 "Should the value of the metric be greater than to the c omparison value.",
470 "Validates if the metric is missing.\nDoesn't take compa risonValue into account."
471 ],
472 "type": "string"
473 },
474 "not": {
475 "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.",
476 "type": "boolean"
477 },
478 "metricName": {
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.",
389 "type": "string" 480 "type": "string"
390 } 481 }
391 }, 482 },
392 "type": "object" 483 "type": "object"
393 }, 484 },
394 "ReportRequest": { 485 "ReportRequest": {
395 "description": "The main request class which specifies the Reporting API request.", 486 "description": "The main request class which specifies the Reporting API request.",
396 "id": "ReportRequest", 487 "id": "ReportRequest",
397 "properties": { 488 "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": { 489 "metrics": {
411 "description": "The metrics requested.\nRequests must specif y at least one metric. Requests can have a\ntotal of 10 metrics.", 490 "description": "The metrics requested.\nRequests must specif y at least one metric. Requests can have a\ntotal of 10 metrics.",
412 "items": { 491 "items": {
413 "$ref": "Metric" 492 "$ref": "Metric"
414 }, 493 },
415 "type": "array" 494 "type": "array"
416 }, 495 },
417 "dimensionFilterClauses": { 496 "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.", 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.",
419 "items": { 498 "items": {
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
451 ], 530 ],
452 "type": "string" 531 "type": "string"
453 }, 532 },
454 "dimensions": { 533 "dimensions": {
455 "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.", 534 "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
456 "items": { 535 "items": {
457 "$ref": "Dimension" 536 "$ref": "Dimension"
458 }, 537 },
459 "type": "array" 538 "type": "array"
460 }, 539 },
461 "pageToken": {
462 "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.",
463 "type": "string"
464 },
465 "dateRanges": { 540 "dateRanges": {
466 "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.", 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.",
467 "items": { 542 "items": {
468 "$ref": "DateRange" 543 "$ref": "DateRange"
469 }, 544 },
470 "type": "array" 545 "type": "array"
471 }, 546 },
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 },
472 "pivots": { 551 "pivots": {
473 "description": "The pivot definitions. Requests can have a m aximum of 2 pivots.", 552 "description": "The pivot definitions. Requests can have a m aximum of 2 pivots.",
474 "items": { 553 "items": {
475 "$ref": "Pivot" 554 "$ref": "Pivot"
476 }, 555 },
477 "type": "array" 556 "type": "array"
478 }, 557 },
479 "includeEmptyRows": { 558 "includeEmptyRows": {
480 "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.", 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.",
481 "type": "boolean" 560 "type": "boolean"
482 }, 561 },
483 "metricFilterClauses": { 562 "metricFilterClauses": {
484 "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.", 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.",
485 "items": { 564 "items": {
486 "$ref": "MetricFilterClause" 565 "$ref": "MetricFilterClause"
487 }, 566 },
488 "type": "array" 567 "type": "array"
489 }, 568 },
490 "pageSize": { 569 "pageSize": {
491 "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.", 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.",
492 "format": "int32", 571 "format": "int32",
493 "type": "integer" 572 "type": "integer"
494 }, 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 },
495 "hideTotals": { 578 "hideTotals": {
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.", 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.",
497 "type": "boolean" 580 "type": "boolean"
498 }, 581 },
499 "hideValueRanges": { 582 "filtersExpression": {
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.", 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).",
501 "type": "boolean"
502 }
503 },
504 "type": "object"
505 },
506 "MetricFilter": {
507 "description": "MetricFilter specifies the filter on a metric.",
508 "id": "MetricFilter",
509 "properties": {
510 "operator": {
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." ,
512 "enum": [
513 "OPERATOR_UNSPECIFIED",
514 "EQUAL",
515 "LESS_THAN",
516 "GREATER_THAN",
517 "IS_MISSING"
518 ],
519 "enumDescriptions": [
520 "If the operator is not specified, it is treated as `EQU AL`.",
521 "Should the value of the metric be exactly equal to the comparison value.",
522 "Should the value of the metric be less than to the comp arison value.",
523 "Should the value of the metric be greater than to the c omparison value.",
524 "Validates if the metric is missing.\nDoesn't take compa risonValue into account."
525 ],
526 "type": "string" 584 "type": "string"
527 }, 585 },
528 "not": { 586 "cohortGroup": {
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.", 587 "$ref": "CohortGroup",
530 "type": "boolean" 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."
531 }, 589 },
532 "metricName": { 590 "viewId": {
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.", 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` .",
534 "type": "string"
535 },
536 "comparisonValue": {
537 "description": "The value to compare against.",
538 "type": "string" 592 "type": "string"
539 } 593 }
540 }, 594 },
541 "type": "object" 595 "type": "object"
542 }, 596 },
543 "Dimension": { 597 "Dimension": {
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.", 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.",
545 "id": "Dimension", 599 "id": "Dimension",
546 "properties": { 600 "properties": {
547 "histogramBuckets": { 601 "histogramBuckets": {
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.", 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.",
549 "items": { 603 "items": {
550 "format": "int64", 604 "format": "int64",
551 "type": "string" 605 "type": "string"
552 }, 606 },
553 "type": "array" 607 "type": "array"
554 }, 608 },
555 "name": { 609 "name": {
556 "description": "Name of the dimension to fetch, for example `ga:browser`.", 610 "description": "Name of the dimension to fetch, for example `ga:browser`.",
557 "type": "string" 611 "type": "string"
558 } 612 }
559 }, 613 },
560 "type": "object" 614 "type": "object"
561 },
562 "DynamicSegment": {
563 "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
564 "id": "DynamicSegment",
565 "properties": {
566 "sessionSegment": {
567 "$ref": "SegmentDefinition",
568 "description": "Session Segment to select sessions to includ e in the segment."
569 },
570 "name": {
571 "description": "The name of the dynamic segment.",
572 "type": "string"
573 },
574 "userSegment": {
575 "$ref": "SegmentDefinition",
576 "description": "User Segment to select users to include in t he segment."
577 }
578 },
579 "type": "object"
580 }, 615 },
581 "SimpleSegment": { 616 "SimpleSegment": {
582 "description": "A Simple segment conditions consist of one or more d imension/metric\nconditions that can be combined.", 617 "description": "A Simple segment conditions consist of one or more d imension/metric\nconditions that can be combined.",
583 "id": "SimpleSegment", 618 "id": "SimpleSegment",
584 "properties": { 619 "properties": {
585 "orFiltersForSegment": { 620 "orFiltersForSegment": {
586 "description": "A list of segment filters groups which are c ombined with logical `AND`\noperator.", 621 "description": "A list of segment filters groups which are c ombined with logical `AND`\noperator.",
587 "items": { 622 "items": {
588 "$ref": "OrFiltersForSegment" 623 "$ref": "OrFiltersForSegment"
589 }, 624 },
590 "type": "array" 625 "type": "array"
591 } 626 }
592 }, 627 },
593 "type": "object" 628 "type": "object"
594 }, 629 },
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 },
595 "ColumnHeader": { 649 "ColumnHeader": {
596 "description": "Column headers.", 650 "description": "Column headers.",
597 "id": "ColumnHeader", 651 "id": "ColumnHeader",
598 "properties": { 652 "properties": {
599 "dimensions": { 653 "dimensions": {
600 "description": "The dimension names in the response.", 654 "description": "The dimension names in the response.",
601 "items": { 655 "items": {
602 "type": "string" 656 "type": "string"
603 }, 657 },
604 "type": "array" 658 "type": "array"
605 }, 659 },
606 "metricHeader": { 660 "metricHeader": {
607 "$ref": "MetricHeader", 661 "$ref": "MetricHeader",
608 "description": "Metric headers for the metrics in the respon se." 662 "description": "Metric headers for the metrics in the respon se."
609 } 663 }
610 }, 664 },
611 "type": "object" 665 "type": "object"
612 }, 666 },
613 "SegmentFilterClause": { 667 "SegmentFilterClause": {
614 "description": "Filter Clause to be used in a segment definition, ca n be wither a metric or\na dimension filter.", 668 "description": "Filter Clause to be used in a segment definition, ca n be wither a metric or\na dimension filter.",
615 "id": "SegmentFilterClause", 669 "id": "SegmentFilterClause",
616 "properties": { 670 "properties": {
617 "metricFilter": {
618 "$ref": "SegmentMetricFilter",
619 "description": "Metric Filter for the segment definition."
620 },
621 "not": { 671 "not": {
622 "description": "Matches the complement (`!`) of the filter." , 672 "description": "Matches the complement (`!`) of the filter." ,
623 "type": "boolean" 673 "type": "boolean"
624 }, 674 },
625 "dimensionFilter": { 675 "dimensionFilter": {
626 "$ref": "SegmentDimensionFilter", 676 "$ref": "SegmentDimensionFilter",
627 "description": "Dimension Filter for the segment definition. " 677 "description": "Dimension Filter for the segment definition. "
678 },
679 "metricFilter": {
680 "$ref": "SegmentMetricFilter",
681 "description": "Metric Filter for the segment definition."
628 } 682 }
629 }, 683 },
630 "type": "object" 684 "type": "object"
631 }, 685 },
632 "MetricFilterClause": { 686 "ReportRow": {
633 "description": "Represents a group of metric filters.\nSet the opera tor value to specify how the filters are logically combined.", 687 "description": "A row in the report.",
634 "id": "MetricFilterClause", 688 "id": "ReportRow",
635 "properties": { 689 "properties": {
636 "filters": { 690 "metrics": {
637 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.", 691 "description": "List of metrics for each requested DateRange .",
638 "items": { 692 "items": {
639 "$ref": "MetricFilter" 693 "$ref": "DateRangeValues"
640 }, 694 },
641 "type": "array" 695 "type": "array"
642 }, 696 },
643 "operator": { 697 "dimensions": {
644 "description": "The operator for combining multiple metric f ilters. If unspecified, it is\ntreated as an `OR`.", 698 "description": "List of requested dimensions.",
645 "enum": [ 699 "items": {
646 "OPERATOR_UNSPECIFIED", 700 "type": "string"
647 "OR", 701 },
648 "AND" 702 "type": "array"
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 } 703 }
657 }, 704 },
658 "type": "object" 705 "type": "object"
659 }, 706 },
660 "Cohort": { 707 "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.", 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.",
662 "id": "Cohort", 709 "id": "Cohort",
663 "properties": { 710 "properties": {
664 "dateRange": {
665 "$ref": "DateRange",
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."
667 },
668 "name": {
669 "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
670 "type": "string"
671 },
672 "type": { 711 "type": {
673 "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.", 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.",
674 "enum": [ 713 "enum": [
675 "UNSPECIFIED_COHORT_TYPE", 714 "UNSPECIFIED_COHORT_TYPE",
676 "FIRST_VISIT_DATE" 715 "FIRST_VISIT_DATE"
677 ], 716 ],
678 "enumDescriptions": [ 717 "enumDescriptions": [
679 "If unspecified it's treated as `FIRST_VISIT_DATE`.", 718 "If unspecified it's treated as `FIRST_VISIT_DATE`.",
680 "Cohorts that are selected based on first visit date." 719 "Cohorts that are selected based on first visit date."
681 ], 720 ],
682 "type": "string" 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"
683 } 758 }
684 }, 759 },
685 "type": "object" 760 "type": "object"
686 },
687 "ReportRow": {
688 "description": "A row in the report.",
689 "id": "ReportRow",
690 "properties": {
691 "metrics": {
692 "description": "List of metrics for each requested DateRange .",
693 "items": {
694 "$ref": "DateRangeValues"
695 },
696 "type": "array"
697 },
698 "dimensions": {
699 "description": "List of requested dimensions.",
700 "items": {
701 "type": "string"
702 },
703 "type": "array"
704 }
705 },
706 "type": "object"
707 }, 761 },
708 "OrFiltersForSegment": { 762 "OrFiltersForSegment": {
709 "description": "A list of segment filters in the `OR` group are comb ined with the logical OR\noperator.", 763 "description": "A list of segment filters in the `OR` group are comb ined with the logical OR\noperator.",
710 "id": "OrFiltersForSegment", 764 "id": "OrFiltersForSegment",
711 "properties": { 765 "properties": {
712 "segmentFilterClauses": { 766 "segmentFilterClauses": {
713 "description": "List of segment filters to be combined with a `OR` operator.", 767 "description": "List of segment filters to be combined with a `OR` operator.",
714 "items": { 768 "items": {
715 "$ref": "SegmentFilterClause" 769 "$ref": "SegmentFilterClause"
716 }, 770 },
717 "type": "array" 771 "type": "array"
718 } 772 }
719 }, 773 },
720 "type": "object" 774 "type": "object"
721 }, 775 },
722 "MetricHeader": { 776 "MetricHeader": {
723 "description": "The headers for the metrics.", 777 "description": "The headers for the metrics.",
724 "id": "MetricHeader", 778 "id": "MetricHeader",
725 "properties": { 779 "properties": {
780 "pivotHeaders": {
781 "description": "Headers for the pivots in the response.",
782 "items": {
783 "$ref": "PivotHeader"
784 },
785 "type": "array"
786 },
726 "metricHeaderEntries": { 787 "metricHeaderEntries": {
727 "description": "Headers for the metrics in the response.", 788 "description": "Headers for the metrics in the response.",
728 "items": { 789 "items": {
729 "$ref": "MetricHeaderEntry" 790 "$ref": "MetricHeaderEntry"
730 }, 791 },
731 "type": "array" 792 "type": "array"
732 },
733 "pivotHeaders": {
734 "description": "Headers for the pivots in the response.",
735 "items": {
736 "$ref": "PivotHeader"
737 },
738 "type": "array"
739 } 793 }
740 }, 794 },
741 "type": "object" 795 "type": "object"
742 }, 796 },
743 "DimensionFilterClause": { 797 "DimensionFilterClause": {
744 "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.", 798 "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
745 "id": "DimensionFilterClause", 799 "id": "DimensionFilterClause",
746 "properties": { 800 "properties": {
747 "filters": { 801 "filters": {
748 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.", 802 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.",
(...skipping 30 matching lines...) Expand all
779 }, 833 },
780 "type": "array" 834 "type": "array"
781 } 835 }
782 }, 836 },
783 "type": "object" 837 "type": "object"
784 }, 838 },
785 "SequenceSegment": { 839 "SequenceSegment": {
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.", 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.",
787 "id": "SequenceSegment", 841 "id": "SequenceSegment",
788 "properties": { 842 "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 },
793 "segmentSequenceSteps": { 843 "segmentSequenceSteps": {
794 "description": "The list of steps in the sequence.", 844 "description": "The list of steps in the sequence.",
795 "items": { 845 "items": {
796 "$ref": "SegmentSequenceStep" 846 "$ref": "SegmentSequenceStep"
797 }, 847 },
798 "type": "array" 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"
799 } 853 }
800 }, 854 },
801 "type": "object" 855 "type": "object"
802 }, 856 },
803 "SegmentMetricFilter": { 857 "SegmentMetricFilter": {
804 "description": "Metric filter to be used in a segment filter clause. ", 858 "description": "Metric filter to be used in a segment filter clause. ",
805 "id": "SegmentMetricFilter", 859 "id": "SegmentMetricFilter",
806 "properties": { 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 },
807 "operator": { 869 "operator": {
808 "description": "Specifies is the operation to perform to com pare the metric. The default\nis `EQUAL`.", 870 "description": "Specifies is the operation to perform to com pare the metric. The default\nis `EQUAL`.",
809 "enum": [ 871 "enum": [
810 "UNSPECIFIED_OPERATOR", 872 "UNSPECIFIED_OPERATOR",
811 "LESS_THAN", 873 "LESS_THAN",
812 "GREATER_THAN", 874 "GREATER_THAN",
813 "EQUAL", 875 "EQUAL",
814 "BETWEEN" 876 "BETWEEN"
815 ], 877 ],
816 "enumDescriptions": [ 878 "enumDescriptions": [
(...skipping 19 matching lines...) Expand all
836 "USER" 898 "USER"
837 ], 899 ],
838 "enumDescriptions": [ 900 "enumDescriptions": [
839 "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.", 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.",
840 "Product scope.", 902 "Product scope.",
841 "Hit scope.", 903 "Hit scope.",
842 "Session scope.", 904 "Session scope.",
843 "User scope." 905 "User scope."
844 ], 906 ],
845 "type": "string" 907 "type": "string"
846 },
847 "maxComparisonValue": {
848 "description": "Max comparison value is only used for `BETWE EN` operator.",
849 "type": "string"
850 },
851 "comparisonValue": {
852 "description": "The value to compare against. If the operato r is `BETWEEN`, this value is\ntreated as minimum comparison value.",
853 "type": "string"
854 } 908 }
855 }, 909 },
856 "type": "object" 910 "type": "object"
857 }, 911 },
858 "DateRangeValues": { 912 "DateRangeValues": {
859 "description": "Used to return a list of metrics for a single DateRa nge / dimension\ncombination", 913 "description": "Used to return a list of metrics for a single DateRa nge / dimension\ncombination",
860 "id": "DateRangeValues", 914 "id": "DateRangeValues",
861 "properties": { 915 "properties": {
862 "values": { 916 "values": {
863 "description": "Each value corresponds to each Metric in the request.", 917 "description": "Each value corresponds to each Metric in the request.",
(...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after
905 }, 959 },
906 "type": "array" 960 "type": "array"
907 } 961 }
908 }, 962 },
909 "type": "object" 963 "type": "object"
910 }, 964 },
911 "Pivot": { 965 "Pivot": {
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.", 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.",
913 "id": "Pivot", 967 "id": "Pivot",
914 "properties": { 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 },
915 "startGroup": { 974 "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.", 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.",
917 "format": "int32", 976 "format": "int32",
918 "type": "integer" 977 "type": "integer"
919 }, 978 },
920 "metrics": { 979 "metrics": {
921 "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.", 980 "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
922 "items": { 981 "items": {
923 "$ref": "Metric" 982 "$ref": "Metric"
924 }, 983 },
925 "type": "array" 984 "type": "array"
926 }, 985 },
927 "dimensionFilterClauses": { 986 "dimensionFilterClauses": {
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.", 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.",
929 "items": { 988 "items": {
930 "$ref": "DimensionFilterClause" 989 "$ref": "DimensionFilterClause"
931 }, 990 },
932 "type": "array" 991 "type": "array"
933 }, 992 },
934 "dimensions": { 993 "dimensions": {
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.", 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.",
936 "items": { 995 "items": {
937 "$ref": "Dimension" 996 "$ref": "Dimension"
938 }, 997 },
939 "type": "array" 998 "type": "array"
940 },
941 "maxGroupCount": {
942 "description": "Specifies the maximum number of groups to re turn.\nThe default value is 10, also the maximum value is 1,000.",
943 "format": "int32",
944 "type": "integer"
945 } 999 }
946 }, 1000 },
947 "type": "object" 1001 "type": "object"
948 }, 1002 },
949 "PivotHeaderEntry": { 1003 "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.", 1004 "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", 1005 "id": "PivotHeaderEntry",
952 "properties": { 1006 "properties": {
953 "dimensionValues": { 1007 "dimensionValues": {
954 "description": "The values for the dimensions in the pivot." , 1008 "description": "The values for the dimensions in the pivot." ,
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after
1032 ], 1086 ],
1033 "type": "string" 1087 "type": "string"
1034 } 1088 }
1035 }, 1089 },
1036 "type": "object" 1090 "type": "object"
1037 }, 1091 },
1038 "ReportData": { 1092 "ReportData": {
1039 "description": "The data part of the report.", 1093 "description": "The data part of the report.",
1040 "id": "ReportData", 1094 "id": "ReportData",
1041 "properties": { 1095 "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": { 1096 "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.", 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.",
1074 "type": "boolean" 1098 "type": "boolean"
1075 }, 1099 },
1076 "rows": { 1100 "rows": {
1077 "description": "There's one ReportRow for every unique combi nation of dimensions.", 1101 "description": "There's one ReportRow for every unique combi nation of dimensions.",
1078 "items": { 1102 "items": {
1079 "$ref": "ReportRow" 1103 "$ref": "ReportRow"
1080 }, 1104 },
1081 "type": "array" 1105 "type": "array"
1082 }, 1106 },
1083 "rowCount": { 1107 "rowCount": {
1084 "description": "Total number of matching rows for this query .", 1108 "description": "Total number of matching rows for this query .",
1085 "format": "int32", 1109 "format": "int32",
1086 "type": "integer" 1110 "type": "integer"
1087 }, 1111 },
1088 "dataLastRefreshed": { 1112 "dataLastRefreshed": {
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.", 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.",
1090 "format": "google-datetime", 1114 "format": "google-datetime",
1091 "type": "string" 1115 "type": "string"
1092 }, 1116 },
1093 "maximums": { 1117 "maximums": {
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.", 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.",
1095 "items": { 1119 "items": {
1096 "$ref": "DateRangeValues" 1120 "$ref": "DateRangeValues"
1097 }, 1121 },
1098 "type": "array" 1122 "type": "array"
1123 },
1124 "samplingSpaceSizes": {
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.",
1126 "items": {
1127 "format": "int64",
1128 "type": "string"
1129 },
1130 "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"
1099 } 1153 }
1100 }, 1154 },
1101 "type": "object" 1155 "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 }
OLDNEW
« no previous file with comments | « discovery/googleapis/analytics__v3.json ('k') | discovery/googleapis/androiddeviceprovisioning__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698