Class: Zernio::AdKeywordQuality

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

Overview

Google Quality Score and the three component ratings behind it (ad_group_criterion.quality_info). Every field is null until Google has rated the keyword: a keyword with too little traffic is unrated, and negatives are never rated. Google's own UNKNOWN / UNSPECIFIED buckets are reported as null so "unrated" has a single representation.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

Instance Attribute Details

#ad_relevance ⇒ Object

How closely the ad matches the intent behind the search (creative_quality_score).



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

def ad_relevance
  @ad_relevance
end

#expected_ctr ⇒ Object

How the click-through rate compares with other ads in the same position (search_predicted_ctr).



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

def expected_ctr
  @expected_ctr
end

#landing_page_experience ⇒ Object

How relevant and useful the landing page is to people who click (post_click_quality_score).



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

def landing_page_experience
  @landing_page_experience
end

#score ⇒ Object

Quality Score, 1-10.



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

def score
  @score
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 69

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'score' => :'score',
    :'expected_ctr' => :'expectedCtr',
    :'ad_relevance' => :'adRelevance',
    :'landing_page_experience' => :'landingPageExperience'
  }
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 203

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



84
85
86
87
88
89
90
91
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 84

def self.openapi_nullable
  Set.new([
    :'score',
    :'expected_ctr',
    :'ad_relevance',
    :'landing_page_experience'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 74

def self.openapi_types
  {
    :'score' => :'Integer',
    :'expected_ctr' => :'String',
    :'ad_relevance' => :'String',
    :'landing_page_experience' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      score == o.score &&
      expected_ctr == o.expected_ctr &&
      ad_relevance == o.ad_relevance &&
      landing_page_experience == o.landing_page_experience
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 196

def hash
  [score, expected_ctr, ad_relevance, landing_page_experience].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



128
129
130
131
132
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 128

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 225

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



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/zernio-sdk/models/ad_keyword_quality.rb', line 136

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  expected_ctr_validator = EnumAttributeValidator.new('String', ["BELOW_AVERAGE", "AVERAGE", "ABOVE_AVERAGE"])
  return false unless expected_ctr_validator.valid?(@expected_ctr)
  ad_relevance_validator = EnumAttributeValidator.new('String', ["BELOW_AVERAGE", "AVERAGE", "ABOVE_AVERAGE"])
  return false unless ad_relevance_validator.valid?(@ad_relevance)
  landing_page_experience_validator = EnumAttributeValidator.new('String', ["BELOW_AVERAGE", "AVERAGE", "ABOVE_AVERAGE"])
  return false unless landing_page_experience_validator.valid?(@landing_page_experience)
  true
end