Class Google::Analytics::Data::V1beta::RunPivotReportRequest

The request to generate a pivot report.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cohort_spec

defcohort_spec()->::Google::Analytics::Data::V1beta::CohortSpec
Returns

#cohort_spec=

defcohort_spec=(value)->::Google::Analytics::Data::V1beta::CohortSpec
Parameter
Returns

#currency_code

defcurrency_code()->::String
Returns
  • (::String) — A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

#currency_code=

defcurrency_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 property'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 property's default currency.

#date_ranges

defdate_ranges()->::Array<::Google::Analytics::Data::V1beta::DateRange>
Returns
  • (::Array<::Google::Analytics::Data::V1beta::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.

#date_ranges=

defdate_ranges=(value)->::Array<::Google::Analytics::Data::V1beta::DateRange>
Parameter
  • value (::Array<::Google::Analytics::Data::V1beta::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.
Returns
  • (::Array<::Google::Analytics::Data::V1beta::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.

#dimension_filter

defdimension_filter()->::Google::Analytics::Data::V1beta::FilterExpression
Returns

#dimension_filter=

defdimension_filter=(value)->::Google::Analytics::Data::V1beta::FilterExpression
Parameter
Returns

#dimensions

defdimensions()->::Array<::Google::Analytics::Data::V1beta::Dimension>
Returns

#dimensions=

defdimensions=(value)->::Array<::Google::Analytics::Data::V1beta::Dimension>
Parameter
Returns

#keep_empty_rows

defkeep_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=

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

#metric_filter

defmetric_filter()->::Google::Analytics::Data::V1beta::FilterExpression
Returns

#metric_filter=

defmetric_filter=(value)->::Google::Analytics::Data::V1beta::FilterExpression
Parameter
  • value (::Google::Analytics::Data::V1beta::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

#metrics

defmetrics()->::Array<::Google::Analytics::Data::V1beta::Metric>
Returns
  • (::Array<::Google::Analytics::Data::V1beta::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.

#metrics=

defmetrics=(value)->::Array<::Google::Analytics::Data::V1beta::Metric>
Parameter
  • value (::Array<::Google::Analytics::Data::V1beta::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.
Returns
  • (::Array<::Google::Analytics::Data::V1beta::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.

#pivots

defpivots()->::Array<::Google::Analytics::Data::V1beta::Pivot>
Returns
  • (::Array<::Google::Analytics::Data::V1beta::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.

#pivots=

defpivots=(value)->::Array<::Google::Analytics::Data::V1beta::Pivot>
Parameter
  • value (::Array<::Google::Analytics::Data::V1beta::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.
Returns
  • (::Array<::Google::Analytics::Data::V1beta::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.

#property

defproperty()->::String
Returns
  • (::String) — 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

    Example: properties/1234

#property=

defproperty=(value)->::String
Parameter
  • value (::String) — 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

    Example: properties/1234

Returns
  • (::String) — 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

    Example: properties/1234

#return_property_quota

defreturn_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=

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.