Class: Zernio::FacebookPlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/facebook_platform_data.rb

Overview

Feed posts support up to 10 images (no mixed video+image). Stories require single media (24h, no captions). Reels require single vertical video (9:16, 3-60s). Carousel posts (carouselCards) render a 2-5 card multi-link post, images only, mutually exclusive with story/reel. Geo-restriction is a hard visibility restriction: users outside the specified countries cannot see the post. Not supported for stories.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 115

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

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

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

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

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

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

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

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

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

Instance Attribute Details

Renders the post as a multi-link carousel (organic Page post). When set, mediaItems must be provided with the same length and all items must be images (no videos). Each cards adds the click-through link and headline for the image at mediaItems. Mutually exclusive with contentType=story|reel. Facebook display truncates name at ~35 chars and description at ~30 chars; longer strings are accepted but get truncated on render.



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

def carousel_cards
  @carousel_cards
end

#carousel_link ⇒ Object

Optional top-level "See more" destination shown on the carousel end card. Defaults to the first card's link when omitted. Only used together with carouselCards.



40
41
42
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 40

def carousel_link
  @carousel_link
end

#content_type ⇒ Object

Set to 'story' for Page Stories (24h ephemeral) or 'reel' for Reels (short vertical video). Defaults to feed post if omitted.



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

def content_type
  @content_type
end

#draft ⇒ Object

When true, creates the post as a draft in Facebook Publishing Tools instead of publishing immediately. Supported for feed posts (text, link, image, video) and reels. Not supported for stories. Drafts expire after ~30 days.



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

def draft
  @draft
end

#first_comment ⇒ Object

Optional first comment to post immediately after publishing (feed posts and reels, not stories). Skipped when draft is true.



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

def first_comment
  @first_comment
end

#geo_restriction ⇒ Object

Returns the value of attribute geo_restriction.



34
35
36
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 34

def geo_restriction
  @geo_restriction
end

#page_id ⇒ Object

Target Facebook Page ID for multi-page posting. If omitted, uses the default page. Use GET /v1/accounts/id/facebook-page to list pages.



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

def page_id
  @page_id
end

#text_format_preset_id ⇒ Object

Facebook-defined preset ID that renders the post as large text on a colored background (Graph text_format_preset_id). Supply the raw numeric ID from Meta; we do not publish a catalog of presets and Facebook may change the available set. Pages only (ignored on personal profiles and groups) and text-only feed posts only: the request is rejected with 400 when mediaItems or carouselCards are present, when contentType is story or reel, or when content is empty. An attachment makes Facebook drop the background silently, so those are rejected up front. Length is NOT rejected: Facebook's composer stops offering a background at around 130 characters, but Meta documents no API limit, so longer content publishes and returns a warning instead. A URL detected in the content is NOT attached as a link preview while a preset is set, because a link attachment also makes Facebook drop the background.



43
44
45
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 43

def text_format_preset_id
  @text_format_preset_id
end

#title ⇒ Object

Reel title (only for contentType=reel). Separate from the caption/content field.



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

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 68

def self.attribute_map
  {
    :'draft' => :'draft',
    :'content_type' => :'contentType',
    :'title' => :'title',
    :'first_comment' => :'firstComment',
    :'page_id' => :'pageId',
    :'geo_restriction' => :'geoRestriction',
    :'carousel_cards' => :'carouselCards',
    :'carousel_link' => :'carouselLink',
    :'text_format_preset_id' => :'textFormatPresetId'
  }
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 277

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



108
109
110
111
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 93

def self.openapi_types
  {
    :'draft' => :'Boolean',
    :'content_type' => :'String',
    :'title' => :'String',
    :'first_comment' => :'String',
    :'page_id' => :'String',
    :'geo_restriction' => :'GeoRestriction',
    :'carousel_cards' => :'Array<FacebookPlatformDataCarouselCardsInner>',
    :'carousel_link' => :'String',
    :'text_format_preset_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      draft == o.draft &&
      content_type == o.content_type &&
      title == o.title &&
      first_comment == o.first_comment &&
      page_id == o.page_id &&
      geo_restriction == o.geo_restriction &&
      carousel_cards == o.carousel_cards &&
      carousel_link == o.carousel_link &&
      text_format_preset_id == o.text_format_preset_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 270

def hash
  [draft, content_type, title, first_comment, page_id, geo_restriction, carousel_cards, carousel_link, text_format_preset_id].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@carousel_cards.nil? && @carousel_cards.length > 5
    invalid_properties.push('invalid value for "carousel_cards", number of items must be less than or equal to 5.')
  end

  if !@carousel_cards.nil? && @carousel_cards.length < 2
    invalid_properties.push('invalid value for "carousel_cards", number of items must be greater than or equal to 2.')
  end

  pattern = Regexp.new(/^\d+$/)
  if !@text_format_preset_id.nil? && @text_format_preset_id !~ pattern
    invalid_properties.push("invalid value for \"text_format_preset_id\", must conform to the pattern #{pattern}.")
  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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 299

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



193
194
195
196
197
198
199
200
201
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 193

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  content_type_validator = EnumAttributeValidator.new('String', ["story", "reel"])
  return false unless content_type_validator.valid?(@content_type)
  return false if !@carousel_cards.nil? && @carousel_cards.length > 5
  return false if !@carousel_cards.nil? && @carousel_cards.length < 2
  return false if !@text_format_preset_id.nil? && @text_format_preset_id !~ Regexp.new(/^\d+$/)
  true
end