class Google::Apis::AnalyticsdataV1beta::RunReportRequest

The request to generate a 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::AnalyticsdataV1beta::CohortSpec]

currency_code[RW]

A currency code in ISO4217 format, such as “AED”, “USD”, “JPY”. If the field is empty, the report uses the property's default currency. Corresponds to the JSON property `currencyCode` @return [String]

date_ranges[RW]

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

dimensions[RW]

The dimensions requested and displayed. Corresponds to the JSON property `dimensions` @return [Array<Google::Apis::AnalyticsdataV1beta::Dimension>]

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]

limit[RW]

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension ` country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](developers.google.com/analytics/ devguides/reporting/data/v1/basics#pagination). Corresponds to the JSON property `limit` @return [Fixnum]

metric_aggregations[RW]

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

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::AnalyticsdataV1beta::FilterExpression]

metrics[RW]

The metrics requested and displayed. Corresponds to the JSON property `metrics` @return [Array<Google::Apis::AnalyticsdataV1beta::Metric>]

offset[RW]

The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [ Pagination](developers.google.com/analytics/devguides/reporting/data/ v1/basics#pagination). Corresponds to the JSON property `offset` @return [Fixnum]

order_bys[RW]

Specifies how rows are ordered in the response. Corresponds to the JSON property `orderBys` @return [Array<Google::Apis::AnalyticsdataV1beta::OrderBy>]

property[RW]

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](developers.google.com/analytics/devguides/reporting/data/ v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/ 1234 Corresponds to the JSON property `property` @return [String]

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_v1beta/classes.rb, line 1954
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_v1beta/classes.rb, line 1959
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)
  @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)
  @property = args[:property] if args.key?(:property)
  @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
end