facebookbusiness 0.3.3.4 → 0.4.0.1

data/lib/facebook_ads/ad_objects/ads_insights.rb

@@ -244,6 +244,7 @@ module FacebookAds
     field :dwell_5_sec, 'string'
     field :dwell_7_sec, 'string'
     field :dwell_rate, 'string'
+    field :earned_impression, 'string'
     field :estimated_ad_recall_rate, 'string'
     field :estimated_ad_recall_rate_lower_bound, 'string'
     field :estimated_ad_recall_rate_upper_bound, 'string'
@@ -264,7 +265,6 @@ module FacebookAds
     field :impression_device, 'string'
     field :impressions, 'string'
     field :impressions_auto_refresh, 'string'
-    field :impressions_dummy, 'string'
     field :impressions_gross, 'string'
     field :inline_link_click_ctr, 'string'
     field :inline_link_clicks, 'string'
@@ -336,7 +336,6 @@ module FacebookAds
     field :video_15_sec_watched_actions, { list: 'AdsActionStats' }
     field :video_30_sec_watched_actions, { list: 'AdsActionStats' }
     field :video_asset, 'object'
-    field :video_avg_percent_watched_actions, { list: 'AdsActionStats' }
     field :video_avg_time_watched_actions, { list: 'AdsActionStats' }
     field :video_complete_watched_actions, { list: 'AdsActionStats' }
     field :video_completed_view_or_15s_passed_actions, { list: 'AdsActionStats' }
@@ -345,7 +344,6 @@ module FacebookAds
     field :video_p25_watched_actions, { list: 'AdsActionStats' }
     field :video_p50_watched_actions, { list: 'AdsActionStats' }
     field :video_p75_watched_actions, { list: 'AdsActionStats' }
-    field :video_p95_watched_actions, { list: 'AdsActionStats' }
     field :video_play_actions, { list: 'AdsActionStats' }
     field :video_play_curve_actions, { list: 'object' }
     field :video_play_retention_0_to_15s_actions, { list: 'object' }

data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb

@@ -37,10 +37,9 @@ module FacebookAds
       "event_source",
       "event_total_counts",
       "event_value_count",
+      "had_pii",
       "host",
-      "people_reached",
-      "pii_keys",
-      "pii_lift",
+      "match_keys",
       "pixel_fire",
       "url",
       "url_by_rule",

data/lib/facebook_ads/ad_objects/application.rb

@@ -148,7 +148,6 @@ module FacebookAds
     field :ios_supports_system_auth, 'bool'
     field :ipad_app_store_id, 'string'
     field :iphone_app_store_id, 'string'
-    field :is_viewer_admin, 'bool'
     field :latest_sdk_version, 'object'
     field :link, 'string'
     field :logging_token, 'string'
@@ -304,6 +303,20 @@ module FacebookAds
       end
     end
 
+    has_edge :app_insights do |edge|
+      edge.get do |api|
+        api.has_param :aggregateby, { enum: %w{AVERAGE_JOURNEY_LENGTH CONVERTED_JOURNEY_PERCENT COUNT COUNT_IDENTIFIED_USERS COUNT_PER_USER DAU EVENT_SOURCE_IDS JOURNEY_CHANNEL_INCLUSION JOURNEY_INCLUSION MAU MEDIAN_JOURNEY_LENGTH MEDIAN_VALUE MEDIAN_VALUE_PER_USER OVERLAP PERCENTILES_COUNT PERCENTILES_USD_VALUE PERCENTILES_VALUE SCORE SESSIONS_PER_JOURNEY SESSION_BOUNCE_RATE SUM SUM_IDENTIFIED_USERS SUM_PER_EVENT TOPK UNKNOWN_USERS USD_SUM USD_SUM_IDENTIFIED_USERS USD_SUM_PER_EVENT USD_SUM_PER_USER USD_VALUE_PER_USER USERS USER_PROPERTY_USER_COUNT VALUE_PER_USER WAU }}
+        api.has_param :breakdowns, { list: 'string' }
+        api.has_param :ecosystem, { enum: %w{GAME NON_GAME }}
+        api.has_param :event_name, 'string'
+        api.has_param :intervals_to_aggregate, 'int'
+        api.has_param :metric_key, 'string'
+        api.has_param :period, { enum: %w{daily days_28 days_60 days_90 hourly lifetime mins_15 monthly range weekly }}
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+      end
+    end
+
     has_edge :app_installed_groups do |edge|
       edge.get 'Group' do |api|
         api.has_param :group_id, 'string'
@@ -475,6 +488,9 @@ module FacebookAds
     end
 
     has_edge :objects do |edge|
+      edge.get 'OpenGraphObject' do |api|
+        api.has_param :type, 'object'
+      end
       edge.post 'OpenGraphObject' do |api|
         api.has_param :object, 'object'
         api.has_param :type, 'string'

data/lib/facebook_ads/ad_objects/brand_audience.rb

@@ -0,0 +1,44 @@
+# 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 BrandAudience < AdObject
+
+    field :account, 'AdAccount'
+    field :delivery_targeting, 'Targeting'
+    field :description, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :sentence_lines, { list: 'string' }
+    field :status, 'string'
+    field :targeting, 'Targeting'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/business.rb

@@ -61,6 +61,7 @@ module FacebookAds
       "ADVERTISE",
       "ANALYZE",
       "CREATIVE",
+      "DRAFT",
       "FB_EMPLOYEE_DSO_ADVERTISE",
       "MANAGE",
     ]
@@ -83,6 +84,7 @@ module FacebookAds
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
       "PAGES_MESSAGING_SUBSCRIPTIONS",
+      "PLATFORM_MANAGE_PAGES",
       "READ_PAGE_MAILBOXES",
       "VIEW_MONETIZATION_INSIGHTS",
     ]
@@ -254,6 +256,18 @@ module FacebookAds
       end
     end
 
+    has_edge :business_invoices do |edge|
+      edge.get 'OracleTransaction' do |api|
+        api.has_param :end_date, 'string'
+        api.has_param :invoice_id, 'int'
+        api.has_param :issue_end_date, 'string'
+        api.has_param :issue_start_date, 'string'
+        api.has_param :root_id, 'int'
+        api.has_param :start_date, 'string'
+        api.has_param :type, { enum: -> { OracleTransaction::TYPE }}
+      end
+    end
+
     has_edge :business_users do |edge|
       edge.get 'BusinessUser'
       edge.post 'BusinessUser' do |api|
@@ -322,6 +336,7 @@ module FacebookAds
     has_edge :creative_folders do |edge|
       edge.get 'BusinessCreativeFolder'
       edge.post 'BusinessCreativeFolder' do |api|
+        api.has_param :description, 'string'
         api.has_param :name, 'string'
       end
     end
@@ -377,6 +392,13 @@ module FacebookAds
       end
     end
 
+    has_edge :initiated_audience_sharing_requests do |edge|
+      edge.get 'BusinessAssetSharingAgreement' do |api|
+        api.has_param :recipient_id, 'string'
+        api.has_param :request_status, { enum: -> { BusinessAssetSharingAgreement::REQUEST_STATUS }}
+      end
+    end
+
     has_edge :initiated_sharing_agreements do |edge|
       edge.get 'BusinessAgreement' do |api|
         api.has_param :receiving_business_id, 'string'
@@ -545,6 +567,13 @@ module FacebookAds
       end
     end
 
+    has_edge :received_audience_sharing_requests do |edge|
+      edge.get 'BusinessAssetSharingAgreement' do |api|
+        api.has_param :initiator_id, 'string'
+        api.has_param :request_status, { enum: -> { BusinessAssetSharingAgreement::REQUEST_STATUS }}
+      end
+    end
+
     has_edge :received_inprogress_onbehalf_requests do |edge|
       edge.get 'BusinessOwnedObjectOnBehalfOfRequest'
     end
@@ -581,11 +610,6 @@ module FacebookAds
 
     has_edge :third_party_measurement_report_dataset do |edge|
       edge.get 'ThirdPartyMeasurementReportDataset'
-      edge.post 'ThirdPartyMeasurementReportDataset' do |api|
-        api.has_param :category, { enum: -> { ThirdPartyMeasurementReportDataset::CATEGORY }}
-        api.has_param :product, { enum: -> { ThirdPartyMeasurementReportDataset::PRODUCT }}
-        api.has_param :schema, { list: 'hash' }
-      end
     end
 
     has_edge :upload_event do |edge|

data/lib/facebook_ads/ad_objects/business_advertisable_applications_result.rb

@@ -27,6 +27,8 @@ module FacebookAds
 
   class BusinessAdvertisableApplicationsResult < AdObject
 
+    field :are_app_events_unavailable, 'bool'
+    field :business, 'Business'
     field :has_insight_permission, 'bool'
     field :id, 'string'
     field :name, 'string'

data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb

@@ -0,0 +1,46 @@
+# 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 BusinessAssetSharingAgreement < AdObject
+    REQUEST_STATUS = [
+      "APPROVE",
+      "DECLINE",
+      "EXPIRED",
+      "IN_PROGRESS",
+    ]
+
+
+    field :id, 'string'
+    field :initiator, 'Business'
+    field :recipient, 'Business'
+    field :relationship_type, { list: 'string' }
+    field :request_status, 'string'
+    field :request_type, 'string'
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/business_creative_folder.rb

@@ -47,6 +47,7 @@ module FacebookAds
     field :creation_time, 'datetime'
     field :id, 'string'
     field :name, 'string'
+    field :description, 'string'
 
     has_edge :agencies do |edge|
       edge.delete do |api|

data/lib/facebook_ads/ad_objects/campaign.rb

@@ -43,7 +43,9 @@ module FacebookAds
       "ACTIVE",
       "ARCHIVED",
       "DELETED",
+      "IN_PROCESS",
       "PAUSED",
+      "WITH_ISSUES",
     ]
 
     STATUS = [
@@ -145,6 +147,10 @@ module FacebookAds
     field :iterative_split_test_configs, { list: 'object' }
     field :upstream_events, 'hash'
 
+    has_edge :ad_studies do |edge|
+      edge.get 'AdStudy'
+    end
+
     has_edge :adlabels do |edge|
       edge.delete do |api|
         api.has_param :adlabels, { list: 'object' }

data/lib/facebook_ads/ad_objects/{copyright_attribution_insights.rb → canvas_body_element.rb}

@@ -25,13 +25,9 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class CopyrightAttributionInsights < AdObject
+  class CanvasBodyElement < AdObject
 
-    field :l7_attribution_page_view, 'int'
-    field :l7_attribution_page_view_delta, 'double'
-    field :l7_attribution_video_view, 'int'
-    field :l7_attribution_video_view_delta, 'double'
-    field :metrics_ending_date, 'string'
+    field :element, 'object'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/check_batch_request_status.rb

@@ -30,7 +30,7 @@ module FacebookAds
     field :errors, { list: 'object' }
     field :errors_total_count, 'int'
     field :handle, 'string'
-    field :invalid_item_ids, { list: 'string' }
+    field :ids_of_invalid_requests, { list: 'string' }
     field :status, 'string'
     field :warnings, { list: 'object' }
     field :warnings_total_count, 'int'

data/lib/facebook_ads/ad_objects/comment.rb

@@ -59,6 +59,7 @@ module FacebookAds
     field :can_hide, 'bool'
     field :can_like, 'bool'
     field :can_remove, 'bool'
+    field :can_reply_privately, 'bool'
     field :comment_count, 'int'
     field :created_time, 'datetime'
     field :from, 'object'
@@ -72,6 +73,7 @@ module FacebookAds
     field :object, 'object'
     field :parent, 'Comment'
     field :permalink_url, 'string'
+    field :private_reply_conversation, 'object'
     field :user_likes, 'bool'
 
     has_edge :comments do |edge|
@@ -81,6 +83,21 @@ module FacebookAds
         api.has_param :order, { enum: -> { Comment::ORDER }}
         api.has_param :since, 'datetime'
       end
+      edge.post 'Comment' do |api|
+        api.has_param :attachment_id, 'string'
+        api.has_param :attachment_share_url, 'string'
+        api.has_param :attachment_url, 'string'
+        api.has_param :comment_privacy_value, { enum: -> { Comment::COMMENT_PRIVACY_VALUE }}
+        api.has_param :facepile_mentioned_ids, { list: 'string' }
+        api.has_param :feedback_source, 'string'
+        api.has_param :is_offline, 'bool'
+        api.has_param :message, 'string'
+        api.has_param :nectar_module, 'string'
+        api.has_param :object_id, 'string'
+        api.has_param :parent_comment_id, 'object'
+        api.has_param :text, 'string'
+        api.has_param :tracking, 'string'
+      end
     end
 
     has_edge :likes do |edge|
@@ -97,6 +114,12 @@ module FacebookAds
       end
     end
 
+    has_edge :private_replies do |edge|
+      edge.post do |api|
+        api.has_param :message, 'string'
+      end
+    end
+
     has_edge :reactions do |edge|
       edge.get 'Profile' do |api|
         api.has_param :type, { enum: -> { Profile::TYPE }}

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -166,24 +166,15 @@ module FacebookAds
     end
 
     has_edge :capabilities do |edge|
+      edge.delete do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
       edge.post do |api|
         api.has_param :accounts_capabilities, 'string'
         api.has_param :relationship_type, { list: 'string' }
       end
     end
 
-    has_edge :data do |edge|
-      edge.post do |api|
-        api.has_param :action_type, { enum: %w{add match optout remove }}
-        api.has_param :batch_seq, 'int'
-        api.has_param :encoding, { enum: %w{md5 plain sha256 }}
-        api.has_param :entries, { list: 'string' }
-        api.has_param :entry_type, { enum: %w{0 1 2 3 4 5 6 }}
-        api.has_param :last_batch_flag, 'bool'
-        api.has_param :session_id, 'int'
-      end
-    end
-
     has_edge :prefills do |edge|
       edge.get 'CustomAudiencePrefillState'
     end

data/lib/facebook_ads/ad_objects/event.rb

@@ -26,6 +26,34 @@ module FacebookAds
   # pull request for this class.
 
   class Event < AdObject
+    CATEGORY = [
+      "ART_EVENT",
+      "BOOK_EVENT",
+      "CLASS_EVENT",
+      "COMEDY_EVENT",
+      "CONFERENCE_EVENT",
+      "DANCE_EVENT",
+      "DINING_EVENT",
+      "FAMILY_EVENT",
+      "FESTIVAL_EVENT",
+      "FITNESS",
+      "FOOD_TASTING",
+      "FUNDRAISER",
+      "LECTURE",
+      "MEETUP",
+      "MOVIE_EVENT",
+      "MUSIC_EVENT",
+      "NEIGHBORHOOD",
+      "NIGHTLIFE",
+      "OTHER",
+      "RELIGIOUS_EVENT",
+      "SHOPPING",
+      "SPORTS_EVENT",
+      "THEATER_EVENT",
+      "VOLUNTEERING",
+      "WORKSHOP",
+    ]
+
     TYPE = [
       "community",
       "group",
@@ -54,7 +82,7 @@ module FacebookAds
 
     field :attending_count, 'int'
     field :can_guests_invite, 'bool'
-    field :category, 'string'
+    field :category, { enum: -> { CATEGORY }}
     field :cover, 'CoverPhoto'
     field :declined_count, 'int'
     field :description, 'string'
@@ -198,7 +226,7 @@ module FacebookAds
         api.has_param :time_since_original_post, 'int'
         api.has_param :title, 'string'
         api.has_param :tracking_info, 'string'
-        api.has_param :unpublished_content_type, { enum: %w{ADS_POST DRAFT INLINE_CREATED PUBLISHED SCHEDULED }}
+        api.has_param :unpublished_content_type, { enum: %w{ADS_POST DRAFT INLINE_CREATED PUBLISHED SCHEDULED SCHEDULED_RECURRING }}
         api.has_param :user_selected_tags, 'bool'
         api.has_param :video_start_time_ms, 'int'
         api.has_param :viewer_coordinates, 'object'
@@ -208,7 +236,6 @@ module FacebookAds
 
     has_edge :live_videos do |edge|
       edge.post 'LiveVideo' do |api|
-        api.has_param :attribution_app_id, 'string'
         api.has_param :content_tags, { list: 'string' }
         api.has_param :description, 'string'
         api.has_param :encoding_settings, 'string'