Class: Zernio::CreateCustomConversionGoalRequest

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
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
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 71

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

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

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

Instance Attribute Details

#account_id ⇒ Object

Zernio SocialAccount id (Google Ads)



19
20
21
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 19

def 
  @account_id
end

#ad_account_id ⇒ Object

Google customer id. Required when the connection has multiple customers.



22
23
24
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 22

def 
  @ad_account_id
end

#conversion_action_ids ⇒ Object

Returns the value of attribute conversion_action_ids.



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

def conversion_action_ids
  @conversion_action_ids
end

#customer_id ⇒ Object

Alias of adAccountId



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

def customer_id
  @customer_id
end

#name ⇒ Object

Returns the value of attribute name.



27
28
29
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 27

def name
  @name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 32

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'ad_account_id' => :'adAccountId',
    :'customer_id' => :'customerId',
    :'name' => :'name',
    :'conversion_action_ids' => :'conversionActionIds'
  }
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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 53

def self.openapi_types
  {
    :'account_id' => :'String',
    :'ad_account_id' => :'String',
    :'customer_id' => :'String',
    :'name' => :'String',
    :'conversion_action_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      customer_id == o.customer_id &&
      name == o.name &&
      conversion_action_ids == o.conversion_action_ids
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


266
267
268
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/zernio-sdk/models/create_custom_conversion_goal_request.rb', line 272

def hash
  [, , customer_id, name, conversion_action_ids].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



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

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

  pattern = Regexp.new(/^\d+$/)
  if !@ad_account_id.nil? && @ad_account_id !~ pattern
    invalid_properties.push("invalid value for \"ad_account_id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@customer_id.nil? && @customer_id !~ pattern
    invalid_properties.push("invalid value for \"customer_id\", must conform to the pattern #{pattern}.")
  end

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

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
  end

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

  if @conversion_action_ids.length > 100
    invalid_properties.push('invalid value for "conversion_action_ids", number of items must be less than or equal to 100.')
  end

  if @conversion_action_ids.length < 1
    invalid_properties.push('invalid value for "conversion_action_ids", number of items must be greater than or equal to 1.')
  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



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

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if !@ad_account_id.nil? && @ad_account_id !~ Regexp.new(/^\d+$/)
  return false if !@customer_id.nil? && @customer_id !~ Regexp.new(/^\d+$/)
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 1
  return false if @conversion_action_ids.nil?
  return false if @conversion_action_ids.length > 100
  return false if @conversion_action_ids.length < 1
  true
end