facebookbusiness 0.3.1.0 → 0.14.0.0

data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb

@@ -28,67 +28,71 @@ module FacebookAds
   class CustomAudienceDataSource < AdObject
     SUB_TYPE = [
       "ANYTHING",
-      "NOTHING",
-      "HASHES",
-      "USER_IDS",
-      "HASHES_OR_USER_IDS",
-      "MOBILE_ADVERTISER_IDS",
+      "APP_USERS",
+      "CAMPAIGN_CONVERSIONS",
+      "COMBINATION_CUSTOM_AUDIENCE_USERS",
+      "CONSTANT_CONTACTS_EMAIL_HASHES",
+      "CONTACT_IMPORTER",
+      "CONVERSION_PIXEL_HITS",
+      "COPY_PASTE_EMAIL_HASHES",
+      "CUSTOM_AUDIENCE_USERS",
+      "CUSTOM_DATA_TARGETING",
+      "DATA_FILE",
+      "DYNAMIC_RULE",
+      "ENGAGEMENT_EVENT_USERS",
+      "EXPANDED_AUDIENCE",
       "EXTERNAL_IDS",
-      "MULTI_HASHES",
-      "TOKENS",
       "EXTERNAL_IDS_MIX",
+      "FACEBOOK_WIFI_EVENTS",
+      "FB_EVENT_SIGNALS",
+      "FB_PIXEL_HITS",
+      "HASHES",
+      "HASHES_OR_USER_IDS",
       "HOUSEHOLD_EXPANSION",
-      "WEB_PIXEL_HITS",
-      "MOBILE_APP_EVENTS",
-      "MOBILE_APP_COMBINATION_EVENTS",
-      "VIDEO_EVENTS",
-      "WEB_PIXEL_COMBINATION_EVENTS",
-      "PLATFORM",
-      "MULTI_DATA_EVENTS",
       "IG_BUSINESS_EVENTS",
-      "STORE_VISIT_EVENTS",
+      "IG_PROMOTED_POST",
       "INSTANT_ARTICLE_EVENTS",
-      "FB_EVENT_SIGNALS",
-      "ENGAGEMENT_EVENT_USERS",
-      "CUSTOM_AUDIENCE_USERS",
-      "PAGE_FANS",
-      "CONVERSION_PIXEL_HITS",
-      "APP_USERS",
-      "S_EXPR",
-      "DYNAMIC_RULE",
-      "CAMPAIGN_CONVERSIONS",
-      "WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS",
+      "LOOKALIKE_PLATFORM",
+      "MAIL_CHIMP_EMAIL_HASHES",
+      "MOBILE_ADVERTISER_IDS",
+      "MOBILE_APP_COMBINATION_EVENTS",
       "MOBILE_APP_CUSTOM_AUDIENCE_USERS",
-      "COMBINATION_CUSTOM_AUDIENCE_USERS",
-      "VIDEO_EVENT_USERS",
-      "FB_PIXEL_HITS",
-      "IG_PROMOTED_POST",
-      "PLACE_VISITS",
+      "MOBILE_APP_EVENTS",
+      "MULTICOUNTRY_COMBINATION",
+      "MULTI_DATA_EVENTS",
+      "MULTI_EVENT_SOURCE",
+      "MULTI_HASHES",
+      "NOTHING",
       "OFFLINE_EVENT_USERS",
-      "EXPANDED_AUDIENCE",
-      "SEED_LIST",
-      "PARTNER_CATEGORY_USERS",
+      "PAGE_FANS",
       "PAGE_SMART_AUDIENCE",
-      "MULTICOUNTRY_COMBINATION",
+      "PARTNER_CATEGORY_USERS",
+      "PLACE_VISITS",
+      "PLATFORM",
       "PLATFORM_USERS",
-      "MULTI_EVENT_SOURCE",
+      "SEED_LIST",
+      "SIGNAL_SOURCE",
       "SMART_AUDIENCE",
-      "MAIL_CHIMP_EMAIL_HASHES",
-      "CONSTANT_CONTACTS_EMAIL_HASHES",
-      "COPY_PASTE_EMAIL_HASHES",
-      "CONTACT_IMPORTER",
-      "DATA_FILE",
+      "STORE_VISIT_EVENTS",
+      "S_EXPR",
+      "TOKENS",
+      "USER_IDS",
+      "VIDEO_EVENTS",
+      "VIDEO_EVENT_USERS",
+      "WEB_PIXEL_COMBINATION_EVENTS",
+      "WEB_PIXEL_HITS",
+      "WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS",
     ]
 
     TYPE = [
-      "UNKNOWN",
-      "FILE_IMPORTED",
+      "CONTACT_IMPORTER",
+      "COPY_PASTE",
       "EVENT_BASED",
+      "FILE_IMPORTED",
+      "HOUSEHOLD_AUDIENCE",
       "SEED_BASED",
       "THIRD_PARTY_IMPORTED",
-      "COPY_PASTE",
-      "CONTACT_IMPORTER",
-      "HOUSEHOLD_AUDIENCE",
+      "UNKNOWN",
     ]
 
 

data/lib/facebook_ads/ad_objects/custom_audience_sharing_status.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class CustomAudienceSharingStatus < AdObject
+
+    field :sharing_relationship_id, 'int'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audienceshared_account_info.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class CustomAudiencesharedAccountInfo < AdObject
+
+    field :account_id, 'string'
+    field :account_name, 'string'
+    field :business_id, 'string'
+    field :business_name, 'string'
+    field :sharing_status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_conversion.rb

@@ -31,26 +31,28 @@ module FacebookAds
       "ADD_TO_CART",
       "ADD_TO_WISHLIST",
       "COMPLETE_REGISTRATION",
-      "CONTENT_VIEW",
-      "INITIATED_CHECKOUT",
-      "LEAD",
-      "PURCHASE",
-      "SEARCH",
       "CONTACT",
+      "CONTENT_VIEW",
       "CUSTOMIZE_PRODUCT",
       "DONATE",
+      "FACEBOOK_SELECTED",
       "FIND_LOCATION",
+      "INITIATED_CHECKOUT",
+      "LEAD",
+      "LISTING_INTERACTION",
+      "OTHER",
+      "PURCHASE",
       "SCHEDULE",
+      "SEARCH",
       "START_TRIAL",
       "SUBMIT_APPLICATION",
       "SUBSCRIBE",
-      "TAKE_SURVEY",
-      "OTHER",
     ]
 
 
     field :account_id, 'string'
     field :aggregation_rule, 'string'
+    field :business, 'Business'
     field :creation_time, 'datetime'
     field :custom_event_type, { enum: -> { CUSTOM_EVENT_TYPE }}
     field :data_sources, { list: 'ExternalEventSource' }
@@ -60,6 +62,7 @@ module FacebookAds
     field :first_fired_time, 'datetime'
     field :id, 'string'
     field :is_archived, 'bool'
+    field :is_unavailable, 'bool'
     field :last_fired_time, 'datetime'
     field :name, 'string'
     field :offline_conversion_data_set, 'OfflineConversionDataSet'
@@ -68,34 +71,7 @@ module FacebookAds
     field :rule, 'string'
     field :advanced_rule, 'string'
     field :event_source_id, 'string'
-
-    has_edge :activities do |edge|
-      edge.get do |api|
-        api.has_param :end_time, 'object'
-        api.has_param :event_type, { enum: %w{conversion_create conversion_delete conversion_update }}
-        api.has_param :start_time, 'object'
-      end
-    end
-
-    has_edge :adaccounts do |edge|
-      edge.delete do |api|
-        api.has_param :account_id, 'string'
-        api.has_param :business, 'string'
-      end
-      edge.post 'CustomConversion' do |api|
-        api.has_param :account_id, 'string'
-        api.has_param :business, 'string'
-      end
-    end
-
-    has_edge :shared_agencies do |edge|
-      edge.delete do |api|
-        api.has_param :business, 'string'
-      end
-      edge.post 'CustomConversion' do |api|
-        api.has_param :business, 'string'
-      end
-    end
+    field :custom_conversion_id, 'string'
 
     has_edge :stats do |edge|
       edge.get 'CustomConversionStatsResult' do |api|

data/lib/facebook_ads/ad_objects/custom_user_settings.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class CustomUserSettings < AdObject
+
+    field :page_level_persistent_menu, { list: 'object' }
+    field :user_level_persistent_menu, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/da_check.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class DaCheck < AdObject
+    CONNECTION_METHOD = [
+      "ALL",
+      "APP",
+      "BROWSER",
+      "SERVER",
+    ]
+
+
+    field :action_uri, 'string'
+    field :description, 'string'
+    field :key, 'string'
+    field :result, 'string'
+    field :title, 'string'
+    field :user_message, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/delivery_window.rb

@@ -0,0 +1,287 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class DeliveryWindow < AdObject
+
+    field :ad, 'int'
+    field :ae, 'int'
+    field :af, 'int'
+    field :ag, 'int'
+    field :ai, 'int'
+    field :al, 'int'
+    field :all, 'int'
+    field :am, 'int'
+    field :an, 'int'
+    field :ao, 'int'
+    field :aq, 'int'
+    field :ar, 'int'
+    field :as, 'int'
+    field :at, 'int'
+    field :au, 'int'
+    field :aw, 'int'
+    field :ax, 'int'
+    field :az, 'int'
+    field :ba, 'int'
+    field :bb, 'int'
+    field :bd, 'int'
+    field :be, 'int'
+    field :bf, 'int'
+    field :bg, 'int'
+    field :bh, 'int'
+    field :bi, 'int'
+    field :bj, 'int'
+    field :bl, 'int'
+    field :bm, 'int'
+    field :bn, 'int'
+    field :bo, 'int'
+    field :bq, 'int'
+    field :br, 'int'
+    field :bs, 'int'
+    field :bt, 'int'
+    field :bv, 'int'
+    field :bw, 'int'
+    field :by, 'int'
+    field :bz, 'int'
+    field :ca, 'int'
+    field :cc, 'int'
+    field :cd, 'int'
+    field :cf, 'int'
+    field :cg, 'int'
+    field :ch, 'int'
+    field :ci, 'int'
+    field :ck, 'int'
+    field :cl, 'int'
+    field :cm, 'int'
+    field :cn, 'int'
+    field :co, 'int'
+    field :cr, 'int'
+    field :cu, 'int'
+    field :cv, 'int'
+    field :cw, 'int'
+    field :cx, 'int'
+    field :cy, 'int'
+    field :cz, 'int'
+    field :de, 'int'
+    field :dj, 'int'
+    field :dk, 'int'
+    field :dm, 'int'
+    field :_do, 'int'
+    field :dz, 'int'
+    field :ec, 'int'
+    field :ee, 'int'
+    field :eg, 'int'
+    field :eh, 'int'
+    field :er, 'int'
+    field :es, 'int'
+    field :et, 'int'
+    field :fi, 'int'
+    field :fj, 'int'
+    field :fk, 'int'
+    field :fm, 'int'
+    field :fo, 'int'
+    field :fr, 'int'
+    field :ga, 'int'
+    field :gb, 'int'
+    field :gd, 'int'
+    field :ge, 'int'
+    field :gf, 'int'
+    field :gg, 'int'
+    field :gh, 'int'
+    field :gi, 'int'
+    field :gl, 'int'
+    field :gm, 'int'
+    field :gn, 'int'
+    field :gp, 'int'
+    field :gq, 'int'
+    field :gr, 'int'
+    field :gs, 'int'
+    field :gt, 'int'
+    field :gu, 'int'
+    field :gw, 'int'
+    field :gy, 'int'
+    field :hk, 'int'
+    field :hm, 'int'
+    field :hn, 'int'
+    field :hr, 'int'
+    field :ht, 'int'
+    field :hu, 'int'
+    field :id, 'int'
+    field :ie, 'int'
+    field :il, 'int'
+    field :im, 'int'
+    field :in, 'int'
+    field :io, 'int'
+    field :iq, 'int'
+    field :ir, 'int'
+    field :is, 'int'
+    field :it, 'int'
+    field :je, 'int'
+    field :jm, 'int'
+    field :jo, 'int'
+    field :jp, 'int'
+    field :ke, 'int'
+    field :kg, 'int'
+    field :kh, 'int'
+    field :ki, 'int'
+    field :km, 'int'
+    field :kn, 'int'
+    field :kp, 'int'
+    field :kr, 'int'
+    field :kw, 'int'
+    field :ky, 'int'
+    field :kz, 'int'
+    field :la, 'int'
+    field :lb, 'int'
+    field :lc, 'int'
+    field :li, 'int'
+    field :lk, 'int'
+    field :lr, 'int'
+    field :ls, 'int'
+    field :lt, 'int'
+    field :lu, 'int'
+    field :lv, 'int'
+    field :ly, 'int'
+    field :ma, 'int'
+    field :mc, 'int'
+    field :md, 'int'
+    field :me, 'int'
+    field :mf, 'int'
+    field :mg, 'int'
+    field :mh, 'int'
+    field :mk, 'int'
+    field :ml, 'int'
+    field :mm, 'int'
+    field :mn, 'int'
+    field :mo, 'int'
+    field :mp, 'int'
+    field :mq, 'int'
+    field :mr, 'int'
+    field :ms, 'int'
+    field :mt, 'int'
+    field :mu, 'int'
+    field :mv, 'int'
+    field :mw, 'int'
+    field :mx, 'int'
+    field :my, 'int'
+    field :mz, 'int'
+    field :na, 'int'
+    field :nc, 'int'
+    field :ne, 'int'
+    field :nf, 'int'
+    field :ng, 'int'
+    field :ni, 'int'
+    field :nl, 'int'
+    field :no, 'int'
+    field :np, 'int'
+    field :nr, 'int'
+    field :nu, 'int'
+    field :nz, 'int'
+    field :om, 'int'
+    field :pa, 'int'
+    field :pe, 'int'
+    field :pf, 'int'
+    field :pg, 'int'
+    field :ph, 'int'
+    field :pk, 'int'
+    field :pl, 'int'
+    field :pm, 'int'
+    field :pn, 'int'
+    field :pr, 'int'
+    field :ps, 'int'
+    field :pt, 'int'
+    field :pw, 'int'
+    field :py, 'int'
+    field :qa, 'int'
+    field :re, 'int'
+    field :ro, 'int'
+    field :rs, 'int'
+    field :ru, 'int'
+    field :rw, 'int'
+    field :sa, 'int'
+    field :sb, 'int'
+    field :sc, 'int'
+    field :sd, 'int'
+    field :se, 'int'
+    field :sg, 'int'
+    field :sh, 'int'
+    field :si, 'int'
+    field :sj, 'int'
+    field :sk, 'int'
+    field :sl, 'int'
+    field :sm, 'int'
+    field :sn, 'int'
+    field :so, 'int'
+    field :sr, 'int'
+    field :ss, 'int'
+    field :st, 'int'
+    field :sv, 'int'
+    field :sx, 'int'
+    field :sy, 'int'
+    field :sz, 'int'
+    field :tc, 'int'
+    field :td, 'int'
+    field :tf, 'int'
+    field :tg, 'int'
+    field :th, 'int'
+    field :tj, 'int'
+    field :tk, 'int'
+    field :tl, 'int'
+    field :tm, 'int'
+    field :tn, 'int'
+    field :to, 'int'
+    field :tr, 'int'
+    field :tt, 'int'
+    field :tv, 'int'
+    field :tw, 'int'
+    field :tz, 'int'
+    field :ua, 'int'
+    field :ug, 'int'
+    field :um, 'int'
+    field :us, 'int'
+    field :uy, 'int'
+    field :uz, 'int'
+    field :va, 'int'
+    field :vc, 'int'
+    field :ve, 'int'
+    field :vg, 'int'
+    field :vi, 'int'
+    field :vn, 'int'
+    field :vu, 'int'
+    field :wf, 'int'
+    field :ws, 'int'
+    field :xk, 'int'
+    field :ye, 'int'
+    field :yt, 'int'
+    field :za, 'int'
+    field :zm, 'int'
+    field :zw, 'int'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end