Class: Zernio::UpdateAdSetRequestPlatformSpecificData

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb

Overview

Platform-specific post-launch delivery settings. The platform is implied by the platform body param. Meta only; other platforms return 400. Unknown keys are rejected.

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 = {}) ⇒ UpdateAdSetRequestPlatformSpecificData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::UpdateAdSetRequestPlatformSpecificData` 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 `Zernio::UpdateAdSetRequestPlatformSpecificData`. 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?(:'optimization_goal')
    self.optimization_goal = attributes[:'optimization_goal']
  end

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

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

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

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

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

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

Instance Attribute Details

#billing_event ⇒ Object

Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).



23
24
25
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 23

def billing_event
  @billing_event
end

#daily_min_spend_target ⇒ Object

Meta daily_min_spend_target: the least this ad set should spend per day, in whole currency units of the ad account. It reserves a share of a CAMPAIGN budget for one ad set, so it requires a campaign using Advantage campaign budget (CBO). On an ad set that owns its budget (ABO) this returns 409. Move the budget to the campaign with PUT /v1/ads/campaigns/{campaignId} first. Meta treats it as a target, not a guarantee, and rejects the combined minimum of a campaign's ad sets going over the campaign budget. Mutually exclusive with lifetimeMinSpendTarget (400): the flavour must match the campaign budget type, a daily budget takes a daily target. Read it back with GET /v1/ads/ad-sets/{adSetId}?fields=daily_min_spend_target.



32
33
34
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 32

def daily_min_spend_target
  @daily_min_spend_target
end

#end_date ⇒ Object

Ad set end_time (ISO 8601).



29
30
31
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 29

def end_date
  @end_date
end

#lifetime_min_spend_target ⇒ Object

Meta lifetime_min_spend_target: the lifetime-budget flavour of dailyMinSpendTarget, in whole currency units. Send this one when the campaign budget is a lifetime budget. Same rules and same rejections.



35
36
37
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 35

def lifetime_min_spend_target
  @lifetime_min_spend_target
end

#optimization_goal ⇒ Object

Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).



20
21
22
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 20

def optimization_goal
  @optimization_goal
end

Returns the value of attribute promoted_object.



37
38
39
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 37

def promoted_object
  @promoted_object
end

#start_date ⇒ Object

Ad set start_time (ISO 8601).



26
27
28
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 26

def start_date
  @start_date
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



53
54
55
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 53

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 58

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 40

def self.attribute_map
  {
    :'optimization_goal' => :'optimizationGoal',
    :'billing_event' => :'billingEvent',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'daily_min_spend_target' => :'dailyMinSpendTarget',
    :'lifetime_min_spend_target' => :'lifetimeMinSpendTarget',
    :'promoted_object' => :'promotedObject'
  }
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 170

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



76
77
78
79
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 63

def self.openapi_types
  {
    :'optimization_goal' => :'String',
    :'billing_event' => :'String',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'daily_min_spend_target' => :'Float',
    :'lifetime_min_spend_target' => :'Float',
    :'promoted_object' => :'UpdateAdSetRequestPlatformSpecificDataPromotedObject'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      optimization_goal == o.optimization_goal &&
      billing_event == o.billing_event &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      daily_min_spend_target == o.daily_min_spend_target &&
      lifetime_min_spend_target == o.lifetime_min_spend_target &&
      promoted_object == o.promoted_object
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 163

def hash
  [optimization_goal, billing_event, start_date, end_date, daily_min_spend_target, lifetime_min_spend_target, promoted_object].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



128
129
130
131
132
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 128

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



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 192

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



136
137
138
139
 
# File 'lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb', line 136

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