Class: Google::Analytics::Data::V1beta::Pivot

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

Overview

Describes the visible dimension columns and rows in the report response.

Instance Attribute Summary collapse

Instance Attribute Details

#field_names ⇒ ::Array<::String>

Returns Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

Returns:

  • (::Array<::String>) —

    Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.



512
513
514
515
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 512

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

#limit ⇒ ::Integer

Returns The number of unique combinations of dimension values to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests.

The product of the limit for each pivot in a RunPivotReportRequest must not exceed 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.

Returns:

  • (::Integer) —

    The number of unique combinations of dimension values to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests.

    The product of the limit for each pivot in a RunPivotReportRequest must not exceed 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.



512
513
514
515
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 512

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

#metric_aggregations ⇒ ::Array<::Google::Analytics::Data::V1beta::MetricAggregation>

Returns Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

Returns:



512
513
514
515
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 512

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

#offset ⇒ ::Integer

Returns The row count of the start row. The first row is counted as row 0.

Returns:

  • (::Integer) —

    The row count of the start row. The first row is counted as row 0.



512
513
514
515
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 512

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

#order_bys ⇒ ::Array<::Google::Analytics::Data::V1beta::OrderBy>

Returns Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

Returns:

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

    Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.



512
513
514
515
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 512

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