Blame - docs/dyn/analyticsdata_v1alpha.v1alpha.html - platform/external/python/google-api-python-client

2021-01-15 07:10:04 -0800

[diff] [blame^]

102

"entity": { # The unique identifier of the property whose events are tracked. # A property whose events are tracked. This entity must be specified for the batch. The entity within RunPivotReportRequest may either be unspecified or consistent with this entity.

103

"propertyId": "A String", # A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

104

},

105

"requests": [ # Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.

106

{ # The request to generate a pivot report.

107

"cohortSpec": { # Specification for a cohort report. # Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

108

"cohortReportSettings": { # Settings of a cohort report. # Settings of a cohort report.

109

"accumulate": True or False, # If true, accumulates the result from first visit day to the end day. Not supported in `RunReportRequest`.

110

},

111

"cohorts": [ # The definition for the cohorts.

112

{ # Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

113

"dateRange": { # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges. # The cohort selects users whose first visit date is between start date and end date defined in the `dateRange`. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. The date range should be aligned with the cohort's granularity. If CohortsRange uses daily granularity, the date range can be aligned to any day. If CohortsRange uses weekly granularity, the date range should be aligned to the week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, the date range should be aligned to the month, starting at the first and ending on the last day of the month.

114

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

115

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

116

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

117

},

118

"dimension": "A String", # The dimension used by cohort. Only supports `firstTouchDate` for retention report.

119

"name": "A String", # Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

120

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

121

],

122

"cohortsRange": { # Describes date range for a cohort report. # The data ranges of cohorts.

123

"endOffset": 42, # For daily cohorts, this will be the end day offset. For weekly cohorts, this will be the week offset.

124

"granularity": "A String", # Reporting date range for each cohort is calculated based on these three fields.

125

"startOffset": 42, # For daily cohorts, this will be the start day offset. For weekly cohorts, this will be the week offset.

126

},

127

},

128

"currencyCode": "A String", # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.

129

"dateRanges": [ # The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.

130

{ # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

131

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

132

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

133

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

134

},

135

],

136

"dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

137

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

138

"expressions": [ # A list of filter expressions.

139

# Object with schema name: FilterExpression

140

],

141

},

142

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

143

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

144

"fromValue": { # To represent a number. # Begins with this number.

145

"doubleValue": 3.14, # Double value

146

"int64Value": "A String", # Integer value

147

},

148

"toValue": { # To represent a number. # Ends with this number.

149

"doubleValue": 3.14, # Double value

150

"int64Value": "A String", # Integer value

151

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

152

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

153

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

154

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

155

"caseSensitive": True or False, # If true, the string value is case sensitive.

156

"values": [ # The list of string values. Must be non-empty.

"A String",

],

},

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

161

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

162

"operation": "A String", # The operation type for this filter.

163

"value": { # To represent a number. # A numeric value or a date value.

164

"doubleValue": 3.14, # Double value

165

"int64Value": "A String", # Integer value

166

},

167

},

168

"stringFilter": { # The filter for string # Strings related filter.

169

"caseSensitive": True or False, # If true, the string value is case sensitive.

170

"matchType": "A String", # The match type for this filter.

171

"value": "A String", # The string value used for the matching.

172

},

173

},

174

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

175

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

176

"expressions": [ # A list of filter expressions.

177

# Object with schema name: FilterExpression

],

},

},

"dimensions": [ # The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

182

{ # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 8 dimensions.

183

"dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

184

"concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).

185

"delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".

186

"dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.

"A String",

],

},

"lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.

191

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

192

},

193

"upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.

194

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

195

},

196

},

197

"name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.

198

},

199

],

200

"entity": { # The unique identifier of the property whose events are tracked. # A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

201

"propertyId": "A String", # A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

202

},

203

"keepEmptyRows": True or False, # If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

204

"metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

205

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

206

"expressions": [ # A list of filter expressions.

207

# Object with schema name: FilterExpression

208

],

209

},

210

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

211

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

212

"fromValue": { # To represent a number. # Begins with this number.

213

"doubleValue": 3.14, # Double value

214

"int64Value": "A String", # Integer value

215

},

216

"toValue": { # To represent a number. # Ends with this number.

217

"doubleValue": 3.14, # Double value

218

"int64Value": "A String", # Integer value

219

},

220

},

221

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

222

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

223

"caseSensitive": True or False, # If true, the string value is case sensitive.

224

"values": [ # The list of string values. Must be non-empty.

"A String",

],

},

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

229

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

230

"operation": "A String", # The operation type for this filter.

231

"value": { # To represent a number. # A numeric value or a date value.

232

"doubleValue": 3.14, # Double value

233

"int64Value": "A String", # Integer value

234

},

235

},

236

"stringFilter": { # The filter for string # Strings related filter.

237

"caseSensitive": True or False, # If true, the string value is case sensitive.

238

"matchType": "A String", # The match type for this filter.

239

"value": "A String", # The string value used for the matching.

240

},

241

},

242

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

243

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

244

"expressions": [ # A list of filter expressions.

245

# Object with schema name: FilterExpression

],

},

},

"metrics": [ # The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

250

{ # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

251

"expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.

252

"invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.

253

"name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.

254

},

255

],

256

"pivots": [ # Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

257

{ # Describes the visible dimension columns and rows in the report response.

258

"fieldNames": [ # Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

259

"A String",

260

],

261

"limit": "A String", # The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.

262

"metricAggregations": [ # Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

263

"A String",

264

],

265

"offset": "A String", # The row count of the start row. The first row is counted as row 0.

266

"orderBys": [ # Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

267

{ # The sort options.

268

"desc": True or False, # If true, sorts by descending order.

269

"dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.

270

"dimensionName": "A String", # A dimension name in the request to order by.

271

"orderType": "A String", # Controls the rule for dimension value ordering.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

272

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

273

"metric": { # Sorts by metric values. # Sorts results by a metric's values.

274

"metricName": "A String", # A metric name in the request to order by.

275

},

276

"pivot": { # Sorts by a pivot column group. # Sorts results by a metric's values within a pivot column group.

277

"metricName": "A String", # In the response to order by, order rows by this column. Must be a metric name from the request.

278

"pivotSelections": [ # Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

279

{ # A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------

280

"dimensionName": "A String", # Must be a dimension name from the request.

281

"dimensionValue": "A String", # Order by only when the named dimension is this value.

282

},

283

],

284

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

285

},

286

],

287

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

288

],

289

"returnPropertyQuota": True or False, # Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

290

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

291

],

292

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

293

294

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

301

302

{ # The batch response containing multiple pivot reports.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

303

"pivotReports": [ # Individual responses. Each response has a separate pivot report request.

304

{ # The response pivot report table corresponding to a pivot request.

305

"aggregates": [ # Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_".

306

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

307

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

308

{ # The value of a dimension.

309

"value": "A String", # Value as a string if the dimension type is a string.

310

},

311

],

312

"metricValues": [ # List of requested visible metric values.

313

{ # The value of a metric.

314

"value": "A String", # Measurement value. See MetricHeader for type.

315

},

316

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

317

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

318

],

319

"dimensionHeaders": [ # Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

320

{ # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

321

"name": "A String", # The dimension's name.

322

},

323

],

324

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.

325

"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

326

},

327

"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

328

{ # Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.

329

"name": "A String", # The metric's name.

330

"type": "A String", # The metric's data type.

331

},

332

],

333

"pivotHeaders": [ # Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]

334

{ # Dimensions' values in a single pivot.

335

"pivotDimensionHeaders": [ # The size is the same as the cardinality of the corresponding dimension combinations.

336

{ # Summarizes dimension values from a row for this pivot.

337

"dimensionValues": [ # Values of multiple dimensions in a pivot.

338

{ # The value of a dimension.

339

"value": "A String", # Value as a string if the dimension type is a string.

},

],

},

],

"rowCount": 42, # The cardinality of the pivot as if offset = 0 and limit = -1. The total number of rows for this pivot's fields regardless of how the parameters offset and limit are specified in the request.

345

},

346

],

347

"propertyQuota": { # Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # This Analytics Property's quota state including this request.

348

"concurrentRequests": { # Current state for a particular quota group. # Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.

349

"consumed": 42, # Quota consumed by this request.

350

"remaining": 42, # Quota remaining after this request.

351

},

352

"serverErrorsPerProjectPerHour": { # Current state for a particular quota group. # Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour.

353

"consumed": 42, # Quota consumed by this request.

354

"remaining": 42, # Quota remaining after this request.

355

},

356

"tokensPerDay": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.

357

"consumed": 42, # Quota consumed by this request.

358

"remaining": 42, # Quota remaining after this request.

359

},

360

"tokensPerHour": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 5,000 tokens per day; Analytics 360 Properties can use 50,000 tokens per day. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas.

361

"consumed": 42, # Quota consumed by this request.

362

"remaining": 42, # Quota remaining after this request.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

363

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

364

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

365

"rows": [ # Rows of dimension value combinations and metric values in the report.

366

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

367

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

368

{ # The value of a dimension.

369

"value": "A String", # Value as a string if the dimension type is a string.

370

},

371

],

372

"metricValues": [ # List of requested visible metric values.

373

{ # The value of a metric.

374

"value": "A String", # Measurement value. See MetricHeader for type.

},

],

},

],

},

],

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="batchRunReports">batchRunReports(body=None, x__xgafv=None)</code>

386

<pre>Returns multiple reports in a batch. All reports must be for the same Entity.

387

388

Args:

389

body: object, The request body.

390

The object takes the form of:

391

392

{ # The batch request containing multiple report requests.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

393

"entity": { # The unique identifier of the property whose events are tracked. # A property whose events are tracked. This entity must be specified for the batch. The entity within RunReportRequest may either be unspecified or consistent with this entity.

394

"propertyId": "A String", # A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

395

},

396

"requests": [ # Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests.

397

{ # The request to generate a report.

398

"cohortSpec": { # Specification for a cohort report. # Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

399

"cohortReportSettings": { # Settings of a cohort report. # Settings of a cohort report.

400

"accumulate": True or False, # If true, accumulates the result from first visit day to the end day. Not supported in `RunReportRequest`.

401

},

402

"cohorts": [ # The definition for the cohorts.

403

{ # Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

404

"dateRange": { # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges. # The cohort selects users whose first visit date is between start date and end date defined in the `dateRange`. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. The date range should be aligned with the cohort's granularity. If CohortsRange uses daily granularity, the date range can be aligned to any day. If CohortsRange uses weekly granularity, the date range should be aligned to the week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, the date range should be aligned to the month, starting at the first and ending on the last day of the month.

405

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

406

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

407

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

408

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

409

"dimension": "A String", # The dimension used by cohort. Only supports `firstTouchDate` for retention report.

410

"name": "A String", # Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.

411

},

412

],

413

"cohortsRange": { # Describes date range for a cohort report. # The data ranges of cohorts.

414

"endOffset": 42, # For daily cohorts, this will be the end day offset. For weekly cohorts, this will be the week offset.

415

"granularity": "A String", # Reporting date range for each cohort is calculated based on these three fields.

416

"startOffset": 42, # For daily cohorts, this will be the start day offset. For weekly cohorts, this will be the week offset.

417

},

418

},

419

"currencyCode": "A String", # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.

420

"dateRanges": [ # Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.

421

{ # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

422

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

423

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

424

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

425

},

426

],

427

"dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

428

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

429

"expressions": [ # A list of filter expressions.

430

# Object with schema name: FilterExpression

431

],

432

},

433

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

434

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

435

"fromValue": { # To represent a number. # Begins with this number.

436

"doubleValue": 3.14, # Double value

437

"int64Value": "A String", # Integer value

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

439

"toValue": { # To represent a number. # Ends with this number.

440

"doubleValue": 3.14, # Double value

441

"int64Value": "A String", # Integer value

442

},

443

},

444

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

445

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

446

"caseSensitive": True or False, # If true, the string value is case sensitive.

447

"values": [ # The list of string values. Must be non-empty.

"A String",

],

},

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

452

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

453

"operation": "A String", # The operation type for this filter.

454

"value": { # To represent a number. # A numeric value or a date value.

455

"doubleValue": 3.14, # Double value

456

"int64Value": "A String", # Integer value

457

},

458

},

459

"stringFilter": { # The filter for string # Strings related filter.

460

"caseSensitive": True or False, # If true, the string value is case sensitive.

461

"matchType": "A String", # The match type for this filter.

462

"value": "A String", # The string value used for the matching.

463

},

464

},

465

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

466

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

467

"expressions": [ # A list of filter expressions.

468

# Object with schema name: FilterExpression

],

},

},

"dimensions": [ # The dimensions requested and displayed.

473

{ # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 8 dimensions.

474

"dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

475

"concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).

476

"delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".

477

"dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.

"A String",

],

},

"lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.

482

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

483

},

484

"upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.

485

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

486

},

487

},

488

"name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.

489

},

490

],

491

"entity": { # The unique identifier of the property whose events are tracked. # A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

492

"propertyId": "A String", # A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

493

},

494

"keepEmptyRows": True or False, # If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

495

"limit": "A String", # The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).

496

"metricAggregations": [ # Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

497

"A String",

498

],

499

"metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

500

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

501

"expressions": [ # A list of filter expressions.

502

# Object with schema name: FilterExpression

503

],

504

},

505

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

506

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

507

"fromValue": { # To represent a number. # Begins with this number.

508

"doubleValue": 3.14, # Double value

509

"int64Value": "A String", # Integer value

510

},

511

"toValue": { # To represent a number. # Ends with this number.

512

"doubleValue": 3.14, # Double value

513

"int64Value": "A String", # Integer value

514

},

515

},

516

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

517

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

518

"caseSensitive": True or False, # If true, the string value is case sensitive.

519

"values": [ # The list of string values. Must be non-empty.

"A String",

],

},

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

524

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

525

"operation": "A String", # The operation type for this filter.

526

"value": { # To represent a number. # A numeric value or a date value.

527

"doubleValue": 3.14, # Double value

528

"int64Value": "A String", # Integer value

529

},

530

},

531

"stringFilter": { # The filter for string # Strings related filter.

532

"caseSensitive": True or False, # If true, the string value is case sensitive.

533

"matchType": "A String", # The match type for this filter.

534

"value": "A String", # The string value used for the matching.

535

},

536

},

537

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

538

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

539

"expressions": [ # A list of filter expressions.

540

# Object with schema name: FilterExpression

],

},

},

"metrics": [ # The metrics requested and displayed.

545

{ # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

546

"expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.

547

"invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.

548

"name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.

549

},

550

],

551

"offset": "A String", # The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).

552

"orderBys": [ # Specifies how rows are ordered in the response.

553

{ # The sort options.

554

"desc": True or False, # If true, sorts by descending order.

555

"dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.

556

"dimensionName": "A String", # A dimension name in the request to order by.

557

"orderType": "A String", # Controls the rule for dimension value ordering.

558

},

559

"metric": { # Sorts by metric values. # Sorts results by a metric's values.

560

"metricName": "A String", # A metric name in the request to order by.

561

},

562

"pivot": { # Sorts by a pivot column group. # Sorts results by a metric's values within a pivot column group.

563

"metricName": "A String", # In the response to order by, order rows by this column. Must be a metric name from the request.

564

"pivotSelections": [ # Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

565

{ # A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------

566

"dimensionName": "A String", # Must be a dimension name from the request.

567

"dimensionValue": "A String", # Order by only when the named dimension is this value.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

568

},

569

],

570

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

571

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

572

],

573

"returnPropertyQuota": True or False, # Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).

574

},

575

],

576

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

577

578

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

585

586

{ # The batch response containing multiple reports.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

587

"reports": [ # Individual responses. Each response has a separate report request.

588

{ # The response report table corresponding to a request.

589

"dimensionHeaders": [ # Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

590

{ # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

591

"name": "A String", # The dimension's name.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

592

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

593

],

594

"maximums": [ # If requested, the maximum values of metrics.

595

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

596

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

597

{ # The value of a dimension.

598

"value": "A String", # Value as a string if the dimension type is a string.

599

},

600

],

601

"metricValues": [ # List of requested visible metric values.

602

{ # The value of a metric.

603

"value": "A String", # Measurement value. See MetricHeader for type.

},

],

},

],

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.

609

"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

610

},

611

"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

612

{ # Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.

613

"name": "A String", # The metric's name.

614

"type": "A String", # The metric's data type.

615

},

616

],

617

"minimums": [ # If requested, the minimum values of metrics.

618

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

619

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

620

{ # The value of a dimension.

621

"value": "A String", # Value as a string if the dimension type is a string.

622

},

623

],

624

"metricValues": [ # List of requested visible metric values.

625

{ # The value of a metric.

626

"value": "A String", # Measurement value. See MetricHeader for type.

},

],

},

],

"propertyQuota": { # Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # This Analytics Property's quota state including this request.

632

"concurrentRequests": { # Current state for a particular quota group. # Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.

633

"consumed": 42, # Quota consumed by this request.

634

"remaining": 42, # Quota remaining after this request.

635

},

636

"serverErrorsPerProjectPerHour": { # Current state for a particular quota group. # Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour.

637

"consumed": 42, # Quota consumed by this request.

638

"remaining": 42, # Quota remaining after this request.

639

},

640

"tokensPerDay": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.

641

"consumed": 42, # Quota consumed by this request.

642

"remaining": 42, # Quota remaining after this request.

643

},

644

"tokensPerHour": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 5,000 tokens per day; Analytics 360 Properties can use 50,000 tokens per day. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas.

645

"consumed": 42, # Quota consumed by this request.

646

"remaining": 42, # Quota remaining after this request.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

647

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

648

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

649

"rowCount": 42, # The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).

650

"rows": [ # Rows of dimension value combinations and metric values in the report.

651

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

652

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

653

{ # The value of a dimension.

654

"value": "A String", # Value as a string if the dimension type is a string.

655

},

656

],

657

"metricValues": [ # List of requested visible metric values.

658

{ # The value of a metric.

659

"value": "A String", # Measurement value. See MetricHeader for type.

},

],

},

],

"totals": [ # If requested, the totaled values of metrics.

665

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

666

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

667

{ # The value of a dimension.

668

"value": "A String", # Value as a string if the dimension type is a string.

669

},

670

],

671

"metricValues": [ # List of requested visible metric values.

672

{ # The value of a metric.

673

"value": "A String", # Measurement value. See MetricHeader for type.

},

],

},

],

},

],

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="close">close()</code>

685

<pre>Close httplib2 connections.</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

689

<code class="details" id="runPivotReport">runPivotReport(body=None, x__xgafv=None)</code>

690

<pre>Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

691

692

Args:

693

body: object, The request body.

694

The object takes the form of:

695

696

{ # The request to generate a pivot report.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

697

"cohortSpec": { # Specification for a cohort report. # Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

698

"cohortReportSettings": { # Settings of a cohort report. # Settings of a cohort report.

699

"accumulate": True or False, # If true, accumulates the result from first visit day to the end day. Not supported in `RunReportRequest`.

700

},

701

"cohorts": [ # The definition for the cohorts.

702

{ # Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

703

"dateRange": { # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges. # The cohort selects users whose first visit date is between start date and end date defined in the `dateRange`. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. The date range should be aligned with the cohort's granularity. If CohortsRange uses daily granularity, the date range can be aligned to any day. If CohortsRange uses weekly granularity, the date range should be aligned to the week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, the date range should be aligned to the month, starting at the first and ending on the last day of the month.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

704

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

705

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

706

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

707

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

708

"dimension": "A String", # The dimension used by cohort. Only supports `firstTouchDate` for retention report.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

709

"name": "A String", # Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

710

},

711

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

712

"cohortsRange": { # Describes date range for a cohort report. # The data ranges of cohorts.

713

"endOffset": 42, # For daily cohorts, this will be the end day offset. For weekly cohorts, this will be the week offset.

714

"granularity": "A String", # Reporting date range for each cohort is calculated based on these three fields.

715

"startOffset": 42, # For daily cohorts, this will be the start day offset. For weekly cohorts, this will be the week offset.

716

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

717

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

718

"currencyCode": "A String", # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

719

"dateRanges": [ # The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.

720

{ # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

721

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

722

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

723

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

724

},

725

],

726

"dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

727

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

728

"expressions": [ # A list of filter expressions.

729

# Object with schema name: FilterExpression

730

],

731

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

732

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

733

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

734

"fromValue": { # To represent a number. # Begins with this number.

735

"doubleValue": 3.14, # Double value

736

"int64Value": "A String", # Integer value

737

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

738

"toValue": { # To represent a number. # Ends with this number.

739

"doubleValue": 3.14, # Double value

740

"int64Value": "A String", # Integer value

741

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

742

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

743

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

744

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

745

"caseSensitive": True or False, # If true, the string value is case sensitive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

746

"values": [ # The list of string values. Must be non-empty.

747

"A String",

748

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

749

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

750

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

751

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

752

"operation": "A String", # The operation type for this filter.

753

"value": { # To represent a number. # A numeric value or a date value.

754

"doubleValue": 3.14, # Double value

755

"int64Value": "A String", # Integer value

756

},

757

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

758

"stringFilter": { # The filter for string # Strings related filter.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

759

"caseSensitive": True or False, # If true, the string value is case sensitive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

760

"matchType": "A String", # The match type for this filter.

761

"value": "A String", # The string value used for the matching.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

762

},

763

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

764

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

765

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

766

"expressions": [ # A list of filter expressions.

767

# Object with schema name: FilterExpression

768

],

769

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

770

},

771

"dimensions": [ # The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

772

{ # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 8 dimensions.

773

"dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

774

"concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).

775

"delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".

776

"dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.

"A String",

],

},

"lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.

781

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

782

},

783

"upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.

784

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

785

},

786

},

787

"name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.

788

},

789

],

790

"entity": { # The unique identifier of the property whose events are tracked. # A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

791

"propertyId": "A String", # A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

792

},

793

"keepEmptyRows": True or False, # If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

794

"metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

795

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

796

"expressions": [ # A list of filter expressions.

797

# Object with schema name: FilterExpression

798

],

799

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

800

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

801

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

802

"fromValue": { # To represent a number. # Begins with this number.

803

"doubleValue": 3.14, # Double value

804

"int64Value": "A String", # Integer value

805

},

806

"toValue": { # To represent a number. # Ends with this number.

807

"doubleValue": 3.14, # Double value

808

"int64Value": "A String", # Integer value

809

},

810

},

811

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

812

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

813

"caseSensitive": True or False, # If true, the string value is case sensitive.

814

"values": [ # The list of string values. Must be non-empty.

"A String",

],

},

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

819

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

820

"operation": "A String", # The operation type for this filter.

821

"value": { # To represent a number. # A numeric value or a date value.

822

"doubleValue": 3.14, # Double value

823

"int64Value": "A String", # Integer value

824

},

825

},

826

"stringFilter": { # The filter for string # Strings related filter.

827

"caseSensitive": True or False, # If true, the string value is case sensitive.

828

"matchType": "A String", # The match type for this filter.

829

"value": "A String", # The string value used for the matching.

830

},

831

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

832

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

833

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

834

"expressions": [ # A list of filter expressions.

835

# Object with schema name: FilterExpression

836

],

837

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

838

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

839

"metrics": [ # The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

840

{ # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

841

"expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

842

"invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.

843

"name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

844

},

845

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

846

"pivots": [ # Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

847

{ # Describes the visible dimension columns and rows in the report response.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

848

"fieldNames": [ # Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

849

"A String",

850

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

851

"limit": "A String", # The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

852

"metricAggregations": [ # Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

853

"A String",

854

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

855

"offset": "A String", # The row count of the start row. The first row is counted as row 0.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

856

"orderBys": [ # Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

857

{ # The sort options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

858

"desc": True or False, # If true, sorts by descending order.

859

"dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.

860

"dimensionName": "A String", # A dimension name in the request to order by.

861

"orderType": "A String", # Controls the rule for dimension value ordering.

862

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

863

"metric": { # Sorts by metric values. # Sorts results by a metric's values.

864

"metricName": "A String", # A metric name in the request to order by.

865

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

866

"pivot": { # Sorts by a pivot column group. # Sorts results by a metric's values within a pivot column group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

867

"metricName": "A String", # In the response to order by, order rows by this column. Must be a metric name from the request.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

868

"pivotSelections": [ # Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

869

{ # A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------

870

"dimensionName": "A String", # Must be a dimension name from the request.

871

"dimensionValue": "A String", # Order by only when the named dimension is this value.

872

},

873

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

874

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

875

},

876

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

877

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

878

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

879

"returnPropertyQuota": True or False, # Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

880

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

881

882

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

889

890

{ # The response pivot report table corresponding to a pivot request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

891

"aggregates": [ # Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_".

892

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

893

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

894

{ # The value of a dimension.

895

"value": "A String", # Value as a string if the dimension type is a string.

896

},

897

],

898

"metricValues": [ # List of requested visible metric values.

899

{ # The value of a metric.

900

"value": "A String", # Measurement value. See MetricHeader for type.

901

},

902

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

903

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

904

],

905

"dimensionHeaders": [ # Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

906

{ # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

907

"name": "A String", # The dimension's name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

908

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

909

],

910

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report.

911

"dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

912

},

913

"metricHeaders": [ # Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

914

{ # Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.

915

"name": "A String", # The metric's name.

916

"type": "A String", # The metric's data type.

917

},

918

],

919

"pivotHeaders": [ # Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]

920

{ # Dimensions' values in a single pivot.

921

"pivotDimensionHeaders": [ # The size is the same as the cardinality of the corresponding dimension combinations.

922

{ # Summarizes dimension values from a row for this pivot.

923

"dimensionValues": [ # Values of multiple dimensions in a pivot.

924

{ # The value of a dimension.

925

"value": "A String", # Value as a string if the dimension type is a string.

},

],

},

],

"rowCount": 42, # The cardinality of the pivot as if offset = 0 and limit = -1. The total number of rows for this pivot's fields regardless of how the parameters offset and limit are specified in the request.

931

},

932

],

933

"propertyQuota": { # Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # This Analytics Property's quota state including this request.

934

"concurrentRequests": { # Current state for a particular quota group. # Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.

935

"consumed": 42, # Quota consumed by this request.

936

"remaining": 42, # Quota remaining after this request.

937

},

938

"serverErrorsPerProjectPerHour": { # Current state for a particular quota group. # Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour.

939

"consumed": 42, # Quota consumed by this request.

940

"remaining": 42, # Quota remaining after this request.

941

},

942

"tokensPerDay": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.

943

"consumed": 42, # Quota consumed by this request.

944

"remaining": 42, # Quota remaining after this request.

945

},

946

"tokensPerHour": { # Current state for a particular quota group. # Standard Analytics Properties can use up to 5,000 tokens per day; Analytics 360 Properties can use 50,000 tokens per day. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas.

947

"consumed": 42, # Quota consumed by this request.

948

"remaining": 42, # Quota remaining after this request.

949

},

950

},

951

"rows": [ # Rows of dimension value combinations and metric values in the report.

952

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

953

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

954

{ # The value of a dimension.

955

"value": "A String", # Value as a string if the dimension type is a string.

956

},

957

],

958

"metricValues": [ # List of requested visible metric values.

959

{ # The value of a metric.

960

"value": "A String", # Measurement value. See MetricHeader for type.

},

],

},

],

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="runReport">runReport(body=None, x__xgafv=None)</code>

970

<pre>Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

971

972

Args:

973

body: object, The request body.

974

The object takes the form of:

975

976

{ # The request to generate a report.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

977

"cohortSpec": { # Specification for a cohort report. # Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

978

"cohortReportSettings": { # Settings of a cohort report. # Settings of a cohort report.

979

"accumulate": True or False, # If true, accumulates the result from first visit day to the end day. Not supported in `RunReportRequest`.

980

},

981

"cohorts": [ # The definition for the cohorts.

982

{ # Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

983

"dateRange": { # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges. # The cohort selects users whose first visit date is between start date and end date defined in the `dateRange`. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. The date range should be aligned with the cohort's granularity. If CohortsRange uses daily granularity, the date range can be aligned to any day. If CohortsRange uses weekly granularity, the date range should be aligned to the week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, the date range should be aligned to the month, starting at the first and ending on the last day of the month.

984

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

985

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

986

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

987

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

988

"dimension": "A String", # The dimension used by cohort. Only supports `firstTouchDate` for retention report.

989

"name": "A String", # Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.

990

},

991

],

992

"cohortsRange": { # Describes date range for a cohort report. # The data ranges of cohorts.

993

"endOffset": 42, # For daily cohorts, this will be the end day offset. For weekly cohorts, this will be the week offset.

994

"granularity": "A String", # Reporting date range for each cohort is calculated based on these three fields.

995

"startOffset": 42, # For daily cohorts, this will be the start day offset. For weekly cohorts, this will be the week offset.

996

},

997

},

998

"currencyCode": "A String", # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.

999

"dateRanges": [ # Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.

1000

{ # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

1001

"endDate": "A String", # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

1002

"name": "A String", # Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.

1003

"startDate": "A String", # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.

1004

},

1005

],

1006

"dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

1007

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

1008

"expressions": [ # A list of filter expressions.

1009

# Object with schema name: FilterExpression

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1010

],

1011

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1012

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

1013

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

1014

"fromValue": { # To represent a number. # Begins with this number.

1015

"doubleValue": 3.14, # Double value

1016

"int64Value": "A String", # Integer value

1017

},

1018

"toValue": { # To represent a number. # Ends with this number.

1019

"doubleValue": 3.14, # Double value

1020

"int64Value": "A String", # Integer value

1021

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1022

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1023

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

1024

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

1025

"caseSensitive": True or False, # If true, the string value is case sensitive.

1026

"values": [ # The list of string values. Must be non-empty.

"A String",

],

},

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

1031

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

1032

"operation": "A String", # The operation type for this filter.

1033

"value": { # To represent a number. # A numeric value or a date value.

1034

"doubleValue": 3.14, # Double value

1035

"int64Value": "A String", # Integer value

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1036

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1037

},

1038

"stringFilter": { # The filter for string # Strings related filter.

1039

"caseSensitive": True or False, # If true, the string value is case sensitive.

1040

"matchType": "A String", # The match type for this filter.

1041

"value": "A String", # The string value used for the matching.

1042

},

1043

},

1044

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

1045

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

1046

"expressions": [ # A list of filter expressions.

1047

# Object with schema name: FilterExpression

],

},

},

"dimensions": [ # The dimensions requested and displayed.

1052

{ # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 8 dimensions.

1053

"dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

1054

"concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).

1055

"delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".

1056

"dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1057

"A String",

1058

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1059

},

1060

"lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.

1061

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

1062

},

1063

"upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.

1064

"dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1065

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1066

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1067

"name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1068

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1069

],

1070

"entity": { # The unique identifier of the property whose events are tracked. # A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

1071

"propertyId": "A String", # A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).

1072

},

1073

"keepEmptyRows": True or False, # If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

1074

"limit": "A String", # The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).

1075

"metricAggregations": [ # Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

1076

"A String",

1077

],

1078

"metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

1079

"andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.

1080

"expressions": [ # A list of filter expressions.

1081

# Object with schema name: FilterExpression

1082

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1083

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1084

"filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.

1085

"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.

1086

"fromValue": { # To represent a number. # Begins with this number.

1087

"doubleValue": 3.14, # Double value

1088

"int64Value": "A String", # Integer value

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1089

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1090

"toValue": { # To represent a number. # Ends with this number.

1091

"doubleValue": 3.14, # Double value

1092

"int64Value": "A String", # Integer value

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1093

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1094

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1095

"fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.

1096

"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.

1097

"caseSensitive": True or False, # If true, the string value is case sensitive.

1098

"values": [ # The list of string values. Must be non-empty.

1099

"A String",

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1100

],

1101

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1102

"nullFilter": True or False, # A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

1103

"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.

1104

"operation": "A String", # The operation type for this filter.

1105

"value": { # To represent a number. # A numeric value or a date value.

1106

"doubleValue": 3.14, # Double value

1107

"int64Value": "A String", # Integer value

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1108

},

1109

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1110

"stringFilter": { # The filter for string # Strings related filter.

1111

"caseSensitive": True or False, # If true, the string value is case sensitive.

1112

"matchType": "A String", # The match type for this filter.

1113

"value": "A String", # The string value used for the matching.

1114

},

1115

},

1116

"notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.

1117

"orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.

1118

"expressions": [ # A list of filter expressions.

1119

# Object with schema name: FilterExpression

],

},

},

"metrics": [ # The metrics requested and displayed.

1124

{ # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

1125

"expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.

1126

"invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.

1127

"name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.

1128

},

1129

],

1130

"offset": "A String", # The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).

1131

"orderBys": [ # Specifies how rows are ordered in the response.

1132

{ # The sort options.

1133

"desc": True or False, # If true, sorts by descending order.

1134

"dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.

1135

"dimensionName": "A String", # A dimension name in the request to order by.

1136

"orderType": "A String", # Controls the rule for dimension value ordering.

1137

},

1138

"metric": { # Sorts by metric values. # Sorts results by a metric's values.

1139

"metricName": "A String", # A metric name in the request to order by.

1140

},

1141

"pivot": { # Sorts by a pivot column group. # Sorts results by a metric's values within a pivot column group.

1142

"metricName": "A String", # In the response to order by, order rows by this column. Must be a metric name from the request.

1143

"pivotSelections": [ # Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

1144

{ # A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------

1145

"dimensionName": "A String", # Must be a dimension name from the request.

1146

"dimensionValue": "A String", # Order by only when the named dimension is this value.

},

],

},

},

],

"returnPropertyQuota": True or False, # Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).

1153

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1154

1155

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1162

1163

{ # The response report table corresponding to a request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1164

"dimensionHeaders": [ # Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

1165

{ # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

1166

"name": "A String", # The dimension's name.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1167

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

1168

],

1169

"maximums": [ # If requested, the maximum values of metrics.

1170

{ # Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

1171

"dimensionValues": [ # List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

1172

{ # The value of a dimension.

1173

"value": "A String", # Value as a string if the dimension type is a string.

1174

},

1175

],

1176

"metricValues": [ # List of requested visible metric values.

1177

{ # The value of a metric.

1178

"value": "A String", # Measurement value. See MetricHeader for type.

1179

},

1180

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1181

},

Yoshi Automation Bot