Class: Zernio::CreateStandaloneAdRequestPlacementAssets

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

Overview

Meta only. Placement asset customization: pin a SPECIFIC asset (image OR video) to each placement group on a SINGLE ad (e.g. a 9:16 on Stories/Reels and a 4:5 on Feed). The same thing Meta Ads Manager produces with "different creative per placement", mapped to the creative's asset_feed_spec + asset_customization_rules. Deterministic pinning, NOT the auto-optimizing pool of dynamicCreative (mutually exclusive). Works on the legacy single shape AND the attach shape (adSetId + placementAssets adds one placement-customized ad to an existing ad set — the way to build N per-placement ads sharing one ad set: create the first normally, attach the rest). Cannot be combined with creatives[]. Shared copy (headline, body, link, CTA) comes from the top-level single-creative fields since only the asset varies by placement. Each rule's placements accepts the same fields as the top-level placements object; Meta enforces co-selection rules and returns an actionable error. Note on text rendering: Meta suppresses primary text and headline on fullscreen placements (Stories and Reels) in actual ad delivery; the fields are accepted and the ad publishes, but the copy is not shown to users. For visible copy on those placements, bake the text into the creative image or video itself. A block is all-image OR all-video, never mixed (Meta's asset_feed_spec carries one ad format). Image mode: defaultImageUrl + rules[].imageUrl. Video mode: defaultVideoUrl + rules[].videoUrl (optional thumbnailUrl/defaultThumbnailUrl posters; Meta auto-generates when omitted). Exactly one catch-all default is required.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 69

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

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

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

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

Instance Attribute Details

#default_image_url ⇒ Object

Image mode. Catch-all image for any placement no rule matches. Required in image mode (Meta mandates a default rule).



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

def default_image_url
  @default_image_url
end

#default_thumbnail_url ⇒ Object

Video mode (optional). Poster image for the default video; Meta auto-generates one when omitted.



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

def default_thumbnail_url
  @default_thumbnail_url
end

#default_video_url ⇒ Object

Video mode. Catch-all video for any placement no rule matches. Required in video mode.



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

def default_video_url
  @default_video_url
end

#rules ⇒ Object

One entry per placement group you want to pin a specific asset to.



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

def rules
  @rules
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 32

def self.attribute_map
  {
    :'default_image_url' => :'defaultImageUrl',
    :'default_video_url' => :'defaultVideoUrl',
    :'default_thumbnail_url' => :'defaultThumbnailUrl',
    :'rules' => :'rules'
  }
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 178

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



62
63
64
65
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 52

def self.openapi_types
  {
    :'default_image_url' => :'String',
    :'default_video_url' => :'String',
    :'default_thumbnail_url' => :'String',
    :'rules' => :'Array<CreateStandaloneAdRequestPlacementAssetsRulesInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_image_url == o.default_image_url &&
      default_video_url == o.default_video_url &&
      default_thumbnail_url == o.default_thumbnail_url &&
      rules == o.rules
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [default_image_url, default_video_url, default_thumbnail_url, rules].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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 106

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @rules.nil?
    invalid_properties.push('invalid value for "rules", rules cannot be nil.')
  end

  if @rules.length > 10
    invalid_properties.push('invalid value for "rules", number of items must be less than or equal to 10.')
  end

  if @rules.length < 1
    invalid_properties.push('invalid value for "rules", number of items must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb', line 200

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @rules.nil?
  return false if @rules.length > 10
  return false if @rules.length < 1
  true
end