class Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest

The request to generate a pivot report.

Attributes

cohort_spec[RW]

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](developers.google.com/analytics/ devguides/reporting/data/v1/advanced#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` @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec]

currency_code[RW]

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` @return [String]

date_ranges[RW]

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` @return [Array<Google::Apis::AnalyticsdataV1alpha::DateRange>]

dimension_filter[RW]

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` @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]

dimensions[RW]

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` @return [Array<Google::Apis::AnalyticsdataV1alpha::Dimension>]

entity[RW]

The unique identifier of the property whose events are tracked. Corresponds to the JSON property `entity` @return [Google::Apis::AnalyticsdataV1alpha::Entity]

keep_empty_rows[RW]

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` @return [Boolean]

keep_empty_rows?[RW]

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` @return [Boolean]

metric_filter[RW]

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` @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]

metrics[RW]

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` @return [Array<Google::Apis::AnalyticsdataV1alpha::Metric>]

pivots[RW]

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` @return [Array<Google::Apis::AnalyticsdataV1alpha::Pivot>]

return_property_quota[RW]

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). Corresponds to the JSON property `returnPropertyQuota` @return [Boolean]

return_property_quota?[RW]

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). Corresponds to the JSON property `returnPropertyQuota` @return [Boolean]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/analyticsdata_v1alpha/classes.rb, line 1394
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/analyticsdata_v1alpha/classes.rb, line 1399
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