Class: Google::Apis::DfareportingV4::Report::CrossDimensionReachCriteria

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

Overview

The report criteria for a report of type "CROSS_DIMENSION_REACH".

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CrossDimensionReachCriteria

Returns a new instance of CrossDimensionReachCriteria.



10833
10834
10835
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10833

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

Instance Attribute Details

#breakdown ⇒ Array<Google::Apis::DfareportingV4::SortedDimension>

The list of dimensions the report should include. Corresponds to the JSON property breakdown

Returns:



10800
10801
10802
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10800

def breakdown
  @breakdown
end

#date_range ⇒ Google::Apis::DfareportingV4::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



10805
10806
10807
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10805

def date_range
  @date_range
end

#dimension ⇒ String

The dimension option. Corresponds to the JSON property dimension

Returns:

  • (String) 


10810
10811
10812
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10810

def dimension
  @dimension
end

#dimension_filters ⇒ Array<Google::Apis::DfareportingV4::DimensionValue>

The list of filters on which dimensions are filtered. Corresponds to the JSON property dimensionFilters

Returns:



10815
10816
10817
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10815

def dimension_filters
  @dimension_filters
end

#metric_names ⇒ Array<String>

The list of names of metrics the report should include. Corresponds to the JSON property metricNames

Returns:

  • (Array<String>) 


10820
10821
10822
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10820

def metric_names
  @metric_names
end

#overlap_metric_names ⇒ Array<String>

The list of names of overlap metrics the report should include. Corresponds to the JSON property overlapMetricNames

Returns:

  • (Array<String>) 


10825
10826
10827
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10825

def overlap_metric_names
  @overlap_metric_names
end

#pivoted ⇒ Boolean Also known as: pivoted?

Whether the report is pivoted or not. Defaults to true. Corresponds to the JSON property pivoted

Returns:

  • (Boolean) 


10830
10831
10832
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10830

def pivoted
  @pivoted
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10838
10839
10840
10841
10842
10843
10844
10845
10846
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10838

def update!(**args)
  @breakdown = args[:breakdown] if args.key?(:breakdown)
  @date_range = args[:date_range] if args.key?(:date_range)
  @dimension = args[:dimension] if args.key?(:dimension)
  @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
  @metric_names = args[:metric_names] if args.key?(:metric_names)
  @overlap_metric_names = args[:overlap_metric_names] if args.key?(:overlap_metric_names)
  @pivoted = args[:pivoted] if args.key?(:pivoted)
end