Class: Google::Apis::AnalyticsdataV1alpha::RunReportRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunReportRequest

Returns a new instance of RunReportRequest.



1697
1698
1699
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1697

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:



1615
1616
1617
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1615

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) 


1621
1622
1623
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1621

def currency_code
  @currency_code
end

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

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

Returns:



1630
1631
1632
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1630

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:



1636
1637
1638
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1636

def dimension_filter
  @dimension_filter
end

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

The dimensions requested and displayed. Corresponds to the JSON property dimensions

Returns:



1641
1642
1643
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1641

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:



1646
1647
1648
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1646

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) 


1653
1654
1655
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1653

def keep_empty_rows
  @keep_empty_rows
end

#limit ⇒ Fixnum

The number of rows to return. If the limit parameter is unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


1661
1662
1663
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1661

def limit
  @limit
end

#metric_aggregations ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1667
1668
1669
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1667

def metric_aggregations
  @metric_aggregations
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:



1673
1674
1675
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1673

def metric_filter
  @metric_filter
end

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

The metrics requested and displayed. Corresponds to the JSON property metrics

Returns:



1678
1679
1680
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1678

def metrics
  @metrics
end

#offset ⇒ Fixnum

The row count of the start row. The first row is counted as row 0. Corresponds to the JSON property offset

Returns:

  • (Fixnum) 


1683
1684
1685
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1683

def offset
  @offset
end

#order_bys ⇒ Array<Google::Apis::AnalyticsdataV1alpha::OrderBy>

Specifies how rows are ordered in the response. Corresponds to the JSON property orderBys

Returns:



1688
1689
1690
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1688

def order_bys
  @order_bys
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) 


1694
1695
1696
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1694

def return_property_quota
  @return_property_quota
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
 
# File 'lib/google/apis/analyticsdata_v1alpha/classes.rb', line 1702

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)
  @limit = args[:limit] if args.key?(:limit)
  @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
  @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
  @metrics = args[:metrics] if args.key?(:metrics)
  @offset = args[:offset] if args.key?(:offset)
  @order_bys = args[:order_bys] if args.key?(:order_bys)
  @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
end