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

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

Issue 2973303002: Api-Roll 51: 2017-07-10 (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/analytics.readonly": { 5 "https://www.googleapis.com/auth/analytics.readonly": {
6 "description": "View your Google Analytics data" 6 "description": "View your Google Analytics data"
7 }, 7 },
8 "https://www.googleapis.com/auth/analytics": { 8 "https://www.googleapis.com/auth/analytics": {
9 "description": "View and manage your Google Analytics data" 9 "description": "View and manage your Google Analytics data"
10 } 10 }
(...skipping 10 matching lines...) Expand all
21 "icons": { 21 "icons": {
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", 22 "x16": "http://www.google.com/images/icons/product/search-16.gif",
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" 23 "x32": "http://www.google.com/images/icons/product/search-32.gif"
24 }, 24 },
25 "id": "analyticsreporting:v4", 25 "id": "analyticsreporting:v4",
26 "kind": "discovery#restDescription", 26 "kind": "discovery#restDescription",
27 "name": "analyticsreporting", 27 "name": "analyticsreporting",
28 "ownerDomain": "google.com", 28 "ownerDomain": "google.com",
29 "ownerName": "Google", 29 "ownerName": "Google",
30 "parameters": { 30 "parameters": {
31 "upload_protocol": {
32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
33 "location": "query",
34 "type": "string"
35 },
36 "prettyPrint": {
37 "default": "true",
38 "description": "Returns response with indentations and line breaks." ,
39 "location": "query",
40 "type": "boolean"
41 },
42 "fields": {
43 "description": "Selector specifying which fields to include in a par tial response.",
44 "location": "query",
45 "type": "string"
46 },
47 "uploadType": {
48 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
49 "location": "query",
50 "type": "string"
51 },
52 "$.xgafv": {
53 "description": "V1 error format.",
54 "enum": [
55 "1",
56 "2"
57 ],
58 "enumDescriptions": [
59 "v1 error format",
60 "v2 error format"
61 ],
62 "location": "query",
63 "type": "string"
64 },
65 "callback": {
66 "description": "JSONP",
67 "location": "query",
68 "type": "string"
69 },
31 "alt": { 70 "alt": {
32 "default": "json", 71 "default": "json",
33 "description": "Data format for response.", 72 "description": "Data format for response.",
34 "enum": [ 73 "enum": [
35 "json", 74 "json",
36 "media", 75 "media",
37 "proto" 76 "proto"
38 ], 77 ],
39 "enumDescriptions": [ 78 "enumDescriptions": [
40 "Responses with Content-Type of application/json", 79 "Responses with Content-Type of application/json",
41 "Media download with context-dependent Content-Type", 80 "Media download with context-dependent Content-Type",
42 "Responses with Content-Type of application/x-protobuf" 81 "Responses with Content-Type of application/x-protobuf"
43 ], 82 ],
44 "location": "query", 83 "location": "query",
45 "type": "string" 84 "type": "string"
46 }, 85 },
86 "access_token": {
87 "description": "OAuth access token.",
88 "location": "query",
89 "type": "string"
90 },
47 "key": { 91 "key": {
48 "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.",
49 "location": "query", 93 "location": "query",
50 "type": "string" 94 "type": "string"
51 }, 95 },
52 "access_token": {
53 "description": "OAuth access token.",
54 "location": "query",
55 "type": "string"
56 },
57 "quotaUser": { 96 "quotaUser": {
58 "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.",
59 "location": "query", 98 "location": "query",
60 "type": "string" 99 "type": "string"
61 }, 100 },
62 "pp": { 101 "pp": {
63 "default": "true", 102 "default": "true",
64 "description": "Pretty-print response.", 103 "description": "Pretty-print response.",
65 "location": "query", 104 "location": "query",
66 "type": "boolean" 105 "type": "boolean"
67 }, 106 },
68 "bearer_token": { 107 "bearer_token": {
69 "description": "OAuth bearer token.", 108 "description": "OAuth bearer token.",
70 "location": "query", 109 "location": "query",
71 "type": "string" 110 "type": "string"
72 }, 111 },
73 "oauth_token": { 112 "oauth_token": {
74 "description": "OAuth 2.0 token for the current user.", 113 "description": "OAuth 2.0 token for the current user.",
75 "location": "query", 114 "location": "query",
76 "type": "string" 115 "type": "string"
77 },
78 "upload_protocol": {
79 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
80 "location": "query",
81 "type": "string"
82 },
83 "prettyPrint": {
84 "default": "true",
85 "description": "Returns response with indentations and line breaks." ,
86 "location": "query",
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": "20170531", 143 "revision": "20170705",
144 "rootUrl": "https://analyticsreporting.googleapis.com/", 144 "rootUrl": "https://analyticsreporting.googleapis.com/",
145 "schemas": { 145 "schemas": {
146 "PivotHeaderEntry": {
147 "description": "The headers for the each of the metric column corres ponding to the metrics\nrequested in the pivots section of the response.",
148 "id": "PivotHeaderEntry",
149 "properties": {
150 "dimensionValues": {
151 "description": "The values for the dimensions in the pivot." ,
152 "items": {
153 "type": "string"
154 },
155 "type": "array"
156 },
157 "metric": {
158 "$ref": "MetricHeaderEntry",
159 "description": "The metric header for the metric in the pivo t."
160 },
161 "dimensionNames": {
162 "description": "The name of the dimensions in the pivot resp onse.",
163 "items": {
164 "type": "string"
165 },
166 "type": "array"
167 }
168 },
169 "type": "object"
170 },
171 "SegmentFilter": {
172 "description": "SegmentFilter defines the segment to be either a sim ple or a sequence\nsegment. A simple segment condition contains dimension and me tric conditions\nto select the sessions or users. A sequence segment condition c an be used to\nselect users or sessions based on sequential conditions.",
173 "id": "SegmentFilter",
174 "properties": {
175 "sequenceSegment": {
176 "$ref": "SequenceSegment",
177 "description": "Sequence conditions consist of one or more s teps, where each step is\ndefined by one or more dimension/metric conditions. Mu ltiple steps can\nbe combined with special sequence operators."
178 },
179 "not": {
180 "description": "If true, match the complement of simple or s equence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segme ntFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegme nt\": [{\n \"segmentFilterClauses\":[{\n \"dimension Filter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
181 "type": "boolean"
182 },
183 "simpleSegment": {
184 "$ref": "SimpleSegment",
185 "description": "A Simple segment conditions consist of one o r more dimension/metric\nconditions that can be combined"
186 }
187 },
188 "type": "object"
189 },
146 "SegmentDefinition": { 190 "SegmentDefinition": {
147 "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.", 191 "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
148 "id": "SegmentDefinition", 192 "id": "SegmentDefinition",
149 "properties": { 193 "properties": {
150 "segmentFilters": { 194 "segmentFilters": {
151 "description": "A segment is defined by a set of segment fil ters which are combined\ntogether with a logical `AND` operation.", 195 "description": "A segment is defined by a set of segment fil ters which are combined\ntogether with a logical `AND` operation.",
152 "items": { 196 "items": {
153 "$ref": "SegmentFilter" 197 "$ref": "SegmentFilter"
154 }, 198 },
155 "type": "array" 199 "type": "array"
(...skipping 29 matching lines...) Expand all
185 ], 229 ],
186 "type": "string" 230 "type": "string"
187 } 231 }
188 }, 232 },
189 "type": "object" 233 "type": "object"
190 }, 234 },
191 "ReportData": { 235 "ReportData": {
192 "description": "The data part of the report.", 236 "description": "The data part of the report.",
193 "id": "ReportData", 237 "id": "ReportData",
194 "properties": { 238 "properties": {
195 "isDataGolden": { 239 "totals": {
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.", 240 "description": "For each requested date range, for the set o f all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression . E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of a ll relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
197 "type": "boolean"
198 },
199 "rows": {
200 "description": "There's one ReportRow for every unique combi nation of dimensions.",
201 "items": { 241 "items": {
202 "$ref": "ReportRow" 242 "$ref": "DateRangeValues"
203 }, 243 },
204 "type": "array" 244 "type": "array"
205 }, 245 },
246 "samplesReadCounts": {
247 "description": "If the results are\n[sampled](https://suppor t.google.com/analytics/answer/2637192),\nthis returns the total number of sample s read, one entry per date range.\nIf the results are not sampled this field wil l not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/ basics#sampling)\nfor details.",
248 "items": {
249 "format": "int64",
250 "type": "string"
251 },
252 "type": "array"
253 },
206 "rowCount": { 254 "rowCount": {
207 "description": "Total number of matching rows for this query .", 255 "description": "Total number of matching rows for this query .",
208 "format": "int32", 256 "format": "int32",
209 "type": "integer" 257 "type": "integer"
210 }, 258 },
259 "rows": {
260 "description": "There's one ReportRow for every unique combi nation of dimensions.",
261 "items": {
262 "$ref": "ReportRow"
263 },
264 "type": "array"
265 },
266 "isDataGolden": {
267 "description": "Indicates if response to this request is gol den or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
268 "type": "boolean"
269 },
211 "dataLastRefreshed": { 270 "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.", 271 "description": "The last time the data in the report was ref reshed. All the hits received\nbefore this timestamp are included in the calcula tion of the report.",
213 "format": "google-datetime", 272 "format": "google-datetime",
214 "type": "string" 273 "type": "string"
215 }, 274 },
216 "maximums": { 275 "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.", 276 "description": "Minimum and maximum values seen over all mat ching rows. These are both\nempty when `hideValueRanges` in the request is false , or when\nrowCount is zero.",
218 "items": { 277 "items": {
219 "$ref": "DateRangeValues" 278 "$ref": "DateRangeValues"
220 }, 279 },
221 "type": "array" 280 "type": "array"
222 }, 281 },
223 "minimums": { 282 "minimums": {
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.", 283 "description": "Minimum and maximum values seen over all mat ching rows. These are both\nempty when `hideValueRanges` in the request is false , or when\nrowCount is zero.",
225 "items": { 284 "items": {
226 "$ref": "DateRangeValues" 285 "$ref": "DateRangeValues"
227 }, 286 },
228 "type": "array" 287 "type": "array"
229 }, 288 },
230 "samplingSpaceSizes": { 289 "samplingSpaceSizes": {
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.", 290 "description": "If the results are\n[sampled](https://suppor t.google.com/analytics/answer/2637192),\nthis returns the total number of\nsampl es present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core /v4/basics#sampling)\nfor details.",
232 "items": { 291 "items": {
233 "format": "int64", 292 "format": "int64",
234 "type": "string" 293 "type": "string"
235 }, 294 },
236 "type": "array" 295 "type": "array"
237 },
238 "totals": {
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.",
240 "items": {
241 "$ref": "DateRangeValues"
242 },
243 "type": "array"
244 },
245 "samplesReadCounts": {
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.",
247 "items": {
248 "format": "int64",
249 "type": "string"
250 },
251 "type": "array"
252 } 296 }
253 }, 297 },
254 "type": "object" 298 "type": "object"
255 }, 299 },
256 "DimensionFilter": { 300 "DimensionFilter": {
257 "description": "Dimension filter specifies the filtering options on a dimension.", 301 "description": "Dimension filter specifies the filtering options on a dimension.",
258 "id": "DimensionFilter", 302 "id": "DimensionFilter",
259 "properties": { 303 "properties": {
260 "caseSensitive": {
261 "description": "Should the match be case sensitive? Default is false.",
262 "type": "boolean"
263 },
264 "dimensionName": {
265 "description": "The dimension to filter on. A DimensionFilte r must contain a dimension.",
266 "type": "string"
267 },
268 "operator": { 304 "operator": {
269 "description": "How to match the dimension to the expression . The default is REGEXP.", 305 "description": "How to match the dimension to the expression . The default is REGEXP.",
270 "enum": [ 306 "enum": [
271 "OPERATOR_UNSPECIFIED", 307 "OPERATOR_UNSPECIFIED",
272 "REGEXP", 308 "REGEXP",
273 "BEGINS_WITH", 309 "BEGINS_WITH",
274 "ENDS_WITH", 310 "ENDS_WITH",
275 "PARTIAL", 311 "PARTIAL",
276 "EXACT", 312 "EXACT",
277 "NUMERIC_EQUAL", 313 "NUMERIC_EQUAL",
278 "NUMERIC_GREATER_THAN", 314 "NUMERIC_GREATER_THAN",
279 "NUMERIC_LESS_THAN", 315 "NUMERIC_LESS_THAN",
280 "IN_LIST" 316 "IN_LIST"
281 ], 317 ],
282 "enumDescriptions": [ 318 "enumDescriptions": [
283 "If the match type is unspecified, it is treated as a `R EGEXP`.", 319 "If the match type is unspecified, it is treated as a `R EGEXP`.",
284 "The match expression is treated as a regular expression . All match types\nare not treated as regular expressions.", 320 "The match expression is treated as a regular expression . All match types\nare not treated as regular expressions.",
285 "Matches the value which begin with the match expression provided.", 321 "Matches the value which begin with the match expression provided.",
286 "Matches the values which end with the match expression provided.", 322 "Matches the values which end with the match expression provided.",
287 "Substring match.", 323 "Substring match.",
288 "The value should match the match expression entirely.", 324 "The value should match the match expression entirely.",
289 "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.", 325 "Integer comparison filters.\ncase sensitivity is ignore d for these and the expression\nis assumed to be a string representing an intege r.\nFailure conditions:\n\n- If expression is not a valid int64, the client shou ld expect\n an error.\n- Input dimensions that are not valid int64 values will never match the\n filter.",
290 "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions." , 326 "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions." ,
291 "Checks if the dimension is numerically less than the ma tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.", 327 "Checks if the dimension is numerically less than the ma tch expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
292 "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." 328 "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoid ing\nevaluating multiple exact match dimension filters which are OR'ed for\never y single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\ nAny response row whose dimension has it is value as A, B or C, matches\nthis Di mensionFilter."
293 ], 329 ],
294 "type": "string" 330 "type": "string"
295 }, 331 },
296 "not": { 332 "dimensionName": {
297 "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.", 333 "description": "The dimension to filter on. A DimensionFilte r must contain a dimension.",
298 "type": "boolean" 334 "type": "string"
299 }, 335 },
300 "expressions": { 336 "expressions": {
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.", 337 "description": "Strings or regular expression to match again st. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter th e\ndimensions as explained in the description of the `IN_LIST` operator.",
302 "items": { 338 "items": {
303 "type": "string" 339 "type": "string"
304 }, 340 },
305 "type": "array" 341 "type": "array"
342 },
343 "not": {
344 "description": "Logical `NOT` operator. If this boolean is s et to true, then the matching\ndimension values will be excluded in the report. The default is false.",
345 "type": "boolean"
346 },
347 "caseSensitive": {
348 "description": "Should the match be case sensitive? Default is false.",
349 "type": "boolean"
306 } 350 }
307 }, 351 },
308 "type": "object" 352 "type": "object"
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 }, 353 },
370 "SegmentDimensionFilter": { 354 "SegmentDimensionFilter": {
371 "description": "Dimension filter specifies the filtering options on a dimension.", 355 "description": "Dimension filter specifies the filtering options on a dimension.",
372 "id": "SegmentDimensionFilter", 356 "id": "SegmentDimensionFilter",
373 "properties": { 357 "properties": {
358 "caseSensitive": {
359 "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
360 "type": "boolean"
361 },
362 "minComparisonValue": {
363 "description": "Minimum comparison values for `BETWEEN` matc h type.",
364 "type": "string"
365 },
366 "maxComparisonValue": {
367 "description": "Maximum comparison values for `BETWEEN` matc h type.",
368 "type": "string"
369 },
374 "dimensionName": { 370 "dimensionName": {
375 "description": "Name of the dimension for which the filter i s being applied.", 371 "description": "Name of the dimension for which the filter i s being applied.",
376 "type": "string" 372 "type": "string"
377 }, 373 },
378 "operator": { 374 "operator": {
379 "description": "The operator to use to match the dimension w ith the expressions.", 375 "description": "The operator to use to match the dimension w ith the expressions.",
380 "enum": [ 376 "enum": [
381 "OPERATOR_UNSPECIFIED", 377 "OPERATOR_UNSPECIFIED",
382 "REGEXP", 378 "REGEXP",
383 "BEGINS_WITH", 379 "BEGINS_WITH",
(...skipping 18 matching lines...) Expand all
402 "Checks if the dimension is numerically between the mini mum and maximum\nof the match expression, boundaries excluded." 398 "Checks if the dimension is numerically between the mini mum and maximum\nof the match expression, boundaries excluded."
403 ], 399 ],
404 "type": "string" 400 "type": "string"
405 }, 401 },
406 "expressions": { 402 "expressions": {
407 "description": "The list of expressions, only the first elem ent is used for all operators", 403 "description": "The list of expressions, only the first elem ent is used for all operators",
408 "items": { 404 "items": {
409 "type": "string" 405 "type": "string"
410 }, 406 },
411 "type": "array" 407 "type": "array"
412 }, 408 }
413 "caseSensitive": { 409 },
414 "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.", 410 "type": "object"
415 "type": "boolean" 411 },
416 }, 412 "OrderBy": {
417 "minComparisonValue": { 413 "description": "Specifies the sorting options.",
418 "description": "Minimum comparison values for `BETWEEN` matc h type.", 414 "id": "OrderBy",
415 "properties": {
416 "orderType": {
417 "description": "The order type. The default orderType is `VA LUE`.",
418 "enum": [
419 "ORDER_TYPE_UNSPECIFIED",
420 "VALUE",
421 "DELTA",
422 "SMART",
423 "HISTOGRAM_BUCKET",
424 "DIMENSION_AS_INTEGER"
425 ],
426 "enumDescriptions": [
427 "Unspecified order type will be treated as sort based on value.",
428 "The sort order is based on the value of the chosen colu mn; looks only at\nthe first date range.",
429 "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.",
430 "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." ,
431 "Histogram order type is applicable only to dimension co lumns with\nnon-empty histogram-buckets.",
432 "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."
433 ],
419 "type": "string" 434 "type": "string"
420 }, 435 },
421 "maxComparisonValue": { 436 "fieldName": {
422 "description": "Maximum comparison values for `BETWEEN` matc h type.", 437 "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.",
438 "type": "string"
439 },
440 "sortOrder": {
441 "description": "The sorting order for the field.",
442 "enum": [
443 "SORT_ORDER_UNSPECIFIED",
444 "ASCENDING",
445 "DESCENDING"
446 ],
447 "enumDescriptions": [
448 "If the sort order is unspecified, the default is ascend ing.",
449 "Ascending sort. The field will be sorted in an ascendin g manner.",
450 "Descending sort. The field will be sorted in a descendi ng manner."
451 ],
423 "type": "string" 452 "type": "string"
424 } 453 }
425 }, 454 },
455 "type": "object"
456 },
457 "Segment": {
458 "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.",
459 "id": "Segment",
460 "properties": {
461 "dynamicSegment": {
462 "$ref": "DynamicSegment",
463 "description": "A dynamic segment definition in the request. "
464 },
465 "segmentId": {
466 "description": "The segment ID of a built-in or custom segme nt, for example `gaid::-3`.",
467 "type": "string"
468 }
469 },
426 "type": "object" 470 "type": "object"
427 }, 471 },
428 "SegmentSequenceStep": { 472 "SegmentSequenceStep": {
429 "description": "A segment sequence definition.", 473 "description": "A segment sequence definition.",
430 "id": "SegmentSequenceStep", 474 "id": "SegmentSequenceStep",
431 "properties": { 475 "properties": {
432 "orFiltersForSegment": { 476 "orFiltersForSegment": {
433 "description": "A sequence is specified with a list of Or gr ouped filters which are\ncombined with `AND` operator.", 477 "description": "A sequence is specified with a list of Or gr ouped filters which are\ncombined with `AND` operator.",
434 "items": { 478 "items": {
435 "$ref": "OrFiltersForSegment" 479 "$ref": "OrFiltersForSegment"
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after
503 "type": "object" 547 "type": "object"
504 }, 548 },
505 "Report": { 549 "Report": {
506 "description": "The data response corresponding to the request.", 550 "description": "The data response corresponding to the request.",
507 "id": "Report", 551 "id": "Report",
508 "properties": { 552 "properties": {
509 "columnHeader": { 553 "columnHeader": {
510 "$ref": "ColumnHeader", 554 "$ref": "ColumnHeader",
511 "description": "The column headers." 555 "description": "The column headers."
512 }, 556 },
557 "nextPageToken": {
558 "description": "Page token to retrieve the next page of resu lts in the list.",
559 "type": "string"
560 },
513 "data": { 561 "data": {
514 "$ref": "ReportData", 562 "$ref": "ReportData",
515 "description": "Response data." 563 "description": "Response data."
516 },
517 "nextPageToken": {
518 "description": "Page token to retrieve the next page of resu lts in the list.",
519 "type": "string"
520 } 564 }
521 }, 565 },
522 "type": "object" 566 "type": "object"
523 }, 567 },
524 "PivotHeader": { 568 "PivotHeader": {
525 "description": "The headers for each of the pivot sections defined i n the request.", 569 "description": "The headers for each of the pivot sections defined i n the request.",
526 "id": "PivotHeader", 570 "id": "PivotHeader",
527 "properties": { 571 "properties": {
528 "pivotHeaderEntries": { 572 "pivotHeaderEntries": {
529 "description": "A single pivot section header.", 573 "description": "A single pivot section header.",
530 "items": { 574 "items": {
531 "$ref": "PivotHeaderEntry" 575 "$ref": "PivotHeaderEntry"
532 }, 576 },
533 "type": "array" 577 "type": "array"
534 }, 578 },
535 "totalPivotGroupsCount": { 579 "totalPivotGroupsCount": {
536 "description": "The total number of groups for this pivot.", 580 "description": "The total number of groups for this pivot.",
537 "format": "int32", 581 "format": "int32",
538 "type": "integer" 582 "type": "integer"
539 } 583 }
540 }, 584 },
541 "type": "object" 585 "type": "object"
542 }, 586 },
543 "DateRange": { 587 "DateRange": {
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`.", 588 "description": "A contiguous set of days: startDate, startDate + 1 d ay, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://e n.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
545 "id": "DateRange", 589 "id": "DateRange",
546 "properties": { 590 "properties": {
547 "startDate": {
548 "description": "The start date for the query in the format ` YYYY-MM-DD`.",
549 "type": "string"
550 },
551 "endDate": { 591 "endDate": {
552 "description": "The end date for the query in the format `YY YY-MM-DD`.", 592 "description": "The end date for the query in the format `YY YY-MM-DD`.",
553 "type": "string" 593 "type": "string"
554 }
555 },
556 "type": "object"
557 },
558 "MetricFilter": {
559 "description": "MetricFilter specifies the filter on a metric.",
560 "id": "MetricFilter",
561 "properties": {
562 "operator": {
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." ,
564 "enum": [
565 "OPERATOR_UNSPECIFIED",
566 "EQUAL",
567 "LESS_THAN",
568 "GREATER_THAN",
569 "IS_MISSING"
570 ],
571 "enumDescriptions": [
572 "If the operator is not specified, it is treated as `EQU AL`.",
573 "Should the value of the metric be exactly equal to the comparison value.",
574 "Should the value of the metric be less than to the comp arison value.",
575 "Should the value of the metric be greater than to the c omparison value.",
576 "Validates if the metric is missing.\nDoesn't take compa risonValue into account."
577 ],
578 "type": "string"
579 }, 594 },
580 "not": { 595 "startDate": {
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.", 596 "description": "The start date for the query in the format ` YYYY-MM-DD`.",
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" 597 "type": "string"
591 } 598 }
592 }, 599 },
593 "type": "object" 600 "type": "object"
594 }, 601 },
595 "ReportRequest": { 602 "ReportRequest": {
596 "description": "The main request class which specifies the Reporting API request.", 603 "description": "The main request class which specifies the Reporting API request.",
597 "id": "ReportRequest", 604 "id": "ReportRequest",
598 "properties": { 605 "properties": {
606 "orderBys": {
607 "description": "Sort order on output rows. To compare two ro ws, the elements of the\nfollowing are applied in order until a difference is fo und. All date\nranges in the output get the same row order.",
608 "items": {
609 "$ref": "OrderBy"
610 },
611 "type": "array"
612 },
613 "segments": {
614 "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request ca n contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n `batchGet` method must contain the same `segments` definition. Requests\nwith se gments must have the `ga:segment` dimension.",
615 "items": {
616 "$ref": "Segment"
617 },
618 "type": "array"
619 },
620 "samplingLevel": {
621 "description": "The desired report\n[sample](https://support .google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#Repor tRequest) within a\n`batchGet` method must contain the same `samplingLevel` defi nition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sam pling)\n for details.",
622 "enum": [
623 "SAMPLING_UNSPECIFIED",
624 "DEFAULT",
625 "SMALL",
626 "LARGE"
627 ],
628 "enumDescriptions": [
629 "If the `samplingLevel` field is unspecified the `DEFAUL T` sampling level\nis used.",
630 "Returns response with a sample size that balances speed and\naccuracy.",
631 "It returns a fast response with a smaller sampling size .",
632 "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
633 ],
634 "type": "string"
635 },
636 "dimensions": {
637 "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
638 "items": {
639 "$ref": "Dimension"
640 },
641 "type": "array"
642 },
643 "pageToken": {
644 "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.",
645 "type": "string"
646 },
647 "dateRanges": {
648 "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.",
649 "items": {
650 "$ref": "DateRange"
651 },
652 "type": "array"
653 },
654 "pivots": {
655 "description": "The pivot definitions. Requests can have a m aximum of 2 pivots.",
656 "items": {
657 "$ref": "Pivot"
658 },
659 "type": "array"
660 },
661 "includeEmptyRows": {
662 "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.",
663 "type": "boolean"
664 },
599 "metricFilterClauses": { 665 "metricFilterClauses": {
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.", 666 "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.",
601 "items": { 667 "items": {
602 "$ref": "MetricFilterClause" 668 "$ref": "MetricFilterClause"
603 }, 669 },
604 "type": "array" 670 "type": "array"
605 }, 671 },
606 "pageSize": { 672 "pageSize": {
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.", 673 "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.",
608 "format": "int32", 674 "format": "int32",
(...skipping 25 matching lines...) Expand all
634 "$ref": "Metric" 700 "$ref": "Metric"
635 }, 701 },
636 "type": "array" 702 "type": "array"
637 }, 703 },
638 "dimensionFilterClauses": { 704 "dimensionFilterClauses": {
639 "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.", 705 "description": "The dimension filter clauses for filtering D imension Values. They are\nlogically combined with the `AND` operator. Note that filtering occurs\nbefore any dimensions are aggregated, so that the returned me trics\nrepresent the total for only the relevant dimensions.",
640 "items": { 706 "items": {
641 "$ref": "DimensionFilterClause" 707 "$ref": "DimensionFilterClause"
642 }, 708 },
643 "type": "array" 709 "type": "array"
710 }
711 },
712 "type": "object"
713 },
714 "MetricFilter": {
715 "description": "MetricFilter specifies the filter on a metric.",
716 "id": "MetricFilter",
717 "properties": {
718 "comparisonValue": {
719 "description": "The value to compare against.",
720 "type": "string"
644 }, 721 },
645 "orderBys": { 722 "operator": {
646 "description": "Sort order on output rows. To compare two ro ws, the elements of the\nfollowing are applied in order until a difference is fo und. All date\nranges in the output get the same row order.", 723 "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREAT ER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_M ISSING`, checks if the metric is missing and would ignore the\ncomparisonValue." ,
647 "items": {
648 "$ref": "OrderBy"
649 },
650 "type": "array"
651 },
652 "segments": {
653 "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request ca n contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n `batchGet` method must contain the same `segments` definition. Requests\nwith se gments must have the `ga:segment` dimension.",
654 "items": {
655 "$ref": "Segment"
656 },
657 "type": "array"
658 },
659 "samplingLevel": {
660 "description": "The desired report\n[sample](https://support .google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#Repor tRequest) within a\n`batchGet` method must contain the same `samplingLevel` defi nition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sam pling)\n for details.",
661 "enum": [ 724 "enum": [
662 "SAMPLING_UNSPECIFIED", 725 "OPERATOR_UNSPECIFIED",
663 "DEFAULT", 726 "EQUAL",
664 "SMALL", 727 "LESS_THAN",
665 "LARGE" 728 "GREATER_THAN",
729 "IS_MISSING"
666 ], 730 ],
667 "enumDescriptions": [ 731 "enumDescriptions": [
668 "If the `samplingLevel` field is unspecified the `DEFAUL T` sampling level\nis used.", 732 "If the operator is not specified, it is treated as `EQU AL`.",
669 "Returns response with a sample size that balances speed and\naccuracy.", 733 "Should the value of the metric be exactly equal to the comparison value.",
670 "It returns a fast response with a smaller sampling size .", 734 "Should the value of the metric be less than to the comp arison value.",
671 "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower." 735 "Should the value of the metric be greater than to the c omparison value.",
736 "Validates if the metric is missing.\nDoesn't take compa risonValue into account."
672 ], 737 ],
673 "type": "string" 738 "type": "string"
674 }, 739 },
675 "dimensions": { 740 "not": {
676 "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.", 741 "description": "Logical `NOT` operator. If this boolean is s et to true, then the matching\nmetric values will be excluded in the report. The default is false.",
677 "items": { 742 "type": "boolean"
678 "$ref": "Dimension"
679 },
680 "type": "array"
681 }, 743 },
682 "pageToken": { 744 "metricName": {
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.", 745 "description": "The metric that will be filtered on. A metri cFilter must contain a metric\nname. A metric name can be an alias earlier defin ed as a metric or it can\nalso be a metric expression.",
684 "type": "string" 746 "type": "string"
685 },
686 "dateRanges": {
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.",
688 "items": {
689 "$ref": "DateRange"
690 },
691 "type": "array"
692 },
693 "pivots": {
694 "description": "The pivot definitions. Requests can have a m aximum of 2 pivots.",
695 "items": {
696 "$ref": "Pivot"
697 },
698 "type": "array"
699 },
700 "includeEmptyRows": {
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.",
702 "type": "boolean"
703 } 747 }
704 }, 748 },
705 "type": "object" 749 "type": "object"
706 }, 750 },
707 "Dimension": { 751 "Dimension": {
708 "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.", 752 "description": "[Dimensions](https://support.google.com/analytics/an swer/1033861)\nare attributes of your data. For example, the dimension `ga:city` \nindicates the city, for example, \"Paris\" or \"New York\", from which\na sess ion originates.",
709 "id": "Dimension", 753 "id": "Dimension",
710 "properties": { 754 "properties": {
711 "histogramBuckets": { 755 "histogramBuckets": {
712 "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.", 756 "description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string repres entation of an\nintegral value will be converted to zero. The bucket values hav e to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\ nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nva lues that fall in a bucket get transformed to a new dimension value. For\nexampl e, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing bucke ts:\n\n- bucket #1: values < 0, dimension value \"<0\"\n- bucket #2: values in [ 0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2 \"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values >= 7, dimension value \"7+\" \n\nNOTE: If you are applying histogram mutation on any dimension, and using\nth at dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to di ctionary\n(lexicographic) order. For example the ascending dictionary order is:\ n\n \"<50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGR AM_BUCKET` order is:\n\n \"<50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe c lient has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a his togram-mutated dimension.",
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
771 "$ref": "MetricHeader", 815 "$ref": "MetricHeader",
772 "description": "Metric headers for the metrics in the respon se." 816 "description": "Metric headers for the metrics in the respon se."
773 } 817 }
774 }, 818 },
775 "type": "object" 819 "type": "object"
776 }, 820 },
777 "SegmentFilterClause": { 821 "SegmentFilterClause": {
778 "description": "Filter Clause to be used in a segment definition, ca n be wither a metric or\na dimension filter.", 822 "description": "Filter Clause to be used in a segment definition, ca n be wither a metric or\na dimension filter.",
779 "id": "SegmentFilterClause", 823 "id": "SegmentFilterClause",
780 "properties": { 824 "properties": {
825 "metricFilter": {
826 "$ref": "SegmentMetricFilter",
827 "description": "Metric Filter for the segment definition."
828 },
781 "not": { 829 "not": {
782 "description": "Matches the complement (`!`) of the filter." , 830 "description": "Matches the complement (`!`) of the filter." ,
783 "type": "boolean" 831 "type": "boolean"
784 }, 832 },
785 "dimensionFilter": { 833 "dimensionFilter": {
786 "$ref": "SegmentDimensionFilter", 834 "$ref": "SegmentDimensionFilter",
787 "description": "Dimension Filter for the segment definition. " 835 "description": "Dimension Filter for the segment definition. "
788 },
789 "metricFilter": {
790 "$ref": "SegmentMetricFilter",
791 "description": "Metric Filter for the segment definition."
792 } 836 }
793 }, 837 },
794 "type": "object" 838 "type": "object"
795 },
796 "MetricFilterClause": {
797 "description": "Represents a group of metric filters.\nSet the opera tor value to specify how the filters are logically combined.",
798 "id": "MetricFilterClause",
799 "properties": {
800 "operator": {
801 "description": "The operator for combining multiple metric f ilters. If unspecified, it is\ntreated as an `OR`.",
802 "enum": [
803 "OPERATOR_UNSPECIFIED",
804 "OR",
805 "AND"
806 ],
807 "enumDescriptions": [
808 "Unspecified operator. It is treated as an `OR`.",
809 "The logical `OR` operator.",
810 "The logical `AND` operator."
811 ],
812 "type": "string"
813 },
814 "filters": {
815 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.",
816 "items": {
817 "$ref": "MetricFilter"
818 },
819 "type": "array"
820 }
821 },
822 "type": "object"
823 }, 839 },
824 "Cohort": { 840 "Cohort": {
825 "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.", 841 "description": "Defines a cohort. A cohort is a group of users who s hare a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
826 "id": "Cohort", 842 "id": "Cohort",
827 "properties": { 843 "properties": {
844 "dateRange": {
845 "$ref": "DateRange",
846 "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end d ate defined in the\nDateRange. The date ranges should be aligned for cohort requ ests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day lo ng,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\n at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshou ld be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field."
847 },
828 "name": { 848 "name": {
829 "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].", 849 "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
830 "type": "string" 850 "type": "string"
831 }, 851 },
832 "dateRange": {
833 "$ref": "DateRange",
834 "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end d ate defined in the\nDateRange. The date ranges should be aligned for cohort requ ests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day lo ng,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\n at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshou ld be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field."
835 },
836 "type": { 852 "type": {
837 "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is tre ated\nas `FIRST_VISIT_DATE` type cohort.", 853 "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is tre ated\nas `FIRST_VISIT_DATE` type cohort.",
838 "enum": [ 854 "enum": [
839 "UNSPECIFIED_COHORT_TYPE", 855 "UNSPECIFIED_COHORT_TYPE",
840 "FIRST_VISIT_DATE" 856 "FIRST_VISIT_DATE"
841 ], 857 ],
842 "enumDescriptions": [ 858 "enumDescriptions": [
843 "If unspecified it's treated as `FIRST_VISIT_DATE`.", 859 "If unspecified it's treated as `FIRST_VISIT_DATE`.",
844 "Cohorts that are selected based on first visit date." 860 "Cohorts that are selected based on first visit date."
845 ], 861 ],
846 "type": "string" 862 "type": "string"
847 } 863 }
848 }, 864 },
849 "type": "object" 865 "type": "object"
850 }, 866 },
851 "ReportRow": { 867 "ReportRow": {
852 "description": "A row in the report.", 868 "description": "A row in the report.",
853 "id": "ReportRow", 869 "id": "ReportRow",
854 "properties": { 870 "properties": {
871 "metrics": {
872 "description": "List of metrics for each requested DateRange .",
873 "items": {
874 "$ref": "DateRangeValues"
875 },
876 "type": "array"
877 },
855 "dimensions": { 878 "dimensions": {
856 "description": "List of requested dimensions.", 879 "description": "List of requested dimensions.",
857 "items": { 880 "items": {
858 "type": "string" 881 "type": "string"
859 }, 882 },
860 "type": "array" 883 "type": "array"
861 },
862 "metrics": {
863 "description": "List of metrics for each requested DateRange .",
864 "items": {
865 "$ref": "DateRangeValues"
866 },
867 "type": "array"
868 } 884 }
869 }, 885 },
870 "type": "object" 886 "type": "object"
887 },
888 "MetricFilterClause": {
889 "description": "Represents a group of metric filters.\nSet the opera tor value to specify how the filters are logically combined.",
890 "id": "MetricFilterClause",
891 "properties": {
892 "filters": {
893 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.",
894 "items": {
895 "$ref": "MetricFilter"
896 },
897 "type": "array"
898 },
899 "operator": {
900 "description": "The operator for combining multiple metric f ilters. If unspecified, it is\ntreated as an `OR`.",
901 "enum": [
902 "OPERATOR_UNSPECIFIED",
903 "OR",
904 "AND"
905 ],
906 "enumDescriptions": [
907 "Unspecified operator. It is treated as an `OR`.",
908 "The logical `OR` operator.",
909 "The logical `AND` operator."
910 ],
911 "type": "string"
912 }
913 },
914 "type": "object"
871 }, 915 },
872 "OrFiltersForSegment": { 916 "OrFiltersForSegment": {
873 "description": "A list of segment filters in the `OR` group are comb ined with the logical OR\noperator.", 917 "description": "A list of segment filters in the `OR` group are comb ined with the logical OR\noperator.",
874 "id": "OrFiltersForSegment", 918 "id": "OrFiltersForSegment",
875 "properties": { 919 "properties": {
876 "segmentFilterClauses": { 920 "segmentFilterClauses": {
877 "description": "List of segment filters to be combined with a `OR` operator.", 921 "description": "List of segment filters to be combined with a `OR` operator.",
878 "items": { 922 "items": {
879 "$ref": "SegmentFilterClause" 923 "$ref": "SegmentFilterClause"
880 }, 924 },
(...skipping 20 matching lines...) Expand all
901 }, 945 },
902 "type": "array" 946 "type": "array"
903 } 947 }
904 }, 948 },
905 "type": "object" 949 "type": "object"
906 }, 950 },
907 "DimensionFilterClause": { 951 "DimensionFilterClause": {
908 "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.", 952 "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
909 "id": "DimensionFilterClause", 953 "id": "DimensionFilterClause",
910 "properties": { 954 "properties": {
955 "filters": {
956 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.",
957 "items": {
958 "$ref": "DimensionFilter"
959 },
960 "type": "array"
961 },
911 "operator": { 962 "operator": {
912 "description": "The operator for combining multiple dimensio n filters. If unspecified, it\nis treated as an `OR`.", 963 "description": "The operator for combining multiple dimensio n filters. If unspecified, it\nis treated as an `OR`.",
913 "enum": [ 964 "enum": [
914 "OPERATOR_UNSPECIFIED", 965 "OPERATOR_UNSPECIFIED",
915 "OR", 966 "OR",
916 "AND" 967 "AND"
917 ], 968 ],
918 "enumDescriptions": [ 969 "enumDescriptions": [
919 "Unspecified operator. It is treated as an `OR`.", 970 "Unspecified operator. It is treated as an `OR`.",
920 "The logical `OR` operator.", 971 "The logical `OR` operator.",
921 "The logical `AND` operator." 972 "The logical `AND` operator."
922 ], 973 ],
923 "type": "string" 974 "type": "string"
924 },
925 "filters": {
926 "description": "The repeated set of filters. They are logica lly combined based on the\noperator specified.",
927 "items": {
928 "$ref": "DimensionFilter"
929 },
930 "type": "array"
931 } 975 }
932 }, 976 },
933 "type": "object" 977 "type": "object"
934 }, 978 },
935 "GetReportsResponse": { 979 "GetReportsResponse": {
936 "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.", 980 "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
937 "id": "GetReportsResponse", 981 "id": "GetReportsResponse",
938 "properties": { 982 "properties": {
939 "reports": { 983 "reports": {
940 "description": "Responses corresponding to each of the reque st.", 984 "description": "Responses corresponding to each of the reque st.",
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
1016 "description": "The value to compare against. If the operato r is `BETWEEN`, this value is\ntreated as minimum comparison value.", 1060 "description": "The value to compare against. If the operato r is `BETWEEN`, this value is\ntreated as minimum comparison value.",
1017 "type": "string" 1061 "type": "string"
1018 } 1062 }
1019 }, 1063 },
1020 "type": "object" 1064 "type": "object"
1021 }, 1065 },
1022 "DateRangeValues": { 1066 "DateRangeValues": {
1023 "description": "Used to return a list of metrics for a single DateRa nge / dimension\ncombination", 1067 "description": "Used to return a list of metrics for a single DateRa nge / dimension\ncombination",
1024 "id": "DateRangeValues", 1068 "id": "DateRangeValues",
1025 "properties": { 1069 "properties": {
1070 "pivotValueRegions": {
1071 "description": "The values of each pivot region.",
1072 "items": {
1073 "$ref": "PivotValueRegion"
1074 },
1075 "type": "array"
1076 },
1026 "values": { 1077 "values": {
1027 "description": "Each value corresponds to each Metric in the request.", 1078 "description": "Each value corresponds to each Metric in the request.",
1028 "items": { 1079 "items": {
1029 "type": "string" 1080 "type": "string"
1030 }, 1081 },
1031 "type": "array" 1082 "type": "array"
1032 },
1033 "pivotValueRegions": {
1034 "description": "The values of each pivot region.",
1035 "items": {
1036 "$ref": "PivotValueRegion"
1037 },
1038 "type": "array"
1039 } 1083 }
1040 }, 1084 },
1041 "type": "object" 1085 "type": "object"
1042 }, 1086 },
1043 "CohortGroup": { 1087 "CohortGroup": {
1044 "description": "Defines a cohort group.\nFor example:\n\n \"cohor tGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"t ype\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08- 01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\" : \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }", 1088 "description": "Defines a cohort group.\nFor example:\n\n \"cohor tGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"t ype\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08- 01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\" : \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
1045 "id": "CohortGroup", 1089 "id": "CohortGroup",
1046 "properties": { 1090 "properties": {
1047 "lifetimeValue": {
1048 "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Co hort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifeti me Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be ali gned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate ` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDa te`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will corre spond to the values in the web interface\n LifeTime value report.\n- The Lifeti me Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days aft er a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not b e aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersu sAppViews)",
1049 "type": "boolean"
1050 },
1051 "cohorts": { 1091 "cohorts": {
1052 "description": "The definition for the cohort.", 1092 "description": "The definition for the cohort.",
1053 "items": { 1093 "items": {
1054 "$ref": "Cohort" 1094 "$ref": "Cohort"
1055 }, 1095 },
1056 "type": "array" 1096 "type": "array"
1097 },
1098 "lifetimeValue": {
1099 "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Co hort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifeti me Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be ali gned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate ` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDa te`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will corre spond to the values in the web interface\n LifeTime value report.\n- The Lifeti me Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days aft er a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not b e aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersu sAppViews)",
1100 "type": "boolean"
1057 } 1101 }
1058 }, 1102 },
1059 "type": "object" 1103 "type": "object"
1060 }, 1104 },
1061 "GetReportsRequest": { 1105 "GetReportsRequest": {
1062 "description": "The batch request containing multiple report request .", 1106 "description": "The batch request containing multiple report request .",
1063 "id": "GetReportsRequest", 1107 "id": "GetReportsRequest",
1064 "properties": { 1108 "properties": {
1065 "reportRequests": { 1109 "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`.", 1110 "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": { 1111 "items": {
1068 "$ref": "ReportRequest" 1112 "$ref": "ReportRequest"
1069 }, 1113 },
1070 "type": "array" 1114 "type": "array"
1071 } 1115 }
1072 }, 1116 },
1073 "type": "object" 1117 "type": "object"
1074 }, 1118 },
1075 "Pivot": { 1119 "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.", 1120 "description": "The Pivot describes the pivot section in the request .\nThe Pivot helps rearrange the information in the table for certain reports\nb y pivoting your data on a second dimension.",
1077 "id": "Pivot", 1121 "id": "Pivot",
1078 "properties": { 1122 "properties": {
1079 "startGroup": { 1123 "dimensionFilterClauses": {
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.", 1124 "description": "DimensionFilterClauses are logically combine d with an `AND` operator: only\ndata that is included by all these DimensionFilt erClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspec ify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen on ly those two browsers would show up as columns.",
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": { 1125 "items": {
1087 "$ref": "Metric" 1126 "$ref": "DimensionFilterClause"
1088 }, 1127 },
1089 "type": "array" 1128 "type": "array"
1090 }, 1129 },
1091 "dimensions": { 1130 "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.", 1131 "description": "A list of dimensions to show as pivot column s. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
1093 "items": { 1132 "items": {
1094 "$ref": "Dimension" 1133 "$ref": "Dimension"
1095 }, 1134 },
1096 "type": "array" 1135 "type": "array"
1097 }, 1136 },
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": { 1137 "maxGroupCount": {
1106 "description": "Specifies the maximum number of groups to re turn.\nThe default value is 10, also the maximum value is 1,000.", 1138 "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", 1139 "format": "int32",
1108 "type": "integer" 1140 "type": "integer"
1109 } 1141 },
1110 }, 1142 "startGroup": {
1111 "type": "object" 1143 "description": "If k metrics were requested, then the respon se will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Fi refox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of t he groups\nof columns is determined by descending order of \"total\" for the fir st of\nthe k values. Ties are broken by lexicographic ordering of the first\npi vot dimension, then lexicographic ordering of the second pivot\ndimension, and s o on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nT he following let you choose which of the groups of k columns are\nincluded in th e response.",
1112 }, 1144 "format": "int32",
1113 "PivotHeaderEntry": { 1145 "type": "integer"
1114 "description": "The headers for the each of the metric column corres ponding to the metrics\nrequested in the pivots section of the response.", 1146 },
1115 "id": "PivotHeaderEntry", 1147 "metrics": {
1116 "properties": { 1148 "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
1117 "dimensionNames": {
1118 "description": "The name of the dimensions in the pivot resp onse.",
1119 "items": { 1149 "items": {
1120 "type": "string" 1150 "$ref": "Metric"
1121 }, 1151 },
1122 "type": "array" 1152 "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 } 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 }
OLDNEW
« no previous file with comments | « discovery/googleapis/adsensehost__v4.1.json ('k') | discovery/googleapis/androidenterprise__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698