Class: Google::Apis::AnalyticsreportingV4::Pivot

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

Overview

The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Pivot

Returns a new instance of Pivot.


1020
1021
1022
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1020

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

Instance Attribute Details

#dimension_filter_clausesArray<Google::Apis::AnalyticsreportingV4::DimensionFilterClause>

DimensionFilterClauses are logically combined with an AND operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have ga:browser as the requested dimension in the pivot region, and you specify key filters to restrict ga:browser to only “IE” or “Firefox”, then only those two browsers would show up as columns. Corresponds to the JSON property dimensionFilterClauses


985
986
987
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 985

def dimension_filter_clauses
  @dimension_filter_clauses
end

#dimensionsArray<Google::Apis::AnalyticsreportingV4::Dimension>

A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request. Corresponds to the JSON property dimensions


992
993
994
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 992

def dimensions
  @dimensions
end

#max_group_countFixnum

Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000. Corresponds to the JSON property maxGroupCount

Returns:

  • (Fixnum)

998
999
1000
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 998

def max_group_count
  @max_group_count
end

#metricsArray<Google::Apis::AnalyticsreportingV4::Metric>

The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request. Corresponds to the JSON property metrics


1004
1005
1006
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1004

def metrics
  @metrics
end

#start_groupFixnum

If k metrics were requested, then the response will contain some data- dependent multiple of k columns in the report. E.g., if you pivoted on the dimension ga:browser then you’d get k columns for “Firefox”, k columns for “ IE”, k columns for “Chrome”, etc. The ordering of the groups of columns is determined by descending order of “total” for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response. Corresponds to the JSON property startGroup

Returns:

  • (Fixnum)

1018
1019
1020
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1018

def start_group
  @start_group
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1025
1026
1027
1028
1029
1030
1031
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1025

def update!(**args)
  @dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @max_group_count = args[:max_group_count] if args.key?(:max_group_count)
  @metrics = args[:metrics] if args.key?(:metrics)
  @start_group = args[:start_group] if args.key?(:start_group)
end