facebookbusiness 23.0.0 → 23.0.2
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/{favorite_catalog.rb → ab_test_post_test_actions.rb} +4 -3
- data/lib/facebook_ads/ad_objects/ad.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +52 -0
- data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +51 -0
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_live_video_advertiser.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +29 -0
- data/lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.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 +8 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +10 -0
- data/lib/facebook_ads/ad_objects/ad_asset_customization_rule_customization_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_additional_data_reconsideration_offer.rb +26 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +8 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_link_url.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_frequency_control_specs.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_group_structure_tree.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_campaign_learning_stage_info.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +11 -0
- data/lib/facebook_ads/ad_objects/ad_creative_asset_groups_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +8 -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 +8 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative_media_sourcing_spec.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_creative_site_links_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_custom_derived_metrics.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +9 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +32 -0
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +25 -0
- data/lib/facebook_ads/ad_objects/ad_study.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +4 -0
- data/lib/facebook_ads/ad_objects/adgroup_metadata.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_action_stats.rb +3 -0
- data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb +3 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +20 -11
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +15 -0
- data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +2 -1
- data/lib/facebook_ads/ad_objects/alm_event.rb +1 -0
- data/lib/facebook_ads/ad_objects/apac_mon_seller_status_api_container.rb +1 -0
- data/lib/facebook_ads/ad_objects/application.rb +1 -7
- data/lib/facebook_ads/ad_objects/audio_asset.rb +1 -0
- data/lib/facebook_ads/ad_objects/avatar.rb +0 -12
- data/lib/facebook_ads/ad_objects/{event_tour.rb → branded_content_fb_promode_user.rb} +7 -13
- data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_media_id.rb +5 -0
- data/lib/facebook_ads/ad_objects/business.rb +23 -0
- data/lib/facebook_ads/ad_objects/business_agreement.rb +4 -0
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +4 -0
- data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +4 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +4 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +13 -0
- data/lib/facebook_ads/ad_objects/canvas.rb +2 -0
- data/lib/facebook_ads/ad_objects/collaborative_ads_partner_businesses.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +2 -3
- data/lib/facebook_ads/ad_objects/content_delivery_report.rb +0 -4
- data/lib/facebook_ads/ad_objects/copyright_ownership_transfer.rb +1 -0
- data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb +1 -0
- data/lib/facebook_ads/ad_objects/ctxdfo_objective_defaults.rb +27 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience_integrity_flags_and_appeal_status.rb +2 -0
- data/lib/facebook_ads/ad_objects/customer_elasticity_study_metrics.rb +25 -0
- data/lib/facebook_ads/ad_objects/delivery_window.rb +1 -0
- data/lib/facebook_ads/ad_objects/event.rb +0 -2
- data/lib/facebook_ads/ad_objects/guidance_lift_estimate.rb +29 -0
- data/lib/facebook_ads/ad_objects/ig_media.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +27 -0
- data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb +526 -0
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +2 -1
- data/lib/facebook_ads/ad_objects/image_copyright.rb +1 -0
- data/lib/facebook_ads/ad_objects/image_reference_match.rb +1 -0
- data/lib/facebook_ads/ad_objects/insights_value.rb +2 -0
- data/lib/facebook_ads/ad_objects/instagram_business_asset.rb +40 -0
- data/lib/facebook_ads/ad_objects/lead_gen_data_draft.rb +1 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +1 -0
- data/lib/facebook_ads/ad_objects/lead_gen_question_option.rb +1 -0
- data/lib/facebook_ads/ad_objects/lookalike_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/marketing_messages_onboarding_status.rb +26 -0
- data/lib/facebook_ads/ad_objects/mcom_invoice_status.rb +3 -0
- data/lib/facebook_ads/ad_objects/media_copyright_attribution.rb +0 -1
- data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/{fb_lite_to_nt_transitions.rb → messenger_call_permissions.rb} +2 -2
- data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +5 -0
- data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +1 -0
- data/lib/facebook_ads/ad_objects/page.rb +54 -2
- data/lib/facebook_ads/ad_objects/{avatar_profile_picture.rb → partner_center_export_file.rb} +2 -1
- data/lib/facebook_ads/ad_objects/partnership_ads_identity.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +20 -0
- data/lib/facebook_ads/ad_objects/product_catalog_check_marketplace_partner_deals_status.rb +27 -0
- data/lib/facebook_ads/ad_objects/product_group.rb +2 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +12 -1
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +1 -0
- data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +2 -0
- data/lib/facebook_ads/ad_objects/robot.rb +1 -0
- data/lib/facebook_ads/ad_objects/shadow_ig_user_collaboration_invites.rb +28 -0
- data/lib/facebook_ads/ad_objects/shop.rb +0 -1
- data/lib/facebook_ads/ad_objects/system_user.rb +4 -0
- data/lib/facebook_ads/ad_objects/trending_topics_spec.rb +27 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -1
- data/lib/facebook_ads/ad_objects/user.rb +3 -4
- data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +2 -0
- data/lib/facebook_ads/ad_objects/video_copyright.rb +2 -0
- data/lib/facebook_ads/ad_objects/video_copyright_match.rb +1 -0
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +52 -2
- data/lib/facebook_ads/ad_objects/whats_app_business_health_status.rb +1 -0
- data/lib/facebook_ads/version.rb +1 -1
- metadata +14 -6
@@ -23,6 +23,7 @@ module FacebookAds
|
|
23
23
|
"BOOK_A_CONSULTATION",
|
24
24
|
"BOOK_NOW",
|
25
25
|
"BOOK_TRAVEL",
|
26
|
+
"BROWSE_SHOP",
|
26
27
|
"BUY",
|
27
28
|
"BUY_NOW",
|
28
29
|
"BUY_TICKETS",
|
@@ -39,11 +40,13 @@ module FacebookAds
|
|
39
40
|
"DOWNLOAD",
|
40
41
|
"EVENT_RSVP",
|
41
42
|
"FIND_A_GROUP",
|
43
|
+
"FIND_OUT_MORE",
|
42
44
|
"FIND_YOUR_GROUPS",
|
43
45
|
"FOLLOW_NEWS_STORYLINE",
|
44
46
|
"FOLLOW_PAGE",
|
45
47
|
"FOLLOW_USER",
|
46
48
|
"GET_A_QUOTE",
|
49
|
+
"GET_DETAILS",
|
47
50
|
"GET_DIRECTIONS",
|
48
51
|
"GET_IN_TOUCH",
|
49
52
|
"GET_OFFER",
|
@@ -77,18 +80,22 @@ module FacebookAds
|
|
77
80
|
"REQUEST_TIME",
|
78
81
|
"SAY_THANKS",
|
79
82
|
"SEE_MORE",
|
83
|
+
"SEE_SHOP",
|
80
84
|
"SELL_NOW",
|
81
85
|
"SEND_A_GIFT",
|
82
86
|
"SEND_GIFT_MONEY",
|
83
87
|
"SEND_UPDATES",
|
84
88
|
"SHARE",
|
85
89
|
"SHOP_NOW",
|
90
|
+
"SHOP_WITH_AI",
|
86
91
|
"SIGN_UP",
|
87
92
|
"SOTTO_SUBSCRIBE",
|
88
93
|
"START_ORDER",
|
89
94
|
"SUBSCRIBE",
|
90
95
|
"SWIPE_UP_PRODUCT",
|
91
96
|
"SWIPE_UP_SHOP",
|
97
|
+
"TRY_DEMO",
|
98
|
+
"TRY_ON_WITH_AI",
|
92
99
|
"UPDATE_APP",
|
93
100
|
"USE_APP",
|
94
101
|
"USE_MOBILE_APP",
|
@@ -99,6 +106,7 @@ module FacebookAds
|
|
99
106
|
"VIEW_IN_CART",
|
100
107
|
"VIEW_PRODUCT",
|
101
108
|
"VISIT_PAGES_FEED",
|
109
|
+
"VISIT_WEBSITE",
|
102
110
|
"WATCH_LIVE_VIDEO",
|
103
111
|
"WATCH_MORE",
|
104
112
|
"WATCH_VIDEO",
|
@@ -16,9 +16,11 @@ module FacebookAds
|
|
16
16
|
class AdAssetFeedSpecLinkUrl < AdObject
|
17
17
|
|
18
18
|
field :adlabels, { list: 'AdAssetFeedSpecAssetLabel' }
|
19
|
+
field :android_url, 'string'
|
19
20
|
field :carousel_see_more_url, 'string'
|
20
21
|
field :deeplink_url, 'string'
|
21
22
|
field :display_url, 'string'
|
23
|
+
field :ios_url, 'string'
|
22
24
|
field :object_store_urls, { list: 'string' }
|
23
25
|
field :url_tags, 'string'
|
24
26
|
field :website_url, 'string'
|
@@ -17,6 +17,9 @@ module FacebookAds
|
|
17
17
|
|
18
18
|
field :attribution_windows, { list: 'string' }
|
19
19
|
field :conversions, 'int'
|
20
|
+
field :dynamic_lp_conversions_threshold, 'int'
|
21
|
+
field :dynamic_lp_days_threshold, 'int'
|
22
|
+
field :dynamic_lp_status, 'string'
|
20
23
|
field :last_sig_edit_ts, 'int'
|
21
24
|
field :status, 'string'
|
22
25
|
has_no_id
|
@@ -23,6 +23,7 @@ module FacebookAds
|
|
23
23
|
"BOOK_A_CONSULTATION",
|
24
24
|
"BOOK_NOW",
|
25
25
|
"BOOK_TRAVEL",
|
26
|
+
"BROWSE_SHOP",
|
26
27
|
"BUY",
|
27
28
|
"BUY_NOW",
|
28
29
|
"BUY_TICKETS",
|
@@ -39,11 +40,13 @@ module FacebookAds
|
|
39
40
|
"DOWNLOAD",
|
40
41
|
"EVENT_RSVP",
|
41
42
|
"FIND_A_GROUP",
|
43
|
+
"FIND_OUT_MORE",
|
42
44
|
"FIND_YOUR_GROUPS",
|
43
45
|
"FOLLOW_NEWS_STORYLINE",
|
44
46
|
"FOLLOW_PAGE",
|
45
47
|
"FOLLOW_USER",
|
46
48
|
"GET_A_QUOTE",
|
49
|
+
"GET_DETAILS",
|
47
50
|
"GET_DIRECTIONS",
|
48
51
|
"GET_IN_TOUCH",
|
49
52
|
"GET_OFFER",
|
@@ -77,18 +80,22 @@ module FacebookAds
|
|
77
80
|
"REQUEST_TIME",
|
78
81
|
"SAY_THANKS",
|
79
82
|
"SEE_MORE",
|
83
|
+
"SEE_SHOP",
|
80
84
|
"SELL_NOW",
|
81
85
|
"SEND_A_GIFT",
|
82
86
|
"SEND_GIFT_MONEY",
|
83
87
|
"SEND_UPDATES",
|
84
88
|
"SHARE",
|
85
89
|
"SHOP_NOW",
|
90
|
+
"SHOP_WITH_AI",
|
86
91
|
"SIGN_UP",
|
87
92
|
"SOTTO_SUBSCRIBE",
|
88
93
|
"START_ORDER",
|
89
94
|
"SUBSCRIBE",
|
90
95
|
"SWIPE_UP_PRODUCT",
|
91
96
|
"SWIPE_UP_SHOP",
|
97
|
+
"TRY_DEMO",
|
98
|
+
"TRY_ON_WITH_AI",
|
92
99
|
"UPDATE_APP",
|
93
100
|
"USE_APP",
|
94
101
|
"USE_MOBILE_APP",
|
@@ -99,6 +106,7 @@ module FacebookAds
|
|
99
106
|
"VIEW_IN_CART",
|
100
107
|
"VIEW_PRODUCT",
|
101
108
|
"VISIT_PAGES_FEED",
|
109
|
+
"VISIT_WEBSITE",
|
102
110
|
"WATCH_LIVE_VIDEO",
|
103
111
|
"WATCH_MORE",
|
104
112
|
"WATCH_VIDEO",
|
@@ -187,6 +195,7 @@ module FacebookAds
|
|
187
195
|
field :creative_sourcing_spec, 'AdCreativeSourcingSpec'
|
188
196
|
field :degrees_of_freedom_spec, 'AdCreativeDegreesOfFreedomSpec'
|
189
197
|
field :destination_set_id, 'string'
|
198
|
+
field :destination_spec, 'AdCreativeDestinationSpec'
|
190
199
|
field :dynamic_ad_voice, 'string'
|
191
200
|
field :effective_authorization_category, 'string'
|
192
201
|
field :effective_instagram_media_id, 'string'
|
@@ -194,6 +203,7 @@ module FacebookAds
|
|
194
203
|
field :enable_direct_install, 'bool'
|
195
204
|
field :enable_launch_instant_app, 'bool'
|
196
205
|
field :facebook_branded_content, 'AdCreativeFacebookBrandedContent'
|
206
|
+
field :format_transformation_spec, { list: 'AdCreativeFormatTransformationSpec' }
|
197
207
|
field :id, 'string'
|
198
208
|
field :image_crops, 'AdsImageCrops'
|
199
209
|
field :image_hash, 'string'
|
@@ -206,6 +216,7 @@ module FacebookAds
|
|
206
216
|
field :link_destination_display_url, 'string'
|
207
217
|
field :link_og_id, 'string'
|
208
218
|
field :link_url, 'string'
|
219
|
+
field :media_sourcing_spec, 'AdCreativeMediaSourcingSpec'
|
209
220
|
field :messenger_sponsored_message, 'string'
|
210
221
|
field :name, 'string'
|
211
222
|
field :object_id, 'string'
|
@@ -15,9 +15,11 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdCreativeBrandedContentAds < AdObject
|
17
17
|
|
18
|
+
field :acting_business_id, 'string'
|
18
19
|
field :ad_format, 'int'
|
19
20
|
field :content_search_input, 'string'
|
20
21
|
field :creator_ad_permission_type, 'string'
|
22
|
+
field :deliver_dynamic_partner_content, 'bool'
|
21
23
|
field :facebook_boost_post_access_token, 'string'
|
22
24
|
field :instagram_boost_post_access_token, 'string'
|
23
25
|
field :is_mca_internal, 'bool'
|
@@ -24,6 +24,7 @@ module FacebookAds
|
|
24
24
|
field :biz_ai, 'AdCreativeFeatureDetails'
|
25
25
|
field :carousel_to_video, 'AdCreativeFeatureDetails'
|
26
26
|
field :catalog_feed_tag, 'AdCreativeFeatureDetails'
|
27
|
+
field :creative_stickers, 'AdCreativeFeatureDetails'
|
27
28
|
field :customize_product_recommendation, 'AdCreativeFeatureDetails'
|
28
29
|
field :cv_transformation, 'AdCreativeFeatureDetails'
|
29
30
|
field :description_automation, 'AdCreativeFeatureDetails'
|
@@ -60,18 +61,25 @@ module FacebookAds
|
|
60
61
|
field :product_tags, 'AdCreativeFeatureDetails'
|
61
62
|
field :profile_card, 'AdCreativeFeatureDetails'
|
62
63
|
field :profile_extension, 'AdCreativeFeatureDetails'
|
64
|
+
field :replace_media_text, 'AdCreativeFeatureDetails'
|
65
|
+
field :reveal_details_over_time, 'AdCreativeFeatureDetails'
|
66
|
+
field :show_destination_blurbs, 'AdCreativeFeatureDetails'
|
63
67
|
field :show_summary, 'AdCreativeFeatureDetails'
|
64
68
|
field :site_extensions, 'AdCreativeFeatureDetails'
|
65
69
|
field :standard_enhancements, 'AdCreativeFeatureDetails'
|
66
70
|
field :standard_enhancements_catalog, 'AdCreativeFeatureDetails'
|
67
71
|
field :text_generation, 'AdCreativeFeatureDetails'
|
68
72
|
field :text_optimizations, 'AdCreativeFeatureDetails'
|
73
|
+
field :text_overlay_translation, 'AdCreativeFeatureDetails'
|
69
74
|
field :text_translation, 'AdCreativeFeatureDetails'
|
70
75
|
field :video_auto_crop, 'AdCreativeFeatureDetails'
|
71
76
|
field :video_filtering, 'AdCreativeFeatureDetails'
|
72
77
|
field :video_highlight, 'AdCreativeFeatureDetails'
|
78
|
+
field :video_highlights, 'AdCreativeFeatureDetails'
|
73
79
|
field :video_to_image, 'AdCreativeFeatureDetails'
|
74
80
|
field :video_uncrop, 'AdCreativeFeatureDetails'
|
81
|
+
field :wa_mm_image_filtering, 'AdCreativeFeatureDetails'
|
82
|
+
field :wa_mm_text_truncation_length, 'AdCreativeFeatureDetails'
|
75
83
|
has_no_id
|
76
84
|
has_no_get
|
77
85
|
has_no_post
|
@@ -45,6 +45,7 @@ module FacebookAds
|
|
45
45
|
field :image_hash, 'string'
|
46
46
|
field :image_layer_specs, { list: 'AdCreativeLinkDataImageLayerSpec' }
|
47
47
|
field :image_overlay_spec, 'AdCreativeLinkDataImageOverlaySpec'
|
48
|
+
field :is_local_expansion, 'bool'
|
48
49
|
field :link, 'string'
|
49
50
|
field :message, 'string'
|
50
51
|
field :multi_share_end_card, 'bool'
|
@@ -23,6 +23,7 @@ module FacebookAds
|
|
23
23
|
"BOOK_A_CONSULTATION",
|
24
24
|
"BOOK_NOW",
|
25
25
|
"BOOK_TRAVEL",
|
26
|
+
"BROWSE_SHOP",
|
26
27
|
"BUY",
|
27
28
|
"BUY_NOW",
|
28
29
|
"BUY_TICKETS",
|
@@ -39,11 +40,13 @@ module FacebookAds
|
|
39
40
|
"DOWNLOAD",
|
40
41
|
"EVENT_RSVP",
|
41
42
|
"FIND_A_GROUP",
|
43
|
+
"FIND_OUT_MORE",
|
42
44
|
"FIND_YOUR_GROUPS",
|
43
45
|
"FOLLOW_NEWS_STORYLINE",
|
44
46
|
"FOLLOW_PAGE",
|
45
47
|
"FOLLOW_USER",
|
46
48
|
"GET_A_QUOTE",
|
49
|
+
"GET_DETAILS",
|
47
50
|
"GET_DIRECTIONS",
|
48
51
|
"GET_IN_TOUCH",
|
49
52
|
"GET_OFFER",
|
@@ -77,18 +80,22 @@ module FacebookAds
|
|
77
80
|
"REQUEST_TIME",
|
78
81
|
"SAY_THANKS",
|
79
82
|
"SEE_MORE",
|
83
|
+
"SEE_SHOP",
|
80
84
|
"SELL_NOW",
|
81
85
|
"SEND_A_GIFT",
|
82
86
|
"SEND_GIFT_MONEY",
|
83
87
|
"SEND_UPDATES",
|
84
88
|
"SHARE",
|
85
89
|
"SHOP_NOW",
|
90
|
+
"SHOP_WITH_AI",
|
86
91
|
"SIGN_UP",
|
87
92
|
"SOTTO_SUBSCRIBE",
|
88
93
|
"START_ORDER",
|
89
94
|
"SUBSCRIBE",
|
90
95
|
"SWIPE_UP_PRODUCT",
|
91
96
|
"SWIPE_UP_SHOP",
|
97
|
+
"TRY_DEMO",
|
98
|
+
"TRY_ON_WITH_AI",
|
92
99
|
"UPDATE_APP",
|
93
100
|
"USE_APP",
|
94
101
|
"USE_MOBILE_APP",
|
@@ -99,6 +106,7 @@ module FacebookAds
|
|
99
106
|
"VIEW_IN_CART",
|
100
107
|
"VIEW_PRODUCT",
|
101
108
|
"VISIT_PAGES_FEED",
|
109
|
+
"VISIT_WEBSITE",
|
102
110
|
"WATCH_LIVE_VIDEO",
|
103
111
|
"WATCH_MORE",
|
104
112
|
"WATCH_VIDEO",
|
@@ -15,10 +15,14 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdCreativeLinkDataCallToActionValue < AdObject
|
17
17
|
|
18
|
+
field :android_url, 'string'
|
18
19
|
field :app_destination, 'string'
|
19
20
|
field :app_link, 'string'
|
20
21
|
field :application, 'string'
|
21
22
|
field :event_id, 'string'
|
23
|
+
field :ios_url, 'string'
|
24
|
+
field :land_on_whatsapp_catalog, 'int'
|
25
|
+
field :land_on_whatsapp_profile, 'int'
|
22
26
|
field :lead_gen_form_id, 'string'
|
23
27
|
field :link, 'string'
|
24
28
|
field :link_caption, 'string'
|
@@ -15,12 +15,15 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdCreativeLinkDataChildAttachment < AdObject
|
17
17
|
|
18
|
+
field :android_url, 'string'
|
18
19
|
field :call_to_action, 'AdCreativeLinkDataCallToAction'
|
19
20
|
field :caption, 'string'
|
20
21
|
field :description, 'string'
|
21
22
|
field :image_crops, 'AdsImageCrops'
|
22
23
|
field :image_hash, 'string'
|
24
|
+
field :ios_url, 'string'
|
23
25
|
field :link, 'string'
|
26
|
+
field :marketing_message_buttons, { list: 'object' }
|
24
27
|
field :name, 'string'
|
25
28
|
field :picture, 'string'
|
26
29
|
field :place_data, 'AdCreativePlaceData'
|
@@ -15,6 +15,12 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdCreativeMediaSourcingSpec < AdObject
|
17
17
|
|
18
|
+
field :bodies, { list: 'object' }
|
19
|
+
field :descriptions, { list: 'object' }
|
20
|
+
field :images, { list: 'object' }
|
21
|
+
field :related_media, 'object'
|
22
|
+
field :titles, { list: 'object' }
|
23
|
+
field :videos, { list: 'object' }
|
18
24
|
has_no_id
|
19
25
|
has_no_get
|
20
26
|
has_no_post
|
@@ -16,10 +16,12 @@ module FacebookAds
|
|
16
16
|
class AdCreativeSiteLinksSpec < AdObject
|
17
17
|
|
18
18
|
field :is_site_link_sticky, 'bool'
|
19
|
+
field :site_link_extra_metadata, 'string'
|
19
20
|
field :site_link_hash, 'string'
|
20
21
|
field :site_link_id, 'string'
|
21
22
|
field :site_link_image_hash, 'string'
|
22
23
|
field :site_link_image_url, 'string'
|
24
|
+
field :site_link_language, 'string'
|
23
25
|
field :site_link_recommendation_type, 'string'
|
24
26
|
field :site_link_title, 'string'
|
25
27
|
field :site_link_url, 'string'
|
@@ -17,11 +17,17 @@ module FacebookAds
|
|
17
17
|
|
18
18
|
field :associated_product_set_id, 'string'
|
19
19
|
field :brand, 'object'
|
20
|
+
field :destination_screenshot_spec, 'object'
|
20
21
|
field :dynamic_site_links_spec, 'object'
|
21
22
|
field :enable_social_feedback_preservation, 'bool'
|
23
|
+
field :intent, 'object'
|
24
|
+
field :pca_spec, 'object'
|
22
25
|
field :promotion_metadata_spec, { list: 'AdCreativePromotionMetadataSpec' }
|
26
|
+
field :site_links_data_consented, 'object'
|
23
27
|
field :site_links_spec, { list: 'AdCreativeSiteLinksSpec' }
|
24
28
|
field :source_url, 'string'
|
29
|
+
field :website_media_spec, 'object'
|
30
|
+
field :website_summary_spec, 'object'
|
25
31
|
has_no_id
|
26
32
|
has_no_get
|
27
33
|
has_no_post
|
@@ -21,15 +21,19 @@ module FacebookAds
|
|
21
21
|
"AUDIENCE_NETWORK_REWARDED_VIDEO",
|
22
22
|
"BIZ_DISCO_FEED_MOBILE",
|
23
23
|
"DESKTOP_FEED_STANDARD",
|
24
|
+
"FACEBOOK_IFU_REELS_MOBILE",
|
24
25
|
"FACEBOOK_PROFILE_FEED_DESKTOP",
|
25
26
|
"FACEBOOK_PROFILE_FEED_MOBILE",
|
26
27
|
"FACEBOOK_PROFILE_REELS_MOBILE",
|
27
28
|
"FACEBOOK_REELS_BANNER",
|
28
29
|
"FACEBOOK_REELS_BANNER_DESKTOP",
|
30
|
+
"FACEBOOK_REELS_BANNER_FEED_ANDROID",
|
31
|
+
"FACEBOOK_REELS_BANNER_FEED_ANDROID_LARGE",
|
29
32
|
"FACEBOOK_REELS_BANNER_FULLSCREEN_IOS",
|
30
33
|
"FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE",
|
31
34
|
"FACEBOOK_REELS_MOBILE",
|
32
35
|
"FACEBOOK_REELS_POSTLOOP",
|
36
|
+
"FACEBOOK_REELS_POSTLOOP_FEED",
|
33
37
|
"FACEBOOK_REELS_STICKER",
|
34
38
|
"FACEBOOK_STORY_MOBILE",
|
35
39
|
"FACEBOOK_STORY_STICKER_MOBILE",
|
@@ -42,7 +46,10 @@ module FacebookAds
|
|
42
46
|
"INSTAGRAM_PROFILE_FEED",
|
43
47
|
"INSTAGRAM_PROFILE_REELS",
|
44
48
|
"INSTAGRAM_REELS",
|
49
|
+
"INSTAGRAM_REELS_INSTREAM",
|
45
50
|
"INSTAGRAM_REELS_OVERLAY",
|
51
|
+
"INSTAGRAM_REELS_WEB",
|
52
|
+
"INSTAGRAM_REELS_WEB_M_SITE",
|
46
53
|
"INSTAGRAM_SEARCH_CHAIN",
|
47
54
|
"INSTAGRAM_SEARCH_GRID",
|
48
55
|
"INSTAGRAM_STANDARD",
|
@@ -53,6 +60,7 @@ module FacebookAds
|
|
53
60
|
"INSTANT_ARTICLE_RECIRCULATION_AD",
|
54
61
|
"INSTANT_ARTICLE_STANDARD",
|
55
62
|
"INSTREAM_BANNER_DESKTOP",
|
63
|
+
"INSTREAM_BANNER_FEED_IOS",
|
56
64
|
"INSTREAM_BANNER_FULLSCREEN_IOS",
|
57
65
|
"INSTREAM_BANNER_FULLSCREEN_MOBILE",
|
58
66
|
"INSTREAM_BANNER_IMMERSIVE_MOBILE",
|
@@ -88,6 +96,7 @@ module FacebookAds
|
|
88
96
|
"product_metadata_automation",
|
89
97
|
"profile_card",
|
90
98
|
"standard_enhancements_catalog",
|
99
|
+
"text_overlay_translation",
|
91
100
|
"video_to_image",
|
92
101
|
]
|
93
102
|
|
@@ -46,6 +46,30 @@ module FacebookAds
|
|
46
46
|
"TUTORIAL_COMPLETION",
|
47
47
|
]
|
48
48
|
|
49
|
+
FULL_FUNNEL_OBJECTIVE = [
|
50
|
+
"APP_INSTALLS",
|
51
|
+
"BRAND_AWARENESS",
|
52
|
+
"EVENT_RESPONSES",
|
53
|
+
"LEAD_GENERATION",
|
54
|
+
"LINK_CLICKS",
|
55
|
+
"LOCAL_AWARENESS",
|
56
|
+
"MESSAGES",
|
57
|
+
"OFFER_CLAIMS",
|
58
|
+
"OUTCOME_APP_PROMOTION",
|
59
|
+
"OUTCOME_AWARENESS",
|
60
|
+
"OUTCOME_ENGAGEMENT",
|
61
|
+
"OUTCOME_LEADS",
|
62
|
+
"OUTCOME_SALES",
|
63
|
+
"OUTCOME_TRAFFIC",
|
64
|
+
"PAGE_LIKES",
|
65
|
+
"POST_ENGAGEMENT",
|
66
|
+
"PRODUCT_CATALOG_SALES",
|
67
|
+
"REACH",
|
68
|
+
"STORE_VISITS",
|
69
|
+
"VIDEO_VIEWS",
|
70
|
+
"WEBSITE_CONVERSIONS",
|
71
|
+
]
|
72
|
+
|
49
73
|
LEAD_ADS_CUSTOM_EVENT_TYPE = [
|
50
74
|
"ACHIEVEMENT_UNLOCKED",
|
51
75
|
"ADD_PAYMENT_INFO",
|
@@ -85,19 +109,27 @@ module FacebookAds
|
|
85
109
|
field :custom_conversion_id, 'string'
|
86
110
|
field :custom_event_str, 'string'
|
87
111
|
field :custom_event_type, { enum: -> { CUSTOM_EVENT_TYPE }}
|
112
|
+
field :dataset_split_id, 'string'
|
113
|
+
field :dataset_split_ids, { list: 'string' }
|
88
114
|
field :event_id, 'string'
|
115
|
+
field :full_funnel_objective, { enum: -> { FULL_FUNNEL_OBJECTIVE }}
|
89
116
|
field :fundraiser_campaign_id, 'string'
|
90
117
|
field :lead_ads_custom_event_str, 'string'
|
91
118
|
field :lead_ads_custom_event_type, { enum: -> { LEAD_ADS_CUSTOM_EVENT_TYPE }}
|
92
119
|
field :lead_ads_form_event_source_type, 'string'
|
93
120
|
field :lead_ads_offsite_conversion_type, 'string'
|
121
|
+
field :lead_ads_selected_pixel_id, 'string'
|
94
122
|
field :mcme_conversion_id, 'string'
|
123
|
+
field :multi_event_product, 'string'
|
95
124
|
field :object_store_url, 'string'
|
125
|
+
field :object_store_urls, { list: 'string' }
|
96
126
|
field :offer_id, 'string'
|
97
127
|
field :offline_conversion_data_set_id, 'string'
|
98
128
|
field :offsite_conversion_event_id, 'string'
|
99
129
|
field :omnichannel_object, 'object'
|
100
130
|
field :page_id, 'string'
|
131
|
+
field :passback_application_id, 'string'
|
132
|
+
field :passback_pixel_id, 'string'
|
101
133
|
field :pixel_aggregation_rule, 'string'
|
102
134
|
field :pixel_id, 'string'
|
103
135
|
field :pixel_rule, 'string'
|
@@ -42,6 +42,7 @@ module FacebookAds
|
|
42
42
|
field :export_name, 'string'
|
43
43
|
field :fields, { list: 'string' }
|
44
44
|
field :filtering, { list: 'object' }
|
45
|
+
field :graph_cache, 'bool'
|
45
46
|
field :level, 'adaccountinsights_level_enum_param'
|
46
47
|
field :limit, 'int'
|
47
48
|
field :product_id_limit, 'int'
|
@@ -57,6 +57,7 @@ module FacebookAds
|
|
57
57
|
"AD_RECALL_LIFT",
|
58
58
|
"APP_INSTALLS",
|
59
59
|
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
60
|
+
"AUTOMATIC_OBJECTIVE",
|
60
61
|
"CONVERSATIONS",
|
61
62
|
"DERIVED_EVENTS",
|
62
63
|
"ENGAGED_USERS",
|
@@ -92,6 +93,12 @@ module FacebookAds
|
|
92
93
|
"PAUSED",
|
93
94
|
]
|
94
95
|
|
96
|
+
AUTOMATIC_MANUAL_STATE = [
|
97
|
+
"AUTOMATIC",
|
98
|
+
"MANUAL",
|
99
|
+
"UNSET",
|
100
|
+
]
|
101
|
+
|
95
102
|
BUDGET_SOURCE = [
|
96
103
|
"NONE",
|
97
104
|
"RMN",
|
@@ -171,6 +178,7 @@ module FacebookAds
|
|
171
178
|
|
172
179
|
OPTIMIZATION_SUB_EVENT = [
|
173
180
|
"NONE",
|
181
|
+
"POST_INTERACTION",
|
174
182
|
"TRAVEL_INTENT",
|
175
183
|
"TRAVEL_INTENT_BUCKET_01",
|
176
184
|
"TRAVEL_INTENT_BUCKET_02",
|
@@ -190,6 +198,11 @@ module FacebookAds
|
|
190
198
|
"4",
|
191
199
|
"5",
|
192
200
|
"6",
|
201
|
+
"7",
|
202
|
+
"8",
|
203
|
+
"9",
|
204
|
+
"10",
|
205
|
+
"11",
|
193
206
|
]
|
194
207
|
|
195
208
|
TUNE_FOR_CATEGORY = [
|
@@ -219,6 +232,7 @@ module FacebookAds
|
|
219
232
|
field :adset_schedule, { list: 'DayPart' }
|
220
233
|
field :asset_feed_id, 'string'
|
221
234
|
field :attribution_spec, { list: 'AttributionSpec' }
|
235
|
+
field :automatic_manual_state, 'string'
|
222
236
|
field :bid_adjustments, 'AdBidAdjustments'
|
223
237
|
field :bid_amount, 'int'
|
224
238
|
field :bid_constraints, 'AdCampaignBidConstraint'
|
@@ -265,6 +279,7 @@ module FacebookAds
|
|
265
279
|
field :optimization_goal, { enum: -> { OPTIMIZATION_GOAL }}
|
266
280
|
field :optimization_sub_event, 'string'
|
267
281
|
field :pacing_type, { list: 'string' }
|
282
|
+
field :placement_soft_opt_out, 'Placement'
|
268
283
|
field :promoted_object, 'AdPromotedObject'
|
269
284
|
field :recommendations, { list: 'AdRecommendation' }
|
270
285
|
field :recurring_budget_semantics, 'bool'
|
@@ -280,8 +295,12 @@ module FacebookAds
|
|
280
295
|
field :targeting_optimization_types, { list: 'hash' }
|
281
296
|
field :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
|
282
297
|
field :time_based_ad_rotation_intervals, { list: 'int' }
|
298
|
+
field :trending_topics_spec, 'TrendingTopicsSpec'
|
283
299
|
field :updated_time, 'datetime'
|
284
300
|
field :use_new_app_click, 'bool'
|
301
|
+
field :value_rule_set_id, 'string'
|
302
|
+
field :value_rules_applied, 'bool'
|
303
|
+
field :budget_schedule_specs, { list: 'object' }
|
285
304
|
field :budget_source, { enum: -> { BUDGET_SOURCE }}
|
286
305
|
field :budget_split_set_id, 'string'
|
287
306
|
field :campaign_spec, 'object'
|
@@ -349,6 +368,10 @@ module FacebookAds
|
|
349
368
|
end
|
350
369
|
|
351
370
|
has_edge :budget_schedules do |edge|
|
371
|
+
edge.get 'HighDemandPeriod' do |api|
|
372
|
+
api.has_param :time_start, 'datetime'
|
373
|
+
api.has_param :time_stop, 'datetime'
|
374
|
+
end
|
352
375
|
edge.post 'HighDemandPeriod' do |api|
|
353
376
|
api.has_param :budget_value, 'int'
|
354
377
|
api.has_param :budget_value_type, { enum: -> { HighDemandPeriod::BUDGET_VALUE_TYPE }}
|
@@ -396,6 +419,7 @@ module FacebookAds
|
|
396
419
|
api.has_param :export_name, 'string'
|
397
420
|
api.has_param :fields, { list: 'string' }
|
398
421
|
api.has_param :filtering, { list: 'object' }
|
422
|
+
api.has_param :graph_cache, 'bool'
|
399
423
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
400
424
|
api.has_param :limit, 'int'
|
401
425
|
api.has_param :product_id_limit, 'int'
|
@@ -420,6 +444,7 @@ module FacebookAds
|
|
420
444
|
api.has_param :export_name, 'string'
|
421
445
|
api.has_param :fields, { list: 'string' }
|
422
446
|
api.has_param :filtering, { list: 'object' }
|
447
|
+
api.has_param :graph_cache, 'bool'
|
423
448
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
424
449
|
api.has_param :limit, 'int'
|
425
450
|
api.has_param :product_id_limit, 'int'
|
@@ -40,6 +40,7 @@ module FacebookAds
|
|
40
40
|
"CREATION_ML_PRECREATION",
|
41
41
|
"CREATOR_FAN_CHALLENGE",
|
42
42
|
"CREATOR_STOREFRONT_PERSONALIZED_VIDEO",
|
43
|
+
"CREATOR_STOREFRONT_PROMOTIONAL_VIDEO",
|
43
44
|
"DATAGENIX_VIDEO",
|
44
45
|
"DCO_AD_ASSET_FEED",
|
45
46
|
"DCO_AUTOGEN_VIDEO",
|
@@ -47,6 +48,7 @@ module FacebookAds
|
|
47
48
|
"DIM_SUM",
|
48
49
|
"DIRECTED_POST_ATTACHMENT",
|
49
50
|
"DIRECT_INBOX",
|
51
|
+
"DOUBLE_PROD_EXPERIMENT",
|
50
52
|
"DROPS_SHOPPING_EVENT_PAGE",
|
51
53
|
"DYNAMIC_ITEM_VIDEO",
|
52
54
|
"DYNAMIC_TEMPLATE_VIDEO",
|
@@ -99,6 +101,7 @@ module FacebookAds
|
|
99
101
|
"MUSIC_CLIP",
|
100
102
|
"MUSIC_CLIP_IN_COMMENT",
|
101
103
|
"MUSIC_CLIP_IN_LIGHTWEIGHT_STATUS",
|
104
|
+
"MUSIC_CLIP_IN_MAPLE_POST",
|
102
105
|
"MUSIC_CLIP_IN_MSGR_NOTE",
|
103
106
|
"MUSIC_CLIP_IN_POLL_OPTION",
|
104
107
|
"MUSIC_CLIP_ON_DATING_PROFILE",
|
@@ -306,6 +309,7 @@ module FacebookAds
|
|
306
309
|
field :privacy, 'Privacy'
|
307
310
|
field :published, 'bool'
|
308
311
|
field :scheduled_publish_time, 'datetime'
|
312
|
+
field :season, 'VideoList'
|
309
313
|
field :source, 'string'
|
310
314
|
field :spherical, 'bool'
|
311
315
|
field :status, 'VideoStatus'
|
@@ -18,6 +18,7 @@ module FacebookAds
|
|
18
18
|
field :ad_standard_enhancements_edit_source, 'int'
|
19
19
|
field :adgroup_creation_source, 'string'
|
20
20
|
field :adgroup_edit_source, 'string'
|
21
|
+
field :adgroup_media_source, 'string'
|
21
22
|
field :carousel_style, 'string'
|
22
23
|
field :carousel_with_static_card_style, 'string'
|
23
24
|
has_no_id
|