Class: Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsdata_v1alpha/classes.rb,
lib/google/apis/analyticsdata_v1alpha/representations.rb,
lib/google/apis/analyticsdata_v1alpha/representations.rb

Overview

The request to generate a pivot report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunPivotReportRequest

Returns a new instance of RunPivotReportRequest.



1372
1373
1374
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1372

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cohort_spec ⇒ Google::Apis::AnalyticsdataV1alpha::CohortSpec

The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the cohort object. Following that cohort for the next six weeks is specified in the cohortsRange object. For examples, see Cohort Report Examples. The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric cohortActiveUsers/ cohortTotalUsers and will be separate rows in the report. Corresponds to the JSON property cohortSpec

Returns:



1302
1303
1304
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1302

def cohort_spec
  @cohort_spec
end

#currency_code ⇒ 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. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


1308
1309
1310
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1308

def currency_code
  @currency_code
end

#date_ranges ⇒ Array<Google::Apis::AnalyticsdataV1alpha::DateRange>

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. Corresponds to the JSON property dateRanges

Returns:



1317
1318
1319
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1317

def date_ranges
  @date_ranges
end

#dimension_filter ⇒ Google::Apis::AnalyticsdataV1alpha::FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. Corresponds to the JSON property dimensionFilter

Returns:



1323
1324
1325
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1323

def dimension_filter
  @dimension_filter
end

#dimensions ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Dimension>

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. Corresponds to the JSON property dimensions

Returns:



1329
1330
1331
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1329

def dimensions
  @dimensions
end

#entity ⇒ Google::Apis::AnalyticsdataV1alpha::Entity

The unique identifier of the property whose events are tracked. Corresponds to the JSON property entity

Returns:



1334
1335
1336
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1334

def entity
  @entity
end

#keep_empty_rows ⇒ Boolean Also known as: keep_empty_rows?

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. Corresponds to the JSON property keepEmptyRows

Returns:

  • (Boolean) 


1341
1342
1343
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1341

def keep_empty_rows
  @keep_empty_rows
end

#metric_filter ⇒ Google::Apis::AnalyticsdataV1alpha::FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. Corresponds to the JSON property metricFilter

Returns:



1348
1349
1350
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1348

def metric_filter
  @metric_filter
end

#metrics ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Metric>

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. Corresponds to the JSON property metrics

Returns:



1355
1356
1357
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1355

def metrics
  @metrics
end

#pivots ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Pivot>

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. Corresponds to the JSON property pivots

Returns:



1363
1364
1365
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1363

def pivots
  @pivots
end

#return_property_quota ⇒ Boolean Also known as: return_property_quota?

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota. Corresponds to the JSON property returnPropertyQuota

Returns:

  • (Boolean) 


1369
1370
1371
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1369

def return_property_quota
  @return_property_quota
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1377

def update!(**args)
  @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
  @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @entity = args[:entity] if args.key?(:entity)
  @keep_empty_rows = args[:keep_empty_rows] if args.key?(:keep_empty_rows)
  @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
  @metrics = args[:metrics] if args.key?(:metrics)
  @pivots = args[:pivots] if args.key?(:pivots)
  @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
end