Class: Google::Apis::AnalyticsdataV1beta::CheckCompatibilityRequest

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

The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the runReport request should be the same values as in your runReport request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CheckCompatibilityRequest

Returns a new instance of CheckCompatibilityRequest.



227
228
229
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 227

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

Instance Attribute Details

#compatibility_filter ⇒ String

Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics. Corresponds to the JSON property compatibilityFilter

Returns:

  • (String) 


201
202
203
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 201

def compatibility_filter
  @compatibility_filter
end

#dimension_filter ⇒ Google::Apis::AnalyticsdataV1beta::FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. Corresponds to the JSON property dimensionFilter

Returns:



207
208
209
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 207

def dimension_filter
  @dimension_filter
end

#dimensions ⇒ Array<Google::Apis::AnalyticsdataV1beta::Dimension>

The dimensions in this report. dimensions should be the same value as in your runReport request. Corresponds to the JSON property dimensions

Returns:



213
214
215
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 213

def dimensions
  @dimensions
end

#metric_filter ⇒ Google::Apis::AnalyticsdataV1beta::FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. Corresponds to the JSON property metricFilter

Returns:



219
220
221
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 219

def metric_filter
  @metric_filter
end

#metrics ⇒ Array<Google::Apis::AnalyticsdataV1beta::Metric>

The metrics in this report. metrics should be the same value as in your runReport request. Corresponds to the JSON property metrics

Returns:



225
226
227
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 225

def metrics
  @metrics
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



232
233
234
235
236
237
238
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 232

def update!(**args)
  @compatibility_filter = args[:compatibility_filter] if args.key?(:compatibility_filter)
  @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
  @metrics = args[:metrics] if args.key?(:metrics)
end