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 "oauth_token": { | |
32 "description": "OAuth 2.0 token for the current user.", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "bearer_token": { | |
37 "description": "OAuth bearer token.", | |
38 "location": "query", | |
39 "type": "string" | |
40 }, | |
41 "upload_protocol": { | 31 "upload_protocol": { |
42 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
43 "location": "query", | 33 "location": "query", |
44 "type": "string" | 34 "type": "string" |
45 }, | 35 }, |
46 "prettyPrint": { | 36 "prettyPrint": { |
47 "default": "true", | 37 "default": "true", |
48 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
49 "location": "query", | 39 "location": "query", |
50 "type": "boolean" | 40 "type": "boolean" |
51 }, | 41 }, |
| 42 "fields": { |
| 43 "description": "Selector specifying which fields to include in a par
tial response.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
52 "uploadType": { | 47 "uploadType": { |
53 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 48 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
54 "location": "query", | 49 "location": "query", |
55 "type": "string" | 50 "type": "string" |
56 }, | 51 }, |
57 "fields": { | |
58 "description": "Selector specifying which fields to include in a par
tial response.", | |
59 "location": "query", | |
60 "type": "string" | |
61 }, | |
62 "$.xgafv": { | 52 "$.xgafv": { |
63 "description": "V1 error format.", | 53 "description": "V1 error format.", |
64 "enum": [ | 54 "enum": [ |
65 "1", | 55 "1", |
66 "2" | 56 "2" |
67 ], | 57 ], |
68 "enumDescriptions": [ | 58 "enumDescriptions": [ |
69 "v1 error format", | 59 "v1 error format", |
70 "v2 error format" | 60 "v2 error format" |
71 ], | 61 ], |
(...skipping 14 matching lines...) Expand all Loading... |
86 "proto" | 76 "proto" |
87 ], | 77 ], |
88 "enumDescriptions": [ | 78 "enumDescriptions": [ |
89 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
90 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
91 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
92 ], | 82 ], |
93 "location": "query", | 83 "location": "query", |
94 "type": "string" | 84 "type": "string" |
95 }, | 85 }, |
| 86 "access_token": { |
| 87 "description": "OAuth access token.", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
96 "key": { | 91 "key": { |
97 "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.", | 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.", |
98 "location": "query", | 93 "location": "query", |
99 "type": "string" | 94 "type": "string" |
100 }, | 95 }, |
101 "access_token": { | |
102 "description": "OAuth access token.", | |
103 "location": "query", | |
104 "type": "string" | |
105 }, | |
106 "quotaUser": { | 96 "quotaUser": { |
107 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 97 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
108 "location": "query", | 98 "location": "query", |
109 "type": "string" | 99 "type": "string" |
110 }, | 100 }, |
111 "pp": { | 101 "pp": { |
112 "default": "true", | 102 "default": "true", |
113 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
114 "location": "query", | 104 "location": "query", |
115 "type": "boolean" | 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 112 "bearer_token": { |
| 113 "description": "OAuth bearer token.", |
| 114 "location": "query", |
| 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "reports": { | 120 "reports": { |
121 "methods": { | 121 "methods": { |
122 "batchGet": { | 122 "batchGet": { |
123 "description": "Returns the Analytics data.", | 123 "description": "Returns the Analytics data.", |
124 "httpMethod": "POST", | 124 "httpMethod": "POST", |
125 "id": "analyticsreporting.reports.batchGet", | 125 "id": "analyticsreporting.reports.batchGet", |
126 "parameterOrder": [], | 126 "parameterOrder": [], |
127 "parameters": {}, | 127 "parameters": {}, |
128 "path": "v4/reports:batchGet", | 128 "path": "v4/reports:batchGet", |
129 "request": { | 129 "request": { |
130 "$ref": "GetReportsRequest" | 130 "$ref": "GetReportsRequest" |
131 }, | 131 }, |
132 "response": { | 132 "response": { |
133 "$ref": "GetReportsResponse" | 133 "$ref": "GetReportsResponse" |
134 }, | 134 }, |
135 "scopes": [ | 135 "scopes": [ |
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": "20161129", | 143 "revision": "20170213", |
144 "rootUrl": "https://analyticsreporting.googleapis.com/", | 144 "rootUrl": "https://analyticsreporting.googleapis.com/", |
145 "schemas": { | 145 "schemas": { |
146 "OrFiltersForSegment": { | |
147 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", | |
148 "id": "OrFiltersForSegment", | |
149 "properties": { | |
150 "segmentFilterClauses": { | |
151 "description": "List of segment filters to be combined with
a `OR` operator.", | |
152 "items": { | |
153 "$ref": "SegmentFilterClause" | |
154 }, | |
155 "type": "array" | |
156 } | |
157 }, | |
158 "type": "object" | |
159 }, | |
160 "MetricHeader": { | |
161 "description": "The headers for the metrics.", | |
162 "id": "MetricHeader", | |
163 "properties": { | |
164 "pivotHeaders": { | |
165 "description": "Headers for the pivots in the response.", | |
166 "items": { | |
167 "$ref": "PivotHeader" | |
168 }, | |
169 "type": "array" | |
170 }, | |
171 "metricHeaderEntries": { | |
172 "description": "Headers for the metrics in the response.", | |
173 "items": { | |
174 "$ref": "MetricHeaderEntry" | |
175 }, | |
176 "type": "array" | |
177 } | |
178 }, | |
179 "type": "object" | |
180 }, | |
181 "DimensionFilterClause": { | 146 "DimensionFilterClause": { |
182 "description": "A group of dimension filters. Set the operator value
to specify how\nthe filters are logically combined.", | 147 "description": "A group of dimension filters. Set the operator value
to specify how\nthe filters are logically combined.", |
183 "id": "DimensionFilterClause", | 148 "id": "DimensionFilterClause", |
184 "properties": { | 149 "properties": { |
185 "operator": { | 150 "operator": { |
186 "description": "The operator for combining multiple dimensio
n filters. If unspecified, it\nis treated as an `OR`.", | 151 "description": "The operator for combining multiple dimensio
n filters. If unspecified, it\nis treated as an `OR`.", |
187 "enum": [ | 152 "enum": [ |
188 "OPERATOR_UNSPECIFIED", | 153 "OPERATOR_UNSPECIFIED", |
189 "OR", | 154 "OR", |
190 "AND" | 155 "AND" |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
235 "description": "If set, first step condition must match the
first hit of the visitor (in\nthe date range).", | 200 "description": "If set, first step condition must match the
first hit of the visitor (in\nthe date range).", |
236 "type": "boolean" | 201 "type": "boolean" |
237 } | 202 } |
238 }, | 203 }, |
239 "type": "object" | 204 "type": "object" |
240 }, | 205 }, |
241 "SegmentMetricFilter": { | 206 "SegmentMetricFilter": { |
242 "description": "Metric filter to be used in a segment filter clause.
", | 207 "description": "Metric filter to be used in a segment filter clause.
", |
243 "id": "SegmentMetricFilter", | 208 "id": "SegmentMetricFilter", |
244 "properties": { | 209 "properties": { |
245 "metricName": { | |
246 "description": "The metric that will be filtered on. A `metr
icFilter` must contain a\nmetric name.", | |
247 "type": "string" | |
248 }, | |
249 "scope": { | 210 "scope": { |
250 "description": "Scope for a metric defines the level at whic
h that metric is defined. The\nspecified metric scope must be equal to or great
er than its primary scope\nas defined in the data model. The primary scope is de
fined by if the\nsegment is selecting users or sessions.", | 211 "description": "Scope for a metric defines the level at whic
h that metric is defined. The\nspecified metric scope must be equal to or great
er than its primary scope\nas defined in the data model. The primary scope is de
fined by if the\nsegment is selecting users or sessions.", |
251 "enum": [ | 212 "enum": [ |
252 "UNSPECIFIED_SCOPE", | 213 "UNSPECIFIED_SCOPE", |
253 "PRODUCT", | 214 "PRODUCT", |
254 "HIT", | 215 "HIT", |
255 "SESSION", | 216 "SESSION", |
256 "USER" | 217 "USER" |
257 ], | 218 ], |
258 "enumDescriptions": [ | 219 "enumDescriptions": [ |
(...skipping 23 matching lines...) Expand all Loading... |
282 "BETWEEN" | 243 "BETWEEN" |
283 ], | 244 ], |
284 "enumDescriptions": [ | 245 "enumDescriptions": [ |
285 "Unspecified operator is treated as `LESS_THAN` operator
.", | 246 "Unspecified operator is treated as `LESS_THAN` operator
.", |
286 "Checks if the metric value is less than comparison valu
e.", | 247 "Checks if the metric value is less than comparison valu
e.", |
287 "Checks if the metric value is greater than comparison v
alue.", | 248 "Checks if the metric value is greater than comparison v
alue.", |
288 "Equals operator.", | 249 "Equals operator.", |
289 "For between operator, both the minimum and maximum are
exclusive.\nWe will use `LT` and `GT` for comparison." | 250 "For between operator, both the minimum and maximum are
exclusive.\nWe will use `LT` and `GT` for comparison." |
290 ], | 251 ], |
291 "type": "string" | 252 "type": "string" |
| 253 }, |
| 254 "metricName": { |
| 255 "description": "The metric that will be filtered on. A `metr
icFilter` must contain a\nmetric name.", |
| 256 "type": "string" |
292 } | 257 } |
293 }, | 258 }, |
294 "type": "object" | 259 "type": "object" |
295 }, | 260 }, |
296 "DateRangeValues": { | 261 "DateRangeValues": { |
297 "description": "Used to return a list of metrics for a single DateRa
nge / dimension\ncombination", | 262 "description": "Used to return a list of metrics for a single DateRa
nge / dimension\ncombination", |
298 "id": "DateRangeValues", | 263 "id": "DateRangeValues", |
299 "properties": { | 264 "properties": { |
300 "values": { | 265 "values": { |
301 "description": "Each value corresponds to each Metric in the
request.", | 266 "description": "Each value corresponds to each Metric in the
request.", |
(...skipping 137 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
439 }, | 404 }, |
440 "type": "array" | 405 "type": "array" |
441 } | 406 } |
442 }, | 407 }, |
443 "type": "object" | 408 "type": "object" |
444 }, | 409 }, |
445 "MetricHeaderEntry": { | 410 "MetricHeaderEntry": { |
446 "description": "Header for the metrics.", | 411 "description": "Header for the metrics.", |
447 "id": "MetricHeaderEntry", | 412 "id": "MetricHeaderEntry", |
448 "properties": { | 413 "properties": { |
449 "name": { | |
450 "description": "The name of the header.", | |
451 "type": "string" | |
452 }, | |
453 "type": { | 414 "type": { |
454 "description": "The type of the metric, for example `INTEGER
`.", | 415 "description": "The type of the metric, for example `INTEGER
`.", |
455 "enum": [ | 416 "enum": [ |
456 "METRIC_TYPE_UNSPECIFIED", | 417 "METRIC_TYPE_UNSPECIFIED", |
457 "INTEGER", | 418 "INTEGER", |
458 "FLOAT", | 419 "FLOAT", |
459 "CURRENCY", | 420 "CURRENCY", |
460 "PERCENT", | 421 "PERCENT", |
461 "TIME" | 422 "TIME" |
462 ], | 423 ], |
463 "enumDescriptions": [ | 424 "enumDescriptions": [ |
464 "Metric type is unspecified.", | 425 "Metric type is unspecified.", |
465 "Integer metric.", | 426 "Integer metric.", |
466 "Float metric.", | 427 "Float metric.", |
467 "Currency metric.", | 428 "Currency metric.", |
468 "Percentage metric.", | 429 "Percentage metric.", |
469 "Time metric in `HH:MM:SS` format." | 430 "Time metric in `HH:MM:SS` format." |
470 ], | 431 ], |
471 "type": "string" | 432 "type": "string" |
| 433 }, |
| 434 "name": { |
| 435 "description": "The name of the header.", |
| 436 "type": "string" |
472 } | 437 } |
473 }, | 438 }, |
474 "type": "object" | 439 "type": "object" |
475 }, | 440 }, |
476 "ReportData": { | 441 "ReportData": { |
477 "description": "The data part of the report.", | 442 "description": "The data part of the report.", |
478 "id": "ReportData", | 443 "id": "ReportData", |
479 "properties": { | 444 "properties": { |
480 "samplingSpaceSizes": { | 445 "samplingSpaceSizes": { |
481 "description": "If the results are\n[sampled](https://suppor
t.google.com/analytics/answer/2637192),\nthis returns the total number of\nsampl
es present, one entry per date range. If the results are not sampled\nthis field
will not be defined. See\n[developer guide](/analytics/devguides/reporting/core
/v4/basics#sampling)\nfor details.", | 446 "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.", |
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
535 }, | 500 }, |
536 "type": "array" | 501 "type": "array" |
537 } | 502 } |
538 }, | 503 }, |
539 "type": "object" | 504 "type": "object" |
540 }, | 505 }, |
541 "DimensionFilter": { | 506 "DimensionFilter": { |
542 "description": "Dimension filter specifies the filtering options on
a dimension.", | 507 "description": "Dimension filter specifies the filtering options on
a dimension.", |
543 "id": "DimensionFilter", | 508 "id": "DimensionFilter", |
544 "properties": { | 509 "properties": { |
545 "not": { | |
546 "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.", | |
547 "type": "boolean" | |
548 }, | |
549 "expressions": { | |
550 "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.", | |
551 "items": { | |
552 "type": "string" | |
553 }, | |
554 "type": "array" | |
555 }, | |
556 "caseSensitive": { | 510 "caseSensitive": { |
557 "description": "Should the match be case sensitive? Default
is false.", | 511 "description": "Should the match be case sensitive? Default
is false.", |
558 "type": "boolean" | 512 "type": "boolean" |
559 }, | 513 }, |
560 "dimensionName": { | 514 "dimensionName": { |
561 "description": "The dimension to filter on. A DimensionFilte
r must contain a dimension.", | 515 "description": "The dimension to filter on. A DimensionFilte
r must contain a dimension.", |
562 "type": "string" | 516 "type": "string" |
563 }, | 517 }, |
564 "operator": { | 518 "operator": { |
565 "description": "How to match the dimension to the expression
. The default is REGEXP.", | 519 "description": "How to match the dimension to the expression
. The default is REGEXP.", |
(...skipping 15 matching lines...) Expand all Loading... |
581 "Matches the value which begin with the match expression
provided.", | 535 "Matches the value which begin with the match expression
provided.", |
582 "Matches the values which end with the match expression
provided.", | 536 "Matches the values which end with the match expression
provided.", |
583 "Substring match.", | 537 "Substring match.", |
584 "The value should match the match expression entirely.", | 538 "The value should match the match expression entirely.", |
585 "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.", | 539 "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.", |
586 "Checks if the dimension is numerically greater than the
match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions."
, | 540 "Checks if the dimension is numerically greater than the
match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions."
, |
587 "Checks if the dimension is numerically less than the ma
tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.", | 541 "Checks if the dimension is numerically less than the ma
tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.", |
588 "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." | 542 "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." |
589 ], | 543 ], |
590 "type": "string" | 544 "type": "string" |
| 545 }, |
| 546 "not": { |
| 547 "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.", |
| 548 "type": "boolean" |
| 549 }, |
| 550 "expressions": { |
| 551 "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.", |
| 552 "items": { |
| 553 "type": "string" |
| 554 }, |
| 555 "type": "array" |
| 556 } |
| 557 }, |
| 558 "type": "object" |
| 559 }, |
| 560 "Segment": { |
| 561 "description": "The segment definition, if the report needs to be se
gmented.\nA Segment is a subset of the Analytics data. For example, of the entir
e\nset of users, one Segment might be users from a particular country or city.", |
| 562 "id": "Segment", |
| 563 "properties": { |
| 564 "dynamicSegment": { |
| 565 "$ref": "DynamicSegment", |
| 566 "description": "A dynamic segment definition in the request.
" |
| 567 }, |
| 568 "segmentId": { |
| 569 "description": "The segment ID of a built-in or custom segme
nt, for example `gaid::-3`.", |
| 570 "type": "string" |
591 } | 571 } |
592 }, | 572 }, |
593 "type": "object" | 573 "type": "object" |
594 }, | 574 }, |
595 "SegmentDimensionFilter": { | 575 "SegmentDimensionFilter": { |
596 "description": "Dimension filter specifies the filtering options on
a dimension.", | 576 "description": "Dimension filter specifies the filtering options on
a dimension.", |
597 "id": "SegmentDimensionFilter", | 577 "id": "SegmentDimensionFilter", |
598 "properties": { | 578 "properties": { |
599 "minComparisonValue": { | 579 "minComparisonValue": { |
600 "description": "Minimum comparison values for `BETWEEN` matc
h type.", | 580 "description": "Minimum comparison values for `BETWEEN` matc
h type.", |
(...skipping 87 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
688 "enumDescriptions": [ | 668 "enumDescriptions": [ |
689 "If the sort order is unspecified, the default is ascend
ing.", | 669 "If the sort order is unspecified, the default is ascend
ing.", |
690 "Ascending sort. The field will be sorted in an ascendin
g manner.", | 670 "Ascending sort. The field will be sorted in an ascendin
g manner.", |
691 "Descending sort. The field will be sorted in a descendi
ng manner." | 671 "Descending sort. The field will be sorted in a descendi
ng manner." |
692 ], | 672 ], |
693 "type": "string" | 673 "type": "string" |
694 } | 674 } |
695 }, | 675 }, |
696 "type": "object" | 676 "type": "object" |
697 }, | 677 }, |
698 "Segment": { | |
699 "description": "The segment definition, if the report needs to be se
gmented.\nA Segment is a subset of the Analytics data. For example, of the entir
e\nset of users, one Segment might be users from a particular country or city.", | |
700 "id": "Segment", | |
701 "properties": { | |
702 "dynamicSegment": { | |
703 "$ref": "DynamicSegment", | |
704 "description": "A dynamic segment definition in the request.
" | |
705 }, | |
706 "segmentId": { | |
707 "description": "The segment ID of a built-in or custom segme
nt, for example `gaid::-3`.", | |
708 "type": "string" | |
709 } | |
710 }, | |
711 "type": "object" | |
712 }, | |
713 "SegmentSequenceStep": { | 678 "SegmentSequenceStep": { |
714 "description": "A segment sequence definition.", | 679 "description": "A segment sequence definition.", |
715 "id": "SegmentSequenceStep", | 680 "id": "SegmentSequenceStep", |
716 "properties": { | 681 "properties": { |
717 "orFiltersForSegment": { | |
718 "description": "A sequence is specified with a list of Or gr
ouped filters which are\ncombined with `AND` operator.", | |
719 "items": { | |
720 "$ref": "OrFiltersForSegment" | |
721 }, | |
722 "type": "array" | |
723 }, | |
724 "matchType": { | 682 "matchType": { |
725 "description": "Specifies if the step immediately precedes o
r can be any time before the\nnext step.", | 683 "description": "Specifies if the step immediately precedes o
r can be any time before the\nnext step.", |
726 "enum": [ | 684 "enum": [ |
727 "UNSPECIFIED_MATCH_TYPE", | 685 "UNSPECIFIED_MATCH_TYPE", |
728 "PRECEDES", | 686 "PRECEDES", |
729 "IMMEDIATELY_PRECEDES" | 687 "IMMEDIATELY_PRECEDES" |
730 ], | 688 ], |
731 "enumDescriptions": [ | 689 "enumDescriptions": [ |
732 "Unspecified match type is treated as precedes.", | 690 "Unspecified match type is treated as precedes.", |
733 "Operator indicates that the previous step precedes the
next step.", | 691 "Operator indicates that the previous step precedes the
next step.", |
734 "Operator indicates that the previous step immediately p
recedes the next\nstep." | 692 "Operator indicates that the previous step immediately p
recedes the next\nstep." |
735 ], | 693 ], |
736 "type": "string" | 694 "type": "string" |
| 695 }, |
| 696 "orFiltersForSegment": { |
| 697 "description": "A sequence is specified with a list of Or gr
ouped filters which are\ncombined with `AND` operator.", |
| 698 "items": { |
| 699 "$ref": "OrFiltersForSegment" |
| 700 }, |
| 701 "type": "array" |
737 } | 702 } |
738 }, | 703 }, |
739 "type": "object" | 704 "type": "object" |
740 }, | 705 }, |
741 "Metric": { | 706 "Metric": { |
742 "description": "[Metrics](https://support.google.com/analytics/answe
r/1033861)\nare the quantitative measurements. For example, the metric `ga:users
`\nindicates the total number of users for the requested time period.", | 707 "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.", |
743 "id": "Metric", | 708 "id": "Metric", |
744 "properties": { | 709 "properties": { |
745 "alias": { | 710 "alias": { |
746 "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.", | 711 "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.", |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
784 }, | 749 }, |
785 "type": "array" | 750 "type": "array" |
786 } | 751 } |
787 }, | 752 }, |
788 "type": "object" | 753 "type": "object" |
789 }, | 754 }, |
790 "Report": { | 755 "Report": { |
791 "description": "The data response corresponding to the request.", | 756 "description": "The data response corresponding to the request.", |
792 "id": "Report", | 757 "id": "Report", |
793 "properties": { | 758 "properties": { |
794 "columnHeader": { | |
795 "$ref": "ColumnHeader", | |
796 "description": "The column headers." | |
797 }, | |
798 "data": { | 759 "data": { |
799 "$ref": "ReportData", | 760 "$ref": "ReportData", |
800 "description": "Response data." | 761 "description": "Response data." |
801 }, | 762 }, |
802 "nextPageToken": { | 763 "nextPageToken": { |
803 "description": "Page token to retrieve the next page of resu
lts in the list.", | 764 "description": "Page token to retrieve the next page of resu
lts in the list.", |
804 "type": "string" | 765 "type": "string" |
| 766 }, |
| 767 "columnHeader": { |
| 768 "$ref": "ColumnHeader", |
| 769 "description": "The column headers." |
805 } | 770 } |
806 }, | 771 }, |
807 "type": "object" | 772 "type": "object" |
808 }, | 773 }, |
809 "PivotHeader": { | 774 "PivotHeader": { |
810 "description": "The headers for each of the pivot sections defined i
n the request.", | 775 "description": "The headers for each of the pivot sections defined i
n the request.", |
811 "id": "PivotHeader", | 776 "id": "PivotHeader", |
812 "properties": { | 777 "properties": { |
813 "pivotHeaderEntries": { | 778 "pivotHeaderEntries": { |
814 "description": "A single pivot section header.", | 779 "description": "A single pivot section header.", |
815 "items": { | 780 "items": { |
816 "$ref": "PivotHeaderEntry" | 781 "$ref": "PivotHeaderEntry" |
817 }, | 782 }, |
818 "type": "array" | 783 "type": "array" |
819 }, | 784 }, |
820 "totalPivotGroupsCount": { | 785 "totalPivotGroupsCount": { |
821 "description": "The total number of groups for this pivot.", | 786 "description": "The total number of groups for this pivot.", |
822 "format": "int32", | 787 "format": "int32", |
823 "type": "integer" | 788 "type": "integer" |
824 } | 789 } |
825 }, | 790 }, |
826 "type": "object" | 791 "type": "object" |
827 }, | 792 }, |
828 "DateRange": { | 793 "DateRange": { |
829 "description": "A contiguous set of days: startDate, startDate + 1 d
ay, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://e
n.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.", | 794 "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`.", |
830 "id": "DateRange", | 795 "id": "DateRange", |
831 "properties": { | 796 "properties": { |
| 797 "startDate": { |
| 798 "description": "The start date for the query in the format `
YYYY-MM-DD`.", |
| 799 "type": "string" |
| 800 }, |
832 "endDate": { | 801 "endDate": { |
833 "description": "The end date for the query in the format `YY
YY-MM-DD`.", | 802 "description": "The end date for the query in the format `YY
YY-MM-DD`.", |
834 "type": "string" | 803 "type": "string" |
835 }, | |
836 "startDate": { | |
837 "description": "The start date for the query in the format `
YYYY-MM-DD`.", | |
838 "type": "string" | |
839 } | 804 } |
840 }, | 805 }, |
841 "type": "object" | 806 "type": "object" |
842 }, | 807 }, |
843 "MetricFilter": { | 808 "MetricFilter": { |
844 "description": "MetricFilter specifies the filter on a metric.", | 809 "description": "MetricFilter specifies the filter on a metric.", |
845 "id": "MetricFilter", | 810 "id": "MetricFilter", |
846 "properties": { | 811 "properties": { |
847 "metricName": { | 812 "metricName": { |
848 "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.", | 813 "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.", |
(...skipping 25 matching lines...) Expand all Loading... |
874 "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.", | 839 "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.", |
875 "type": "boolean" | 840 "type": "boolean" |
876 } | 841 } |
877 }, | 842 }, |
878 "type": "object" | 843 "type": "object" |
879 }, | 844 }, |
880 "ReportRequest": { | 845 "ReportRequest": { |
881 "description": "The main request class which specifies the Reporting
API request.", | 846 "description": "The main request class which specifies the Reporting
API request.", |
882 "id": "ReportRequest", | 847 "id": "ReportRequest", |
883 "properties": { | 848 "properties": { |
| 849 "pageSize": { |
| 850 "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.", |
| 851 "format": "int32", |
| 852 "type": "integer" |
| 853 }, |
| 854 "hideTotals": { |
| 855 "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.", |
| 856 "type": "boolean" |
| 857 }, |
| 858 "hideValueRanges": { |
| 859 "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.", |
| 860 "type": "boolean" |
| 861 }, |
| 862 "filtersExpression": { |
| 863 "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).", |
| 864 "type": "string" |
| 865 }, |
| 866 "cohortGroup": { |
| 867 "$ref": "CohortGroup", |
| 868 "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." |
| 869 }, |
| 870 "viewId": { |
| 871 "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`
.", |
| 872 "type": "string" |
| 873 }, |
884 "metrics": { | 874 "metrics": { |
885 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", | 875 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", |
886 "items": { | 876 "items": { |
887 "$ref": "Metric" | 877 "$ref": "Metric" |
888 }, | 878 }, |
889 "type": "array" | 879 "type": "array" |
890 }, | 880 }, |
891 "dimensionFilterClauses": { | 881 "dimensionFilterClauses": { |
892 "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.", | 882 "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.", |
893 "items": { | 883 "items": { |
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
953 "includeEmptyRows": { | 943 "includeEmptyRows": { |
954 "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.", | 944 "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.", |
955 "type": "boolean" | 945 "type": "boolean" |
956 }, | 946 }, |
957 "metricFilterClauses": { | 947 "metricFilterClauses": { |
958 "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.", | 948 "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.", |
959 "items": { | 949 "items": { |
960 "$ref": "MetricFilterClause" | 950 "$ref": "MetricFilterClause" |
961 }, | 951 }, |
962 "type": "array" | 952 "type": "array" |
963 }, | |
964 "pageSize": { | |
965 "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.", | |
966 "format": "int32", | |
967 "type": "integer" | |
968 }, | |
969 "hideValueRanges": { | |
970 "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.", | |
971 "type": "boolean" | |
972 }, | |
973 "hideTotals": { | |
974 "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.", | |
975 "type": "boolean" | |
976 }, | |
977 "cohortGroup": { | |
978 "$ref": "CohortGroup", | |
979 "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." | |
980 }, | |
981 "filtersExpression": { | |
982 "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).", | |
983 "type": "string" | |
984 }, | |
985 "viewId": { | |
986 "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`
.", | |
987 "type": "string" | |
988 } | 953 } |
989 }, | 954 }, |
990 "type": "object" | 955 "type": "object" |
991 }, | 956 }, |
992 "Dimension": { | 957 "Dimension": { |
993 "description": "[Dimensions](https://support.google.com/analytics/an
swer/1033861)\nare attributes of your data. For example, the dimension `ga:city`
\nindicates the city, for example, \"Paris\" or \"New York\", from which\na sess
ion originates.", | 958 "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.", |
994 "id": "Dimension", | 959 "id": "Dimension", |
995 "properties": { | 960 "properties": { |
996 "histogramBuckets": { | 961 "histogramBuckets": { |
997 "description": "If non-empty, we place dimension values into
buckets after string to\nint64. Dimension values that are not the string repres
entation of an\nintegral value will be converted to zero. The bucket values hav
e to be in\nincreasing order. Each bucket is closed on the lower end, and open
on the\nupper end. The \"first\" bucket includes all values less than the first\
nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nva
lues that fall in a bucket get transformed to a new dimension value. For\nexampl
e, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing bucke
ts:\n\n- bucket #1: values < 0, dimension value \"<0\"\n- bucket #2: values in [
0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2
\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in
[4,7), dimension value \"4-6\"\n- bucket #6: values >= 7, dimension value \"7+\"
\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nth
at dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for
that purpose. Without that the dimension values\nwill be sorted according to di
ctionary\n(lexicographic) order. For example the ascending dictionary order is:\
n\n \"<50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGR
AM_BUCKET` order is:\n\n \"<50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe c
lient has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a his
togram-mutated dimension.", | 962 "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.", |
998 "items": { | 963 "items": { |
999 "format": "int64", | 964 "format": "int64", |
1000 "type": "string" | 965 "type": "string" |
1001 }, | 966 }, |
1002 "type": "array" | 967 "type": "array" |
1003 }, | 968 }, |
1004 "name": { | 969 "name": { |
1005 "description": "Name of the dimension to fetch, for example
`ga:browser`.", | 970 "description": "Name of the dimension to fetch, for example
`ga:browser`.", |
1006 "type": "string" | 971 "type": "string" |
1007 } | 972 } |
1008 }, | 973 }, |
1009 "type": "object" | 974 "type": "object" |
1010 }, | 975 }, |
1011 "SimpleSegment": { | |
1012 "description": "A Simple segment conditions consist of one or more d
imension/metric\nconditions that can be combined.", | |
1013 "id": "SimpleSegment", | |
1014 "properties": { | |
1015 "orFiltersForSegment": { | |
1016 "description": "A list of segment filters groups which are c
ombined with logical `AND`\noperator.", | |
1017 "items": { | |
1018 "$ref": "OrFiltersForSegment" | |
1019 }, | |
1020 "type": "array" | |
1021 } | |
1022 }, | |
1023 "type": "object" | |
1024 }, | |
1025 "DynamicSegment": { | 976 "DynamicSegment": { |
1026 "description": "Dynamic segment definition for defining the segment
within the request.\nA segment can select users, sessions or both.", | 977 "description": "Dynamic segment definition for defining the segment
within the request.\nA segment can select users, sessions or both.", |
1027 "id": "DynamicSegment", | 978 "id": "DynamicSegment", |
1028 "properties": { | 979 "properties": { |
| 980 "userSegment": { |
| 981 "$ref": "SegmentDefinition", |
| 982 "description": "User Segment to select users to include in t
he segment." |
| 983 }, |
1029 "sessionSegment": { | 984 "sessionSegment": { |
1030 "$ref": "SegmentDefinition", | 985 "$ref": "SegmentDefinition", |
1031 "description": "Session Segment to select sessions to includ
e in the segment." | 986 "description": "Session Segment to select sessions to includ
e in the segment." |
1032 }, | 987 }, |
1033 "name": { | 988 "name": { |
1034 "description": "The name of the dynamic segment.", | 989 "description": "The name of the dynamic segment.", |
1035 "type": "string" | 990 "type": "string" |
1036 }, | |
1037 "userSegment": { | |
1038 "$ref": "SegmentDefinition", | |
1039 "description": "User Segment to select users to include in t
he segment." | |
1040 } | 991 } |
1041 }, | 992 }, |
1042 "type": "object" | 993 "type": "object" |
| 994 }, |
| 995 "SimpleSegment": { |
| 996 "description": "A Simple segment conditions consist of one or more d
imension/metric\nconditions that can be combined.", |
| 997 "id": "SimpleSegment", |
| 998 "properties": { |
| 999 "orFiltersForSegment": { |
| 1000 "description": "A list of segment filters groups which are c
ombined with logical `AND`\noperator.", |
| 1001 "items": { |
| 1002 "$ref": "OrFiltersForSegment" |
| 1003 }, |
| 1004 "type": "array" |
| 1005 } |
| 1006 }, |
| 1007 "type": "object" |
1043 }, | 1008 }, |
1044 "ColumnHeader": { | 1009 "ColumnHeader": { |
1045 "description": "Column headers.", | 1010 "description": "Column headers.", |
1046 "id": "ColumnHeader", | 1011 "id": "ColumnHeader", |
1047 "properties": { | 1012 "properties": { |
1048 "dimensions": { | 1013 "dimensions": { |
1049 "description": "The dimension names in the response.", | 1014 "description": "The dimension names in the response.", |
1050 "items": { | 1015 "items": { |
1051 "type": "string" | 1016 "type": "string" |
1052 }, | 1017 }, |
(...skipping 18 matching lines...) Expand all Loading... |
1071 "description": "Matches the complement (`!`) of the filter."
, | 1036 "description": "Matches the complement (`!`) of the filter."
, |
1072 "type": "boolean" | 1037 "type": "boolean" |
1073 }, | 1038 }, |
1074 "dimensionFilter": { | 1039 "dimensionFilter": { |
1075 "$ref": "SegmentDimensionFilter", | 1040 "$ref": "SegmentDimensionFilter", |
1076 "description": "Dimension Filter for the segment definition.
" | 1041 "description": "Dimension Filter for the segment definition.
" |
1077 } | 1042 } |
1078 }, | 1043 }, |
1079 "type": "object" | 1044 "type": "object" |
1080 }, | 1045 }, |
1081 "MetricFilterClause": { | 1046 "ReportRow": { |
1082 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", | 1047 "description": "A row in the report.", |
1083 "id": "MetricFilterClause", | 1048 "id": "ReportRow", |
1084 "properties": { | 1049 "properties": { |
1085 "operator": { | 1050 "metrics": { |
1086 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", | 1051 "description": "List of metrics for each requested DateRange
.", |
1087 "enum": [ | 1052 "items": { |
1088 "OPERATOR_UNSPECIFIED", | 1053 "$ref": "DateRangeValues" |
1089 "OR", | 1054 }, |
1090 "AND" | 1055 "type": "array" |
1091 ], | |
1092 "enumDescriptions": [ | |
1093 "Unspecified operator. It is treated as an `OR`.", | |
1094 "The logical `OR` operator.", | |
1095 "The logical `AND` operator." | |
1096 ], | |
1097 "type": "string" | |
1098 }, | 1056 }, |
1099 "filters": { | 1057 "dimensions": { |
1100 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", | 1058 "description": "List of requested dimensions.", |
1101 "items": { | 1059 "items": { |
1102 "$ref": "MetricFilter" | 1060 "type": "string" |
1103 }, | 1061 }, |
1104 "type": "array" | 1062 "type": "array" |
1105 } | 1063 } |
1106 }, | 1064 }, |
1107 "type": "object" | 1065 "type": "object" |
1108 }, | 1066 }, |
1109 "Cohort": { | 1067 "Cohort": { |
1110 "description": "Defines a cohort. A cohort is a group of users who s
hare a common\ncharacteristic. For example, all users with the same acquisition
date\nbelong to the same cohort.", | 1068 "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.", |
1111 "id": "Cohort", | 1069 "id": "Cohort", |
1112 "properties": { | 1070 "properties": { |
(...skipping 13 matching lines...) Expand all Loading... |
1126 ], | 1084 ], |
1127 "enumDescriptions": [ | 1085 "enumDescriptions": [ |
1128 "If unspecified it's treated as `FIRST_VISIT_DATE`.", | 1086 "If unspecified it's treated as `FIRST_VISIT_DATE`.", |
1129 "Cohorts that are selected based on first visit date." | 1087 "Cohorts that are selected based on first visit date." |
1130 ], | 1088 ], |
1131 "type": "string" | 1089 "type": "string" |
1132 } | 1090 } |
1133 }, | 1091 }, |
1134 "type": "object" | 1092 "type": "object" |
1135 }, | 1093 }, |
1136 "ReportRow": { | 1094 "MetricFilterClause": { |
1137 "description": "A row in the report.", | 1095 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", |
1138 "id": "ReportRow", | 1096 "id": "MetricFilterClause", |
1139 "properties": { | 1097 "properties": { |
1140 "metrics": { | 1098 "operator": { |
1141 "description": "List of metrics for each requested DateRange
.", | 1099 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", |
| 1100 "enum": [ |
| 1101 "OPERATOR_UNSPECIFIED", |
| 1102 "OR", |
| 1103 "AND" |
| 1104 ], |
| 1105 "enumDescriptions": [ |
| 1106 "Unspecified operator. It is treated as an `OR`.", |
| 1107 "The logical `OR` operator.", |
| 1108 "The logical `AND` operator." |
| 1109 ], |
| 1110 "type": "string" |
| 1111 }, |
| 1112 "filters": { |
| 1113 "description": "The repeated set of filters. They are logica
lly combined based on the\noperator specified.", |
1142 "items": { | 1114 "items": { |
1143 "$ref": "DateRangeValues" | 1115 "$ref": "MetricFilter" |
| 1116 }, |
| 1117 "type": "array" |
| 1118 } |
| 1119 }, |
| 1120 "type": "object" |
| 1121 }, |
| 1122 "OrFiltersForSegment": { |
| 1123 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", |
| 1124 "id": "OrFiltersForSegment", |
| 1125 "properties": { |
| 1126 "segmentFilterClauses": { |
| 1127 "description": "List of segment filters to be combined with
a `OR` operator.", |
| 1128 "items": { |
| 1129 "$ref": "SegmentFilterClause" |
| 1130 }, |
| 1131 "type": "array" |
| 1132 } |
| 1133 }, |
| 1134 "type": "object" |
| 1135 }, |
| 1136 "MetricHeader": { |
| 1137 "description": "The headers for the metrics.", |
| 1138 "id": "MetricHeader", |
| 1139 "properties": { |
| 1140 "metricHeaderEntries": { |
| 1141 "description": "Headers for the metrics in the response.", |
| 1142 "items": { |
| 1143 "$ref": "MetricHeaderEntry" |
1144 }, | 1144 }, |
1145 "type": "array" | 1145 "type": "array" |
1146 }, | 1146 }, |
1147 "dimensions": { | 1147 "pivotHeaders": { |
1148 "description": "List of requested dimensions.", | 1148 "description": "Headers for the pivots in the response.", |
1149 "items": { | 1149 "items": { |
1150 "type": "string" | 1150 "$ref": "PivotHeader" |
1151 }, | 1151 }, |
1152 "type": "array" | 1152 "type": "array" |
1153 } | 1153 } |
1154 }, | 1154 }, |
1155 "type": "object" | 1155 "type": "object" |
1156 } | 1156 } |
1157 }, | 1157 }, |
1158 "servicePath": "", | 1158 "servicePath": "", |
1159 "title": "Google Analytics Reporting API", | 1159 "title": "Google Analytics Reporting API", |
1160 "version": "v4" | 1160 "version": "v4" |
1161 } | 1161 } |
OLD | NEW |