Class: Zernio::GooglePmaxAssetGroupUpdate

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

Overview

Replacement assets for an existing Performance Max asset group, sent on PUT /v1/ads/adId. Google assets are immutable (AssetService only creates), so each field you send becomes new assets linked to the asset group, and the assets that role held are unlinked in the same atomic request. Send one field or many; a field you omit is left untouched. Re-sending a value the asset group already carries is a no-op for that asset, not a re-upload. Unlinked assets stay in the account's asset library: Google has no asset delete. At least one description must be 60 characters or fewer. Texts within each list must be distinct.

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#business_name ⇒ Object

Replaces the BUSINESS_NAME asset.



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

def business_name
  @business_name
end

#descriptions ⇒ Object

Replaces every DESCRIPTION asset. At least one must be 60 characters or fewer.



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

def descriptions
  @descriptions
end

#final_url ⇒ Object

Replaces the asset group's final URL.



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

def final_url
  @final_url
end

#headlines ⇒ Object

Replaces every HEADLINE asset on the group.



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

def headlines
  @headlines
end

#images ⇒ Object

Returns the value of attribute images.



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

def images
  @images
end

#long_headline ⇒ Object

Replaces the LONG_HEADLINE asset.



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

def long_headline
  @long_headline
end

#youtube_video_ids ⇒ Object

Replaces YOUTUBE_VIDEO assets with existing YouTube video ids. Video uploads and arbitrary video URLs are not supported.



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

def youtube_video_ids
  @youtube_video_ids
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 58

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 40

def self.attribute_map
  {
    :'final_url' => :'finalUrl',
    :'headlines' => :'headlines',
    :'long_headline' => :'longHeadline',
    :'descriptions' => :'descriptions',
    :'business_name' => :'businessName',
    :'images' => :'images',
    :'youtube_video_ids' => :'youtubeVideoIds'
  }
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 337

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



76
77
78
79
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'final_url' => :'String',
    :'headlines' => :'Array<String>',
    :'long_headline' => :'String',
    :'descriptions' => :'Array<String>',
    :'business_name' => :'String',
    :'images' => :'GooglePmaxAssetGroupUpdateImages',
    :'youtube_video_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 310

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      final_url == o.final_url &&
      headlines == o.headlines &&
      long_headline == o.long_headline &&
      descriptions == o.descriptions &&
      business_name == o.business_name &&
      images == o.images &&
      youtube_video_ids == o.youtube_video_ids
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


324
325
326
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 330

def hash
  [final_url, headlines, long_headline, descriptions, business_name, images, youtube_video_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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^https?:\/\//)
  if !@final_url.nil? && @final_url !~ pattern
    invalid_properties.push("invalid value for \"final_url\", must conform to the pattern #{pattern}.")
  end

  if !@headlines.nil? && @headlines.length > 15
    invalid_properties.push('invalid value for "headlines", number of items must be less than or equal to 15.')
  end

  if !@headlines.nil? && @headlines.length < 3
    invalid_properties.push('invalid value for "headlines", number of items must be greater than or equal to 3.')
  end

  if !@long_headline.nil? && @long_headline.to_s.length > 90
    invalid_properties.push('invalid value for "long_headline", the character length must be smaller than or equal to 90.')
  end

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

  if !@descriptions.nil? && @descriptions.length > 5
    invalid_properties.push('invalid value for "descriptions", number of items must be less than or equal to 5.')
  end

  if !@descriptions.nil? && @descriptions.length < 2
    invalid_properties.push('invalid value for "descriptions", number of items must be greater than or equal to 2.')
  end

  if !@business_name.nil? && @business_name.to_s.length > 25
    invalid_properties.push('invalid value for "business_name", the character length must be smaller than or equal to 25.')
  end

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

  if !@youtube_video_ids.nil? && @youtube_video_ids.length > 5
    invalid_properties.push('invalid value for "youtube_video_ids", number of items must be less than or equal to 5.')
  end

  if !@youtube_video_ids.nil? && @youtube_video_ids.length < 1
    invalid_properties.push('invalid value for "youtube_video_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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 359

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/zernio-sdk/models/google_pmax_asset_group_update.rb', line 187

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@final_url.nil? && @final_url !~ Regexp.new(/^https?:\/\//)
  return false if !@headlines.nil? && @headlines.length > 15
  return false if !@headlines.nil? && @headlines.length < 3
  return false if !@long_headline.nil? && @long_headline.to_s.length > 90
  return false if !@long_headline.nil? && @long_headline.to_s.length < 1
  return false if !@descriptions.nil? && @descriptions.length > 5
  return false if !@descriptions.nil? && @descriptions.length < 2
  return false if !@business_name.nil? && @business_name.to_s.length > 25
  return false if !@business_name.nil? && @business_name.to_s.length < 1
  return false if !@youtube_video_ids.nil? && @youtube_video_ids.length > 5
  return false if !@youtube_video_ids.nil? && @youtube_video_ids.length < 1
  true
end