Class: Google::Apis::DfareportingV5::ReportDataQueryRequest

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

Overview

The request body containing ad-hoc query parameters.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReportDataQueryRequest

Returns a new instance of ReportDataQueryRequest.



11589
11590
11591
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11589

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

Instance Attribute Details

#date_range ⇒ Google::Apis::DfareportingV5::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



11554
11555
11556
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11554

def date_range
  @date_range
end

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

Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message DimensionValue. Corresponds to the JSON property dimensionFilters

Returns:



11560
11561
11562
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11560

def dimension_filters
  @dimension_filters
end

#dimension_names ⇒ Array<String>

Optional. The list of dimension names to group by. Corresponds to the JSON property dimensionNames

Returns:

  • (Array<String>) 


11565
11566
11567
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11565

def dimension_names
  @dimension_names
end

#max_results ⇒ Fixnum

Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced ( clamped) down to 1000. Negative values will be rejected. Corresponds to the JSON property maxResults

Returns:

  • (Fixnum) 


11572
11573
11574
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11572

def max_results
  @max_results
end

#metric_names ⇒ Array<String>

Required. The list of metric names to include. Corresponds to the JSON property metricNames

Returns:

  • (Array<String>) 


11577
11578
11579
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11577

def metric_names
  @metric_names
end

#page_token ⇒ String

Optional. Continuation token for paginating results. Corresponds to the JSON property pageToken

Returns:

  • (String) 


11582
11583
11584
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11582

def page_token
  @page_token
end

#sort_bys ⇒ Array<Google::Apis::DfareportingV5::SortBy>

Optional. Sort options across either requested dimensions or metrics. Corresponds to the JSON property sortBys

Returns:



11587
11588
11589
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11587

def sort_bys
  @sort_bys
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11594
11595
11596
11597
11598
11599
11600
11601
11602
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 11594

def update!(**args)
  @date_range = args[:date_range] if args.key?(:date_range)
  @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
  @dimension_names = args[:dimension_names] if args.key?(:dimension_names)
  @max_results = args[:max_results] if args.key?(:max_results)
  @metric_names = args[:metric_names] if args.key?(:metric_names)
  @page_token = args[:page_token] if args.key?(:page_token)
  @sort_bys = args[:sort_bys] if args.key?(:sort_bys)
end