Class: Google::Apis::AdexchangesellerV1_1::ReportingMetadataEntry

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

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) ⇒ ReportingMetadataEntry

Returns a new instance of ReportingMetadataEntry



685
686
687
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 685

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

Instance Attribute Details

#compatible_dimensions ⇒ Array<String>

For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to. Corresponds to the JSON property compatibleDimensions

Returns:

  • (Array<String>) 


644
645
646
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 644

def compatible_dimensions
  @compatible_dimensions
end

#compatible_metrics ⇒ Array<String>

The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with. Corresponds to the JSON property compatibleMetrics

Returns:

  • (Array<String>) 


650
651
652
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 650

def compatible_metrics
  @compatible_metrics
end

#id ⇒ String

Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric. Corresponds to the JSON property id

Returns:

  • (String) 


656
657
658
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 656

def id
  @id
end

#kind ⇒ String

Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry. Corresponds to the JSON property kind

Returns:

  • (String) 


661
662
663
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 661

def kind
  @kind
end

#required_dimensions ⇒ Array<String>

The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. Corresponds to the JSON property requiredDimensions

Returns:

  • (Array<String>) 


669
670
671
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 669

def required_dimensions
  @required_dimensions
end

#required_metrics ⇒ Array<String>

The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. Corresponds to the JSON property requiredMetrics

Returns:

  • (Array<String>) 


677
678
679
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 677

def required_metrics
  @required_metrics
end

#supported_products ⇒ Array<String>

The codes of the projects supported by the dimension or metric this reporting metadata entry describes. Corresponds to the JSON property supportedProducts

Returns:

  • (Array<String>) 


683
684
685
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 683

def supported_products
  @supported_products
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



690
691
692
693
694
695
696
697
698
 
# File 'generated/google/apis/adexchangeseller_v1_1/classes.rb', line 690

def update!(**args)
  @compatible_dimensions = args[:compatible_dimensions] if args.key?(:compatible_dimensions)
  @compatible_metrics = args[:compatible_metrics] if args.key?(:compatible_metrics)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @required_dimensions = args[:required_dimensions] if args.key?(:required_dimensions)
  @required_metrics = args[:required_metrics] if args.key?(:required_metrics)
  @supported_products = args[:supported_products] if args.key?(:supported_products)
end