Class: Zernio::LinkedInAdsPlatformDataThoughtLeader

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

Overview

POST /v1/ads/create only. Sponsors an existing LinkedIn post (a share or ugcPost authored by your organization's Company Page) as the creative, keeping its commentary, author and engagement. Unlike boostPost, which provisions its own CampaignGroup + Campaign around the post, this variant attaches the reference under the campaign /v1/ads/create builds — same shape as every other format, so the caller can pick bidding / targeting / schedule freely. No headline, body, imageUrl or organization are needed; the referenced post carries its own commentary and author. Mutually exclusive with the other creative sources. Posts from personal profiles (Thought Leader Ads) are NOT supported (see postUrn).

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 54

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

Instance Attribute Details

#post_urn ⇒ Object

LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via "Copy link to post" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). The post must be authored by an organization (Company Page). Member (personal profile) posts, i.e. Thought Leader Ads proper, are rejected by LinkedIn's public Marketing API regardless of sponsorship approval and of post type (a LinkedIn limitation; their Campaign Manager creates those through a private API). Referencing a member post returns a 422 with a clear error.



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

def post_urn
  @post_urn
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'post_urn' => :'postUrn'
  }
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 139

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'post_urn' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



118
119
120
121
122
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 118

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


126
127
128
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



132
133
134
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 132

def hash
  [post_urn].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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 77

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

  pattern = Regexp.new(/^urn:li:(share|ugcPost):\d+$/)
  if @post_urn !~ pattern
    invalid_properties.push("invalid value for \"post_urn\", 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



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 161

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



94
95
96
97
98
99
 
# File 'lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb', line 94

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @post_urn.nil?
  return false if @post_urn !~ Regexp.new(/^urn:li:(share|ugcPost):\d+$/)
  true
end