Google Analytics Data V1alpha API - Class Google::Analytics::Data::V1alpha::RunReportRequest (v0.8.3)

Reference documentation and code samples for the Google Analytics Data V1alpha API class Google::Analytics::Data::V1alpha::RunReportRequest.

The request to generate a report.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#cohort_spec

def cohort_spec() -> ::Google::Analytics::Data::V1alpha::CohortSpec

Returns

• (::Google::Analytics::Data::V1alpha::CohortSpec) — Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

#cohort_spec=

def cohort_spec=(value) -> ::Google::Analytics::Data::V1alpha::CohortSpec

Parameter

• value (::Google::Analytics::Data::V1alpha::CohortSpec) — Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

Returns

• (::Google::Analytics::Data::V1alpha::CohortSpec) — Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

#currency_code

def currency_code() -> ::String

Returns

• (::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.

#currency_code=

def currency_code=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#date_ranges

def date_ranges() -> ::Array<::Google::Analytics::Data::V1alpha::DateRange>

Returns

• (::Array<::Google::Analytics::Data::V1alpha::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.

#date_ranges=

def date_ranges=(value) -> ::Array<::Google::Analytics::Data::V1alpha::DateRange>

Parameter

• value (::Array<::Google::Analytics::Data::V1alpha::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.

Returns

• (::Array<::Google::Analytics::Data::V1alpha::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.

#dimension_filter

def dimension_filter() -> ::Google::Analytics::Data::V1alpha::FilterExpression

Returns

• (::Google::Analytics::Data::V1alpha::FilterExpression) — The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

#dimension_filter=

def dimension_filter=(value) -> ::Google::Analytics::Data::V1alpha::FilterExpression

Parameter

• value (::Google::Analytics::Data::V1alpha::FilterExpression) — The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Returns

• (::Google::Analytics::Data::V1alpha::FilterExpression) — The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

#dimensions

def dimensions() -> ::Array<::Google::Analytics::Data::V1alpha::Dimension>

Returns

• (::Array<::Google::Analytics::Data::V1alpha::Dimension>) — The dimensions requested and displayed.

#dimensions=

def dimensions=(value) -> ::Array<::Google::Analytics::Data::V1alpha::Dimension>

Parameter

• value (::Array<::Google::Analytics::Data::V1alpha::Dimension>) — The dimensions requested and displayed.

Returns

• (::Array<::Google::Analytics::Data::V1alpha::Dimension>) — The dimensions requested and displayed.

#entity

def entity() -> ::Google::Analytics::Data::V1alpha::Entity

Returns

• (::Google::Analytics::Data::V1alpha::Entity) — A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

#entity=

def entity=(value) -> ::Google::Analytics::Data::V1alpha::Entity

Parameter

• value (::Google::Analytics::Data::V1alpha::Entity) — A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

Returns

• (::Google::Analytics::Data::V1alpha::Entity) — A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

#keep_empty_rows

def keep_empty_rows() -> ::Boolean

Returns

• (::Boolean) — 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.

#keep_empty_rows=

def keep_empty_rows=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.

#limit

def limit() -> ::Integer

Returns

• (::Integer) — The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

  To learn more about this pagination parameter, see Pagination.

#limit=

def limit=(value) -> ::Integer

Parameter

• value (::Integer) — The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

  To learn more about this pagination parameter, see Pagination.

Returns

• (::Integer) — The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

  To learn more about this pagination parameter, see Pagination.

#metric_aggregations

def metric_aggregations() -> ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>

Returns

• (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

#metric_aggregations=

def metric_aggregations=(value) -> ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>

Parameter

• value (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

Returns

• (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

#metric_filter

def metric_filter() -> ::Google::Analytics::Data::V1alpha::FilterExpression

Returns

• (::Google::Analytics::Data::V1alpha::FilterExpression) — 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.

#metric_filter=

def metric_filter=(value) -> ::Google::Analytics::Data::V1alpha::FilterExpression

Parameter

• value (::Google::Analytics::Data::V1alpha::FilterExpression) — 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.

Returns

• (::Google::Analytics::Data::V1alpha::FilterExpression) — 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.

#metrics

def metrics() -> ::Array<::Google::Analytics::Data::V1alpha::Metric>

Returns

• (::Array<::Google::Analytics::Data::V1alpha::Metric>) — The metrics requested and displayed.

#metrics=

def metrics=(value) -> ::Array<::Google::Analytics::Data::V1alpha::Metric>

Parameter

• value (::Array<::Google::Analytics::Data::V1alpha::Metric>) — The metrics requested and displayed.

Returns

• (::Array<::Google::Analytics::Data::V1alpha::Metric>) — The metrics requested and displayed.

#offset

def offset() -> ::Integer

Returns

• (::Integer) — The row count of the start row. The first row is counted as row 0.

  To learn more about this pagination parameter, see Pagination.

#offset=

def offset=(value) -> ::Integer

Parameter

• value (::Integer) — The row count of the start row. The first row is counted as row 0.

  To learn more about this pagination parameter, see Pagination.

Returns

• (::Integer) — The row count of the start row. The first row is counted as row 0.

  To learn more about this pagination parameter, see Pagination.

#order_bys

def order_bys() -> ::Array<::Google::Analytics::Data::V1alpha::OrderBy>

Returns

• (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how rows are ordered in the response.

#order_bys=

def order_bys=(value) -> ::Array<::Google::Analytics::Data::V1alpha::OrderBy>

Parameter

• value (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how rows are ordered in the response.

Returns

• (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how rows are ordered in the response.

#return_property_quota

def return_property_quota() -> ::Boolean

Returns

• (::Boolean) — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

#return_property_quota=

def return_property_quota=(value) -> ::Boolean

Parameter

• value (::Boolean) — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

Returns

• (::Boolean) — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.