Class: Zernio::CreateStandaloneAdRequestTracking

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

Overview

Meta only. Attaches pixel measurement to the ad regardless of the optimization goal (the "Website events" tracking row in Ads Manager). pixelId becomes the ad's tracking_specs (offsite_conversion + fb_pixel); urlTags becomes the ad's url_tags (click-tracking query params). Applied on the legacy single-creative shape, every ad of the multi-creative shape, and the attach shape. NOTE: tracking lives on the AD object and is not inherited from the ad set, so pass it on EVERY attach call that should carry the pixel.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 59

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

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

Instance Attribute Details

#pixel_id ⇒ Object

Meta Pixel ID to attach for offsite-conversion measurement.



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

def pixel_id
  @pixel_id
end

#url_tags ⇒ Object

Click-URL params appended to the ad's destination as url_tags (e.g. utm_source).



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

def url_tags
  @url_tags
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



39
40
41
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 39

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 26

def self.attribute_map
  {
    :'pixel_id' => :'pixelId',
    :'url_tags' => :'urlTags'
  }
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 123

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 44

def self.openapi_types
  {
    :'pixel_id' => :'String',
    :'url_tags' => :'Array<UpdateAdTrackingTagsRequestUrlTagsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



101
102
103
104
105
106
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 101

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


110
111
112
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 110

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



116
117
118
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 116

def hash
  [pixel_id, url_tags].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



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

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



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 145

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
 
# File 'lib/zernio-sdk/models/create_standalone_ad_request_tracking.rb', line 94

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