Class: Google::Apis::AdexchangesellerV2_0::ReportingMetadataEntry

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangeseller_v2_0/classes.rb,
generated/google/apis/adexchangeseller_v2_0/representations.rb,
generated/google/apis/adexchangeseller_v2_0/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.


635
636
637
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 635

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

Instance Attribute Details

#compatible_dimensionsArray<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>)

594
595
596
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 594

def compatible_dimensions
  @compatible_dimensions
end

#compatible_metricsArray<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>)

600
601
602
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 600

def compatible_metrics
  @compatible_metrics
end

#idString

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)

606
607
608
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 606

def id
  @id
end

#kindString

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

Returns:

  • (String)

611
612
613
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 611

def kind
  @kind
end

#required_dimensionsArray<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>)

619
620
621
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 619

def required_dimensions
  @required_dimensions
end

#required_metricsArray<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>)

627
628
629
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 627

def required_metrics
  @required_metrics
end

#supported_productsArray<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>)

633
634
635
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 633

def supported_products
  @supported_products
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


640
641
642
643
644
645
646
647
648
# File 'generated/google/apis/adexchangeseller_v2_0/classes.rb', line 640

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