Class: Zernio::ListInboxConversations200ResponseDataInnerMetadata

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

Overview

Ad-click attribution for a conversation that started from a Meta ad. Absent when the conversation did not originate from an ad click. Captured from the referral Meta attaches to the first inbound message after the click, which is the only message that carries it. If the same person later clicks a different ad, the original values are kept, so the first ad wins. One exception on WhatsApp: when Meta omits ctwa_clid from that referral, a later Meta automatic event can supply it and refresh ctwa_captured_at, so treat ctwa_captured_at as the time Zernio stored the value, not the time of the click. Two families of keys, one per surface. They never appear together: - ctwa_* is WhatsApp Click-to-WhatsApp. The ad ID is ctwa_source_id. There is no meta_ad_id on WhatsApp. - meta_ad_* is Instagram Click-to-Direct and Facebook Messenger Click-to-Message. The ad ID is meta_ad_id. ctwa_clid never appears on these platforms. Every key is optional and only the keys Meta supplied are returned, so read defensively. Meta does not send a campaign or ad set ID, so none is exposed here. More keys may be added over time. Treat any key you do not recognise as an opaque string. Key names differ from the message.received webhook on purpose. The webhook forwards Meta's referral verbatim (ad_id, source, type) while the stored conversation record uses the prefixed names below. Renaming either side would break existing integrations, so both spellings are kept.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ctwa_captured_at ⇒ Object

WhatsApp only. When Zernio stored this referral. Always present when a WhatsApp referral was captured.



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

def ctwa_captured_at
  @ctwa_captured_at
end

#ctwa_clid ⇒ Object

WhatsApp only. Meta's click identifier, the value to forward to the Meta Conversions API for Business Messaging. Meta omits it on some numbers, so a WhatsApp referral can arrive without it.



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

def ctwa_clid
  @ctwa_clid
end

#ctwa_headline ⇒ Object

WhatsApp only. Headline of the ad creative at click time.



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

def ctwa_headline
  @ctwa_headline
end

#ctwa_source_id ⇒ Object

WhatsApp only. The Meta ad ID the user clicked. This is the WhatsApp equivalent of meta_ad_id.



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

def ctwa_source_id
  @ctwa_source_id
end

#ctwa_source_type ⇒ Object

WhatsApp only. What the user clicked, as supplied by Meta (for example ad or post).



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

def ctwa_source_type
  @ctwa_source_type
end

#ctwa_source_url ⇒ Object

WhatsApp only. Meta's URL for the ad that was clicked, normally an fb.me short link.



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

def ctwa_source_url
  @ctwa_source_url
end

#meta_ad_captured_at ⇒ Object

Instagram and Facebook only. When Zernio stored this referral. Always present when an Instagram or Facebook referral was captured.



68
69
70
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 68

def meta_ad_captured_at
  @meta_ad_captured_at
end

#meta_ad_flow_id ⇒ Object

Instagram and Facebook only. The Meta flow the ad launched, for flow ads.



65
66
67
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 65

def meta_ad_flow_id
  @meta_ad_flow_id
end

#meta_ad_id ⇒ Object

Instagram and Facebook only. The Meta ad ID the user clicked. Always present when an Instagram or Facebook referral was captured.



38
39
40
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 38

def meta_ad_id
  @meta_ad_id
end

#meta_ad_photo_url ⇒ Object

Instagram and Facebook only. Image of the ad creative at click time.



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

def meta_ad_photo_url
  @meta_ad_photo_url
end

#meta_ad_post_id ⇒ Object

Instagram and Facebook only. The organic post the ad promoted, when the ad was a boosted post.



59
60
61
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 59

def meta_ad_post_id
  @meta_ad_post_id
end

#meta_ad_product_id ⇒ Object

Instagram and Facebook only. The catalogue product the user clicked, for product ads.



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

def meta_ad_product_id
  @meta_ad_product_id
end

#meta_ad_ref ⇒ Object

Instagram and Facebook only. The ref parameter passed through from the ad creative.



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

def meta_ad_ref
  @meta_ad_ref
end

#meta_ad_source ⇒ Object

Instagram and Facebook only. Meta-supplied source identifier, for example ADS.



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

def meta_ad_source
  @meta_ad_source
end

#meta_ad_title ⇒ Object

Instagram and Facebook only. Title of the ad creative at click time.



50
51
52
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 50

def meta_ad_title
  @meta_ad_title
end

#meta_ad_type ⇒ Object

Instagram and Facebook only. Meta-supplied referral type, for example OPEN_THREAD.



44
45
46
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 44

def meta_ad_type
  @meta_ad_type
end

#meta_ad_video_url ⇒ Object

Instagram and Facebook only. Video of the ad creative at click time.



56
57
58
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 56

def meta_ad_video_url
  @meta_ad_video_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



94
95
96
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 94

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 71

def self.attribute_map
  {
    :'ctwa_clid' => :'ctwa_clid',
    :'ctwa_source_id' => :'ctwa_source_id',
    :'ctwa_source_type' => :'ctwa_source_type',
    :'ctwa_source_url' => :'ctwa_source_url',
    :'ctwa_headline' => :'ctwa_headline',
    :'ctwa_captured_at' => :'ctwa_captured_at',
    :'meta_ad_id' => :'meta_ad_id',
    :'meta_ad_source' => :'meta_ad_source',
    :'meta_ad_type' => :'meta_ad_type',
    :'meta_ad_ref' => :'meta_ad_ref',
    :'meta_ad_title' => :'meta_ad_title',
    :'meta_ad_photo_url' => :'meta_ad_photo_url',
    :'meta_ad_video_url' => :'meta_ad_video_url',
    :'meta_ad_post_id' => :'meta_ad_post_id',
    :'meta_ad_product_id' => :'meta_ad_product_id',
    :'meta_ad_flow_id' => :'meta_ad_flow_id',
    :'meta_ad_captured_at' => :'meta_ad_captured_at'
  }
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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 271

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



127
128
129
130
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'ctwa_clid' => :'String',
    :'ctwa_source_id' => :'String',
    :'ctwa_source_type' => :'String',
    :'ctwa_source_url' => :'String',
    :'ctwa_headline' => :'String',
    :'ctwa_captured_at' => :'Time',
    :'meta_ad_id' => :'String',
    :'meta_ad_source' => :'String',
    :'meta_ad_type' => :'String',
    :'meta_ad_ref' => :'String',
    :'meta_ad_title' => :'String',
    :'meta_ad_photo_url' => :'String',
    :'meta_ad_video_url' => :'String',
    :'meta_ad_post_id' => :'String',
    :'meta_ad_product_id' => :'String',
    :'meta_ad_flow_id' => :'String',
    :'meta_ad_captured_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ctwa_clid == o.ctwa_clid &&
      ctwa_source_id == o.ctwa_source_id &&
      ctwa_source_type == o.ctwa_source_type &&
      ctwa_source_url == o.ctwa_source_url &&
      ctwa_headline == o.ctwa_headline &&
      ctwa_captured_at == o.ctwa_captured_at &&
      meta_ad_id == o.meta_ad_id &&
      meta_ad_source == o.meta_ad_source &&
      meta_ad_type == o.meta_ad_type &&
      meta_ad_ref == o.meta_ad_ref &&
      meta_ad_title == o.meta_ad_title &&
      meta_ad_photo_url == o.meta_ad_photo_url &&
      meta_ad_video_url == o.meta_ad_video_url &&
      meta_ad_post_id == o.meta_ad_post_id &&
      meta_ad_product_id == o.meta_ad_product_id &&
      meta_ad_flow_id == o.meta_ad_flow_id &&
      meta_ad_captured_at == o.meta_ad_captured_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [ctwa_clid, ctwa_source_id, ctwa_source_type, ctwa_source_url, ctwa_headline, ctwa_captured_at, meta_ad_id, meta_ad_source, meta_ad_type, meta_ad_ref, meta_ad_title, meta_ad_photo_url, meta_ad_video_url, meta_ad_post_id, meta_ad_product_id, meta_ad_flow_id, meta_ad_captured_at].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



219
220
221
222
223
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 219

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 293

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



227
228
229
230
 
# File 'lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb', line 227

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