Class: PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdsAnalyticsCreateAsyncRequestAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

  if attributes.key?(:'click_window_days')
    self.click_window_days = attributes[:'click_window_days']
  else
    self.click_window_days = 30
  end

  if attributes.key?(:'engagement_window_days')
    self.engagement_window_days = attributes[:'engagement_window_days']
  else
    self.engagement_window_days = 30
  end

  if attributes.key?(:'view_window_days')
    self.view_window_days = attributes[:'view_window_days']
  else
    self.view_window_days = 1
  end

  if attributes.key?(:'conversion_report_time')
    self.conversion_report_time = attributes[:'conversion_report_time']
  else
    self.conversion_report_time = 'TIME_OF_AD_ACTION'
  end

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

Instance Attribute Details

#attribution_types ⇒ Object

List of types of attribution for the conversion report



40
41
42
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 40

def attribution_types
  @attribution_types
end

#click_window_days ⇒ Object

Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to ‘30` days.



28
29
30
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 28

def click_window_days
  @click_window_days
end

#conversion_report_time ⇒ Object

The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.



37
38
39
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 37

def conversion_report_time
  @conversion_report_time
end

#end_date ⇒ Object

Metric report end date (UTC). Format: YYYY-MM-DD



22
23
24
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 22

def end_date
  @end_date
end

#engagement_window_days ⇒ Object

Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to ‘30` days.



31
32
33
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 31

def engagement_window_days
  @engagement_window_days
end

#granularity ⇒ Object

TOTAL - metrics are aggregated over the specified date range.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
MONTHLY - metrics are broken down monthly



25
26
27
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 25

def granularity
  @granularity
end

#start_date ⇒ Object

Metric report start date (UTC). Format: YYYY-MM-DD



19
20
21
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 19

def start_date
  @start_date
end

#view_window_days ⇒ Object

Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to ‘1` day.



34
35
36
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 34

def view_window_days
  @view_window_days
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 43

def self.attribute_map
  {
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'granularity' => :'granularity',
    :'click_window_days' => :'click_window_days',
    :'engagement_window_days' => :'engagement_window_days',
    :'view_window_days' => :'view_window_days',
    :'conversion_report_time' => :'conversion_report_time',
    :'attribution_types' => :'attribution_types'
  }
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



239
240
241
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 239

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 62

def self.openapi_types
  {
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'granularity' => :'Granularity',
    :'click_window_days' => :'ConversionAttributionWindowDays',
    :'engagement_window_days' => :'ConversionAttributionWindowDays',
    :'view_window_days' => :'ConversionAttributionWindowDays',
    :'conversion_report_time' => :'ConversionReportTimeType',
    :'attribution_types' => :'Array<ConversionReportAttributionType>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      granularity == o.granularity &&
      click_window_days == o.click_window_days &&
      engagement_window_days == o.engagement_window_days &&
      view_window_days == o.view_window_days &&
      conversion_report_time == o.conversion_report_time &&
      attribution_types == o.attribution_types
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 269

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = PinterestSdkClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 340

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 246

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 232

def hash
  [start_date, end_date, granularity, click_window_days, engagement_window_days, view_window_days, conversion_report_time, attribution_types].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



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
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  if @start_date.nil?
    invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
  end

  pattern = Regexp.new(/^(\d{4})-(\d{2})-(\d{2})$/)
  if @start_date !~ pattern
    invalid_properties.push("invalid value for \"start_date\", must conform to the pattern #{pattern}.")
  end

  if @end_date.nil?
    invalid_properties.push('invalid value for "end_date", end_date cannot be nil.')
  end

  pattern = Regexp.new(/^(\d{4})-(\d{2})-(\d{2})$/)
  if @end_date !~ pattern
    invalid_properties.push("invalid value for \"end_date\", must conform to the pattern #{pattern}.")
  end

  if @granularity.nil?
    invalid_properties.push('invalid value for "granularity", granularity cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



316
317
318
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 316

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 322

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



310
311
312
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 310

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



170
171
172
173
174
175
176
177
 
# File 'lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb', line 170

def valid?
  return false if @start_date.nil?
  return false if @start_date !~ Regexp.new(/^(\d{4})-(\d{2})-(\d{2})$/)
  return false if @end_date.nil?
  return false if @end_date !~ Regexp.new(/^(\d{4})-(\d{2})-(\d{2})$/)
  return false if @granularity.nil?
  true
end