OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/analytics.readonly": { |
| 6 "description": "View your Google Analytics data" |
| 7 }, |
5 "https://www.googleapis.com/auth/analytics": { | 8 "https://www.googleapis.com/auth/analytics": { |
6 "description": "View and manage your Google Analytics data" | 9 "description": "View and manage your Google Analytics data" |
7 }, | |
8 "https://www.googleapis.com/auth/analytics.readonly": { | |
9 "description": "View your Google Analytics data" | |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://analyticsreporting.googleapis.com/", | 15 "baseUrl": "https://analyticsreporting.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "AnalyticsReporting", | 17 "canonicalName": "AnalyticsReporting", |
18 "description": "Accesses Analytics report data.", | 18 "description": "Accesses Analytics report data.", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "https://developers.google.com/analytics/devguides/repo
rting/core/v4/", | 20 "documentationLink": "https://developers.google.com/analytics/devguides/repo
rting/core/v4/", |
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 "uploadType": { | |
32 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "fields": { | |
37 "description": "Selector specifying which fields to include in a par
tial response.", | |
38 "location": "query", | |
39 "type": "string" | |
40 }, | |
41 "callback": { | |
42 "description": "JSONP", | |
43 "location": "query", | |
44 "type": "string" | |
45 }, | |
46 "$.xgafv": { | |
47 "description": "V1 error format.", | |
48 "enum": [ | |
49 "1", | |
50 "2" | |
51 ], | |
52 "enumDescriptions": [ | |
53 "v1 error format", | |
54 "v2 error format" | |
55 ], | |
56 "location": "query", | |
57 "type": "string" | |
58 }, | |
59 "alt": { | 31 "alt": { |
60 "default": "json", | 32 "default": "json", |
61 "description": "Data format for response.", | 33 "description": "Data format for response.", |
62 "enum": [ | 34 "enum": [ |
63 "json", | 35 "json", |
64 "media", | 36 "media", |
65 "proto" | 37 "proto" |
66 ], | 38 ], |
67 "enumDescriptions": [ | 39 "enumDescriptions": [ |
68 "Responses with Content-Type of application/json", | 40 "Responses with Content-Type of application/json", |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
106 "upload_protocol": { | 78 "upload_protocol": { |
107 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 79 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
108 "location": "query", | 80 "location": "query", |
109 "type": "string" | 81 "type": "string" |
110 }, | 82 }, |
111 "prettyPrint": { | 83 "prettyPrint": { |
112 "default": "true", | 84 "default": "true", |
113 "description": "Returns response with indentations and line breaks."
, | 85 "description": "Returns response with indentations and line breaks."
, |
114 "location": "query", | 86 "location": "query", |
115 "type": "boolean" | 87 "type": "boolean" |
| 88 }, |
| 89 "fields": { |
| 90 "description": "Selector specifying which fields to include in a par
tial response.", |
| 91 "location": "query", |
| 92 "type": "string" |
| 93 }, |
| 94 "uploadType": { |
| 95 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 96 "location": "query", |
| 97 "type": "string" |
| 98 }, |
| 99 "callback": { |
| 100 "description": "JSONP", |
| 101 "location": "query", |
| 102 "type": "string" |
| 103 }, |
| 104 "$.xgafv": { |
| 105 "description": "V1 error format.", |
| 106 "enum": [ |
| 107 "1", |
| 108 "2" |
| 109 ], |
| 110 "enumDescriptions": [ |
| 111 "v1 error format", |
| 112 "v2 error format" |
| 113 ], |
| 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": "20170427", | 143 "revision": "20170531", |
144 "rootUrl": "https://analyticsreporting.googleapis.com/", | 144 "rootUrl": "https://analyticsreporting.googleapis.com/", |
145 "schemas": { | 145 "schemas": { |
146 "GetReportsRequest": { | |
147 "description": "The batch request containing multiple report request
.", | |
148 "id": "GetReportsRequest", | |
149 "properties": { | |
150 "reportRequests": { | |
151 "description": "Requests, each request will have a separate
response.\nThere can be a maximum of 5 requests. All requests should have the sa
me\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.", | |
152 "items": { | |
153 "$ref": "ReportRequest" | |
154 }, | |
155 "type": "array" | |
156 } | |
157 }, | |
158 "type": "object" | |
159 }, | |
160 "Pivot": { | |
161 "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.", | |
162 "id": "Pivot", | |
163 "properties": { | |
164 "startGroup": { | |
165 "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.", | |
166 "format": "int32", | |
167 "type": "integer" | |
168 }, | |
169 "metrics": { | |
170 "description": "The pivot metrics. Pivot metrics are part of
the\nrestriction on total number of metrics allowed in the request.", | |
171 "items": { | |
172 "$ref": "Metric" | |
173 }, | |
174 "type": "array" | |
175 }, | |
176 "dimensions": { | |
177 "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.", | |
178 "items": { | |
179 "$ref": "Dimension" | |
180 }, | |
181 "type": "array" | |
182 }, | |
183 "dimensionFilterClauses": { | |
184 "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.", | |
185 "items": { | |
186 "$ref": "DimensionFilterClause" | |
187 }, | |
188 "type": "array" | |
189 }, | |
190 "maxGroupCount": { | |
191 "description": "Specifies the maximum number of groups to re
turn.\nThe default value is 10, also the maximum value is 1,000.", | |
192 "format": "int32", | |
193 "type": "integer" | |
194 } | |
195 }, | |
196 "type": "object" | |
197 }, | |
198 "PivotHeaderEntry": { | |
199 "description": "The headers for the each of the metric column corres
ponding to the metrics\nrequested in the pivots section of the response.", | |
200 "id": "PivotHeaderEntry", | |
201 "properties": { | |
202 "dimensionNames": { | |
203 "description": "The name of the dimensions in the pivot resp
onse.", | |
204 "items": { | |
205 "type": "string" | |
206 }, | |
207 "type": "array" | |
208 }, | |
209 "metric": { | |
210 "$ref": "MetricHeaderEntry", | |
211 "description": "The metric header for the metric in the pivo
t." | |
212 }, | |
213 "dimensionValues": { | |
214 "description": "The values for the dimensions in the pivot."
, | |
215 "items": { | |
216 "type": "string" | |
217 }, | |
218 "type": "array" | |
219 } | |
220 }, | |
221 "type": "object" | |
222 }, | |
223 "SegmentFilter": { | |
224 "description": "SegmentFilter defines the segment to be either a sim
ple or a sequence\nsegment. A simple segment condition contains dimension and me
tric conditions\nto select the sessions or users. A sequence segment condition c
an be used to\nselect users or sessions based on sequential conditions.", | |
225 "id": "SegmentFilter", | |
226 "properties": { | |
227 "sequenceSegment": { | |
228 "$ref": "SequenceSegment", | |
229 "description": "Sequence conditions consist of one or more s
teps, where each step is\ndefined by one or more dimension/metric conditions. Mu
ltiple steps can\nbe combined with special sequence operators." | |
230 }, | |
231 "not": { | |
232 "description": "If true, match the complement of simple or s
equence segment.\nFor example, to match all visits not from \"New York\", we can
define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segme
ntFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegme
nt\": [{\n \"segmentFilterClauses\":[{\n \"dimension
Filter\": {\n \"dimensionName\": \"ga:city\",\n
\"expressions\": [\"New York\"]\n }\n }]\n
}]\n },\n \"not\": \"True\"\n }]\n },", | |
233 "type": "boolean" | |
234 }, | |
235 "simpleSegment": { | |
236 "$ref": "SimpleSegment", | |
237 "description": "A Simple segment conditions consist of one o
r more dimension/metric\nconditions that can be combined" | |
238 } | |
239 }, | |
240 "type": "object" | |
241 }, | |
242 "SegmentDefinition": { | 146 "SegmentDefinition": { |
243 "description": "SegmentDefinition defines the segment to be a set of
SegmentFilters which\nare combined together with a logical `AND` operation.", | 147 "description": "SegmentDefinition defines the segment to be a set of
SegmentFilters which\nare combined together with a logical `AND` operation.", |
244 "id": "SegmentDefinition", | 148 "id": "SegmentDefinition", |
245 "properties": { | 149 "properties": { |
246 "segmentFilters": { | 150 "segmentFilters": { |
247 "description": "A segment is defined by a set of segment fil
ters which are combined\ntogether with a logical `AND` operation.", | 151 "description": "A segment is defined by a set of segment fil
ters which are combined\ntogether with a logical `AND` operation.", |
248 "items": { | 152 "items": { |
249 "$ref": "SegmentFilter" | 153 "$ref": "SegmentFilter" |
250 }, | 154 }, |
251 "type": "array" | 155 "type": "array" |
252 } | 156 } |
253 }, | 157 }, |
254 "type": "object" | 158 "type": "object" |
255 }, | 159 }, |
256 "MetricHeaderEntry": { | 160 "MetricHeaderEntry": { |
257 "description": "Header for the metrics.", | 161 "description": "Header for the metrics.", |
258 "id": "MetricHeaderEntry", | 162 "id": "MetricHeaderEntry", |
259 "properties": { | 163 "properties": { |
| 164 "name": { |
| 165 "description": "The name of the header.", |
| 166 "type": "string" |
| 167 }, |
260 "type": { | 168 "type": { |
261 "description": "The type of the metric, for example `INTEGER
`.", | 169 "description": "The type of the metric, for example `INTEGER
`.", |
262 "enum": [ | 170 "enum": [ |
263 "METRIC_TYPE_UNSPECIFIED", | 171 "METRIC_TYPE_UNSPECIFIED", |
264 "INTEGER", | 172 "INTEGER", |
265 "FLOAT", | 173 "FLOAT", |
266 "CURRENCY", | 174 "CURRENCY", |
267 "PERCENT", | 175 "PERCENT", |
268 "TIME" | 176 "TIME" |
269 ], | 177 ], |
270 "enumDescriptions": [ | 178 "enumDescriptions": [ |
271 "Metric type is unspecified.", | 179 "Metric type is unspecified.", |
272 "Integer metric.", | 180 "Integer metric.", |
273 "Float metric.", | 181 "Float metric.", |
274 "Currency metric.", | 182 "Currency metric.", |
275 "Percentage metric.", | 183 "Percentage metric.", |
276 "Time metric in `HH:MM:SS` format." | 184 "Time metric in `HH:MM:SS` format." |
277 ], | 185 ], |
278 "type": "string" | 186 "type": "string" |
279 }, | |
280 "name": { | |
281 "description": "The name of the header.", | |
282 "type": "string" | |
283 } | 187 } |
284 }, | 188 }, |
285 "type": "object" | 189 "type": "object" |
286 }, | 190 }, |
287 "ReportData": { | 191 "ReportData": { |
288 "description": "The data part of the report.", | 192 "description": "The data part of the report.", |
289 "id": "ReportData", | 193 "id": "ReportData", |
290 "properties": { | 194 "properties": { |
| 195 "isDataGolden": { |
| 196 "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.", |
| 197 "type": "boolean" |
| 198 }, |
| 199 "rows": { |
| 200 "description": "There's one ReportRow for every unique combi
nation of dimensions.", |
| 201 "items": { |
| 202 "$ref": "ReportRow" |
| 203 }, |
| 204 "type": "array" |
| 205 }, |
| 206 "rowCount": { |
| 207 "description": "Total number of matching rows for this query
.", |
| 208 "format": "int32", |
| 209 "type": "integer" |
| 210 }, |
| 211 "dataLastRefreshed": { |
| 212 "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.", |
| 213 "format": "google-datetime", |
| 214 "type": "string" |
| 215 }, |
| 216 "maximums": { |
| 217 "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.", |
| 218 "items": { |
| 219 "$ref": "DateRangeValues" |
| 220 }, |
| 221 "type": "array" |
| 222 }, |
291 "minimums": { | 223 "minimums": { |
292 "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.", | 224 "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.", |
293 "items": { | 225 "items": { |
294 "$ref": "DateRangeValues" | 226 "$ref": "DateRangeValues" |
295 }, | 227 }, |
296 "type": "array" | 228 "type": "array" |
297 }, | 229 }, |
298 "samplingSpaceSizes": { | 230 "samplingSpaceSizes": { |
299 "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.", | 231 "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.", |
300 "items": { | 232 "items": { |
301 "format": "int64", | 233 "format": "int64", |
302 "type": "string" | 234 "type": "string" |
303 }, | 235 }, |
304 "type": "array" | 236 "type": "array" |
305 }, | 237 }, |
306 "totals": { | 238 "totals": { |
307 "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.", | 239 "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.", |
308 "items": { | 240 "items": { |
309 "$ref": "DateRangeValues" | 241 "$ref": "DateRangeValues" |
310 }, | 242 }, |
311 "type": "array" | 243 "type": "array" |
312 }, | 244 }, |
313 "samplesReadCounts": { | 245 "samplesReadCounts": { |
314 "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.", | 246 "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.", |
315 "items": { | 247 "items": { |
316 "format": "int64", | 248 "format": "int64", |
317 "type": "string" | 249 "type": "string" |
318 }, | 250 }, |
319 "type": "array" | 251 "type": "array" |
320 }, | |
321 "isDataGolden": { | |
322 "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.", | |
323 "type": "boolean" | |
324 }, | |
325 "rows": { | |
326 "description": "There's one ReportRow for every unique combi
nation of dimensions.", | |
327 "items": { | |
328 "$ref": "ReportRow" | |
329 }, | |
330 "type": "array" | |
331 }, | |
332 "rowCount": { | |
333 "description": "Total number of matching rows for this query
.", | |
334 "format": "int32", | |
335 "type": "integer" | |
336 }, | |
337 "dataLastRefreshed": { | |
338 "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.", | |
339 "format": "google-datetime", | |
340 "type": "string" | |
341 }, | |
342 "maximums": { | |
343 "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.", | |
344 "items": { | |
345 "$ref": "DateRangeValues" | |
346 }, | |
347 "type": "array" | |
348 } | 252 } |
349 }, | 253 }, |
350 "type": "object" | 254 "type": "object" |
351 }, | 255 }, |
352 "DimensionFilter": { | 256 "DimensionFilter": { |
353 "description": "Dimension filter specifies the filtering options on
a dimension.", | 257 "description": "Dimension filter specifies the filtering options on
a dimension.", |
354 "id": "DimensionFilter", | 258 "id": "DimensionFilter", |
355 "properties": { | 259 "properties": { |
356 "caseSensitive": { | 260 "caseSensitive": { |
357 "description": "Should the match be case sensitive? Default
is false.", | 261 "description": "Should the match be case sensitive? Default
is false.", |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
396 "expressions": { | 300 "expressions": { |
397 "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.", | 301 "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.", |
398 "items": { | 302 "items": { |
399 "type": "string" | 303 "type": "string" |
400 }, | 304 }, |
401 "type": "array" | 305 "type": "array" |
402 } | 306 } |
403 }, | 307 }, |
404 "type": "object" | 308 "type": "object" |
405 }, | 309 }, |
| 310 "OrderBy": { |
| 311 "description": "Specifies the sorting options.", |
| 312 "id": "OrderBy", |
| 313 "properties": { |
| 314 "sortOrder": { |
| 315 "description": "The sorting order for the field.", |
| 316 "enum": [ |
| 317 "SORT_ORDER_UNSPECIFIED", |
| 318 "ASCENDING", |
| 319 "DESCENDING" |
| 320 ], |
| 321 "enumDescriptions": [ |
| 322 "If the sort order is unspecified, the default is ascend
ing.", |
| 323 "Ascending sort. The field will be sorted in an ascendin
g manner.", |
| 324 "Descending sort. The field will be sorted in a descendi
ng manner." |
| 325 ], |
| 326 "type": "string" |
| 327 }, |
| 328 "fieldName": { |
| 329 "description": "The field which to sort by. The default sort
order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify on
e field for sort here. For example,\n`ga:browser, ga:city` is not valid.", |
| 330 "type": "string" |
| 331 }, |
| 332 "orderType": { |
| 333 "description": "The order type. The default orderType is `VA
LUE`.", |
| 334 "enum": [ |
| 335 "ORDER_TYPE_UNSPECIFIED", |
| 336 "VALUE", |
| 337 "DELTA", |
| 338 "SMART", |
| 339 "HISTOGRAM_BUCKET", |
| 340 "DIMENSION_AS_INTEGER" |
| 341 ], |
| 342 "enumDescriptions": [ |
| 343 "Unspecified order type will be treated as sort based on
value.", |
| 344 "The sort order is based on the value of the chosen colu
mn; looks only at\nthe first date range.", |
| 345 "The sort order is based on the difference of the values
of the chosen\ncolumn between the first two date ranges. Usable only if there
are\nexactly two date ranges.", |
| 346 "The sort order is based on weighted value of the chosen
column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe
`(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios."
, |
| 347 "Histogram order type is applicable only to dimension co
lumns with\nnon-empty histogram-buckets.", |
| 348 "If the dimensions are fixed length numbers, ordinary so
rt would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions a
re\nvariable length numbers." |
| 349 ], |
| 350 "type": "string" |
| 351 } |
| 352 }, |
| 353 "type": "object" |
| 354 }, |
| 355 "Segment": { |
| 356 "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.", |
| 357 "id": "Segment", |
| 358 "properties": { |
| 359 "dynamicSegment": { |
| 360 "$ref": "DynamicSegment", |
| 361 "description": "A dynamic segment definition in the request.
" |
| 362 }, |
| 363 "segmentId": { |
| 364 "description": "The segment ID of a built-in or custom segme
nt, for example `gaid::-3`.", |
| 365 "type": "string" |
| 366 } |
| 367 }, |
| 368 "type": "object" |
| 369 }, |
406 "SegmentDimensionFilter": { | 370 "SegmentDimensionFilter": { |
407 "description": "Dimension filter specifies the filtering options on
a dimension.", | 371 "description": "Dimension filter specifies the filtering options on
a dimension.", |
408 "id": "SegmentDimensionFilter", | 372 "id": "SegmentDimensionFilter", |
409 "properties": { | 373 "properties": { |
410 "caseSensitive": { | |
411 "description": "Should the match be case sensitive, ignored
for `IN_LIST` operator.", | |
412 "type": "boolean" | |
413 }, | |
414 "minComparisonValue": { | |
415 "description": "Minimum comparison values for `BETWEEN` matc
h type.", | |
416 "type": "string" | |
417 }, | |
418 "maxComparisonValue": { | |
419 "description": "Maximum comparison values for `BETWEEN` matc
h type.", | |
420 "type": "string" | |
421 }, | |
422 "dimensionName": { | 374 "dimensionName": { |
423 "description": "Name of the dimension for which the filter i
s being applied.", | 375 "description": "Name of the dimension for which the filter i
s being applied.", |
424 "type": "string" | 376 "type": "string" |
425 }, | 377 }, |
426 "operator": { | 378 "operator": { |
427 "description": "The operator to use to match the dimension w
ith the expressions.", | 379 "description": "The operator to use to match the dimension w
ith the expressions.", |
428 "enum": [ | 380 "enum": [ |
429 "OPERATOR_UNSPECIFIED", | 381 "OPERATOR_UNSPECIFIED", |
430 "REGEXP", | 382 "REGEXP", |
431 "BEGINS_WITH", | 383 "BEGINS_WITH", |
(...skipping 18 matching lines...) Expand all Loading... |
450 "Checks if the dimension is numerically between the mini
mum and maximum\nof the match expression, boundaries excluded." | 402 "Checks if the dimension is numerically between the mini
mum and maximum\nof the match expression, boundaries excluded." |
451 ], | 403 ], |
452 "type": "string" | 404 "type": "string" |
453 }, | 405 }, |
454 "expressions": { | 406 "expressions": { |
455 "description": "The list of expressions, only the first elem
ent is used for all operators", | 407 "description": "The list of expressions, only the first elem
ent is used for all operators", |
456 "items": { | 408 "items": { |
457 "type": "string" | 409 "type": "string" |
458 }, | 410 }, |
459 "type": "array" | 411 "type": "array" |
460 } | 412 }, |
461 }, | 413 "caseSensitive": { |
462 "type": "object" | 414 "description": "Should the match be case sensitive, ignored
for `IN_LIST` operator.", |
463 }, | 415 "type": "boolean" |
464 "OrderBy": { | 416 }, |
465 "description": "Specifies the sorting options.", | 417 "minComparisonValue": { |
466 "id": "OrderBy", | 418 "description": "Minimum comparison values for `BETWEEN` matc
h type.", |
467 "properties": { | |
468 "fieldName": { | |
469 "description": "The field which to sort by. The default sort
order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify on
e field for sort here. For example,\n`ga:browser, ga:city` is not valid.", | |
470 "type": "string" | 419 "type": "string" |
471 }, | 420 }, |
472 "orderType": { | 421 "maxComparisonValue": { |
473 "description": "The order type. The default orderType is `VA
LUE`.", | 422 "description": "Maximum comparison values for `BETWEEN` matc
h type.", |
474 "enum": [ | |
475 "ORDER_TYPE_UNSPECIFIED", | |
476 "VALUE", | |
477 "DELTA", | |
478 "SMART", | |
479 "HISTOGRAM_BUCKET", | |
480 "DIMENSION_AS_INTEGER" | |
481 ], | |
482 "enumDescriptions": [ | |
483 "Unspecified order type will be treated as sort based on
value.", | |
484 "The sort order is based on the value of the chosen colu
mn; looks only at\nthe first date range.", | |
485 "The sort order is based on the difference of the values
of the chosen\ncolumn between the first two date ranges. Usable only if there
are\nexactly two date ranges.", | |
486 "The sort order is based on weighted value of the chosen
column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe
`(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios."
, | |
487 "Histogram order type is applicable only to dimension co
lumns with\nnon-empty histogram-buckets.", | |
488 "If the dimensions are fixed length numbers, ordinary so
rt would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions a
re\nvariable length numbers." | |
489 ], | |
490 "type": "string" | |
491 }, | |
492 "sortOrder": { | |
493 "description": "The sorting order for the field.", | |
494 "enum": [ | |
495 "SORT_ORDER_UNSPECIFIED", | |
496 "ASCENDING", | |
497 "DESCENDING" | |
498 ], | |
499 "enumDescriptions": [ | |
500 "If the sort order is unspecified, the default is ascend
ing.", | |
501 "Ascending sort. The field will be sorted in an ascendin
g manner.", | |
502 "Descending sort. The field will be sorted in a descendi
ng manner." | |
503 ], | |
504 "type": "string" | 423 "type": "string" |
505 } | 424 } |
506 }, | 425 }, |
507 "type": "object" | |
508 }, | |
509 "Segment": { | |
510 "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.", | |
511 "id": "Segment", | |
512 "properties": { | |
513 "dynamicSegment": { | |
514 "$ref": "DynamicSegment", | |
515 "description": "A dynamic segment definition in the request.
" | |
516 }, | |
517 "segmentId": { | |
518 "description": "The segment ID of a built-in or custom segme
nt, for example `gaid::-3`.", | |
519 "type": "string" | |
520 } | |
521 }, | |
522 "type": "object" | 426 "type": "object" |
523 }, | 427 }, |
524 "SegmentSequenceStep": { | 428 "SegmentSequenceStep": { |
525 "description": "A segment sequence definition.", | 429 "description": "A segment sequence definition.", |
526 "id": "SegmentSequenceStep", | 430 "id": "SegmentSequenceStep", |
527 "properties": { | 431 "properties": { |
528 "orFiltersForSegment": { | 432 "orFiltersForSegment": { |
529 "description": "A sequence is specified with a list of Or gr
ouped filters which are\ncombined with `AND` operator.", | 433 "description": "A sequence is specified with a list of Or gr
ouped filters which are\ncombined with `AND` operator.", |
530 "items": { | 434 "items": { |
531 "$ref": "OrFiltersForSegment" | 435 "$ref": "OrFiltersForSegment" |
(...skipping 101 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
633 "format": "int32", | 537 "format": "int32", |
634 "type": "integer" | 538 "type": "integer" |
635 } | 539 } |
636 }, | 540 }, |
637 "type": "object" | 541 "type": "object" |
638 }, | 542 }, |
639 "DateRange": { | 543 "DateRange": { |
640 "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`.", | 544 "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`.", |
641 "id": "DateRange", | 545 "id": "DateRange", |
642 "properties": { | 546 "properties": { |
| 547 "startDate": { |
| 548 "description": "The start date for the query in the format `
YYYY-MM-DD`.", |
| 549 "type": "string" |
| 550 }, |
643 "endDate": { | 551 "endDate": { |
644 "description": "The end date for the query in the format `YY
YY-MM-DD`.", | 552 "description": "The end date for the query in the format `YY
YY-MM-DD`.", |
645 "type": "string" | 553 "type": "string" |
646 }, | |
647 "startDate": { | |
648 "description": "The start date for the query in the format `
YYYY-MM-DD`.", | |
649 "type": "string" | |
650 } | 554 } |
651 }, | 555 }, |
652 "type": "object" | 556 "type": "object" |
653 }, | 557 }, |
654 "MetricFilter": { | 558 "MetricFilter": { |
655 "description": "MetricFilter specifies the filter on a metric.", | 559 "description": "MetricFilter specifies the filter on a metric.", |
656 "id": "MetricFilter", | 560 "id": "MetricFilter", |
657 "properties": { | 561 "properties": { |
658 "metricName": { | |
659 "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.", | |
660 "type": "string" | |
661 }, | |
662 "comparisonValue": { | |
663 "description": "The value to compare against.", | |
664 "type": "string" | |
665 }, | |
666 "operator": { | 562 "operator": { |
667 "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."
, | 563 "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."
, |
668 "enum": [ | 564 "enum": [ |
669 "OPERATOR_UNSPECIFIED", | 565 "OPERATOR_UNSPECIFIED", |
670 "EQUAL", | 566 "EQUAL", |
671 "LESS_THAN", | 567 "LESS_THAN", |
672 "GREATER_THAN", | 568 "GREATER_THAN", |
673 "IS_MISSING" | 569 "IS_MISSING" |
674 ], | 570 ], |
675 "enumDescriptions": [ | 571 "enumDescriptions": [ |
676 "If the operator is not specified, it is treated as `EQU
AL`.", | 572 "If the operator is not specified, it is treated as `EQU
AL`.", |
677 "Should the value of the metric be exactly equal to the
comparison value.", | 573 "Should the value of the metric be exactly equal to the
comparison value.", |
678 "Should the value of the metric be less than to the comp
arison value.", | 574 "Should the value of the metric be less than to the comp
arison value.", |
679 "Should the value of the metric be greater than to the c
omparison value.", | 575 "Should the value of the metric be greater than to the c
omparison value.", |
680 "Validates if the metric is missing.\nDoesn't take compa
risonValue into account." | 576 "Validates if the metric is missing.\nDoesn't take compa
risonValue into account." |
681 ], | 577 ], |
682 "type": "string" | 578 "type": "string" |
683 }, | 579 }, |
684 "not": { | 580 "not": { |
685 "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.", | 581 "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.", |
686 "type": "boolean" | 582 "type": "boolean" |
| 583 }, |
| 584 "metricName": { |
| 585 "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.", |
| 586 "type": "string" |
| 587 }, |
| 588 "comparisonValue": { |
| 589 "description": "The value to compare against.", |
| 590 "type": "string" |
687 } | 591 } |
688 }, | 592 }, |
689 "type": "object" | 593 "type": "object" |
690 }, | 594 }, |
691 "ReportRequest": { | 595 "ReportRequest": { |
692 "description": "The main request class which specifies the Reporting
API request.", | 596 "description": "The main request class which specifies the Reporting
API request.", |
693 "id": "ReportRequest", | 597 "id": "ReportRequest", |
694 "properties": { | 598 "properties": { |
695 "metricFilterClauses": { | 599 "metricFilterClauses": { |
696 "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.", | 600 "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.", |
697 "items": { | 601 "items": { |
698 "$ref": "MetricFilterClause" | 602 "$ref": "MetricFilterClause" |
699 }, | 603 }, |
700 "type": "array" | 604 "type": "array" |
701 }, | 605 }, |
702 "pageSize": { | 606 "pageSize": { |
703 "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.", | 607 "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.", |
704 "format": "int32", | 608 "format": "int32", |
705 "type": "integer" | 609 "type": "integer" |
706 }, | 610 }, |
| 611 "hideTotals": { |
| 612 "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.", |
| 613 "type": "boolean" |
| 614 }, |
707 "hideValueRanges": { | 615 "hideValueRanges": { |
708 "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.", | 616 "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.", |
709 "type": "boolean" | 617 "type": "boolean" |
710 }, | 618 }, |
711 "hideTotals": { | 619 "filtersExpression": { |
712 "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.", | 620 "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).", |
713 "type": "boolean" | 621 "type": "string" |
714 }, | 622 }, |
715 "cohortGroup": { | 623 "cohortGroup": { |
716 "$ref": "CohortGroup", | 624 "$ref": "CohortGroup", |
717 "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." | 625 "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." |
718 }, | 626 }, |
719 "filtersExpression": { | |
720 "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).", | |
721 "type": "string" | |
722 }, | |
723 "viewId": { | 627 "viewId": { |
724 "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`
.", | 628 "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`
.", |
725 "type": "string" | 629 "type": "string" |
726 }, | 630 }, |
727 "metrics": { | 631 "metrics": { |
728 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", | 632 "description": "The metrics requested.\nRequests must specif
y at least one metric. Requests can have a\ntotal of 10 metrics.", |
729 "items": { | 633 "items": { |
730 "$ref": "Metric" | 634 "$ref": "Metric" |
731 }, | 635 }, |
732 "type": "array" | 636 "type": "array" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
768 ], | 672 ], |
769 "type": "string" | 673 "type": "string" |
770 }, | 674 }, |
771 "dimensions": { | 675 "dimensions": { |
772 "description": "The dimensions requested.\nRequests can have
a total of 7 dimensions.", | 676 "description": "The dimensions requested.\nRequests can have
a total of 7 dimensions.", |
773 "items": { | 677 "items": { |
774 "$ref": "Dimension" | 678 "$ref": "Dimension" |
775 }, | 679 }, |
776 "type": "array" | 680 "type": "array" |
777 }, | 681 }, |
| 682 "pageToken": { |
| 683 "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.", |
| 684 "type": "string" |
| 685 }, |
778 "dateRanges": { | 686 "dateRanges": { |
779 "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.", | 687 "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.", |
780 "items": { | 688 "items": { |
781 "$ref": "DateRange" | 689 "$ref": "DateRange" |
782 }, | 690 }, |
783 "type": "array" | 691 "type": "array" |
784 }, | 692 }, |
785 "pageToken": { | |
786 "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.", | |
787 "type": "string" | |
788 }, | |
789 "pivots": { | 693 "pivots": { |
790 "description": "The pivot definitions. Requests can have a m
aximum of 2 pivots.", | 694 "description": "The pivot definitions. Requests can have a m
aximum of 2 pivots.", |
791 "items": { | 695 "items": { |
792 "$ref": "Pivot" | 696 "$ref": "Pivot" |
793 }, | 697 }, |
794 "type": "array" | 698 "type": "array" |
795 }, | 699 }, |
796 "includeEmptyRows": { | 700 "includeEmptyRows": { |
797 "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.", | 701 "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.", |
798 "type": "boolean" | 702 "type": "boolean" |
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
867 "$ref": "MetricHeader", | 771 "$ref": "MetricHeader", |
868 "description": "Metric headers for the metrics in the respon
se." | 772 "description": "Metric headers for the metrics in the respon
se." |
869 } | 773 } |
870 }, | 774 }, |
871 "type": "object" | 775 "type": "object" |
872 }, | 776 }, |
873 "SegmentFilterClause": { | 777 "SegmentFilterClause": { |
874 "description": "Filter Clause to be used in a segment definition, ca
n be wither a metric or\na dimension filter.", | 778 "description": "Filter Clause to be used in a segment definition, ca
n be wither a metric or\na dimension filter.", |
875 "id": "SegmentFilterClause", | 779 "id": "SegmentFilterClause", |
876 "properties": { | 780 "properties": { |
| 781 "not": { |
| 782 "description": "Matches the complement (`!`) of the filter."
, |
| 783 "type": "boolean" |
| 784 }, |
877 "dimensionFilter": { | 785 "dimensionFilter": { |
878 "$ref": "SegmentDimensionFilter", | 786 "$ref": "SegmentDimensionFilter", |
879 "description": "Dimension Filter for the segment definition.
" | 787 "description": "Dimension Filter for the segment definition.
" |
880 }, | 788 }, |
881 "metricFilter": { | 789 "metricFilter": { |
882 "$ref": "SegmentMetricFilter", | 790 "$ref": "SegmentMetricFilter", |
883 "description": "Metric Filter for the segment definition." | 791 "description": "Metric Filter for the segment definition." |
884 }, | |
885 "not": { | |
886 "description": "Matches the complement (`!`) of the filter."
, | |
887 "type": "boolean" | |
888 } | 792 } |
889 }, | 793 }, |
890 "type": "object" | 794 "type": "object" |
891 }, | |
892 "ReportRow": { | |
893 "description": "A row in the report.", | |
894 "id": "ReportRow", | |
895 "properties": { | |
896 "metrics": { | |
897 "description": "List of metrics for each requested DateRange
.", | |
898 "items": { | |
899 "$ref": "DateRangeValues" | |
900 }, | |
901 "type": "array" | |
902 }, | |
903 "dimensions": { | |
904 "description": "List of requested dimensions.", | |
905 "items": { | |
906 "type": "string" | |
907 }, | |
908 "type": "array" | |
909 } | |
910 }, | |
911 "type": "object" | |
912 }, | 795 }, |
913 "MetricFilterClause": { | 796 "MetricFilterClause": { |
914 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", | 797 "description": "Represents a group of metric filters.\nSet the opera
tor value to specify how the filters are logically combined.", |
915 "id": "MetricFilterClause", | 798 "id": "MetricFilterClause", |
916 "properties": { | 799 "properties": { |
917 "operator": { | 800 "operator": { |
918 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", | 801 "description": "The operator for combining multiple metric f
ilters. If unspecified, it is\ntreated as an `OR`.", |
919 "enum": [ | 802 "enum": [ |
920 "OPERATOR_UNSPECIFIED", | 803 "OPERATOR_UNSPECIFIED", |
921 "OR", | 804 "OR", |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
958 ], | 841 ], |
959 "enumDescriptions": [ | 842 "enumDescriptions": [ |
960 "If unspecified it's treated as `FIRST_VISIT_DATE`.", | 843 "If unspecified it's treated as `FIRST_VISIT_DATE`.", |
961 "Cohorts that are selected based on first visit date." | 844 "Cohorts that are selected based on first visit date." |
962 ], | 845 ], |
963 "type": "string" | 846 "type": "string" |
964 } | 847 } |
965 }, | 848 }, |
966 "type": "object" | 849 "type": "object" |
967 }, | 850 }, |
| 851 "ReportRow": { |
| 852 "description": "A row in the report.", |
| 853 "id": "ReportRow", |
| 854 "properties": { |
| 855 "dimensions": { |
| 856 "description": "List of requested dimensions.", |
| 857 "items": { |
| 858 "type": "string" |
| 859 }, |
| 860 "type": "array" |
| 861 }, |
| 862 "metrics": { |
| 863 "description": "List of metrics for each requested DateRange
.", |
| 864 "items": { |
| 865 "$ref": "DateRangeValues" |
| 866 }, |
| 867 "type": "array" |
| 868 } |
| 869 }, |
| 870 "type": "object" |
| 871 }, |
968 "OrFiltersForSegment": { | 872 "OrFiltersForSegment": { |
969 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", | 873 "description": "A list of segment filters in the `OR` group are comb
ined with the logical OR\noperator.", |
970 "id": "OrFiltersForSegment", | 874 "id": "OrFiltersForSegment", |
971 "properties": { | 875 "properties": { |
972 "segmentFilterClauses": { | 876 "segmentFilterClauses": { |
973 "description": "List of segment filters to be combined with
a `OR` operator.", | 877 "description": "List of segment filters to be combined with
a `OR` operator.", |
974 "items": { | 878 "items": { |
975 "$ref": "SegmentFilterClause" | 879 "$ref": "SegmentFilterClause" |
976 }, | 880 }, |
977 "type": "array" | 881 "type": "array" |
(...skipping 168 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1146 }, | 1050 }, |
1147 "cohorts": { | 1051 "cohorts": { |
1148 "description": "The definition for the cohort.", | 1052 "description": "The definition for the cohort.", |
1149 "items": { | 1053 "items": { |
1150 "$ref": "Cohort" | 1054 "$ref": "Cohort" |
1151 }, | 1055 }, |
1152 "type": "array" | 1056 "type": "array" |
1153 } | 1057 } |
1154 }, | 1058 }, |
1155 "type": "object" | 1059 "type": "object" |
| 1060 }, |
| 1061 "GetReportsRequest": { |
| 1062 "description": "The batch request containing multiple report request
.", |
| 1063 "id": "GetReportsRequest", |
| 1064 "properties": { |
| 1065 "reportRequests": { |
| 1066 "description": "Requests, each request will have a separate
response.\nThere can be a maximum of 5 requests. All requests should have the sa
me\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.", |
| 1067 "items": { |
| 1068 "$ref": "ReportRequest" |
| 1069 }, |
| 1070 "type": "array" |
| 1071 } |
| 1072 }, |
| 1073 "type": "object" |
| 1074 }, |
| 1075 "Pivot": { |
| 1076 "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.", |
| 1077 "id": "Pivot", |
| 1078 "properties": { |
| 1079 "startGroup": { |
| 1080 "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.", |
| 1081 "format": "int32", |
| 1082 "type": "integer" |
| 1083 }, |
| 1084 "metrics": { |
| 1085 "description": "The pivot metrics. Pivot metrics are part of
the\nrestriction on total number of metrics allowed in the request.", |
| 1086 "items": { |
| 1087 "$ref": "Metric" |
| 1088 }, |
| 1089 "type": "array" |
| 1090 }, |
| 1091 "dimensions": { |
| 1092 "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.", |
| 1093 "items": { |
| 1094 "$ref": "Dimension" |
| 1095 }, |
| 1096 "type": "array" |
| 1097 }, |
| 1098 "dimensionFilterClauses": { |
| 1099 "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.", |
| 1100 "items": { |
| 1101 "$ref": "DimensionFilterClause" |
| 1102 }, |
| 1103 "type": "array" |
| 1104 }, |
| 1105 "maxGroupCount": { |
| 1106 "description": "Specifies the maximum number of groups to re
turn.\nThe default value is 10, also the maximum value is 1,000.", |
| 1107 "format": "int32", |
| 1108 "type": "integer" |
| 1109 } |
| 1110 }, |
| 1111 "type": "object" |
| 1112 }, |
| 1113 "PivotHeaderEntry": { |
| 1114 "description": "The headers for the each of the metric column corres
ponding to the metrics\nrequested in the pivots section of the response.", |
| 1115 "id": "PivotHeaderEntry", |
| 1116 "properties": { |
| 1117 "dimensionNames": { |
| 1118 "description": "The name of the dimensions in the pivot resp
onse.", |
| 1119 "items": { |
| 1120 "type": "string" |
| 1121 }, |
| 1122 "type": "array" |
| 1123 }, |
| 1124 "metric": { |
| 1125 "$ref": "MetricHeaderEntry", |
| 1126 "description": "The metric header for the metric in the pivo
t." |
| 1127 }, |
| 1128 "dimensionValues": { |
| 1129 "description": "The values for the dimensions in the pivot."
, |
| 1130 "items": { |
| 1131 "type": "string" |
| 1132 }, |
| 1133 "type": "array" |
| 1134 } |
| 1135 }, |
| 1136 "type": "object" |
| 1137 }, |
| 1138 "SegmentFilter": { |
| 1139 "description": "SegmentFilter defines the segment to be either a sim
ple or a sequence\nsegment. A simple segment condition contains dimension and me
tric conditions\nto select the sessions or users. A sequence segment condition c
an be used to\nselect users or sessions based on sequential conditions.", |
| 1140 "id": "SegmentFilter", |
| 1141 "properties": { |
| 1142 "sequenceSegment": { |
| 1143 "$ref": "SequenceSegment", |
| 1144 "description": "Sequence conditions consist of one or more s
teps, where each step is\ndefined by one or more dimension/metric conditions. Mu
ltiple steps can\nbe combined with special sequence operators." |
| 1145 }, |
| 1146 "not": { |
| 1147 "description": "If true, match the complement of simple or s
equence segment.\nFor example, to match all visits not from \"New York\", we can
define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segme
ntFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegme
nt\": [{\n \"segmentFilterClauses\":[{\n \"dimension
Filter\": {\n \"dimensionName\": \"ga:city\",\n
\"expressions\": [\"New York\"]\n }\n }]\n
}]\n },\n \"not\": \"True\"\n }]\n },", |
| 1148 "type": "boolean" |
| 1149 }, |
| 1150 "simpleSegment": { |
| 1151 "$ref": "SimpleSegment", |
| 1152 "description": "A Simple segment conditions consist of one o
r more dimension/metric\nconditions that can be combined" |
| 1153 } |
| 1154 }, |
| 1155 "type": "object" |
1156 } | 1156 } |
1157 }, | 1157 }, |
1158 "servicePath": "", | 1158 "servicePath": "", |
1159 "title": "Google Analytics Reporting API", | 1159 "title": "Google Analytics Reporting API", |
1160 "version": "v4" | 1160 "version": "v4" |
1161 } | 1161 } |
OLD | NEW |