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

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

[diff] [blame^]

97

name: string, Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

98

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

105

106

{ # The dimensions and metrics currently accepted in reporting methods.

Yoshi Automation Bot

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

[diff] [blame^]

107

"metrics": [ # The metric descriptions.

108

{ # Explains a metric.

109

"customDefinition": True or False, # True if the metric is a custom metric for this property.

110

"deprecatedApiNames": [ # Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.

111

"A String",

112

],

113

"apiName": "A String", # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.

114

"type": "A String", # The type of this metric.

115

"expression": "A String", # The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

116

"description": "A String", # Description of how this metric is used and calculated.

117

"uiName": "A String", # This metric's name within the Google Analytics user interface. For example, `Event count`.

118

},

119

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

120

"dimensions": [ # The dimension descriptions.

121

{ # Explains a dimension.

Yoshi Automation Bot

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

[diff] [blame^]

122

"uiName": "A String", # This dimension's name within the Google Analytics user interface. For example, `Event name`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

123

"deprecatedApiNames": [ # Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`.

124

"A String",

125

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

"customDefinition": True or False, # True if the dimension is a custom dimension for this property.

Yoshi Automation Bot

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

[diff] [blame]

127

"description": "A String", # Description of how this dimension is used and calculated.

128

"apiName": "A String", # This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

129

},

130

],

Yoshi Automation Bot

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

[diff] [blame]

131

"name": "A String", # Resource name of this metadata.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

}</pre>

</div>

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

137

<pre>The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

138

139

Args:

Yoshi Automation Bot

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

[diff] [blame^]

140

property: string, A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234 (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

141

body: object, The request body.

142

The object takes the form of:

143

144

{ # The request to generate a realtime report.

Yoshi Automation Bot

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

[diff] [blame^]

145

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

146

"A String",

147

],

Yoshi Automation Bot

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

[diff] [blame]

148

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

149

{ # 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.

Yoshi Automation Bot

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

[diff] [blame^]

150

"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]

151

"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).

Yoshi Automation Bot

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

[diff] [blame]

152

"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).

153

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

154

"A String",

155

],

156

"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".

157

},

Yoshi Automation Bot

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

[diff] [blame^]

158

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

159

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

160

},

161

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

162

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

163

},

Yoshi Automation Bot

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

[diff] [blame]

164

},

165

},

166

],

Yoshi Automation Bot

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

[diff] [blame^]

167

"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.

168

"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.

169

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

170

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

171

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

172

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

173

},

Yoshi Automation Bot

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

[diff] [blame^]

174

"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.

175

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

176

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

177

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

178

"A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

179

],

180

},

Yoshi Automation Bot

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

[diff] [blame^]

181

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

182

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

183

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

184

"doubleValue": 3.14, # Double value

185

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

186

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

187

},

Yoshi Automation Bot

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

[diff] [blame^]

188

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

Yoshi Automation Bot

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

[diff] [blame]

189

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

190

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

191

"doubleValue": 3.14, # Double value

192

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

193

},

194

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

195

"doubleValue": 3.14, # Double value

196

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

197

},

198

},

Yoshi Automation Bot

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

[diff] [blame]

199

},

200

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

201

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

202

# Object with schema name: FilterExpression

203

],

204

},

Yoshi Automation Bot

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

[diff] [blame^]

205

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

206

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

207

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

208

# Object with schema name: FilterExpression

],

},

},

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

213

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

214

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

215

"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`.

216

"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`.

217

},

218

],

219

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

220

"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.

221

"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.

222

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

223

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

224

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

225

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

226

},

227

"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.

228

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

229

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

230

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

"A String",

],

},

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

235

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

236

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

237

"doubleValue": 3.14, # Double value

238

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

239

},

240

},

241

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

242

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

243

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

244

"doubleValue": 3.14, # Double value

245

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

246

},

247

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

248

"doubleValue": 3.14, # Double value

249

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

},

},

},

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

254

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

255

# Object with schema name: FilterExpression

256

],

257

},

258

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

259

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

260

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

261

# Object with schema name: FilterExpression

262

],

263

},

Yoshi Automation Bot

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

[diff] [blame]

264

},

265

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

Yoshi Automation Bot

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

[diff] [blame^]

266

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

267

{ # The sort options.

268

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

269

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

270

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

271

},

272

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

273

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

274

"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.

275

{ # 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 ---------|----------|----------------|----------|----------------

276

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

277

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

278

},

279

],

280

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

281

},

282

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

283

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

284

},

285

},

286

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

287

}

288

289

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

296

297

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

298

"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 Realtime quota state including this request.

299

"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.

300

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

301

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

302

},

Yoshi Automation Bot

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

[diff] [blame]

303

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

304

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

305

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

306

},

Yoshi Automation Bot

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

[diff] [blame]

307

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

308

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

309

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

310

},

Yoshi Automation Bot

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

[diff] [blame^]

311

"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.

312

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

313

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

314

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

315

},

Yoshi Automation Bot

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

[diff] [blame^]

316

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

317

{ # 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" } ] ```

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

318

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

319

{ # The value of a metric.

320

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

321

},

322

],

Yoshi Automation Bot

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

[diff] [blame]

323

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

324

{ # The value of a dimension.

325

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

326

},

327

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

328

},

329

],

Yoshi Automation Bot

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

[diff] [blame^]

330

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

331

{ # 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.

332

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

333

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

334

},

335

],

Yoshi Automation Bot

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

[diff] [blame]

336

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

337

{ # 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" } ] ```

338

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

339

{ # The value of a metric.

340

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

341

},

342

],

343

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

344

{ # The value of a dimension.

345

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

},

],

},

],

Yoshi Automation Bot

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

[diff] [blame]

350

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

351

{ # 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" } ] ```

352

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

353

{ # The value of a metric.

354

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

355

},

356

],

357

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

358

{ # The value of a dimension.

359

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

},

],

},

],

Yoshi Automation Bot

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

[diff] [blame^]

364

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

Yoshi Automation Bot

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

[diff] [blame]

365

{ # 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" } ] ```

366

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

367

{ # The value of a metric.

368

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

369

},

370

],

371

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

372

{ # The value of a dimension.

373

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

374

},

375

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

376

},

377

],

Yoshi Automation Bot

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

[diff] [blame^]

378

"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.

379

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

380

{ # 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.

381

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

382

},

383

],

Bu Sun Kim