Class: PinterestSdkClient::AdGroupAudienceSizingResponse

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AdGroupAudienceSizingResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 58

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::AdGroupAudienceSizingResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::AdGroupAudienceSizingResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'audience_size_lower_bound')
    self.audience_size_lower_bound = attributes[:'audience_size_lower_bound']
  end

  if attributes.key?(:'audience_size_upper_bound')
    self.audience_size_upper_bound = attributes[:'audience_size_upper_bound']
  end
end

Instance Attribute Details

#audience_size_lower_bound ⇒ Object

The lower confidence bound of the estimated potential audience size. "Potential audience size" estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.



19
20
21
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 19

def audience_size_lower_bound
  @audience_size_lower_bound
end

#audience_size_upper_bound ⇒ Object

The upper confidence bound of the estimated potential audience size. "Potential audience size" estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.



22
23
24
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 22

def audience_size_upper_bound
  @audience_size_upper_bound
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



33
34
35
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 33

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



38
39
40
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 38

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



25
26
27
28
29
30
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 25

def self.attribute_map
  {
    :'audience_size_lower_bound' => :'audience_size_lower_bound',
    :'audience_size_upper_bound' => :'audience_size_upper_bound'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 120

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



51
52
53
54
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 51

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 43

def self.openapi_types
  {
    :'audience_size_lower_bound' => :'Float',
    :'audience_size_upper_bound' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



98
99
100
101
102
103
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 98

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      audience_size_lower_bound == o.audience_size_lower_bound &&
      audience_size_upper_bound == o.audience_size_upper_bound
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


107
108
109
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 107

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



113
114
115
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 113

def hash
  [audience_size_lower_bound, audience_size_upper_bound].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



83
84
85
86
87
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 83

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 142

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



91
92
93
94
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_response.rb', line 91

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end