facebookbusiness 23.0.1 → 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/ad.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +48 -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 +47 -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_targeting_unified.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_user_settings.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +2 -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_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 +10 -1
- 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 +6 -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 +5 -0
- data/lib/facebook_ads/ad_objects/ad_custom_derived_metrics.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +5 -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 +16 -0
- data/lib/facebook_ads/ad_objects/ad_study.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +3 -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 +17 -11
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +14 -0
- data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +2 -1
- data/lib/facebook_ads/ad_objects/application.rb +1 -1
- 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/branded_content_shadow_ig_media_id.rb +5 -0
- data/lib/facebook_ads/ad_objects/business.rb +8 -0
- data/lib/facebook_ads/ad_objects/business_agreement.rb +4 -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/campaign.rb +12 -0
- data/lib/facebook_ads/ad_objects/canvas.rb +2 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +0 -3
- 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/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 +7 -0
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +2 -1
- 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/{favorite_catalog.rb → marketing_messages_onboarding_status.rb} +5 -3
- data/lib/facebook_ads/ad_objects/media_copyright_attribution.rb +0 -1
- 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/open_bridge_configuration.rb +1 -0
- data/lib/facebook_ads/ad_objects/page.rb +47 -1
- 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 +14 -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 +10 -1
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +1 -1
- data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +2 -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/trending_topics_spec.rb +27 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -0
- data/lib/facebook_ads/ad_objects/user.rb +1 -6
- data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +1 -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 +50 -1
- data/lib/facebook_ads/ad_objects/whats_app_business_health_status.rb +1 -0
- data/lib/facebook_ads/version.rb +1 -1
- metadata +12 -5
@@ -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,6 +61,9 @@ 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'
|
@@ -71,8 +75,10 @@ module FacebookAds
|
|
71
75
|
field :video_auto_crop, 'AdCreativeFeatureDetails'
|
72
76
|
field :video_filtering, 'AdCreativeFeatureDetails'
|
73
77
|
field :video_highlight, 'AdCreativeFeatureDetails'
|
78
|
+
field :video_highlights, 'AdCreativeFeatureDetails'
|
74
79
|
field :video_to_image, 'AdCreativeFeatureDetails'
|
75
80
|
field :video_uncrop, 'AdCreativeFeatureDetails'
|
81
|
+
field :wa_mm_image_filtering, 'AdCreativeFeatureDetails'
|
76
82
|
field :wa_mm_text_truncation_length, 'AdCreativeFeatureDetails'
|
77
83
|
has_no_id
|
78
84
|
has_no_get
|
@@ -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,16 @@ 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'
|
25
30
|
field :website_summary_spec, 'object'
|
26
31
|
has_no_id
|
27
32
|
has_no_get
|
@@ -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",
|
@@ -45,6 +49,7 @@ module FacebookAds
|
|
45
49
|
"INSTAGRAM_REELS_INSTREAM",
|
46
50
|
"INSTAGRAM_REELS_OVERLAY",
|
47
51
|
"INSTAGRAM_REELS_WEB",
|
52
|
+
"INSTAGRAM_REELS_WEB_M_SITE",
|
48
53
|
"INSTAGRAM_SEARCH_CHAIN",
|
49
54
|
"INSTAGRAM_SEARCH_GRID",
|
50
55
|
"INSTAGRAM_STANDARD",
|
@@ -55,6 +60,7 @@ module FacebookAds
|
|
55
60
|
"INSTANT_ARTICLE_RECIRCULATION_AD",
|
56
61
|
"INSTANT_ARTICLE_STANDARD",
|
57
62
|
"INSTREAM_BANNER_DESKTOP",
|
63
|
+
"INSTREAM_BANNER_FEED_IOS",
|
58
64
|
"INSTREAM_BANNER_FULLSCREEN_IOS",
|
59
65
|
"INSTREAM_BANNER_FULLSCREEN_MOBILE",
|
60
66
|
"INSTREAM_BANNER_IMMERSIVE_MOBILE",
|
@@ -110,6 +110,7 @@ module FacebookAds
|
|
110
110
|
field :custom_event_str, 'string'
|
111
111
|
field :custom_event_type, { enum: -> { CUSTOM_EVENT_TYPE }}
|
112
112
|
field :dataset_split_id, 'string'
|
113
|
+
field :dataset_split_ids, { list: 'string' }
|
113
114
|
field :event_id, 'string'
|
114
115
|
field :full_funnel_objective, { enum: -> { FULL_FUNNEL_OBJECTIVE }}
|
115
116
|
field :fundraiser_campaign_id, 'string'
|
@@ -117,7 +118,9 @@ module FacebookAds
|
|
117
118
|
field :lead_ads_custom_event_type, { enum: -> { LEAD_ADS_CUSTOM_EVENT_TYPE }}
|
118
119
|
field :lead_ads_form_event_source_type, 'string'
|
119
120
|
field :lead_ads_offsite_conversion_type, 'string'
|
121
|
+
field :lead_ads_selected_pixel_id, 'string'
|
120
122
|
field :mcme_conversion_id, 'string'
|
123
|
+
field :multi_event_product, 'string'
|
121
124
|
field :object_store_url, 'string'
|
122
125
|
field :object_store_urls, { list: 'string' }
|
123
126
|
field :offer_id, 'string'
|
@@ -125,6 +128,8 @@ module FacebookAds
|
|
125
128
|
field :offsite_conversion_event_id, 'string'
|
126
129
|
field :omnichannel_object, 'object'
|
127
130
|
field :page_id, 'string'
|
131
|
+
field :passback_application_id, 'string'
|
132
|
+
field :passback_pixel_id, 'string'
|
128
133
|
field :pixel_aggregation_rule, 'string'
|
129
134
|
field :pixel_id, 'string'
|
130
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'
|
@@ -178,6 +178,7 @@ module FacebookAds
|
|
178
178
|
|
179
179
|
OPTIMIZATION_SUB_EVENT = [
|
180
180
|
"NONE",
|
181
|
+
"POST_INTERACTION",
|
181
182
|
"TRAVEL_INTENT",
|
182
183
|
"TRAVEL_INTENT_BUCKET_01",
|
183
184
|
"TRAVEL_INTENT_BUCKET_02",
|
@@ -198,6 +199,10 @@ module FacebookAds
|
|
198
199
|
"5",
|
199
200
|
"6",
|
200
201
|
"7",
|
202
|
+
"8",
|
203
|
+
"9",
|
204
|
+
"10",
|
205
|
+
"11",
|
201
206
|
]
|
202
207
|
|
203
208
|
TUNE_FOR_CATEGORY = [
|
@@ -274,6 +279,7 @@ module FacebookAds
|
|
274
279
|
field :optimization_goal, { enum: -> { OPTIMIZATION_GOAL }}
|
275
280
|
field :optimization_sub_event, 'string'
|
276
281
|
field :pacing_type, { list: 'string' }
|
282
|
+
field :placement_soft_opt_out, 'Placement'
|
277
283
|
field :promoted_object, 'AdPromotedObject'
|
278
284
|
field :recommendations, { list: 'AdRecommendation' }
|
279
285
|
field :recurring_budget_semantics, 'bool'
|
@@ -289,8 +295,12 @@ module FacebookAds
|
|
289
295
|
field :targeting_optimization_types, { list: 'hash' }
|
290
296
|
field :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
|
291
297
|
field :time_based_ad_rotation_intervals, { list: 'int' }
|
298
|
+
field :trending_topics_spec, 'TrendingTopicsSpec'
|
292
299
|
field :updated_time, 'datetime'
|
293
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' }
|
294
304
|
field :budget_source, { enum: -> { BUDGET_SOURCE }}
|
295
305
|
field :budget_split_set_id, 'string'
|
296
306
|
field :campaign_spec, 'object'
|
@@ -358,6 +368,10 @@ module FacebookAds
|
|
358
368
|
end
|
359
369
|
|
360
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
|
361
375
|
edge.post 'HighDemandPeriod' do |api|
|
362
376
|
api.has_param :budget_value, 'int'
|
363
377
|
api.has_param :budget_value_type, { enum: -> { HighDemandPeriod::BUDGET_VALUE_TYPE }}
|
@@ -405,6 +419,7 @@ module FacebookAds
|
|
405
419
|
api.has_param :export_name, 'string'
|
406
420
|
api.has_param :fields, { list: 'string' }
|
407
421
|
api.has_param :filtering, { list: 'object' }
|
422
|
+
api.has_param :graph_cache, 'bool'
|
408
423
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
409
424
|
api.has_param :limit, 'int'
|
410
425
|
api.has_param :product_id_limit, 'int'
|
@@ -429,6 +444,7 @@ module FacebookAds
|
|
429
444
|
api.has_param :export_name, 'string'
|
430
445
|
api.has_param :fields, { list: 'string' }
|
431
446
|
api.has_param :filtering, { list: 'object' }
|
447
|
+
api.has_param :graph_cache, 'bool'
|
432
448
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
433
449
|
api.has_param :limit, 'int'
|
434
450
|
api.has_param :product_id_limit, 'int'
|
@@ -48,6 +48,7 @@ module FacebookAds
|
|
48
48
|
"DIM_SUM",
|
49
49
|
"DIRECTED_POST_ATTACHMENT",
|
50
50
|
"DIRECT_INBOX",
|
51
|
+
"DOUBLE_PROD_EXPERIMENT",
|
51
52
|
"DROPS_SHOPPING_EVENT_PAGE",
|
52
53
|
"DYNAMIC_ITEM_VIDEO",
|
53
54
|
"DYNAMIC_TEMPLATE_VIDEO",
|
@@ -100,6 +101,7 @@ module FacebookAds
|
|
100
101
|
"MUSIC_CLIP",
|
101
102
|
"MUSIC_CLIP_IN_COMMENT",
|
102
103
|
"MUSIC_CLIP_IN_LIGHTWEIGHT_STATUS",
|
104
|
+
"MUSIC_CLIP_IN_MAPLE_POST",
|
103
105
|
"MUSIC_CLIP_IN_MSGR_NOTE",
|
104
106
|
"MUSIC_CLIP_IN_POLL_OPTION",
|
105
107
|
"MUSIC_CLIP_ON_DATING_PROFILE",
|
@@ -307,6 +309,7 @@ module FacebookAds
|
|
307
309
|
field :privacy, 'Privacy'
|
308
310
|
field :published, 'bool'
|
309
311
|
field :scheduled_publish_time, 'datetime'
|
312
|
+
field :season, 'VideoList'
|
310
313
|
field :source, 'string'
|
311
314
|
field :spherical, 'bool'
|
312
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
|
@@ -21,18 +21,21 @@ module FacebookAds
|
|
21
21
|
field :_1d_ev, 'string'
|
22
22
|
field :_1d_ev_all_conversions, 'string'
|
23
23
|
field :_1d_ev_first_conversion, 'string'
|
24
|
+
field :_1d_passback, 'string'
|
24
25
|
field :_1d_view, 'string'
|
25
26
|
field :_1d_view_all_conversions, 'string'
|
26
27
|
field :_1d_view_first_conversion, 'string'
|
27
28
|
field :_28d_click, 'string'
|
28
29
|
field :_28d_click_all_conversions, 'string'
|
29
30
|
field :_28d_click_first_conversion, 'string'
|
31
|
+
field :_28d_passback, 'string'
|
30
32
|
field :_28d_view, 'string'
|
31
33
|
field :_28d_view_all_conversions, 'string'
|
32
34
|
field :_28d_view_first_conversion, 'string'
|
33
35
|
field :_7d_click, 'string'
|
34
36
|
field :_7d_click_all_conversions, 'string'
|
35
37
|
field :_7d_click_first_conversion, 'string'
|
38
|
+
field :_7d_passback, 'string'
|
36
39
|
field :_7d_view, 'string'
|
37
40
|
field :_7d_view_all_conversions, 'string'
|
38
41
|
field :_7d_view_first_conversion, 'string'
|
@@ -21,18 +21,21 @@ module FacebookAds
|
|
21
21
|
field :_1d_ev, { list: 'int' }
|
22
22
|
field :_1d_ev_all_conversions, { list: 'int' }
|
23
23
|
field :_1d_ev_first_conversion, { list: 'int' }
|
24
|
+
field :_1d_passback, { list: 'int' }
|
24
25
|
field :_1d_view, { list: 'int' }
|
25
26
|
field :_1d_view_all_conversions, { list: 'int' }
|
26
27
|
field :_1d_view_first_conversion, { list: 'int' }
|
27
28
|
field :_28d_click, { list: 'int' }
|
28
29
|
field :_28d_click_all_conversions, { list: 'int' }
|
29
30
|
field :_28d_click_first_conversion, { list: 'int' }
|
31
|
+
field :_28d_passback, { list: 'int' }
|
30
32
|
field :_28d_view, { list: 'int' }
|
31
33
|
field :_28d_view_all_conversions, { list: 'int' }
|
32
34
|
field :_28d_view_first_conversion, { list: 'int' }
|
33
35
|
field :_7d_click, { list: 'int' }
|
34
36
|
field :_7d_click_all_conversions, { list: 'int' }
|
35
37
|
field :_7d_click_first_conversion, { list: 'int' }
|
38
|
+
field :_7d_passback, { list: 'int' }
|
36
39
|
field :_7d_view, { list: 'int' }
|
37
40
|
field :_7d_view_all_conversions, { list: 'int' }
|
38
41
|
field :_7d_view_first_conversion, { list: 'int' }
|
@@ -73,10 +73,14 @@ module FacebookAds
|
|
73
73
|
"call_to_action_asset",
|
74
74
|
"coarse_conversion_value",
|
75
75
|
"comscore_market",
|
76
|
-
"comscore_market_code",
|
77
76
|
"conversion_destination",
|
78
77
|
"country",
|
78
|
+
"creative_automation_asset_id",
|
79
79
|
"creative_relaxation_asset_type",
|
80
|
+
"crm_advertiser_l12_territory_ids",
|
81
|
+
"crm_advertiser_subvertical_id",
|
82
|
+
"crm_advertiser_vertical_id",
|
83
|
+
"crm_ult_advertiser_id",
|
80
84
|
"description_asset",
|
81
85
|
"device_platform",
|
82
86
|
"dma",
|
@@ -109,10 +113,22 @@ module FacebookAds
|
|
109
113
|
"place_page_id",
|
110
114
|
"platform_position",
|
111
115
|
"postback_sequence_index",
|
116
|
+
"product_brand_breakdown",
|
117
|
+
"product_category_breakdown",
|
118
|
+
"product_custom_label_0_breakdown",
|
119
|
+
"product_custom_label_1_breakdown",
|
120
|
+
"product_custom_label_2_breakdown",
|
121
|
+
"product_custom_label_3_breakdown",
|
122
|
+
"product_custom_label_4_breakdown",
|
123
|
+
"product_group_content_id_breakdown",
|
112
124
|
"product_id",
|
125
|
+
"product_set_id_breakdown",
|
113
126
|
"publisher_platform",
|
114
127
|
"redownload",
|
115
128
|
"region",
|
129
|
+
"rta_ugc_topic",
|
130
|
+
"rule_set_id",
|
131
|
+
"rule_set_name",
|
116
132
|
"signal_source_bucket",
|
117
133
|
"skan_campaign_id",
|
118
134
|
"skan_conversion_id",
|
@@ -319,17 +335,7 @@ module FacebookAds
|
|
319
335
|
field :outbound_clicks, { list: 'AdsActionStats' }
|
320
336
|
field :outbound_clicks_ctr, { list: 'AdsActionStats' }
|
321
337
|
field :place_page_name, 'string'
|
322
|
-
field :product_brand, 'string'
|
323
|
-
field :product_category, 'string'
|
324
|
-
field :product_content_id, 'string'
|
325
|
-
field :product_custom_label_0, 'string'
|
326
|
-
field :product_custom_label_1, 'string'
|
327
|
-
field :product_custom_label_2, 'string'
|
328
|
-
field :product_custom_label_3, 'string'
|
329
|
-
field :product_custom_label_4, 'string'
|
330
|
-
field :product_group_content_id, 'string'
|
331
338
|
field :product_group_retailer_id, 'string'
|
332
|
-
field :product_name, 'string'
|
333
339
|
field :product_retailer_id, 'string'
|
334
340
|
field :product_views, 'string'
|
335
341
|
field :purchase_per_landing_page_view, 'string'
|
@@ -19,9 +19,13 @@ module FacebookAds
|
|
19
19
|
field :add_overlays_opt_in_status, 'string'
|
20
20
|
field :adgroup_name_template, 'object'
|
21
21
|
field :ads_cs_catalog_opt_out_timestamp, { list: 'hash' }
|
22
|
+
field :ads_cs_sitelinks_opt_in_status, 'string'
|
23
|
+
field :ads_cs_sitelinks_opt_out_timestamp, { list: 'hash' }
|
22
24
|
field :ads_tool_visits, { list: 'object' }
|
25
|
+
field :aplusc_ai_agent_opt_in_status, 'string'
|
23
26
|
field :aplusc_carousel_cda_opt_in_status, 'string'
|
24
27
|
field :aplusc_carousel_inline_comment_opt_in_status, 'string'
|
28
|
+
field :aplusc_da_opt_in_status, 'string'
|
25
29
|
field :aplusc_enhance_cta_opt_in_status, 'string'
|
26
30
|
field :aplusc_epa_opt_in_status, 'string'
|
27
31
|
field :aplusc_local_store_extension_opt_in_status, 'string'
|
@@ -37,6 +41,8 @@ module FacebookAds
|
|
37
41
|
field :campaign_name_template, 'object'
|
38
42
|
field :carousel_to_video_opt_in_status, 'string'
|
39
43
|
field :connected_sources_catalog_opt_in_status, 'string'
|
44
|
+
field :create_cta_sticker_opt_in_status, 'string'
|
45
|
+
field :creative_flex_opt_in_status, 'string'
|
40
46
|
field :da_add_overlays_opt_in_status, 'string'
|
41
47
|
field :da_hide_price_opt_in_status, 'string'
|
42
48
|
field :default_creation_mode, 'string'
|
@@ -45,15 +51,18 @@ module FacebookAds
|
|
45
51
|
field :export_format_default, 'string'
|
46
52
|
field :focus_mode_default, 'string'
|
47
53
|
field :gen_ai_alpha_test_status, 'int'
|
54
|
+
field :gen_ai_auto_select_opt_in_status, 'string'
|
48
55
|
field :id, 'string'
|
49
56
|
field :image_background_generation_opt_in_status, 'string'
|
50
57
|
field :image_brightness_and_contrast_opt_in_status, 'string'
|
51
58
|
field :image_expansion_opt_in_status, 'string'
|
59
|
+
field :image_templates_text_extraction_opt_in_status, 'string'
|
52
60
|
field :is_ads_ai_consented, 'bool'
|
53
61
|
field :is_cbo_default_on, 'bool'
|
54
62
|
field :is_se_removal_guidance_dismissed, 'bool'
|
55
63
|
field :last_used_post_format, 'string'
|
56
64
|
field :last_visited_time, 'datetime'
|
65
|
+
field :metadata_brand_kit_last_opt_out_timestamp, 'int'
|
57
66
|
field :metadata_brand_kit_opt_in_status, 'string'
|
58
67
|
field :music_on_reels_opt_in, { list: 'hash' }
|
59
68
|
field :muted_cbo_midflight_education_messages, { list: 'string' }
|
@@ -64,6 +73,8 @@ module FacebookAds
|
|
64
73
|
field :placement_group_vertical_opt_in_status, 'string'
|
65
74
|
field :previously_seen_recommendations, { list: 'string' }
|
66
75
|
field :product_extensions_opt_in, 'string'
|
76
|
+
field :reactive_control_settings, { list: 'object' }
|
77
|
+
field :replace_media_text_opt_in_status, 'string'
|
67
78
|
field :sa_off_conv_loc_seen, 'string'
|
68
79
|
field :saoff_published_l2_conv_loc_seen, 'string'
|
69
80
|
field :saon_migr_l1_seen_status, 'string'
|
@@ -94,6 +105,9 @@ module FacebookAds
|
|
94
105
|
field :use_pe_create_flow, 'bool'
|
95
106
|
field :use_stepper_primary_entry, 'bool'
|
96
107
|
field :user, 'User'
|
108
|
+
field :website_media_opt_in_status, 'string'
|
109
|
+
field :website_reviews_data_opt_in_status, 'string'
|
110
|
+
field :website_selling_points_data_opt_in_status, 'string'
|
97
111
|
has_no_post
|
98
112
|
has_no_delete
|
99
113
|
|
@@ -28,13 +28,14 @@ module FacebookAds
|
|
28
28
|
|
29
29
|
field :id, 'string'
|
30
30
|
field :is_default_setting, 'bool'
|
31
|
+
field :last_attach_time, 'datetime'
|
31
32
|
field :name, 'string'
|
32
33
|
field :product_type, 'string'
|
33
34
|
field :status, 'string'
|
34
35
|
field :rules, { list: 'hash' }
|
35
36
|
has_no_delete
|
36
37
|
|
37
|
-
has_edge :
|
38
|
+
has_edge :deleteruleset do |edge|
|
38
39
|
edge.post 'AdsValueAdjustmentRuleCollection'
|
39
40
|
end
|
40
41
|
|
@@ -250,7 +250,7 @@ module FacebookAds
|
|
250
250
|
api.has_param :include_video_data, 'bool'
|
251
251
|
api.has_param :install_id, 'string'
|
252
252
|
api.has_param :install_referrer, 'string'
|
253
|
-
api.has_param :install_timestamp, '
|
253
|
+
api.has_param :install_timestamp, 'double'
|
254
254
|
api.has_param :installer_package, 'string'
|
255
255
|
api.has_param :is_fb, 'bool'
|
256
256
|
api.has_param :limited_data_use, 'bool'
|
@@ -19,6 +19,7 @@ module FacebookAds
|
|
19
19
|
field :all_ddex_main_artists, 'string'
|
20
20
|
field :audio_cluster_id, 'string'
|
21
21
|
field :cover_image_source, 'string'
|
22
|
+
field :description, 'string'
|
22
23
|
field :display_artist, 'string'
|
23
24
|
field :download_hd_url, 'string'
|
24
25
|
field :download_sd_url, 'string'
|
@@ -19,17 +19,5 @@ module FacebookAds
|
|
19
19
|
has_no_post
|
20
20
|
has_no_delete
|
21
21
|
|
22
|
-
has_edge :models do |edge|
|
23
|
-
edge.get do |api|
|
24
|
-
api.has_param :client_name, 'string'
|
25
|
-
api.has_param :client_version, 'string'
|
26
|
-
api.has_param :config_id, 'string'
|
27
|
-
api.has_param :force_generate, 'bool'
|
28
|
-
api.has_param :platform, 'string'
|
29
|
-
api.has_param :profile, 'string'
|
30
|
-
api.has_param :sdk_version, 'string'
|
31
|
-
end
|
32
|
-
end
|
33
|
-
|
34
22
|
end
|
35
23
|
end
|
@@ -14,6 +14,11 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class BrandedContentShadowIgMediaId < AdObject
|
17
|
+
MEDIA_RELATIONSHIP = [
|
18
|
+
"IS_TAGGED",
|
19
|
+
"OWNED",
|
20
|
+
]
|
21
|
+
|
17
22
|
|
18
23
|
field :eligibility_errors, { list: 'string' }
|
19
24
|
field :has_permission_for_partnership_ad, 'bool'
|
@@ -858,6 +858,7 @@ module FacebookAds
|
|
858
858
|
field :id, 'string'
|
859
859
|
field :is_hidden, 'bool'
|
860
860
|
field :link, 'string'
|
861
|
+
field :marketing_messages_onboarding_status, 'MarketingMessagesOnboardingStatus'
|
861
862
|
field :name, 'string'
|
862
863
|
field :payment_account_id, 'string'
|
863
864
|
field :primary_page, 'Page'
|
@@ -895,6 +896,13 @@ module FacebookAds
|
|
895
896
|
end
|
896
897
|
end
|
897
898
|
|
899
|
+
has_edge :ad_custom_derived_metrics do |edge|
|
900
|
+
edge.get 'AdCustomDerivedMetrics' do |api|
|
901
|
+
api.has_param :adhoc_custom_metrics, { list: 'string' }
|
902
|
+
api.has_param :scope, { enum: -> { AdCustomDerivedMetrics::SCOPE }}
|
903
|
+
end
|
904
|
+
end
|
905
|
+
|
898
906
|
has_edge :ad_review_requests do |edge|
|
899
907
|
edge.post do |api|
|
900
908
|
api.has_param :ad_account_ids, { list: 'string' }
|