facebookbusiness 20.0.1 → 20.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad_account.rb +29 -1
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +57 -0
- data/lib/facebook_ads/ad_objects/ad_account_recommendations.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/{product_feed_missing_feed_item_replacement.rb → ad_campaign_conversion_value_expression_spec.rb} +4 -4
- data/lib/facebook_ads/ad_objects/ad_creative.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +2 -0
- data/lib/facebook_ads/ad_objects/{product_catalog_example_feed.rb → ad_creative_destination_spec.rb} +2 -2
- data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +0 -6
- data/lib/facebook_ads/ad_objects/ad_creative_feature_details.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_layer_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_moment.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_creative_marketing_message_structured_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_site_links_spec.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +15 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +2 -6
- data/lib/facebook_ads/ad_objects/adjacent_content_delivery_report.rb +2 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +5 -1
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +3 -1
- data/lib/facebook_ads/ad_objects/alm_ad_account_info.rb +30 -0
- data/lib/facebook_ads/ad_objects/alm_end_advertiser_info.rb +27 -0
- data/lib/facebook_ads/ad_objects/alm_event.rb +34 -0
- data/lib/facebook_ads/ad_objects/alm_guidance.rb +28 -0
- data/lib/facebook_ads/ad_objects/alm_guidance_metrics.rb +37 -0
- data/lib/facebook_ads/ad_objects/application.rb +1 -0
- data/lib/facebook_ads/ad_objects/automotive_model.rb +7 -4
- data/lib/facebook_ads/ad_objects/{page_videos_you_can_use.rb → brand_safety_campaign_config.rb} +3 -4
- data/lib/facebook_ads/ad_objects/business.rb +21 -1
- data/lib/facebook_ads/ad_objects/business_role_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +6 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +1 -0
- data/lib/facebook_ads/ad_objects/catalog_item_rejection_reasons.rb +1 -0
- data/lib/facebook_ads/ad_objects/catalog_smart_pixel_settings.rb +0 -3
- data/lib/facebook_ads/ad_objects/commerce_order.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_order_transaction_detail.rb +5 -0
- data/lib/facebook_ads/ad_objects/{cpas_setup_catalog_progress.rb → content_block_list.rb} +14 -5
- data/lib/facebook_ads/ad_objects/ctwa_whats_app_numbers_info.rb +1 -0
- data/lib/facebook_ads/ad_objects/ctx_partner_app_welcome_message_flow.rb +2 -0
- data/lib/facebook_ads/ad_objects/{vidwalla_broadcast.rb → dataset.rb} +3 -2
- data/lib/facebook_ads/ad_objects/destination.rb +7 -4
- data/lib/facebook_ads/ad_objects/flight.rb +7 -4
- data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +3 -0
- data/lib/facebook_ads/ad_objects/group.rb +0 -2
- data/lib/facebook_ads/ad_objects/home_listing.rb +7 -4
- data/lib/facebook_ads/ad_objects/hotel.rb +7 -4
- data/lib/facebook_ads/ad_objects/ig_media.rb +5 -4
- data/lib/facebook_ads/ad_objects/ig_media_for_ig_only_api.rb +9 -1
- data/lib/facebook_ads/ad_objects/ig_refresh_access_token_for_ig_only_api.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_upcoming_event.rb +23 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +5 -2
- data/lib/facebook_ads/ad_objects/{bcp_creator_ig_user.rb → ig_user_export_for_cam.rb} +1 -1
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +101 -0
- data/lib/facebook_ads/ad_objects/insights_result.rb +7 -190
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +5 -0
- data/lib/facebook_ads/ad_objects/instagram_user.rb +2 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +4 -0
- data/lib/facebook_ads/ad_objects/local_service_business.rb +7 -0
- data/lib/facebook_ads/ad_objects/media_title.rb +7 -4
- data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +73 -0
- data/lib/facebook_ads/ad_objects/messaging_apps_info.rb +1 -0
- data/lib/facebook_ads/ad_objects/offline_product_item.rb +7 -0
- data/lib/facebook_ads/ad_objects/{instant_article_cta.rb → override_details.rb} +10 -5
- data/lib/facebook_ads/ad_objects/page.rb +9 -13
- data/lib/facebook_ads/ad_objects/page_ctx_messaging_feature_limit.rb +27 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +6 -2
- data/lib/facebook_ads/ad_objects/{user_set_reporting_root.rb → product_delivery_preference.rb} +4 -3
- data/lib/facebook_ads/ad_objects/product_group.rb +5 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +18 -1
- data/lib/facebook_ads/ad_objects/reseller_guidance.rb +0 -3
- data/lib/facebook_ads/ad_objects/server_side/event_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/server_side/util.rb +1 -1
- data/lib/facebook_ads/ad_objects/{product_catalog_microdata_stats_pixel_info.rb → shadow_ig_user_partnership_ads_media_errors.rb} +5 -3
- data/lib/facebook_ads/ad_objects/stories.rb +7 -2
- data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb +14 -2
- data/lib/facebook_ads/ad_objects/transactable_item.rb +7 -0
- data/lib/facebook_ads/ad_objects/user.rb +1 -2
- data/lib/facebook_ads/ad_objects/vehicle.rb +7 -4
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +7 -4
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +69 -1
- data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb +2 -0
- data/lib/facebook_ads/version.rb +1 -1
- metadata +20 -19
- data/lib/facebook_ads/ad_objects/adoptable_pet.rb +0 -77
- data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb +0 -36
- data/lib/facebook_ads/ad_objects/expirable_post.rb +0 -43
- data/lib/facebook_ads/ad_objects/generic_video_asset.rb +0 -69
- data/lib/facebook_ads/ad_objects/location_based_item.rb +0 -53
- data/lib/facebook_ads/ad_objects/video_asset.rb +0 -75
@@ -14,9 +14,32 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class IgUpcomingEvent < AdObject
|
17
|
+
NOTIFICATION_SUBTYPES = [
|
18
|
+
"AFTER_EVENT_1DAY",
|
19
|
+
"AFTER_EVENT_2DAY",
|
20
|
+
"AFTER_EVENT_3DAY",
|
21
|
+
"AFTER_EVENT_4DAY",
|
22
|
+
"AFTER_EVENT_5DAY",
|
23
|
+
"AFTER_EVENT_6DAY",
|
24
|
+
"AFTER_EVENT_7DAY",
|
25
|
+
"BEFORE_EVENT_15MIN",
|
26
|
+
"BEFORE_EVENT_1DAY",
|
27
|
+
"BEFORE_EVENT_1HOUR",
|
28
|
+
"BEFORE_EVENT_2DAY",
|
29
|
+
"EVENT_START",
|
30
|
+
"RESCHEDULED",
|
31
|
+
]
|
32
|
+
|
33
|
+
NOTIFICATION_TARGET_TIME = [
|
34
|
+
"EVENT_END",
|
35
|
+
"EVENT_START",
|
36
|
+
]
|
37
|
+
|
17
38
|
|
18
39
|
field :end_time, 'datetime'
|
19
40
|
field :id, 'string'
|
41
|
+
field :notification_subtypes, { list: 'string' }
|
42
|
+
field :notification_target_time, 'string'
|
20
43
|
field :start_time, 'datetime'
|
21
44
|
field :title, 'string'
|
22
45
|
has_no_delete
|
@@ -49,6 +49,7 @@ module FacebookAds
|
|
49
49
|
|
50
50
|
has_edge :branded_content_advertisable_medias do |edge|
|
51
51
|
edge.get 'BrandedContentShadowIgMediaId' do |api|
|
52
|
+
api.has_param :ad_code, 'string'
|
52
53
|
api.has_param :creator_username, 'string'
|
53
54
|
api.has_param :only_fetch_allowlisted, 'bool'
|
54
55
|
api.has_param :permalinks, { list: 'string' }
|
@@ -81,8 +82,10 @@ module FacebookAds
|
|
81
82
|
end
|
82
83
|
|
83
84
|
has_edge :dataset do |edge|
|
84
|
-
edge.get '
|
85
|
-
edge.post '
|
85
|
+
edge.get 'Dataset'
|
86
|
+
edge.post 'Dataset' do |api|
|
87
|
+
api.has_param :dataset_name, 'string'
|
88
|
+
end
|
86
89
|
end
|
87
90
|
|
88
91
|
has_edge :insights do |edge|
|
@@ -13,7 +13,7 @@ module FacebookAds
|
|
13
13
|
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
|
-
class
|
16
|
+
class IgUserExportForCam < AdObject
|
17
17
|
|
18
18
|
field :email, 'string'
|
19
19
|
field :id, 'string'
|
@@ -16,12 +16,34 @@ module FacebookAds
|
|
16
16
|
class IgUserForIgOnlyApi < AdObject
|
17
17
|
|
18
18
|
field :account_type, 'string'
|
19
|
+
field :biography, 'string'
|
20
|
+
field :followers_count, 'int'
|
21
|
+
field :follows_count, 'int'
|
19
22
|
field :id, 'string'
|
20
23
|
field :media_count, 'int'
|
24
|
+
field :name, 'string'
|
25
|
+
field :profile_picture_url, 'string'
|
26
|
+
field :user_id, 'int'
|
21
27
|
field :username, 'string'
|
28
|
+
field :website, 'string'
|
22
29
|
has_no_post
|
23
30
|
has_no_delete
|
24
31
|
|
32
|
+
has_edge :content_publishing_limit do |edge|
|
33
|
+
edge.get 'ContentPublishingLimitResponse' do |api|
|
34
|
+
api.has_param :since, 'datetime'
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
has_edge :conversations do |edge|
|
39
|
+
edge.get 'UnifiedThread' do |api|
|
40
|
+
api.has_param :folder, 'string'
|
41
|
+
api.has_param :platform, { enum: -> { UnifiedThread::PLATFORM }}
|
42
|
+
api.has_param :tags, { list: 'string' }
|
43
|
+
api.has_param :user_id, 'string'
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
25
47
|
has_edge :live_media do |edge|
|
26
48
|
edge.get
|
27
49
|
end
|
@@ -31,11 +53,90 @@ module FacebookAds
|
|
31
53
|
api.has_param :since, 'datetime'
|
32
54
|
api.has_param :until, 'datetime'
|
33
55
|
end
|
56
|
+
edge.post do |api|
|
57
|
+
api.has_param :audio_name, 'string'
|
58
|
+
api.has_param :caption, 'string'
|
59
|
+
api.has_param :children, { list: 'string' }
|
60
|
+
api.has_param :collaborators, { list: 'string' }
|
61
|
+
api.has_param :cover_url, 'string'
|
62
|
+
api.has_param :image_url, 'string'
|
63
|
+
api.has_param :is_carousel_item, 'bool'
|
64
|
+
api.has_param :location_id, 'string'
|
65
|
+
api.has_param :media_type, 'string'
|
66
|
+
api.has_param :product_tags, { list: 'hash' }
|
67
|
+
api.has_param :share_to_feed, 'bool'
|
68
|
+
api.has_param :thumb_offset, 'string'
|
69
|
+
api.has_param :upload_type, 'string'
|
70
|
+
api.has_param :user_tags, { list: 'hash' }
|
71
|
+
api.has_param :video_url, 'string'
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
has_edge :mediapublish do |edge|
|
76
|
+
edge.post do |api|
|
77
|
+
api.has_param :creation_id, 'int'
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
has_edge :mentions do |edge|
|
82
|
+
edge.post do |api|
|
83
|
+
api.has_param :comment_id, 'string'
|
84
|
+
api.has_param :media_id, 'string'
|
85
|
+
api.has_param :message, 'string'
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
has_edge :messageattachments do |edge|
|
90
|
+
edge.post do |api|
|
91
|
+
api.has_param :message, 'object'
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
has_edge :messages do |edge|
|
96
|
+
edge.post do |api|
|
97
|
+
api.has_param :message, 'object'
|
98
|
+
api.has_param :messaging_type, { enum: %w{MESSAGE_TAG RESPONSE UPDATE UTILITY }}
|
99
|
+
api.has_param :payload, 'string'
|
100
|
+
api.has_param :recipient, 'object'
|
101
|
+
api.has_param :sender_action, { enum: %w{MARK_SEEN REACT TYPING_OFF TYPING_ON UNREACT }}
|
102
|
+
api.has_param :tag, 'object'
|
103
|
+
api.has_param :thread_control, 'object'
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
has_edge :messenger_profile do |edge|
|
108
|
+
edge.delete do |api|
|
109
|
+
api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS PAYMENT_SETTINGS PERSISTENT_MENU PLATFORM SUBJECT_TO_NEW_EU_PRIVACY_RULES TARGET_AUDIENCE TITLE WHITELISTED_DOMAINS }} }
|
110
|
+
end
|
111
|
+
edge.get
|
112
|
+
edge.post do |api|
|
113
|
+
api.has_param :ice_breakers, { list: 'hash' }
|
114
|
+
api.has_param :persistent_menu, { list: 'object' }
|
115
|
+
end
|
34
116
|
end
|
35
117
|
|
36
118
|
has_edge :stories do |edge|
|
37
119
|
edge.get
|
38
120
|
end
|
39
121
|
|
122
|
+
has_edge :subscribed_apps do |edge|
|
123
|
+
edge.delete
|
124
|
+
edge.get
|
125
|
+
edge.post do |api|
|
126
|
+
api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen standby story_insights }} }
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
130
|
+
has_edge :tags do |edge|
|
131
|
+
edge.get
|
132
|
+
end
|
133
|
+
|
134
|
+
has_edge :welcome_message_flows do |edge|
|
135
|
+
edge.get 'CtxPartnerAppWelcomeMessageFlow' do |api|
|
136
|
+
api.has_param :app_id, 'string'
|
137
|
+
api.has_param :flow_id, 'string'
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
40
141
|
end
|
41
142
|
end
|
@@ -47,196 +47,13 @@ module FacebookAds
|
|
47
47
|
]
|
48
48
|
|
49
49
|
METRIC = [
|
50
|
-
"
|
51
|
-
"
|
52
|
-
"
|
53
|
-
"
|
54
|
-
"
|
55
|
-
"
|
56
|
-
"
|
57
|
-
"fb_media_matching_copyright_daily_post_impressions_by_country",
|
58
|
-
"fb_media_matching_copyright_daily_post_impressions_by_locale",
|
59
|
-
"fb_media_matching_copyright_daily_post_impressions_by_matching_post_id",
|
60
|
-
"fb_media_matching_copyright_daily_post_impressions_by_matching_post_owner_id",
|
61
|
-
"fb_media_matching_copyright_daily_post_reactions_anger_count",
|
62
|
-
"fb_media_matching_copyright_daily_post_reactions_haha_count",
|
63
|
-
"fb_media_matching_copyright_daily_post_reactions_like_count",
|
64
|
-
"fb_media_matching_copyright_daily_post_reactions_love_count",
|
65
|
-
"fb_media_matching_copyright_daily_post_reactions_sorry_count",
|
66
|
-
"fb_media_matching_copyright_daily_post_reactions_wow_count",
|
67
|
-
"fb_media_matching_copyright_daily_post_share_count",
|
68
|
-
"fb_media_matching_copyright_like_count",
|
69
|
-
"fb_media_matching_copyright_post_impressions",
|
70
|
-
"fb_media_matching_copyright_post_impressions_by_age_bucket_and_gender",
|
71
|
-
"fb_media_matching_copyright_post_impressions_by_country",
|
72
|
-
"fb_media_matching_copyright_post_impressions_by_locale",
|
73
|
-
"fb_media_matching_copyright_post_impressions_by_matching_post_id",
|
74
|
-
"fb_media_matching_copyright_post_impressions_by_matching_post_owner_id",
|
75
|
-
"fb_media_matching_copyright_post_reactions_anger_count",
|
76
|
-
"fb_media_matching_copyright_post_reactions_haha_count",
|
77
|
-
"fb_media_matching_copyright_post_reactions_like_count",
|
78
|
-
"fb_media_matching_copyright_post_reactions_love_count",
|
79
|
-
"fb_media_matching_copyright_post_reactions_sorry_count",
|
80
|
-
"fb_media_matching_copyright_post_reactions_wow_count",
|
81
|
-
"fb_media_matching_copyright_post_share_count",
|
82
|
-
"fb_reels_replay_count",
|
83
|
-
"fb_reels_total_plays",
|
84
|
-
"has_total_video_views_by_publisher_platform_type",
|
85
|
-
"post_impressions_unique",
|
86
|
-
"post_video_avg_time_watched",
|
87
|
-
"post_video_followers",
|
88
|
-
"post_video_likes_by_reaction_type",
|
89
|
-
"post_video_retention_graph",
|
90
|
-
"post_video_social_actions",
|
91
|
-
"post_video_view_time",
|
92
|
-
"rights_manager_matching_copyright_matching_page_or_profile_view_count",
|
93
|
-
"rights_manager_matching_copyright_matching_video_view_count",
|
94
|
-
"rights_manager_matching_copyright_video_view_count",
|
95
|
-
"rights_manager_matching_copyright_video_view_count_60s",
|
96
|
-
"rights_manager_matching_copyright_video_view_count_60s_by_age_bucket_and_gender",
|
97
|
-
"rights_manager_matching_copyright_video_view_count_60s_by_country_id",
|
98
|
-
"rights_manager_matching_copyright_video_view_count_60s_by_locale",
|
99
|
-
"total_audio_only_product_listen_count",
|
100
|
-
"total_video_10s_views",
|
101
|
-
"total_video_10s_views_auto_played",
|
102
|
-
"total_video_10s_views_clicked_to_play",
|
103
|
-
"total_video_10s_views_organic",
|
104
|
-
"total_video_10s_views_paid",
|
105
|
-
"total_video_10s_views_sound_on",
|
106
|
-
"total_video_10s_views_unique",
|
107
|
-
"total_video_15s_views",
|
108
|
-
"total_video_30s_views",
|
109
|
-
"total_video_30s_views_auto_played",
|
110
|
-
"total_video_30s_views_clicked_to_play",
|
111
|
-
"total_video_30s_views_organic",
|
112
|
-
"total_video_30s_views_paid",
|
113
|
-
"total_video_30s_views_unique",
|
114
|
-
"total_video_60s_excludes_shorter_views",
|
115
|
-
"total_video_60s_excludes_shorter_views_by_age_bucket_and_gender",
|
116
|
-
"total_video_60s_excludes_shorter_views_by_distribution_source",
|
117
|
-
"total_video_60s_excludes_shorter_views_by_growth_accounting_bucket",
|
118
|
-
"total_video_60s_excludes_shorter_views_by_growth_accounting_bucket_and_time_since_creation_bucket",
|
119
|
-
"total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer",
|
120
|
-
"total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer_and_time_since_creation_bucket",
|
121
|
-
"total_video_60s_excludes_shorter_views_live",
|
122
|
-
"total_video_60s_excludes_shorter_views_unique",
|
123
|
-
"total_video_60s_excludes_shorter_views_unique_by_age_bucket_and_gender",
|
124
|
-
"total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket",
|
125
|
-
"total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket_and_time_since_creation_bucket",
|
126
|
-
"total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer",
|
127
|
-
"total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer_and_time_since_creation_bucket",
|
128
|
-
"total_video_ad_break_ad_cpm",
|
129
|
-
"total_video_ad_break_ad_impressions",
|
130
|
-
"total_video_ad_break_earnings",
|
131
|
-
"total_video_ad_break_earnings_with_subsidy",
|
132
|
-
"total_video_ad_impressions_by_monetization_type",
|
133
|
-
"total_video_avg_time_watched",
|
134
|
-
"total_video_avg_time_watched_by_distribution_source",
|
135
|
-
"total_video_avg_time_watched_by_is_60s_returning_viewer",
|
136
|
-
"total_video_avg_time_watched_by_time_since_creation_bucket",
|
137
|
-
"total_video_avg_time_watched_followers",
|
138
|
-
"total_video_avg_time_watched_live",
|
139
|
-
"total_video_comment_sentiment",
|
140
|
-
"total_video_comment_sentiment_by_factors",
|
141
|
-
"total_video_complete_views",
|
142
|
-
"total_video_complete_views_auto_played",
|
143
|
-
"total_video_complete_views_clicked_to_play",
|
144
|
-
"total_video_complete_views_organic",
|
145
|
-
"total_video_complete_views_organic_unique",
|
146
|
-
"total_video_complete_views_paid",
|
147
|
-
"total_video_complete_views_paid_unique",
|
148
|
-
"total_video_complete_views_unique",
|
149
|
-
"total_video_consumption_rate",
|
150
|
-
"total_video_followers_unique",
|
151
|
-
"total_video_growth_score",
|
152
|
-
"total_video_growth_score_by_factors",
|
153
|
-
"total_video_impressions",
|
154
|
-
"total_video_impressions_fan",
|
155
|
-
"total_video_impressions_fan_paid",
|
156
|
-
"total_video_impressions_fan_paid_unique",
|
157
|
-
"total_video_impressions_fan_unique",
|
158
|
-
"total_video_impressions_organic",
|
159
|
-
"total_video_impressions_organic_unique",
|
160
|
-
"total_video_impressions_paid",
|
161
|
-
"total_video_impressions_paid_unique",
|
162
|
-
"total_video_impressions_unique",
|
163
|
-
"total_video_impressions_viral",
|
164
|
-
"total_video_impressions_viral_unique",
|
165
|
-
"total_video_imps_count_unique_by_age_bucket",
|
166
|
-
"total_video_imps_count_unique_by_age_bucket_and_gender",
|
167
|
-
"total_video_imps_count_unique_by_gender",
|
168
|
-
"total_video_likes_by_reaction_type",
|
169
|
-
"total_video_negative_feedback",
|
170
|
-
"total_video_net_followers",
|
171
|
-
"total_video_net_followers_unique",
|
172
|
-
"total_video_net_followers_unique_by_time_since_creation_bucket",
|
173
|
-
"total_video_play_count",
|
174
|
-
"total_video_play_count_by_is_60s_returning_viewer_and_time_since_creation_bucket",
|
175
|
-
"total_video_play_count_by_time_since_creation_bucket",
|
176
|
-
"total_video_reactions_by_type_total",
|
177
|
-
"total_video_relative_retention_graph",
|
178
|
-
"total_video_retention_graph",
|
179
|
-
"total_video_retention_graph_15s",
|
180
|
-
"total_video_retention_graph_15s_followers",
|
181
|
-
"total_video_retention_graph_15s_newsfeed",
|
182
|
-
"total_video_retention_graph_15s_recommended",
|
183
|
-
"total_video_retention_graph_15s_shares",
|
184
|
-
"total_video_retention_graph_15s_watch",
|
185
|
-
"total_video_retention_graph_autoplayed",
|
186
|
-
"total_video_retention_graph_clicked_to_play",
|
187
|
-
"total_video_retention_graph_gender_female",
|
188
|
-
"total_video_retention_graph_gender_male",
|
189
|
-
"total_video_social_actions",
|
190
|
-
"total_video_social_actions_comment_by_distribution_type",
|
191
|
-
"total_video_social_actions_count_unique",
|
192
|
-
"total_video_social_actions_count_unique_by_age_bucket",
|
193
|
-
"total_video_social_actions_count_unique_by_age_bucket_and_gender",
|
194
|
-
"total_video_social_actions_count_unique_by_gender",
|
195
|
-
"total_video_social_actions_reaction_by_distribution_type",
|
196
|
-
"total_video_stories_by_action_type",
|
197
|
-
"total_video_unfollowers",
|
198
|
-
"total_video_unfollowers_unique",
|
199
|
-
"total_video_view_count_unique_by_age_bucket",
|
200
|
-
"total_video_view_count_unique_by_age_bucket_and_gender",
|
201
|
-
"total_video_view_count_unique_by_gender",
|
202
|
-
"total_video_view_time_by_age_bucket_and_gender",
|
203
|
-
"total_video_view_time_by_country_id",
|
204
|
-
"total_video_view_time_by_distribution_source",
|
205
|
-
"total_video_view_time_by_distribution_type",
|
206
|
-
"total_video_view_time_by_is_60s_returning_viewer_and_time_since_creation_bucket",
|
207
|
-
"total_video_view_time_by_region_id",
|
208
|
-
"total_video_view_time_by_time_since_creation_bucket",
|
209
|
-
"total_video_view_total_time",
|
210
|
-
"total_video_view_total_time_by_is_60s_returning_viewer",
|
211
|
-
"total_video_view_total_time_by_paid_non_paid",
|
212
|
-
"total_video_view_total_time_live",
|
213
|
-
"total_video_view_total_time_organic",
|
214
|
-
"total_video_view_total_time_paid",
|
215
|
-
"total_video_view_total_time_vod",
|
216
|
-
"total_video_views",
|
217
|
-
"total_video_views_autoplayed",
|
218
|
-
"total_video_views_by_age_bucket_and_gender",
|
219
|
-
"total_video_views_by_country_id",
|
220
|
-
"total_video_views_by_distribution_type",
|
221
|
-
"total_video_views_by_paid_non_paid",
|
222
|
-
"total_video_views_by_region_id",
|
223
|
-
"total_video_views_by_region_id_proper",
|
224
|
-
"total_video_views_clicked_to_play",
|
225
|
-
"total_video_views_gender_female",
|
226
|
-
"total_video_views_gender_female_live",
|
227
|
-
"total_video_views_gender_male",
|
228
|
-
"total_video_views_gender_male_live",
|
229
|
-
"total_video_views_live",
|
230
|
-
"total_video_views_live_autoplayed",
|
231
|
-
"total_video_views_live_clicked_to_play",
|
232
|
-
"total_video_views_organic",
|
233
|
-
"total_video_views_organic_unique",
|
234
|
-
"total_video_views_paid",
|
235
|
-
"total_video_views_paid_unique",
|
236
|
-
"total_video_views_sound_on",
|
237
|
-
"total_video_views_unique",
|
238
|
-
"total_video_views_vod",
|
239
|
-
"video_asset_60s_video_view_total_count_by_is_monetizable",
|
50
|
+
"PAGES_FB_STORY_REPLIES",
|
51
|
+
"PAGES_FB_STORY_SHARES",
|
52
|
+
"PAGES_FB_STORY_STICKER_INTERACTIONS",
|
53
|
+
"PAGES_FB_STORY_THREAD_LIGHTWEIGHT_REACTIONS",
|
54
|
+
"PAGE_STORY_IMPRESSIONS_BY_STORY_ID",
|
55
|
+
"PAGE_STORY_IMPRESSIONS_BY_STORY_ID_UNIQUE",
|
56
|
+
"STORY_INTERACTION",
|
240
57
|
]
|
241
58
|
|
242
59
|
|
@@ -31,15 +31,20 @@ module FacebookAds
|
|
31
31
|
"impressions",
|
32
32
|
"likes",
|
33
33
|
"navigation",
|
34
|
+
"peak_concurrent_viewers",
|
34
35
|
"plays",
|
35
36
|
"profile_activity",
|
36
37
|
"profile_visits",
|
38
|
+
"quotes",
|
37
39
|
"reach",
|
38
40
|
"replies",
|
41
|
+
"reposts",
|
39
42
|
"saved",
|
40
43
|
"shares",
|
44
|
+
"thread_replies",
|
41
45
|
"total_interactions",
|
42
46
|
"video_views",
|
47
|
+
"views",
|
43
48
|
]
|
44
49
|
|
45
50
|
PERIOD = [
|
@@ -51,6 +51,8 @@ module FacebookAds
|
|
51
51
|
edge.get 'IgUpcomingEvent'
|
52
52
|
edge.post 'IgUpcomingEvent' do |api|
|
53
53
|
api.has_param :end_time, 'datetime'
|
54
|
+
api.has_param :notification_subtypes, { list: { enum: -> { IgUpcomingEvent::NOTIFICATION_SUBTYPES }} }
|
55
|
+
api.has_param :notification_target_time, { enum: -> { IgUpcomingEvent::NOTIFICATION_TARGET_TIME }}
|
54
56
|
api.has_param :start_time, 'datetime'
|
55
57
|
api.has_param :title, 'string'
|
56
58
|
end
|
@@ -15,6 +15,7 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class LeadGenFormPreviewDetails < AdObject
|
17
17
|
|
18
|
+
field :call_business_text, 'string'
|
18
19
|
field :call_to_action_title, 'string'
|
19
20
|
field :contact_information_text, 'string'
|
20
21
|
field :creatives_overview_default_text, 'string'
|
@@ -39,15 +40,18 @@ module FacebookAds
|
|
39
40
|
field :optional_question_text, 'string'
|
40
41
|
field :personal_info_text, 'string'
|
41
42
|
field :phone_number_inline_context_text, 'string'
|
43
|
+
field :privacy_policy_link_text, 'string'
|
42
44
|
field :privacy_policy_title_section_title_text, 'string'
|
43
45
|
field :privacy_setting_description, 'string'
|
44
46
|
field :products_section_headers, { list: 'hash' }
|
45
47
|
field :qualified_thank_you_card_transparency_info_text, 'string'
|
48
|
+
field :redeem_promo_code_text, 'string'
|
46
49
|
field :review_your_info_text, 'string'
|
47
50
|
field :secure_sharing_text, 'string'
|
48
51
|
field :slide_to_submit_text, 'string'
|
49
52
|
field :social_proof_section_headers, { list: 'hash' }
|
50
53
|
field :submit_button_text, 'string'
|
54
|
+
field :view_file_text, 'string'
|
51
55
|
has_no_id
|
52
56
|
has_no_get
|
53
57
|
has_no_post
|
@@ -97,5 +97,12 @@ module FacebookAds
|
|
97
97
|
edge.get 'CatalogItemChannelsToIntegrityStatus'
|
98
98
|
end
|
99
99
|
|
100
|
+
has_edge :override_details do |edge|
|
101
|
+
edge.get 'OverrideDetails' do |api|
|
102
|
+
api.has_param :keys, { list: 'string' }
|
103
|
+
api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
100
107
|
end
|
101
108
|
end
|
@@ -57,14 +57,17 @@ module FacebookAds
|
|
57
57
|
field :visibility, { enum: -> { VISIBILITY }}
|
58
58
|
field :wiki_data_item, 'string'
|
59
59
|
|
60
|
-
has_edge :augmented_realities_metadata do |edge|
|
61
|
-
edge.get 'DynamicArMetadata'
|
62
|
-
end
|
63
|
-
|
64
60
|
has_edge :channels_to_integrity_status do |edge|
|
65
61
|
edge.get 'CatalogItemChannelsToIntegrityStatus'
|
66
62
|
end
|
67
63
|
|
64
|
+
has_edge :override_details do |edge|
|
65
|
+
edge.get 'OverrideDetails' do |api|
|
66
|
+
api.has_param :keys, { list: 'string' }
|
67
|
+
api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
68
71
|
has_edge :videos_metadata do |edge|
|
69
72
|
edge.get 'DynamicVideoMetadata'
|
70
73
|
end
|
@@ -0,0 +1,73 @@
|
|
1
|
+
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
2
|
+
# All rights reserved.
|
3
|
+
|
4
|
+
# This source code is licensed under the license found in the
|
5
|
+
# LICENSE file in the root directory of this source tree.
|
6
|
+
|
7
|
+
# FB:AUTOGEN
|
8
|
+
|
9
|
+
module FacebookAds
|
10
|
+
# This class is auto-generated.
|
11
|
+
|
12
|
+
# For any issues or feature requests related to this class, please let us know
|
13
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
14
|
+
# pull request for this class.
|
15
|
+
|
16
|
+
class MessageDeliveryEstimate < AdObject
|
17
|
+
OPTIMIZATION_GOAL = [
|
18
|
+
"AD_RECALL_LIFT",
|
19
|
+
"APP_INSTALLS",
|
20
|
+
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
21
|
+
"CONVERSATIONS",
|
22
|
+
"DERIVED_EVENTS",
|
23
|
+
"ENGAGED_USERS",
|
24
|
+
"EVENT_RESPONSES",
|
25
|
+
"IMPRESSIONS",
|
26
|
+
"IN_APP_VALUE",
|
27
|
+
"LANDING_PAGE_VIEWS",
|
28
|
+
"LEAD_GENERATION",
|
29
|
+
"LINK_CLICKS",
|
30
|
+
"MEANINGFUL_CALL_ATTEMPT",
|
31
|
+
"MESSAGING_APPOINTMENT_CONVERSION",
|
32
|
+
"MESSAGING_PURCHASE_CONVERSION",
|
33
|
+
"NONE",
|
34
|
+
"OFFSITE_CONVERSIONS",
|
35
|
+
"PAGE_LIKES",
|
36
|
+
"POST_ENGAGEMENT",
|
37
|
+
"PROFILE_VISIT",
|
38
|
+
"QUALITY_CALL",
|
39
|
+
"QUALITY_LEAD",
|
40
|
+
"REACH",
|
41
|
+
"REMINDERS_SET",
|
42
|
+
"SUBSCRIBERS",
|
43
|
+
"THRUPLAY",
|
44
|
+
"VALUE",
|
45
|
+
"VISIT_INSTAGRAM_PROFILE",
|
46
|
+
]
|
47
|
+
|
48
|
+
PACING_TYPE = [
|
49
|
+
"DAY_PARTING",
|
50
|
+
"DISABLED",
|
51
|
+
"NO_PACING",
|
52
|
+
"PROBABILISTIC_PACING",
|
53
|
+
"PROBABILISTIC_PACING_V2",
|
54
|
+
"STANDARD",
|
55
|
+
]
|
56
|
+
|
57
|
+
|
58
|
+
field :estimate_cost, 'double'
|
59
|
+
field :estimate_cost_lower_bound, 'double'
|
60
|
+
field :estimate_cost_upper_bound, 'double'
|
61
|
+
field :estimate_coverage_lower_bound, 'int'
|
62
|
+
field :estimate_coverage_upper_bound, 'int'
|
63
|
+
field :estimate_delivery, 'int'
|
64
|
+
field :estimate_delivery_lower_bound, 'int'
|
65
|
+
field :estimate_delivery_upper_bound, 'int'
|
66
|
+
field :estimate_status, 'string'
|
67
|
+
has_no_id
|
68
|
+
has_no_get
|
69
|
+
has_no_post
|
70
|
+
has_no_delete
|
71
|
+
|
72
|
+
end
|
73
|
+
end
|
@@ -52,5 +52,12 @@ module FacebookAds
|
|
52
52
|
edge.get 'CatalogItemChannelsToIntegrityStatus'
|
53
53
|
end
|
54
54
|
|
55
|
+
has_edge :override_details do |edge|
|
56
|
+
edge.get 'OverrideDetails' do |api|
|
57
|
+
api.has_param :keys, { list: 'string' }
|
58
|
+
api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
55
62
|
end
|
56
63
|
end
|
@@ -13,13 +13,18 @@ module FacebookAds
|
|
13
13
|
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
|
-
class
|
16
|
+
class OverrideDetails < AdObject
|
17
|
+
TYPE = [
|
18
|
+
"COUNTRY",
|
19
|
+
"LANGUAGE",
|
20
|
+
"LANGUAGE_AND_COUNTRY",
|
21
|
+
]
|
17
22
|
|
18
|
-
|
19
|
-
field :
|
20
|
-
field :publisher_defined_value, 'double'
|
23
|
+
|
24
|
+
field :key, 'string'
|
21
25
|
field :type, 'string'
|
22
|
-
field :
|
26
|
+
field :values, 'object'
|
27
|
+
has_no_id
|
23
28
|
has_no_get
|
24
29
|
has_no_post
|
25
30
|
has_no_delete
|