facebookbusiness 0.3.1.0 → 0.14.0.0

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -27,121 +27,240 @@ module FacebookAds
 
   class AdAccountTargetingUnified < AdObject
     LIMIT_TYPE = [
-      "adgroup_id",
-      "genders",
-      "age_min",
-      "age_max",
-      "country_groups",
-      "countries",
-      "country",
-      "cities",
-      "radius",
-      "regions",
-      "zips",
-      "interests",
-      "keywords",
-      "education_schools",
+      "behaviors",
+      "college_years",
       "education_majors",
-      "work_positions",
-      "work_employers",
-      "relationship_statuses",
+      "education_schools",
+      "education_statuses",
+      "ethnic_affinity",
+      "family_statuses",
+      "generation",
+      "home_ownership",
+      "home_type",
+      "home_value",
+      "household_composition",
+      "income",
+      "industries",
       "interested_in",
-      "locales",
+      "interests",
+      "life_events",
+      "location_categories",
+      "moms",
+      "net_worth",
+      "office_type",
+      "politics",
+      "relationship_statuses",
       "user_adclusters",
-      "excluded_user_adclusters",
-      "conjunctive_user_adclusters",
-      "custom_audiences",
-      "excluded_custom_audiences",
+      "work_employers",
+      "work_positions",
+    ]
+
+    REGULATED_CATEGORIES = [
+      "CREDIT",
+      "EMPLOYMENT",
+      "HOUSING",
+      "ISSUES_ELECTIONS_POLITICS",
+      "NONE",
+      "ONLINE_GAMBLING_AND_GAMING",
+    ]
+
+    WHITELISTED_TYPES = [
+      "adgroup_id",
+      "age_max",
+      "age_min",
+      "alternate_auto_targeting_option",
+      "app_install_state",
+      "audience_network_positions",
+      "behaviors",
+      "brand_safety_content_filter_levels",
+      "brand_safety_content_severity_levels",
+      "catalog_based_targeting",
+      "cities",
+      "city_keys",
       "college_years",
-      "education_statuses",
+      "conjunctive_user_adclusters",
       "connections",
-      "excluded_connections",
-      "friends_of_connections",
-      "user_event",
+      "contextual_targeting_categories",
+      "countries",
+      "country",
+      "country_groups",
+      "custom_audiences",
+      "device_platforms",
+      "direct_install_devices",
       "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",
+      "education_majors",
+      "education_schools",
+      "education_statuses",
+      "effective_audience_network_positions",
+      "effective_device_platforms",
       "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",
+      "effective_oculus_positions",
+      "effective_publisher_platforms",
+      "effective_whatsapp_positions",
+      "engagement_specs",
+      "ethnic_affinity",
+      "exclude_previous_days",
+      "exclude_reached_since",
+      "excluded_brand_safety_content_types",
+      "excluded_connections",
+      "excluded_custom_audiences",
+      "excluded_dynamic_audience_ids",
+      "excluded_engagement_specs",
+      "excluded_geo_locations",
+      "excluded_mobile_device_model",
+      "excluded_product_audience_specs",
       "excluded_publisher_categories",
       "excluded_publisher_list_ids",
-      "publisher_visibility_categories",
-      "user_device",
-      "mobile_device_model",
+      "excluded_user_adclusters",
       "excluded_user_device",
-      "excluded_mobile_device_model",
-      "user_os",
-      "wireless_carrier",
+      "exclusions",
+      "facebook_positions",
       "family_statuses",
-      "industries",
-      "life_events",
-      "political_views",
-      "politics",
-      "behaviors",
-      "income",
-      "net_worth",
-      "home_type",
+      "fb_deal_id",
+      "flexible_spec",
+      "follow_profiles",
+      "follow_profiles_negative",
+      "format",
+      "friends_of_connections",
+      "gatekeepers",
+      "genders",
+      "generation",
+      "geo_locations",
       "home_ownership",
+      "home_type",
       "home_value",
-      "ethnic_affinity",
-      "generation",
       "household_composition",
+      "id",
+      "income",
+      "industries",
+      "instagram_hashtags",
+      "instagram_positions",
+      "instream_video_skippable_excluded",
+      "instream_video_sponsorship_placements",
+      "interest_defaults_source",
+      "interested_in",
+      "interests",
+      "is_instagram_destination_ad",
+      "is_whatsapp_destination_ad",
+      "keywords",
+      "life_events",
+      "locales",
+      "location_categories",
+      "location_cluster_ids",
+      "location_expansion",
+      "marketplace_product_categories",
+      "messenger_positions",
+      "mobile_device_model",
       "moms",
+      "net_worth",
+      "oculus_positions",
       "office_type",
-      "targeting_optimization",
-      "direct_install_devices",
-      "engagement_specs",
-      "excluded_engagement_specs",
+      "page_types",
+      "place_page_set_ids",
+      "political_views",
+      "politics",
       "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",
+      "prospecting_audience",
+      "publisher_platforms",
+      "radius",
+      "region_keys",
+      "regions",
+      "relationship_statuses",
+      "rtb_flag",
+      "site_category",
+      "targeting_optimization",
+      "targeting_relaxation_types",
+      "timezones",
       "topic",
-      "format",
       "trending",
-      "gatekeepers",
-      "follow_profiles",
-      "follow_profiles_negative",
-      "location_categories",
+      "user_adclusters",
+      "user_device",
+      "user_event",
+      "user_os",
       "user_page_threads",
       "user_page_threads_excluded",
-      "is_whatsapp_destination_ad",
-      "marketplace_product_categories",
-      "instream_video_sponsorship_placements",
+      "whatsapp_positions",
+      "wireless_carrier",
+      "work_employers",
+      "work_positions",
+      "zips",
+    ]
+
+    APP_STORE = [
+      "amazon_app_store",
+      "apk_mirror",
+      "apk_monk",
+      "apk_pure",
+      "aptoide_a1_store",
+      "bemobi_mobile_store",
+      "does_not_exist",
+      "fb_android_store",
+      "fb_canvas",
+      "fb_gameroom",
+      "galaxy_store",
+      "google_play",
+      "instant_game",
+      "itunes",
+      "itunes_ipad",
+      "oculus_app_store",
+      "oppo",
+      "roku_channel_store",
+      "uptodown",
+      "vivo",
+      "windows_10_store",
+      "windows_store",
+      "xiaomi",
+    ]
+
+    OBJECTIVE = [
+      "APP_INSTALLS",
+      "BRAND_AWARENESS",
+      "CONVERSIONS",
+      "EVENT_RESPONSES",
+      "LEAD_GENERATION",
+      "LINK_CLICKS",
+      "LOCAL_AWARENESS",
+      "MESSAGES",
+      "OFFER_CLAIMS",
+      "PAGE_LIKES",
+      "POST_ENGAGEMENT",
+      "PRODUCT_CATALOG_SALES",
+      "REACH",
+      "STORE_VISITS",
+      "VIDEO_VIEWS",
+    ]
+
+    MODE = [
+      "best_performing",
+      "recently_used",
+      "related",
+      "suggestions",
     ]
 
 
-    field :audience_size, 'int'
+    field :audience_size_lower_bound, 'int'
+    field :audience_size_upper_bound, '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

data/lib/facebook_ads/ad_objects/ad_account_tracking_data.rb

@@ -0,0 +1,37 @@
+# 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'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -27,76 +27,88 @@ module FacebookAds
 
   class AdActivity < AdObject
     EVENT_TYPE = [
-      "ad_account_update_spend_limit",
-      "ad_account_reset_spend_limit",
-      "ad_account_remove_spend_limit",
-      "ad_account_set_business_information",
-      "ad_account_update_status",
+      "account_spending_limit_reached",
       "ad_account_add_user_to_role",
-      "ad_account_remove_user_from_role",
-      "add_images",
-      "edit_images",
-      "delete_images",
       "ad_account_billing_charge",
       "ad_account_billing_charge_failed",
       "ad_account_billing_chargeback",
       "ad_account_billing_chargeback_reversal",
       "ad_account_billing_decline",
       "ad_account_billing_refund",
-      "billing_event",
+      "ad_account_remove_spend_limit",
+      "ad_account_remove_user_from_role",
+      "ad_account_reset_spend_limit",
+      "ad_account_set_business_information",
+      "ad_account_update_spend_limit",
+      "ad_account_update_status",
+      "ad_review_approved",
+      "ad_review_declined",
       "add_funding_source",
-      "remove_funding_source",
-      "create_campaign_group",
-      "update_campaign_name",
-      "update_campaign_run_status",
-      "update_campaign_group_spend_cap",
-      "create_campaign_legacy",
-      "update_campaign_budget",
-      "update_campaign_duration",
+      "add_images",
+      "billing_event",
       "campaign_ended",
+      "campaign_spending_limit_reached",
+      "conversion_event_updated",
+      "create_ad",
       "create_ad_set",
-      "update_ad_set_bidding",
+      "create_audience",
+      "create_campaign_group",
+      "create_campaign_legacy",
+      "delete_audience",
+      "delete_images",
+      "di_ad_set_learning_stage_exit",
+      "edit_and_update_ad_creative",
+      "edit_images",
+      "first_delivery_event",
+      "funding_event_initiated",
+      "funding_event_successful",
+      "lifetime_budget_spent",
+      "receive_audience",
+      "remove_funding_source",
+      "remove_shared_audience",
+      "share_audience",
+      "unknown",
+      "unshare_audience",
+      "update_ad_bid_info",
+      "update_ad_bid_type",
+      "update_ad_creative",
+      "update_ad_friendly_name",
+      "update_ad_labels",
+      "update_ad_run_status",
+      "update_ad_run_status_to_be_set_after_review",
+      "update_ad_set_ad_keywords",
+      "update_ad_set_bid_adjustments",
       "update_ad_set_bid_strategy",
+      "update_ad_set_bidding",
       "update_ad_set_budget",
       "update_ad_set_duration",
-      "update_ad_set_run_status",
+      "update_ad_set_learning_stage_status",
+      "update_ad_set_min_spend_target",
       "update_ad_set_name",
       "update_ad_set_optimization_goal",
+      "update_ad_set_run_status",
+      "update_ad_set_spend_cap",
       "update_ad_set_target_spec",
-      "update_ad_set_bid_adjustments",
-      "create_ad",
-      "ad_review_approved",
-      "ad_review_declined",
-      "update_ad_creative",
-      "edit_and_update_ad_creative",
-      "update_ad_bid_info",
-      "update_ad_bid_type",
-      "update_ad_run_status",
-      "update_ad_run_status_to_be_set_after_review",
-      "update_ad_friendly_name",
       "update_ad_targets_spec",
       "update_adgroup_stop_delivery",
-      "first_delivery_event",
-      "create_audience",
       "update_audience",
-      "delete_audience",
-      "share_audience",
-      "receive_audience",
-      "unshare_audience",
-      "remove_shared_audience",
-      "unknown",
-      "account_spending_limit_reached",
-      "campaign_spending_limit_reached",
-      "lifetime_budget_spent",
-      "funding_event_initiated",
-      "funding_event_successful",
-      "update_ad_labels",
-      "di_ad_set_learning_stage_exit",
+      "update_campaign_ad_scheduling",
+      "update_campaign_budget",
+      "update_campaign_budget_optimization_toggling_status",
+      "update_campaign_delivery_type",
+      "update_campaign_group_ad_scheduling",
+      "update_campaign_group_delivery_type",
+      "update_campaign_group_spend_cap",
+      "update_campaign_name",
+      "update_campaign_run_status",
+      "update_campaign_schedule",
+      "update_delivery_type_cross_level_shift",
     ]
 
     CATEGORY = [
       "ACCOUNT",
       "AD",
+      "AD_KEYWORDS",
       "AD_SET",
       "AUDIENCE",
       "BID",
@@ -107,6 +119,13 @@ module FacebookAds
       "TARGETING",
     ]
 
+    DATA_SOURCE = [
+      "CALYPSO",
+      "TAO",
+      "TAO_AD_ACCOUNT",
+      "TAO_AD_STATUS",
+    ]
+
 
     field :actor_id, 'string'
     field :actor_name, 'string'

data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb

@@ -27,53 +27,74 @@ module FacebookAds
 
   class AdAssetFeedSpec < AdObject
     CALL_TO_ACTION_TYPES = [
-      "OPEN_LINK",
-      "LIKE_PAGE",
-      "SHOP_NOW",
-      "PLAY_GAME",
-      "INSTALL_APP",
-      "USE_APP",
+      "ADD_TO_CART",
+      "APPLY_NOW",
+      "BOOK_TRAVEL",
+      "BUY",
+      "BUY_NOW",
+      "BUY_TICKETS",
       "CALL",
       "CALL_ME",
-      "INSTALL_MOBILE_APP",
-      "USE_MOBILE_APP",
-      "MOBILE_DOWNLOAD",
-      "BOOK_TRAVEL",
-      "LISTEN_MUSIC",
-      "WATCH_VIDEO",
-      "LEARN_MORE",
-      "SIGN_UP",
+      "CALL_NOW",
+      "CONTACT",
+      "CONTACT_US",
+      "DONATE",
+      "DONATE_NOW",
       "DOWNLOAD",
-      "WATCH_MORE",
-      "NO_BUTTON",
-      "VISIT_PAGES_FEED",
-      "APPLY_NOW",
-      "BUY_NOW",
+      "EVENT_RSVP",
+      "FIND_A_GROUP",
+      "FIND_YOUR_GROUPS",
+      "FOLLOW_NEWS_STORYLINE",
+      "FOLLOW_PAGE",
+      "FOLLOW_USER",
+      "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
-      "BUY_TICKETS",
-      "UPDATE_APP",
-      "GET_DIRECTIONS",
-      "BUY",
+      "GET_QUOTE",
+      "GET_SHOWTIMES",
+      "GET_STARTED",
+      "INSTALL_APP",
+      "INSTALL_MOBILE_APP",
+      "LEARN_MORE",
+      "LIKE_PAGE",
+      "LISTEN_MUSIC",
+      "LISTEN_NOW",
       "MESSAGE_PAGE",
-      "DONATE",
-      "SUBSCRIBE",
+      "MOBILE_DOWNLOAD",
+      "MOMENTS",
+      "NO_BUTTON",
+      "OPEN_LINK",
+      "ORDER_NOW",
+      "PAY_TO_ACCESS",
+      "PLAY_GAME",
+      "PLAY_GAME_ON_FACEBOOK",
+      "PURCHASE_GIFT_CARDS",
+      "RECORD_NOW",
+      "REFER_FRIENDS",
+      "REQUEST_TIME",
       "SAY_THANKS",
+      "SEE_MORE",
       "SELL_NOW",
+      "SEND_A_GIFT",
+      "SEND_GIFT_MONEY",
       "SHARE",
-      "DONATE_NOW",
-      "GET_QUOTE",
-      "CONTACT_US",
-      "ORDER_NOW",
-      "ADD_TO_CART",
+      "SHOP_NOW",
+      "SIGN_UP",
+      "SOTTO_SUBSCRIBE",
+      "START_ORDER",
+      "SUBSCRIBE",
+      "SWIPE_UP_PRODUCT",
+      "SWIPE_UP_SHOP",
+      "UPDATE_APP",
+      "USE_APP",
+      "USE_MOBILE_APP",
       "VIDEO_ANNOTATION",
-      "MOMENTS",
-      "RECORD_NOW",
-      "GET_SHOWTIMES",
-      "LISTEN_NOW",
-      "EVENT_RSVP",
+      "VIDEO_CALL",
+      "VISIT_PAGES_FEED",
+      "WATCH_MORE",
+      "WATCH_VIDEO",
       "WHATSAPP_MESSAGE",
-      "FOLLOW_NEWS_STORYLINE",
+      "WOODHENGE_SUPPORT",
     ]
 
 
@@ -83,12 +104,16 @@ module FacebookAds
     field :autotranslate, { list: 'string' }
     field :bodies, { list: 'AdAssetFeedSpecBody' }
     field :call_to_action_types, { list: { enum: -> { CALL_TO_ACTION_TYPES }} }
+    field :call_to_actions, { list: 'object' }
     field :captions, { list: 'AdAssetFeedSpecCaption' }
+    field :carousels, { list: 'object' }
     field :descriptions, { list: 'AdAssetFeedSpecDescription' }
+    field :events, { list: 'object' }
     field :groups, { list: 'AdAssetFeedSpecGroupRule' }
     field :images, { list: 'AdAssetFeedSpecImage' }
     field :link_urls, { list: 'AdAssetFeedSpecLinkUrl' }
     field :optimization_type, 'string'
+    field :posts, { list: 'object' }
     field :titles, { list: 'AdAssetFeedSpecTitle' }
     field :videos, { list: 'AdAssetFeedSpecVideo' }
     has_no_id

data/lib/facebook_ads/ad_objects/ad_async_request.rb

@@ -26,28 +26,20 @@ module FacebookAds
   # pull request for this class.
 
   class AdAsyncRequest < AdObject
-    STATUS = [
-      "INITIAL",
-      "IN_PROGRESS",
-      "SUCCESS",
-      "ERROR",
+    STATUSES = [
       "CANCELED",
-      "PENDING_DEPENDENCY",
       "CANCELED_DEPENDENCY",
-      "ERROR_DEPENDENCY",
+      "ERROR",
       "ERROR_CONFLICTS",
-    ]
-
-    STATUSES = [
+      "ERROR_DEPENDENCY",
       "INITIAL",
       "IN_PROGRESS",
-      "SUCCESS",
-      "ERROR",
-      "CANCELED",
       "PENDING_DEPENDENCY",
-      "CANCELED_DEPENDENCY",
-      "ERROR_DEPENDENCY",
-      "ERROR_CONFLICTS",
+      "PROCESS_BY_AD_ASYNC_ENGINE",
+      "PROCESS_BY_EVENT_PROCESSOR",
+      "SUCCESS",
+      "USER_CANCELED",
+      "USER_CANCELED_DEPENDENCY",
     ]
 
 
@@ -57,11 +49,10 @@ module FacebookAds
     field :input, 'hash'
     field :result, 'hash'
     field :scope_object_id, 'string'
-    field :status, { enum: -> { STATUS }}
+    field :status, 'string'
     field :type, 'string'
     field :updated_time, 'datetime'
     has_no_post
-    has_no_delete
 
   end
 end