Class: PinterestSdkClient::AdGroupAudienceSizingRequest

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 102

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

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

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

  if attributes.key?(:'placement_group')
    self.placement_group = attributes[:'placement_group']
  else
    self.placement_group = 'ALL'
  end

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

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

Instance Attribute Details

#auto_targeting_enabled ⇒ Object

Enable auto-targeting for ad group. Default value is True. Also known as <a href="help.pinterest.com/en/business/article/performance-plus-targeting" target="_blank">"Pinterest Performance+ targeting"</a>.



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

def auto_targeting_enabled
  @auto_targeting_enabled
end

#creative_types ⇒ Object

Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.



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

def creative_types
  @creative_types
end

#keywords ⇒ Object

Array of keyword objects. If the keywords field is missing, all keywords will be targeted.



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

def keywords
  @keywords
end

#placement_group ⇒ Object

<a href="/docs/redoc/#section/Placement-group">Placement group</a>.



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

def placement_group
  @placement_group
end

#product_group_ids ⇒ Object

Targeted product group IDs. </p><strong>Note:</strong> This can only be combined with shopping/catalog sales campaigns. For more information, <a href="help.pinterest.com/en/business/article/shopping-ads#section-14571" target="_blank">click here</a>. SHOPPING_RETARGETING must be included in targeting_spec object or this field will be ignored.



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

def product_group_ids
  @product_group_ids
end

#targeting_spec ⇒ Object

Returns the value of attribute targeting_spec.



33
34
35
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 33

def targeting_spec
  @targeting_spec
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 58

def self.attribute_map
  {
    :'auto_targeting_enabled' => :'auto_targeting_enabled',
    :'creative_types' => :'creative_types',
    :'keywords' => :'keywords',
    :'placement_group' => :'placement_group',
    :'product_group_ids' => :'product_group_ids',
    :'targeting_spec' => :'targeting_spec'
  }
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 194

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



92
93
94
95
96
97
98
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 92

def self.openapi_nullable
  Set.new([
    :'creative_types',
    :'keywords',
    :'product_group_ids',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 80

def self.openapi_types
  {
    :'auto_targeting_enabled' => :'Boolean',
    :'creative_types' => :'Array<String>',
    :'keywords' => :'Array<AdGroupAudienceSizingRequestKeywordsInner>',
    :'placement_group' => :'PlacementGroupType',
    :'product_group_ids' => :'Array<String>',
    :'targeting_spec' => :'TargetingSpec'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_targeting_enabled == o.auto_targeting_enabled &&
      creative_types == o.creative_types &&
      keywords == o.keywords &&
      placement_group == o.placement_group &&
      product_group_ids == o.product_group_ids &&
      targeting_spec == o.targeting_spec
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 187

def hash
  [auto_targeting_enabled, creative_types, keywords, placement_group, product_group_ids, targeting_spec].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



153
154
155
156
157
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 153

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 216

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



161
162
163
164
 
# File 'lib/pinterest_sdk/models/ad_group_audience_sizing_request.rb', line 161

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