Class: Zernio::CreateStandaloneAdRequestPlacements

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

Overview

Meta only. Manual ad placements. Omit for automatic placements (Meta's default, recommended for most cases — Meta optimises delivery across all eligible surfaces). When set, restricts delivery to the chosen surfaces, mapped onto the ad set's targeting.{publisher_platforms, facebook_positions, instagram_positions, messenger_positions, audience_network_positions, threads_positions, whatsapp_positions, device_platforms}. Enum membership is validated here; Meta additionally enforces co-selection rules (e.g. some positions require their parent publisher platform) and returns an actionable error which we surface. Non-Meta platforms reject this field.

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 105

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

  if attributes.key?(:'facebook_positions')
    if (value = attributes[:'facebook_positions']).is_a?(Array)
      self.facebook_positions = value
    end
  end

  if attributes.key?(:'instagram_positions')
    if (value = attributes[:'instagram_positions']).is_a?(Array)
      self.instagram_positions = value
    end
  end

  if attributes.key?(:'messenger_positions')
    if (value = attributes[:'messenger_positions']).is_a?(Array)
      self.messenger_positions = value
    end
  end

  if attributes.key?(:'audience_network_positions')
    if (value = attributes[:'audience_network_positions']).is_a?(Array)
      self.audience_network_positions = value
    end
  end

  if attributes.key?(:'threads_positions')
    if (value = attributes[:'threads_positions']).is_a?(Array)
      self.threads_positions = value
    end
  end

  if attributes.key?(:'whatsapp_positions')
    if (value = attributes[:'whatsapp_positions']).is_a?(Array)
      self.whatsapp_positions = value
    end
  end

  if attributes.key?(:'device_platforms')
    if (value = attributes[:'device_platforms']).is_a?(Array)
      self.device_platforms = value
    end
  end
end

Instance Attribute Details

#audience_network_positions ⇒ Object

Returns the value of attribute audience_network_positions.



28
29
30
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 28

def audience_network_positions
  @audience_network_positions
end

#device_platforms ⇒ Object

Restrict by device. Omit to deliver on both mobile and desktop.



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

def device_platforms
  @device_platforms
end

#facebook_positions ⇒ Object

Returns the value of attribute facebook_positions.



22
23
24
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 22

def facebook_positions
  @facebook_positions
end

#instagram_positions ⇒ Object

Returns the value of attribute instagram_positions.



24
25
26
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 24

def instagram_positions
  @instagram_positions
end

#messenger_positions ⇒ Object

Returns the value of attribute messenger_positions.



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

def messenger_positions
  @messenger_positions
end

#publisher_platforms ⇒ Object

Top-level platforms to deliver on. A position field below is only honoured when its parent platform is included here.



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

def publisher_platforms
  @publisher_platforms
end

#threads_positions ⇒ Object

Returns the value of attribute threads_positions.



30
31
32
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 30

def threads_positions
  @threads_positions
end

#whatsapp_positions ⇒ Object

Returns the value of attribute whatsapp_positions.



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

def whatsapp_positions
  @whatsapp_positions
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 60

def self.attribute_map
  {
    :'publisher_platforms' => :'publisherPlatforms',
    :'facebook_positions' => :'facebookPositions',
    :'instagram_positions' => :'instagramPositions',
    :'messenger_positions' => :'messengerPositions',
    :'audience_network_positions' => :'audienceNetworkPositions',
    :'threads_positions' => :'threadsPositions',
    :'whatsapp_positions' => :'whatsappPositions',
    :'device_platforms' => :'devicePlatforms'
  }
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 213

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



98
99
100
101
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 84

def self.openapi_types
  {
    :'publisher_platforms' => :'Array<String>',
    :'facebook_positions' => :'Array<String>',
    :'instagram_positions' => :'Array<String>',
    :'messenger_positions' => :'Array<String>',
    :'audience_network_positions' => :'Array<String>',
    :'threads_positions' => :'Array<String>',
    :'whatsapp_positions' => :'Array<String>',
    :'device_platforms' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      publisher_platforms == o.publisher_platforms &&
      facebook_positions == o.facebook_positions &&
      instagram_positions == o.instagram_positions &&
      messenger_positions == o.messenger_positions &&
      audience_network_positions == o.audience_network_positions &&
      threads_positions == o.threads_positions &&
      whatsapp_positions == o.whatsapp_positions &&
      device_platforms == o.device_platforms
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 206

def hash
  [publisher_platforms, facebook_positions, instagram_positions, messenger_positions, audience_network_positions, threads_positions, whatsapp_positions, device_platforms].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



170
171
172
173
174
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 170

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 235

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



178
179
180
181
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placements.rb', line 178

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