Class: FacebookAds::AdTargeting

Inherits:
Object
  • Object
show all
Defined in:
lib/facebook_ads/ad_targeting.rb

Overview

developers.facebook.com/docs/marketing-api/targeting-specs

Constant Summary collapse

MEN = 
1
WOMEN = 
2
GENDERS = 
[MEN, WOMEN].freeze
ANDROID_OS = 
'Android'.freeze
APPLE_OS = 
'iOS'.freeze
OSES = 
[ANDROID_OS, APPLE_OS].freeze
ANDROID_DEVICES = 
%w[Android_Smartphone Android_Tablet].freeze
APPLE_DEVICES = 
%w[iPhone iPad iPod].freeze
DEVICES = 
ANDROID_DEVICES + APPLE_DEVICES
INSTALLED = 
'installed'.freeze
NOT_INSTALLED = 
'not_installed'.freeze
APP_INSTALL_STATES = 
[INSTALLED, NOT_INSTALLED].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdTargeting

Returns a new instance of AdTargeting.



19
20
21
22
23
24
25
26
27
 
# File 'lib/facebook_ads/ad_targeting.rb', line 19

def initialize
  # self.genders = [WOMEN] # If nil, defaults to all genders.
  # self.age_min = 18 # If nil, defaults to 18.
  # self.age_max = 65 # If nil, defaults to 65+.
  # self.user_os = [ANDROID_OS]
  # self.user_device = ANDROID_DEVICES
  # self.app_install_state = NOT_INSTALLED
  self.income = [] # An a rray of objects with 'id' and optional 'name'
end

Instance Attribute Details

#age_max ⇒ Object

Returns the value of attribute age_max.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def age_max
  @age_max
end

#age_min ⇒ Object

Returns the value of attribute age_min.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def age_min
  @age_min
end

#app_install_state ⇒ Object

Returns the value of attribute app_install_state.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def app_install_state
  @app_install_state
end

#countries ⇒ Object

Returns the value of attribute countries.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def countries
  @countries
end

#custom_locations ⇒ Object

Returns the value of attribute custom_locations.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def custom_locations
  @custom_locations
end

#genders ⇒ Object

Returns the value of attribute genders.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def genders
  @genders
end

#income ⇒ Object

Returns the value of attribute income.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def income
  @income
end

#user_device ⇒ Object

Returns the value of attribute user_device.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def user_device
  @user_device
end

#user_os ⇒ Object

Returns the value of attribute user_os.



17
18
19
 
# File 'lib/facebook_ads/ad_targeting.rb', line 17

def user_os
  @user_os
end

Instance Method Details

#geo_locations ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/facebook_ads/ad_targeting.rb', line 29

def geo_locations
  if custom_locations
    { custom_locations: custom_locations }
  elsif countries
    { countries: countries }
  else
    { countries: ['US'] }
  end
end

#to_hash ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/facebook_ads/ad_targeting.rb', line 57

def to_hash
  {
    genders: genders,
    age_min: age_min,
    age_max: age_max,
    geo_locations: geo_locations,
    user_os: user_os,
    user_device: user_device,
    app_install_state: app_install_state,
    income: income
  }.reject { |_k, v| v.nil? }
end

#validate! ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/facebook_ads/ad_targeting.rb', line 39

def validate!
  { gender: genders, countries: countries, user_os: user_os, user_device: user_device, custom_locations: custom_locations }.each_pair do |key, array|
    if !array.nil? && !array.is_a?(Array)
      raise Exception, "#{self.class.name}: #{key} must be an array"
    end
  end

  { genders: [genders, GENDERS], user_os: [user_os, OSES], user_device: [user_device, DEVICES] }.each_pair do |key, provided_and_acceptable|
    provided, acceptable = provided_and_acceptable

    if !provided.nil? && !(invalid = provided.detect { |value| !acceptable.include?(value) }).nil?
      raise Exception, "#{self.class.name}: #{invalid} is an invalid #{key}"
    end
  end

  true
end