facebookbusiness 0.3.1.1 → 0.3.1.5

data/lib/facebook_ads/ad_objects/ad_account_roas.rb

@@ -26,38 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class AdAccountRoas < AdObject
-    FIELDS = [
-      "adgroup_id",
-      "arpu_180d",
-      "arpu_1d",
-      "arpu_30d",
-      "arpu_365d",
-      "arpu_3d",
-      "arpu_7d",
-      "arpu_90d",
-      "campaign_group_id",
-      "campaign_id",
-      "date_start",
-      "date_stop",
-      "installs",
-      "revenue",
-      "revenue_180d",
-      "revenue_1d",
-      "revenue_30d",
-      "revenue_365d",
-      "revenue_3d",
-      "revenue_7d",
-      "revenue_90d",
-      "spend",
-      "yield_180d",
-      "yield_1d",
-      "yield_30d",
-      "yield_365d",
-      "yield_3d",
-      "yield_7d",
-      "yield_90d",
-    ]
-
 
     field :adgroup_id, 'string'
     field :arpu_180d, 'double'
@@ -88,8 +56,7 @@ module FacebookAds
     field :yield_3d, 'double'
     field :yield_7d, 'double'
     field :yield_90d, 'double'
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_spend_limit.rb

@@ -0,0 +1,42 @@
+# 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 AdAccountSpendLimit < AdObject
+
+    field :amount_spent, 'string'
+    field :group_id, 'string'
+    field :limit_id, 'string'
+    field :limit_value, 'string'
+    field :time_created, 'int'
+    field :time_start, 'int'
+    field :time_stop, 'int'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_subsidy_amount_details.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 AdAccountSubsidyAmountDetails < AdObject
+
+    field :entered_amount, 'CurrencyAmount'
+    field :fee_amount, 'CurrencyAmount'
+    field :total_amount, 'CurrencyAmount'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -26,127 +26,29 @@ module FacebookAds
   # pull request for this class.
 
   class AdAccountTargetingUnified < AdObject
-    LIMIT_TYPE = [
-      "adgroup_id",
-      "genders",
-      "age_min",
-      "age_max",
-      "country_groups",
-      "countries",
-      "country",
-      "cities",
-      "radius",
-      "regions",
-      "zips",
-      "interests",
-      "keywords",
-      "education_schools",
-      "education_majors",
-      "work_positions",
-      "work_employers",
-      "relationship_statuses",
-      "interested_in",
-      "locales",
-      "user_adclusters",
-      "excluded_user_adclusters",
-      "conjunctive_user_adclusters",
-      "custom_audiences",
-      "excluded_custom_audiences",
-      "college_years",
-      "education_statuses",
-      "connections",
-      "excluded_connections",
-      "friends_of_connections",
-      "user_event",
-      "dynamic_audience_ids",
-      "excluded_dynamic_audience_ids",
-      "rtb_flag",
-      "site_category",
-      "geo_locations",
-      "excluded_geo_locations",
-      "timezones",
-      "place_page_set_ids",
-      "page_types",
-      "publisher_platforms",
-      "effective_publisher_platforms",
-      "facebook_positions",
-      "effective_facebook_positions",
-      "instagram_positions",
-      "effective_instagram_positions",
-      "messenger_positions",
-      "effective_messenger_positions",
-      "device_platforms",
-      "effective_device_platforms",
-      "audience_network_positions",
-      "effective_audience_network_positions",
-      "whatsapp_positions",
-      "effective_whatsapp_positions",
-      "excluded_publisher_categories",
-      "excluded_publisher_list_ids",
-      "publisher_visibility_categories",
-      "user_device",
-      "mobile_device_model",
-      "excluded_user_device",
-      "excluded_mobile_device_model",
-      "user_os",
-      "wireless_carrier",
-      "family_statuses",
-      "industries",
-      "life_events",
-      "political_views",
-      "politics",
-      "behaviors",
-      "income",
-      "net_worth",
-      "home_type",
-      "home_ownership",
-      "home_value",
-      "ethnic_affinity",
-      "generation",
-      "household_composition",
-      "moms",
-      "office_type",
-      "targeting_optimization",
-      "direct_install_devices",
-      "engagement_specs",
-      "excluded_engagement_specs",
-      "product_audience_specs",
-      "excluded_product_audience_specs",
-      "exclusions",
-      "flexible_spec",
-      "exclude_reached_since",
-      "exclude_previous_days",
-      "app_install_state",
-      "fb_deal_id",
-      "interest_defaults_source",
-      "alternate_auto_targeting_option",
-      "contextual_targeting_categories",
-      "topic",
-      "format",
-      "trending",
-      "gatekeepers",
-      "follow_profiles",
-      "follow_profiles_negative",
-      "location_categories",
-      "user_page_threads",
-      "user_page_threads_excluded",
-      "is_whatsapp_destination_ad",
-      "marketplace_product_categories",
-      "instream_video_sponsorship_placements",
-    ]
-
 
     field :audience_size, 'int'
+    field :conversion_lift, 'double'
     field :description, 'string'
     field :id, 'string'
+    field :img, 'string'
+    field :info, 'string'
+    field :info_title, 'string'
     field :is_recommendation, 'bool'
+    field :key, 'string'
+    field :link, 'string'
     field :name, 'string'
+    field :parent, 'string'
+    field :partner, 'string'
     field :path, { list: 'string' }
+    field :performance_rating, 'int'
+    field :raw_name, 'string'
     field :recommendation_model, 'string'
     field :search_interest_id, 'string'
+    field :source, 'string'
+    field :spend, 'double'
     field :type, 'string'
     field :valid, 'bool'
-    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_tracking_data.rb

@@ -0,0 +1,36 @@
+# 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 AdAccountTrackingData < AdObject
+
+    field :tracking_specs, 'ConversionActionQuery'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_user.rb

@@ -30,7 +30,6 @@ module FacebookAds
     field :id, 'string'
     field :name, 'string'
     field :tasks, { list: 'string' }
-    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_account_user_permissions.rb

@@ -0,0 +1,45 @@
+# 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 AdAccountUserPermissions < AdObject
+
+    field :business, 'Business'
+    field :business_persona, 'BusinessPersona'
+    field :created_by, 'User'
+    field :created_time, 'datetime'
+    field :email, 'string'
+    field :status, 'string'
+    field :tasks, { list: 'string' }
+    field :updated_by, 'User'
+    field :updated_time, 'datetime'
+    field :user, 'User'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb

@@ -0,0 +1,55 @@
+# 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 AdAccountUserSettings < AdObject
+
+    field :ad_account, 'AdAccount'
+    field :ad_object_export_format, 'string'
+    field :auto_review_video_caption, 'bool'
+    field :column_suggestion_status, 'string'
+    field :default_account_overview_agegender_metrics, { list: 'string' }
+    field :default_account_overview_location_metrics, { list: 'string' }
+    field :default_account_overview_metrics, { list: 'string' }
+    field :default_account_overview_time_metrics, { list: 'string' }
+    field :default_builtin_column_preset, 'string'
+    field :default_nam_time_range, 'string'
+    field :draft_mode_enabled, 'bool'
+    field :export_deleted_items_with_delivery, 'bool'
+    field :export_summary_row, 'bool'
+    field :id, 'string'
+    field :last_used_columns, 'object'
+    field :last_used_pe_filters, { list: 'object' }
+    field :rb_export_format, 'string'
+    field :rb_export_raw_data, 'bool'
+    field :rb_export_summary_row, 'bool'
+    field :show_archived_data, 'bool'
+    field :user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -120,8 +120,7 @@ module FacebookAds
     field :object_name, 'string'
     field :object_type, 'string'
     field :translated_event_type, 'string'
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/ad_asset_feed.rb

@@ -0,0 +1,216 @@
+# 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 AdAssetFeed < AdObject
+    AD_FORMATS = [
+      "AUTOMATIC_FORMAT",
+      "CAROUSEL_IMAGE",
+      "CAROUSEL_VIDEO",
+      "SINGLE_IMAGE",
+      "SINGLE_VIDEO",
+    ]
+
+    CALL_TO_ACTION_TYPES = [
+      "OPEN_LINK",
+      "LIKE_PAGE",
+      "SHOP_NOW",
+      "PLAY_GAME",
+      "INSTALL_APP",
+      "USE_APP",
+      "CALL",
+      "CALL_ME",
+      "INSTALL_MOBILE_APP",
+      "USE_MOBILE_APP",
+      "MOBILE_DOWNLOAD",
+      "BOOK_TRAVEL",
+      "LISTEN_MUSIC",
+      "WATCH_VIDEO",
+      "LEARN_MORE",
+      "SIGN_UP",
+      "DOWNLOAD",
+      "WATCH_MORE",
+      "NO_BUTTON",
+      "VISIT_PAGES_FEED",
+      "APPLY_NOW",
+      "BUY_NOW",
+      "GET_OFFER",
+      "GET_OFFER_VIEW",
+      "BUY_TICKETS",
+      "UPDATE_APP",
+      "GET_DIRECTIONS",
+      "BUY",
+      "MESSAGE_PAGE",
+      "DONATE",
+      "SUBSCRIBE",
+      "SAY_THANKS",
+      "SELL_NOW",
+      "SHARE",
+      "DONATE_NOW",
+      "GET_QUOTE",
+      "CONTACT_US",
+      "ORDER_NOW",
+      "ADD_TO_CART",
+      "VIDEO_ANNOTATION",
+      "MOMENTS",
+      "RECORD_NOW",
+      "GET_SHOWTIMES",
+      "LISTEN_NOW",
+      "WOODHENGE_SUPPORT",
+      "EVENT_RSVP",
+      "WHATSAPP_MESSAGE",
+      "FOLLOW_NEWS_STORYLINE",
+    ]
+
+    OPTIMIZATION_TYPE = [
+      "REGULAR",
+      "LANGUAGE",
+      "PLACEMENT",
+      "VIDEO_BANDWIDTH",
+      "BRAND",
+      "ASSET_CUSTOMIZATION",
+      "DCO_PARITY",
+    ]
+
+    CALL_TO_ACTION_TYPE = [
+      "OPEN_LINK",
+      "LIKE_PAGE",
+      "SHOP_NOW",
+      "PLAY_GAME",
+      "INSTALL_APP",
+      "USE_APP",
+      "CALL",
+      "CALL_ME",
+      "INSTALL_MOBILE_APP",
+      "USE_MOBILE_APP",
+      "MOBILE_DOWNLOAD",
+      "BOOK_TRAVEL",
+      "LISTEN_MUSIC",
+      "WATCH_VIDEO",
+      "LEARN_MORE",
+      "SIGN_UP",
+      "DOWNLOAD",
+      "WATCH_MORE",
+      "NO_BUTTON",
+      "VISIT_PAGES_FEED",
+      "APPLY_NOW",
+      "BUY_NOW",
+      "GET_OFFER",
+      "GET_OFFER_VIEW",
+      "BUY_TICKETS",
+      "UPDATE_APP",
+      "GET_DIRECTIONS",
+      "BUY",
+      "MESSAGE_PAGE",
+      "DONATE",
+      "SUBSCRIBE",
+      "SAY_THANKS",
+      "SELL_NOW",
+      "SHARE",
+      "DONATE_NOW",
+      "GET_QUOTE",
+      "CONTACT_US",
+      "ORDER_NOW",
+      "ADD_TO_CART",
+      "VIDEO_ANNOTATION",
+      "MOMENTS",
+      "RECORD_NOW",
+      "GET_SHOWTIMES",
+      "LISTEN_NOW",
+      "WOODHENGE_SUPPORT",
+      "EVENT_RSVP",
+      "WHATSAPP_MESSAGE",
+      "FOLLOW_NEWS_STORYLINE",
+    ]
+
+
+    field :account, 'AdAccount'
+    field :ad_formats, { list: 'string' }
+    field :additional_data, 'object'
+    field :autotranslate, { list: 'string' }
+    field :id, 'string'
+    field :optimization_type, 'string'
+    field :images, { list: 'object' }
+    field :videos, { list: 'object' }
+    field :bodies, { list: 'object' }
+    field :call_to_action_types, { list: { enum: -> { CALL_TO_ACTION_TYPES }} }
+    field :descriptions, { list: 'object' }
+    field :link_urls, { list: 'object' }
+    field :titles, { list: 'object' }
+    field :captions, { list: 'object' }
+    field :groups, { list: 'object' }
+    field :target_rules, { list: 'object' }
+    field :asset_customization_rules, { list: 'object' }
+    field :call_to_actions, { list: 'object' }
+    field :image, 'object'
+    field :video, 'object'
+    field :call_to_action_type, { enum: -> { CALL_TO_ACTION_TYPE }}
+    field :default_language, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :asset_customization_rules do |edge|
+      edge.get
+    end
+
+    has_edge :bodies do |edge|
+      edge.get
+    end
+
+    has_edge :call_to_action_types do |edge|
+      edge.get
+    end
+
+    has_edge :captions do |edge|
+      edge.get
+    end
+
+    has_edge :descriptions do |edge|
+      edge.get
+    end
+
+    has_edge :groups do |edge|
+      edge.get
+    end
+
+    has_edge :images do |edge|
+      edge.get
+    end
+
+    has_edge :link_urls do |edge|
+      edge.get
+    end
+
+    has_edge :titles do |edge|
+      edge.get
+    end
+
+    has_edge :videos do |edge|
+      edge.get
+    end
+
+  end
+end