facebookbusiness 0.10.0.0 → 0.10.0.1

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -139,6 +139,10 @@ module FacebookAds
       end
     end
 
+    has_edge :auto_markets do |edge|
+      edge.get
+    end
+
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|
         api.has_param :bulk_pagination, 'bool'
@@ -159,6 +163,10 @@ module FacebookAds
       end
     end
 
+    has_edge :autos do |edge|
+      edge.get
+    end
+
     has_edge :batch do |edge|
       edge.post 'ProductCatalog' do |api|
         api.has_param :allow_upsert, 'bool'
@@ -287,6 +295,13 @@ module FacebookAds
       end
     end
 
+    has_edge :media_titles do |edge|
+      edge.get do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
     has_edge :pricing_variables_batch do |edge|
       edge.get 'ProductCatalogPricingVariablesBatch' do |api|
         api.has_param :handle, 'string'

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -53,6 +53,7 @@ module FacebookAds
 
     FEED_TYPE = [
       "AUTO",
+      "AUTOMOTIVE_MODEL",
       "DESTINATION",
       "FLIGHT",
       "HOME_LISTING",
@@ -128,6 +129,10 @@ module FacebookAds
     field :rules, { list: 'string' }
     field :selected_override_fields, { list: 'string' }
 
+    has_edge :auto_markets do |edge|
+      edge.get
+    end
+
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|
         api.has_param :bulk_pagination, 'bool'
@@ -135,6 +140,10 @@ module FacebookAds
       end
     end
 
+    has_edge :autos do |edge|
+      edge.get
+    end
+
     has_edge :destinations do |edge|
       edge.get 'Destination' do |api|
         api.has_param :bulk_pagination, 'bool'
@@ -163,6 +172,13 @@ module FacebookAds
       end
     end
 
+    has_edge :media_titles do |edge|
+      edge.get do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
     has_edge :products do |edge|
       edge.get 'ProductItem' do |api|
         api.has_param :bulk_pagination, 'bool'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -62,6 +62,15 @@ module FacebookAds
       "unisex",
     ]
 
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
     REVIEW_STATUS = [
       "",
       "approved",
@@ -317,6 +326,7 @@ module FacebookAds
     field :gtin, 'string'
     field :id, 'string'
     field :image_cdn_urls, 'hash'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :image_url, 'string'
     field :images, { list: 'string' }
     field :inventory, 'int'

data/lib/facebook_ads/ad_objects/product_item_ar_data.rb

@@ -39,6 +39,7 @@ module FacebookAds
       "OFFLINE_CONVERSIONS",
       "SHOPS",
       "UNIVERSAL_CHECKOUT",
+      "WHATSAPP",
     ]
 
 

data/lib/facebook_ads/ad_objects/product_set.rb

@@ -73,6 +73,13 @@ module FacebookAds
       end
     end
 
+    has_edge :media_titles do |edge|
+      edge.get do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
     has_edge :products do |edge|
       edge.get 'ProductItem' do |api|
         api.has_param :bulk_pagination, 'bool'

data/lib/facebook_ads/ad_objects/saved_audience.rb

@@ -29,6 +29,7 @@ module FacebookAds
 
     field :account, 'AdAccount'
     field :approximate_count, 'int'
+    field :approximate_count_64bit, 'int'
     field :description, 'string'
     field :extra_info, 'string'
     field :id, 'string'

data/lib/facebook_ads/ad_objects/server_side/user_data.rb

@@ -22,53 +22,157 @@ module FacebookAds
     # UserData is a set of identifiers Facebook can use for targeted attribution
     class UserData
 
+      # A list of email addresses, in lowercase.
+      # Example: ['joe@eg.com']
+      attr_accessor :emails
+
       # An email address, in lowercase.
       # Example: joe@eg.com
-      attr_accessor :email
+      def email
+        @emails ? @emails[0] : nil
+      end
+      def email=(email)
+        @emails = [email]
+      end
+
+      # A list of phone numbers. Include only digits with country code, area code, and number.
+      # Example: ['16505551212']
+      attr_accessor :phones
 
       # A phone number. Include only digits with country code, area code, and number.
       # Example: 16505551212
-      attr_accessor :phone
+      def phone
+        @phones ? @phones[0] : nil
+      end
+      def phone=(phone)
+        @phones = [phone]
+      end
+
+      # A list of genders, in lowercase.
+      # Example: ['f']
+      attr_accessor :genders
 
       # Gender, in lowercase. Either f or m.
-      attr_accessor :gender
+      def gender
+        @genders ? @genders[0] : nil
+      end
+      def gender=(gender)
+        @genders = [gender]
+      end
+
+      # A list of dates of birth given as year, month, and day.
+      # Format should be 'YYYYMMDD'
+      # Example: ['19971226'] for December 26, 1997.
+      attr_accessor :dates_of_birth
 
       # A date of birth given as year, month, and day.
       # Format should be 'YYYYMMDD'
       # Example: 19971226 for December 26, 1997.
-      attr_accessor :date_of_birth
+      def date_of_birth
+        @dates_of_birth ? @dates_of_birth[0] : nil
+      end
+      def date_of_birth=(date_of_birth)
+        @dates_of_birth = [date_of_birth]
+      end
+
+      # A list of last names in lowercase.
+      # Example: ['smith']
+      attr_accessor :last_names
 
       # A last name in lowercase.
       # Example: smith
-      attr_accessor :last_name
+      def last_name
+        @last_names ? @last_names[0] : nil
+      end
+      def last_name=(last_name)
+        @last_names = [last_name]
+      end
+
+      # A list of first names in lowercase.
+      # Example: ['joe']
+      attr_accessor :first_names
 
       # A first name in lowercase.
       # Example: joe
-      attr_accessor :first_name
+      def first_name
+        @first_names ? @first_names[0] : nil
+      end
+      def first_name=(first_name)
+        @first_names = [first_name]
+      end
+
+      # A list of cities in lower-case without spaces or punctuation.
+      # Example: ['menlopark']
+      attr_accessor :cities
 
       # A city in lower-case without spaces or punctuation.
       # Example: menlopark
-      attr_accessor :city
+      def city
+        @cities ? @cities[0] : nil
+      end
+      def city=(city)
+        @cities = [city]
+      end
+
+      # A list of two-letter country codes in lowercase.
+      # Example: ['us']
+      attr_accessor :country_codes
 
       # A two-letter country code in lowercase.
       # Example: us
-      attr_accessor :country_code
+      def country_code
+        @country_codes ? @country_codes[0] : nil
+      end
+      def country_code=(country_code)
+        @country_codes = [country_code]
+      end
+
+      # A list of two-letter state codes in lowercase.
+      # Example: ['ca']
+      attr_accessor :states
 
       # A two-letter state code in lowercase.
       # Example: ca
-      attr_accessor :state
+      def state
+        @states ? @states[0] : nil
+      end
+      def state=(state)
+        @states = [state]
+      end
+
+      # A list of five-digit zip codes for United States.
+      # For other locations, follow each country's standards.
+      # Example: ['94035'] (for United States)
+      attr_accessor :zip_codes
 
       # A five-digit zip code for United States.
       # For other locations, follow each country's standards.
       # Example: 94035 (for United States)
-      attr_accessor :zip_code
+      def zip_code
+        @zip_codes ? @zip_codes[0] : nil
+      end
+      def zip_code=(zip_code)
+        @zip_codes = [zip_code]
+      end
+
+      # A list of unique IDs from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs.
+      # In the Offline Conversions API (https://www.facebook.com/business/help/104039186799009),
+      # this is known as extern_id. For more information, see Offline Conversions, Providing External IDs.
+      # If External ID is being sent via other channels, then it should be sent in the same format
+      # via the Conversions API.
+      attr_accessor :external_ids
 
       # Any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs.
       # In the Offline Conversions API (https://www.facebook.com/business/help/104039186799009),
       # this is known as extern_id. For more information, see Offline Conversions, Providing External IDs.
       # If External ID is being sent via other channels, then it should be sent in the same format
-      # via the server-side API.
-      attr_accessor :external_id
+      # via the Conversions API.
+      def external_id
+        @external_ids ? @external_ids[0] : nil
+      end
+      def external_id=(external_id)
+        @external_ids = [external_id]
+      end
 
       # The IP address of the browser corresponding to the event.
       attr_accessor :client_ip_address
@@ -78,13 +182,13 @@ module FacebookAds
 
       # The Facebook click ID value stored in the _fbc browser cookie under your domain.
       # See Managing fbc and fbp Parameters for how to get this value
-      # (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc),
+      # (https://developers.facebook.com/docs/marketing-api/facebook-pixel/conversions-api/parameters#fbc),
       # or generate this value from a fbclid query parameter.
       attr_accessor :fbc
 
       # The Facebook browser ID value stored in the _fbp browser cookie under your domain.
       # See Managing fbc and fbp Parameters for how to get this value
-      # (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc),
+      # (https://developers.facebook.com/docs/marketing-api/facebook-pixel/conversions-api/parameters#fbc),
       # or generate this value from a fbclid query parameter.
       attr_accessor :fbp
 
@@ -109,21 +213,32 @@ module FacebookAds
       # The date of birth month.
       attr_accessor :dobm
 
-      # THe date of birth year.
+      # The date of birth year.
       attr_accessor :doby
 
       #UserData is a set of identifiers Facebook can use for targeted attribution
       # @param [String] email
+      # @param [Array<String>] emails
       # @param [String] phone
+      # @param [Array<String>] phones
       # @param [String] gender
+      # @param [Array<String>] genders
       # @param [String] date_of_birth
+      # @param [Array<String>] dates_of_births
       # @param [String] last_name
+      # @param [Array<String>] last_names
       # @param [String] first_name
+      # @param [Array<String>] first_names
       # @param [String] city
+      # @param [Array<String>] cities
       # @param [String] state
+      # @param [Array<String>] states
       # @param [String] country_code
+      # @param [Array<String>] country_codes
       # @param [String] zip_code
+      # @param [Array<String>] zip_codes
       # @param [String] external_id
+      # @param [Array<String>] external_ids
       # @param [String] client_ip_address
       # @param [String] client_user_agent
       # @param [String] fbc
@@ -136,44 +251,91 @@ module FacebookAds
       # @param [String] dobd
       # @param [String] dobm
       # @param [String] doby
-      def initialize(email: nil, phone: nil, gender: nil, date_of_birth: nil,
-                     last_name: nil, first_name: nil, city: nil, state: nil,
-                     country_code: nil, zip_code: nil, external_id: nil, client_ip_address: nil,
+      def initialize(email: nil, emails: nil, phone: nil, phones: nil, gender: nil, genders: nil,
+                     date_of_birth: nil, dates_of_birth: nil, last_name: nil, last_names: nil,
+                     first_name: nil, first_names: nil, city: nil, cities: nil, state: nil, states: nil,
+                     country_code: nil, country_codes: nil, zip_code: nil, zip_codes: nil,
+                     external_id: nil, external_ids: nil, client_ip_address: nil,
                      client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: nil, lead_id: nil,
                      f5first: nil, f5last: nil, fi: nil, dobd: nil, dobm: nil, doby: nil)
+        validate_constructor_values(emails, email, 'emails', 'email')
+        validate_constructor_values(phones, phone, 'phones', 'phone')
+        validate_constructor_values(genders, gender, 'genders', 'gender')
+        validate_constructor_values(dates_of_birth, date_of_birth, 'dates_of_birth', 'date_of_birth')
+        validate_constructor_values(first_names, first_name, 'first_names', 'first_name')
+        validate_constructor_values(last_names, last_name, 'last_names', 'last_name')
+        validate_constructor_values(cities, city, 'cities', 'city')
+        validate_constructor_values(country_codes, country_code, 'country_codes', 'country_code')
+        validate_constructor_values(states, state, 'states', 'state')
+        validate_constructor_values(zip_codes, zip_code, 'zip_codes', 'zip_code')
+        validate_constructor_values(external_ids, external_id, 'external_ids', 'external_id')
+
         unless email.nil?
           self.email = email
         end
+        unless emails.nil?
+          self.emails = emails
+        end
         unless phone.nil?
           self.phone = phone
         end
+        unless phones.nil?
+          self.phones = phones
+        end
         unless gender.nil?
           self.gender = gender
         end
+        unless genders.nil?
+          self.genders = genders
+        end
         unless date_of_birth.nil?
           self.date_of_birth = date_of_birth
         end
+        unless dates_of_birth.nil?
+          self.dates_of_birth = dates_of_birth
+        end
         unless last_name.nil?
           self.last_name = last_name
         end
+        unless last_names.nil?
+          self.last_names = last_names
+        end
         unless first_name.nil?
           self.first_name = first_name
         end
+        unless first_names.nil?
+          self.first_names = first_names
+        end
         unless city.nil?
           self.city = city
         end
+        unless cities.nil?
+          self.cities = cities
+        end
         unless state.nil?
           self.state = state
         end
+        unless states.nil?
+          self.states = states
+        end
         unless country_code.nil?
           self.country_code = country_code
         end
+        unless country_codes.nil?
+          self.country_codes = country_codes
+        end
         unless zip_code.nil?
           self.zip_code = zip_code
         end
+        unless zip_codes.nil?
+          self.zip_codes = zip_codes
+        end
         unless external_id.nil?
           self.external_id = external_id
         end
+        unless external_ids.nil?
+          self.external_ids = external_ids
+        end
         unless client_ip_address.nil?
           self.client_ip_address = client_ip_address
         end
@@ -220,48 +382,70 @@ module FacebookAds
         # convert string to symbol for hash key
         attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-        if attributes.has_key?(:'email')
-          self.email = attributes[:'email']
+        if attributes.has_key?(:'emails')
+          self.emails = attributes[:'emails']
+        elsif attributes.has_key?(:'email')
+          self.emails = [attributes[:'email']]
         end
 
-        if attributes.has_key?(:'phone')
-          self.phone = attributes[:'phone']
+        if attributes.has_key?(:'phones')
+          self.phones = attributes[:'phones']
+        elsif attributes.has_key?(:'phone')
+          self.phones = [attributes[:'phone']]
         end
 
-        if attributes.has_key?(:'gender')
-          self.gender = attributes[:'gender']
+        if attributes.has_key?(:'genders')
+          self.genders = attributes[:'genders']
+        elsif attributes.has_key?(:'gender')
+          self.genders = [attributes[:'gender']]
         end
 
-        if attributes.has_key?(:'date_of_birth')
-          self.date_of_birth = attributes[:'date_of_birth']
+        if attributes.has_key?(:'dates_of_birth')
+          self.dates_of_birth = attributes[:'dates_of_birth']
+        elsif attributes.has_key?(:'date_of_birth')
+          self.dates_of_birth = [attributes[:'date_of_birth']]
         end
 
-        if attributes.has_key?(:'last_name')
-          self.last_name = attributes[:'last_name']
+        if attributes.has_key?(:'last_names')
+          self.last_names = attributes[:'last_names']
+        elsif attributes.has_key?(:'last_name')
+          self.last_names = [attributes[:'last_name']]
         end
 
-        if attributes.has_key?(:'first_name')
-          self.first_name = attributes[:'first_name']
+        if attributes.has_key?(:'first_names')
+          self.first_names = attributes[:'first_names']
+        elsif attributes.has_key?(:'first_name')
+          self.first_names = [attributes[:'first_name']]
         end
 
-        if attributes.has_key?(:'city')
-          self.city = attributes[:'city']
+        if attributes.has_key?(:'cities')
+          self.cities = attributes[:'cities']
+        elsif attributes.has_key?(:'city')
+          self.cities = [attributes[:'city']]
         end
 
-        if attributes.has_key?(:'country_code')
-          self.country_code = attributes[:'country_code']
+        if attributes.has_key?(:'country_codes')
+          self.country_codes = attributes[:'country_codes']
+        elsif attributes.has_key?(:'country_code')
+          self.country_codes = [attributes[:'country_code']]
         end
 
-        if attributes.has_key?(:'state')
-          self.state = attributes[:'state']
+        if attributes.has_key?(:'states')
+          self.states = attributes[:'states']
+        elsif attributes.has_key?(:'state')
+          self.states = [attributes[:'state']]
         end
 
-        if attributes.has_key?(:'zip_code')
-          self.zip_code = attributes[:'zip_code']
+        if attributes.has_key?(:'zip_codes')
+          self.zip_codes = attributes[:'zip_codes']
+        elsif attributes.has_key?(:'zip_code')
+          self.zip_codes = [attributes[:'zip_code']]
         end
 
-        if attributes.has_key?(:'external_id')
-          self.external_id = attributes[:'external_id']
+        if attributes.has_key?(:'external_ids')
+          self.external_ids = attributes[:'external_ids']
+        elsif attributes.has_key?(:'external_id')
+          self.external_ids = [attributes[:'external_id']]
         end
 
         if attributes.has_key?(:'client_ip_address')
@@ -313,17 +497,17 @@ module FacebookAds
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
-            email == o.email &&
-            phone == o.phone &&
-            gender == o.gender &&
-            date_of_birth == o.date_of_birth &&
-            last_name == o.last_name &&
-            first_name == o.first_name &&
-            city == o.city &&
-            country_code == o.country_code &&
-            state == o.state &&
-            zip_code == o.zip_code &&
-            external_id == o.external_id &&
+            emails == o.emails &&
+            phones == o.phones &&
+            genders == o.genders &&
+            dates_of_birth == o.dates_of_birth &&
+            last_names == o.last_names &&
+            first_names == o.first_names &&
+            cities == o.cities &&
+            country_codes == o.country_codes &&
+            states == o.states &&
+            zip_codes == o.zip_codes &&
+            external_ids == o.external_ids &&
             client_ip_address == o.client_ip_address &&
             client_user_agent == o.client_user_agent &&
             fbc == o.fbc &&
@@ -347,17 +531,17 @@ module FacebookAds
       # @return [Fixnum] Hash code
       def hash
         [
-            email,
-            phone,
-            gender,
-            date_of_birth,
-            last_name,
-            first_name,
-            city,
-            country_code,
-            state,
-            zip_code,
-            external_id,
+            emails,
+            phones,
+            genders,
+            dates_of_birth,
+            last_names,
+            first_names,
+            cities,
+            country_codes,
+            states,
+            zip_codes,
+            external_ids,
             client_ip_address,
             client_user_agent,
             fbc,
@@ -378,38 +562,38 @@ module FacebookAds
       # @return [String] String presentation of the object
       def to_s
         hash = {}
-        unless email.nil?
-          hash['email'] = email
+        unless emails.nil?
+          hash['emails'] = emails
         end
-        unless phone.nil?
-          hash['phone'] = phone
+        unless phones.nil?
+          hash['phones'] = phones
         end
-        unless gender.nil?
-          hash['gender'] = gender
+        unless genders.nil?
+          hash['genders'] = genders
         end
-        unless date_of_birth.nil?
-          hash['date_of_birth'] = date_of_birth
+        unless dates_of_birth.nil?
+          hash['dates_of_birth'] = dates_of_birth
         end
-        unless last_name.nil?
-          hash['last_name'] = last_name
+        unless last_names.nil?
+          hash['last_names'] = last_names
         end
-        unless first_name.nil?
-          hash['first_name'] = first_name
+        unless first_names.nil?
+          hash['first_names'] = first_names
         end
-        unless city.nil?
-          hash['city'] = city
+        unless cities.nil?
+          hash['cities'] = cities
         end
-        unless country_code.nil?
-          hash['country_code'] = country_code
+        unless country_codes.nil?
+          hash['country_codes'] = country_codes
         end
-        unless state.nil?
-          hash['state'] = state
+        unless states.nil?
+          hash['states'] = states
         end
-        unless zip_code.nil?
-          hash['zip_code'] = zip_code
+        unless zip_codes.nil?
+          hash['zip_codes'] = zip_codes
         end
-        unless external_id.nil?
-          hash['external_id'] = external_id
+        unless external_ids.nil?
+          hash['external_ids'] = external_ids
         end
         unless client_ip_address.nil?
           hash['client_ip_address'] = client_ip_address
@@ -455,37 +639,37 @@ module FacebookAds
       def normalize
         hash = {}
         unless email.nil?
-          hash['em'] = FacebookAds::ServerSide::Util.normalize(email, 'em')
+          hash['em'] = FacebookAds::ServerSide::Util.normalize_array(emails, 'em')
         end
         unless phone.nil?
-          hash['ph'] = FacebookAds::ServerSide::Util.normalize(phone, 'ph')
+          hash['ph'] = FacebookAds::ServerSide::Util.normalize_array(phones, 'ph')
         end
         unless gender.nil?
-          hash['ge'] = FacebookAds::ServerSide::Util.normalize(gender, 'ge')
+          hash['ge'] = FacebookAds::ServerSide::Util.normalize_array(genders, 'ge')
         end
         unless date_of_birth.nil?
-          hash['db'] = FacebookAds::ServerSide::Util.normalize(date_of_birth, 'db')
+          hash['db'] = FacebookAds::ServerSide::Util.normalize_array(dates_of_birth, 'db')
         end
         unless last_name.nil?
-          hash['ln'] = FacebookAds::ServerSide::Util.normalize(last_name, 'ln')
+          hash['ln'] = FacebookAds::ServerSide::Util.normalize_array(last_names, 'ln')
         end
         unless first_name.nil?
-          hash['fn'] = FacebookAds::ServerSide::Util.normalize(first_name, 'fn')
+          hash['fn'] = FacebookAds::ServerSide::Util.normalize_array(first_names, 'fn')
         end
         unless city.nil?
-          hash['ct'] = FacebookAds::ServerSide::Util.normalize(city, 'ct')
+          hash['ct'] = FacebookAds::ServerSide::Util.normalize_array(cities, 'ct')
         end
         unless country_code.nil?
-          hash['country'] = FacebookAds::ServerSide::Util.normalize(country_code, 'country')
+          hash['country'] = FacebookAds::ServerSide::Util.normalize_array(country_codes, 'country')
         end
         unless state.nil?
-          hash['st'] = FacebookAds::ServerSide::Util.normalize(state, 'st')
+          hash['st'] = FacebookAds::ServerSide::Util.normalize_array(states, 'st')
         end
         unless zip_code.nil?
-          hash['zp'] = FacebookAds::ServerSide::Util.normalize(zip_code, 'zp')
+          hash['zp'] = FacebookAds::ServerSide::Util.normalize_array(zip_codes, 'zp')
         end
         unless external_id.nil?
-          hash['external_id'] = external_id
+          hash['external_id'] = external_ids
         end
         unless client_ip_address.nil?
           hash['client_ip_address'] = client_ip_address
@@ -523,7 +707,17 @@ module FacebookAds
         unless doby.nil?
           hash['doby'] = FacebookAds::ServerSide::Util.normalize(doby, 'doby')
         end
-        hash
+        hash.select{|k, v| !v.nil?}
+      end
+
+      def validate_constructor_values(multi_value, single_value, multi_string, single_string)
+        if !multi_value.nil? && !single_value.nil?
+          raise ArgumentError.new(
+            'Cannot set both %s and %s parameters via constructor. ' % [
+              multi_string, single_string
+            ] + 'Please set either the multi or single parameter, not both.'
+          )
+        end
       end
     end
   end