Class: Zernio::ErrorResponseDetails

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/error_response_details.rb

Overview

Additional structured context (e.g. field-level validation errors), for example privateReplyConsumed on the private-reply endpoint's 400 when the comment's single reply is already spent. On a Google Ads 429 it carries quotaExhausted: true, which marks the failure as Google's own ads quota rather than a Zernio rate limit, so you can keep calling other platforms instead of backing off everywhere. When Google names the scope it also carries quotaScope: DEVELOPER means the shared developer-token budget (every Google account is affected and there is nothing to change on your side), ACCOUNT means your own ad account. A Meta 429 carries neither field. A Zernio Google Ads budget 429 carries budgetScope instead, and never quotaExhausted: these are Zernio's own limits, applied before the call reaches Google. user is your own burst or daily allowance, so the work is yours to reschedule; platform is the fleet-wide daily budget shared with every other customer, so only waiting for the reset clears it. The two scopes are separate axes from quotaScope, not the same pool named twice. A failed Meta ad create (POST /v1/ads/create, POST /v1/ads/boost, POST /v1/ads/ctwa) carries stage, adAccountId and createdObjects: where it failed, on which ad account, and every object this request had already created with what cleanup did to it. left_behind objects still exist on the ad account (Meta refused the delete, typically on a held account), so delete them yourself or reuse them. unconfirmedWrite is set when Meta answered a create with a 5xx or dropped the connection and Zernio could not confirm whether the object exists: check that parent before creating it again.

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 105

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

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

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

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

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

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

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

Instance Attribute Details

#ad_account_id ⇒ Object

Meta ad create failures only. The ad account the request wrote to (act_...).



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

def 
  @ad_account_id
end

#budget_scope ⇒ Object

Zernio Google Ads operations-budget 429 only (never set alongside quotaExhausted). user is your own burst/daily allowance; platform is the fleet-wide daily budget shared across customers.



37
38
39
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 37

def budget_scope
  @budget_scope
end

#created_objects ⇒ Object

Meta ad create failures only. Every object this request created before failing, in creation order. Objects you referenced (an existing campaign, ad set, creative or video) are never listed and never deleted.



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

def created_objects
  @created_objects
end

#quota_exhausted ⇒ Object

Google Ads 429 only. True when the upstream Google Ads quota is spent rather than a Zernio limit.



31
32
33
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 31

def quota_exhausted
  @quota_exhausted
end

#quota_scope ⇒ Object

Google Ads 429 only, when Google names the scope. DEVELOPER is the shared developer-token budget; ACCOUNT is your ad account.



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

def quota_scope
  @quota_scope
end

#stage ⇒ Object

Meta ad create failures only. The step that failed: media (image/video download or upload), campaign, adset, creative, ad (the ad POST itself, where Meta's code 31 / 3858385 hold and 100 / 1359188 payment rejections land), activation (switching the created objects on), or other (a read or check before any write).



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

def stage
  @stage
end

#unconfirmed_write ⇒ Object

Returns the value of attribute unconfirmed_write.



28
29
30
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 28

def unconfirmed_write
  @unconfirmed_write
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



75
76
77
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 75

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 80

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 62

def self.attribute_map
  {
    :'stage' => :'stage',
    :'ad_account_id' => :'adAccountId',
    :'created_objects' => :'createdObjects',
    :'unconfirmed_write' => :'unconfirmedWrite',
    :'quota_exhausted' => :'quotaExhausted',
    :'quota_scope' => :'quotaScope',
    :'budget_scope' => :'budgetScope'
  }
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 230

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 85

def self.openapi_types
  {
    :'stage' => :'String',
    :'ad_account_id' => :'String',
    :'created_objects' => :'Array<ErrorResponseDetailsCreatedObjectsInner>',
    :'unconfirmed_write' => :'ErrorResponseDetailsUnconfirmedWrite',
    :'quota_exhausted' => :'Boolean',
    :'quota_scope' => :'String',
    :'budget_scope' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      stage == o.stage &&
       == o. &&
      created_objects == o.created_objects &&
      unconfirmed_write == o.unconfirmed_write &&
      quota_exhausted == o.quota_exhausted &&
      quota_scope == o.quota_scope &&
      budget_scope == o.budget_scope
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 223

def hash
  [stage, , created_objects, unconfirmed_write, quota_exhausted, quota_scope, budget_scope].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



152
153
154
155
156
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 152

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 252

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



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/zernio-sdk/models/error_response_details.rb', line 160

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  stage_validator = EnumAttributeValidator.new('String', ["media", "campaign", "adset", "creative", "ad", "activation", "other"])
  return false unless stage_validator.valid?(@stage)
  quota_scope_validator = EnumAttributeValidator.new('String', ["DEVELOPER", "ACCOUNT"])
  return false unless quota_scope_validator.valid?(@quota_scope)
  budget_scope_validator = EnumAttributeValidator.new('String', ["user", "platform"])
  return false unless budget_scope_validator.valid?(@budget_scope)
  true
end