Class: Google::Apis::AnalyticsdataV1beta::Pivot

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsdata_v1beta/classes.rb,
lib/google/apis/analyticsdata_v1beta/representations.rb,
lib/google/apis/analyticsdata_v1beta/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Pivot

Returns a new instance of Pivot.



1222
1223
1224
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1222

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#field_names ⇒ 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. Corresponds to the JSON property fieldNames

Returns:

  • (Array<String>) 


1191
1192
1193
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1191

def field_names
  @field_names
end

#limit ⇒ Fixnum

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 100,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1, 000,000. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


1201
1202
1203
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1201

def limit
  @limit
end

#metric_aggregations ⇒ Array<String>

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations. Corresponds to the JSON property metricAggregations

Returns:

  • (Array<String>) 


1207
1208
1209
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1207

def metric_aggregations
  @metric_aggregations
end

#offset ⇒ Fixnum

The row count of the start row. The first row is counted as row 0. Corresponds to the JSON property offset

Returns:

  • (Fixnum) 


1212
1213
1214
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1212

def offset
  @offset
end

#order_bys ⇒ Array<Google::Apis::AnalyticsdataV1beta::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. Corresponds to the JSON property orderBys

Returns:



1220
1221
1222
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1220

def order_bys
  @order_bys
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1227

def update!(**args)
  @field_names = args[:field_names] if args.key?(:field_names)
  @limit = args[:limit] if args.key?(:limit)
  @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
  @offset = args[:offset] if args.key?(:offset)
  @order_bys = args[:order_bys] if args.key?(:order_bys)
end