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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1beta/analytics_data_api.rb

Overview

The request to generate a pivot report.

Instance Attribute Summary collapse

Instance Attribute Details

#cohort_spec ⇒ ::Google::Analytics::Data::V1beta::CohortSpec

Returns Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

Returns:



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#comparisons ⇒ ::Array<::Google::Analytics::Data::V1beta::Comparison>

Returns Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

Returns:

  • (::Array<::Google::Analytics::Data::V1beta::Comparison>) —

    Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#currency_code ⇒ ::String

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



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date_ranges ⇒ ::Array<::Google::Analytics::Data::V1beta::DateRange>

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



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimension_filter ⇒ ::Google::Analytics::Data::V1beta::FilterExpression

Returns The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Returns:



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimensions ⇒ ::Array<::Google::Analytics::Data::V1beta::Dimension>

Returns The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

Returns:



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#keep_empty_rows ⇒ ::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.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

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.

    Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

    For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metric_filter ⇒ ::Google::Analytics::Data::V1beta::FilterExpression

Returns 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:



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metrics ⇒ ::Array<::Google::Analytics::Data::V1beta::Metric>

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



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pivots ⇒ ::Array<::Google::Analytics::Data::V1beta::Pivot>

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



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#property ⇒ ::String

Returns 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



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#return_property_quota ⇒ ::Boolean

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



311
312
313
314
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 311

class RunPivotReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end