facebookbusiness 22.0.2 → 23.0.1
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_suggested_tag.rb → ab_test_post_test_actions.rb} +2 -4
- data/lib/facebook_ads/ad_objects/ad.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +27 -40
- 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 +35 -1
- data/lib/facebook_ads/ad_objects/ad_account_agency_fee_config.rb +34 -0
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -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 +6 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +8 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_asset_onsite_destinations.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_asset_target_rule_targeting.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_group_agency_fee_config_for_api.rb +27 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_creative_feature_customizations.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +9 -0
- data/lib/facebook_ads/ad_objects/ad_creative_format_transformation_spec.rb +26 -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_image_overlay_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_media_sourcing_spec.rb +24 -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 +2 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +7 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +29 -0
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +31 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +4 -13
- data/lib/facebook_ads/ad_objects/ads_action_stats.rb +3 -0
- data/lib/facebook_ads/ad_objects/ads_dataset.rb +5 -0
- data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb +3 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +50 -0
- data/lib/facebook_ads/ad_objects/ads_naming_template.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_pixel_capi_integration_quality.rb +5 -0
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +11 -0
- data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +10 -0
- data/lib/facebook_ads/ad_objects/ai_generated_product_image.rb +26 -0
- data/lib/facebook_ads/ad_objects/alm_event.rb +1 -0
- data/lib/facebook_ads/ad_objects/alm_guidance.rb +1 -0
- data/lib/facebook_ads/ad_objects/alm_guidance_metrics.rb +9 -0
- data/lib/facebook_ads/ad_objects/apac_mon_seller_status_api_container.rb +25 -0
- data/lib/facebook_ads/ad_objects/application.rb +17 -6
- data/lib/facebook_ads/ad_objects/audio_sub_label.rb +29 -0
- data/lib/facebook_ads/ad_objects/{shadow_ig_media_boosted_insights_result.rb → branded_content_fb_promode_user.rb} +5 -6
- data/lib/facebook_ads/ad_objects/business.rb +40 -7
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_role_request.rb +19 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +23 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +3 -0
- data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +0 -1
- data/lib/facebook_ads/ad_objects/china_business_onboarding_vetting_request.rb +3 -0
- data/lib/facebook_ads/ad_objects/collaborative_ads_partner_businesses.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +6 -0
- data/lib/facebook_ads/ad_objects/content_delivery_report.rb +2 -4
- data/lib/facebook_ads/ad_objects/copyright_ownership_transfer.rb +28 -0
- data/lib/facebook_ads/ad_objects/creative_multicell_test_config.rb +4 -0
- data/lib/facebook_ads/ad_objects/ctwa_whats_app_numbers_info.rb +1 -0
- data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -1
- data/lib/facebook_ads/ad_objects/custom_audience_integrity_flags_and_appeal_status.rb +29 -0
- data/lib/facebook_ads/ad_objects/delivery_window.rb +1 -0
- data/lib/facebook_ads/ad_objects/event.rb +1 -0
- data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +3 -0
- data/lib/facebook_ads/ad_objects/group.rb +2 -0
- data/lib/facebook_ads/ad_objects/home_listing.rb +2 -0
- data/lib/facebook_ads/ad_objects/ig_comment_from_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_media.rb +3 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +26 -0
- data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb +549 -0
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +8 -2
- data/lib/facebook_ads/ad_objects/ig_user_messenger_profile.rb +26 -0
- 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_result.rb +1 -2
- data/lib/facebook_ads/ad_objects/{ads_value_adjustment_rule.rb → instagram_business_asset.rb} +3 -6
- data/lib/facebook_ads/ad_objects/{bespoke_partner_guidance_laser.rb → instagram_thread.rb} +4 -6
- data/lib/facebook_ads/ad_objects/instagram_user.rb +0 -11
- data/lib/facebook_ads/ad_objects/lead_gen_client_validation_rules.rb +27 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +2 -0
- data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page.rb +1 -0
- data/lib/facebook_ads/ad_objects/lookalike_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/managed_partner_business.rb +544 -0
- data/lib/facebook_ads/ad_objects/management_site_link.rb +31 -0
- data/lib/facebook_ads/ad_objects/mcom_invoice_status.rb +3 -0
- data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/messenger_call_settings.rb +2 -0
- data/lib/facebook_ads/ad_objects/messenger_profile.rb +0 -2
- data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +5 -0
- data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +4 -0
- data/lib/facebook_ads/ad_objects/organization.rb +0 -2
- data/lib/facebook_ads/ad_objects/page.rb +17 -7
- data/lib/facebook_ads/ad_objects/product_catalog.rb +44 -1
- data/lib/facebook_ads/ad_objects/product_catalog_check_marketplace_partner_sellers_status.rb +27 -0
- data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_group.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +10 -0
- data/lib/facebook_ads/ad_objects/product_item_video_data.rb +26 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +1 -0
- data/lib/facebook_ads/ad_objects/robot.rb +1 -0
- data/lib/facebook_ads/ad_objects/shadow_ig_user_ctx_partner_app_welcome_message_flow.rb +31 -0
- data/lib/facebook_ads/ad_objects/system_user.rb +4 -0
- data/lib/facebook_ads/ad_objects/targeting.rb +2 -0
- data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +0 -1
- data/lib/facebook_ads/ad_objects/user.rb +8 -1
- data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/vehicle.rb +3 -0
- data/lib/facebook_ads/ad_objects/{split_test_config.rb → website_creative_info.rb} +3 -7
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +8 -4
- data/lib/facebook_ads/ad_objects/whats_app_business_pre_verified_phone_number.rb +1 -1
- data/lib/facebook_ads/version.rb +2 -2
- metadata +22 -9
- data/lib/facebook_ads/ad_objects/event_tour.rb +0 -35
- data/lib/facebook_ads/ad_objects/keyword_delivery_report.rb +0 -33
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dcd8a5a008d2beb3575f08e2a2416d4d2ba3a16b839e011c5a2e4418428578f6
|
4
|
+
data.tar.gz: 5356e50d8add9846073cf98c2ae5da146ba2c061aece3859aef7910e072faeff
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 41ddd59a4c31a74d666d78600829688a99af91d109a7bf766aa7728742ab4e19c901684f4847fcfdb2a82fd161251da985034d4f71680a054288b996183ad4c2
|
7
|
+
data.tar.gz: c7f484c5645b8ddaf57e077aa2b3eb71e51877082b4a64fa2dbd3ee3d4e85306ff31285b5838ec22d8c7f767b3df2802773c50189c0b9240d310fa042af9369f
|
data/lib/facebook_ads/ad_objects/{ad_account_suggested_tag.rb → ab_test_post_test_actions.rb}
RENAMED
@@ -13,11 +13,9 @@ 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 AbTestPostTestActions < AdObject
|
17
17
|
|
18
|
-
field :
|
19
|
-
field :x, 'double'
|
20
|
-
field :y, 'double'
|
18
|
+
field :auto_change_budget_to_winner, 'int'
|
21
19
|
has_no_id
|
22
20
|
has_no_get
|
23
21
|
has_no_post
|
@@ -164,6 +164,7 @@ module FacebookAds
|
|
164
164
|
end
|
165
165
|
edge.post 'Ad' do |api|
|
166
166
|
api.has_param :adset_id, 'string'
|
167
|
+
api.has_param :creative_parameters, 'AdCreative'
|
167
168
|
api.has_param :rename_options, 'object'
|
168
169
|
api.has_param :status_option, { enum: -> { Ad::STATUS_OPTION }}
|
169
170
|
end
|
@@ -183,6 +184,7 @@ module FacebookAds
|
|
183
184
|
api.has_param :fields, { list: 'string' }
|
184
185
|
api.has_param :filtering, { list: 'object' }
|
185
186
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
187
|
+
api.has_param :limit, 'int'
|
186
188
|
api.has_param :product_id_limit, 'int'
|
187
189
|
api.has_param :sort, { list: 'string' }
|
188
190
|
api.has_param :summary, { list: 'string' }
|
@@ -206,6 +208,7 @@ module FacebookAds
|
|
206
208
|
api.has_param :fields, { list: 'string' }
|
207
209
|
api.has_param :filtering, { list: 'object' }
|
208
210
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
211
|
+
api.has_param :limit, 'int'
|
209
212
|
api.has_param :product_id_limit, 'int'
|
210
213
|
api.has_param :sort, { list: 'string' }
|
211
214
|
api.has_param :summary, { list: 'string' }
|
@@ -121,7 +121,6 @@ module FacebookAds
|
|
121
121
|
"GENERIC",
|
122
122
|
"HOME_LISTING",
|
123
123
|
"HOTEL",
|
124
|
-
"JOB",
|
125
124
|
"LOCAL_SERVICE_BUSINESS",
|
126
125
|
"MEDIA_TITLE",
|
127
126
|
"OFFLINE_PRODUCT",
|
@@ -310,9 +309,11 @@ module FacebookAds
|
|
310
309
|
api.has_param :creative_sourcing_spec, 'hash'
|
311
310
|
api.has_param :degrees_of_freedom_spec, 'hash'
|
312
311
|
api.has_param :destination_set_id, 'string'
|
312
|
+
api.has_param :destination_spec, 'hash'
|
313
313
|
api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
|
314
314
|
api.has_param :enable_launch_instant_app, 'bool'
|
315
315
|
api.has_param :facebook_branded_content, 'hash'
|
316
|
+
api.has_param :format_transformation_spec, { list: 'hash' }
|
316
317
|
api.has_param :image_crops, 'hash'
|
317
318
|
api.has_param :image_file, 'string'
|
318
319
|
api.has_param :image_hash, 'string'
|
@@ -487,15 +488,19 @@ module FacebookAds
|
|
487
488
|
api.has_param :adlabels, { list: 'object' }
|
488
489
|
api.has_param :adset_schedule, { list: 'object' }
|
489
490
|
api.has_param :attribution_spec, { list: 'hash' }
|
491
|
+
api.has_param :automatic_manual_state, { enum: -> { AdSet::AUTOMATIC_MANUAL_STATE }}
|
490
492
|
api.has_param :bid_adjustments, 'object'
|
491
493
|
api.has_param :bid_amount, 'int'
|
492
494
|
api.has_param :bid_constraints, 'hash'
|
493
495
|
api.has_param :bid_strategy, { enum: -> { AdSet::BID_STRATEGY }}
|
494
496
|
api.has_param :billing_event, { enum: -> { AdSet::BILLING_EVENT }}
|
497
|
+
api.has_param :budget_source, { enum: -> { AdSet::BUDGET_SOURCE }}
|
498
|
+
api.has_param :budget_split_set_id, 'string'
|
495
499
|
api.has_param :campaign_attribution, 'object'
|
496
500
|
api.has_param :campaign_id, 'string'
|
497
501
|
api.has_param :campaign_spec, 'object'
|
498
502
|
api.has_param :creative_sequence, { list: 'string' }
|
503
|
+
api.has_param :creative_sequence_repetition_pattern, { enum: -> { AdSet::CREATIVE_SEQUENCE_REPETITION_PATTERN }}
|
499
504
|
api.has_param :daily_budget, 'int'
|
500
505
|
api.has_param :daily_imps, 'int'
|
501
506
|
api.has_param :daily_min_spend_target, 'int'
|
@@ -511,6 +516,7 @@ module FacebookAds
|
|
511
516
|
api.has_param :full_funnel_exploration_mode, { enum: -> { AdSet::FULL_FUNNEL_EXPLORATION_MODE }}
|
512
517
|
api.has_param :is_ba_skip_delayed_eligible, 'bool'
|
513
518
|
api.has_param :is_dynamic_creative, 'bool'
|
519
|
+
api.has_param :is_incremental_attribution_enabled, 'bool'
|
514
520
|
api.has_param :is_sac_cfca_terms_certified, 'bool'
|
515
521
|
api.has_param :lifetime_budget, 'int'
|
516
522
|
api.has_param :lifetime_imps, 'int'
|
@@ -614,6 +620,7 @@ module FacebookAds
|
|
614
620
|
api.has_param :instant_game_entry_point_data, 'string'
|
615
621
|
api.has_param :is_boost_intended, 'bool'
|
616
622
|
api.has_param :is_group_linking_post, 'bool'
|
623
|
+
api.has_param :is_partnership_ad, 'bool'
|
617
624
|
api.has_param :is_voice_clip, 'bool'
|
618
625
|
api.has_param :location_source_id, 'string'
|
619
626
|
api.has_param :name, 'string'
|
@@ -624,6 +631,7 @@ module FacebookAds
|
|
624
631
|
api.has_param :og_suggestion_mechanism, 'string'
|
625
632
|
api.has_param :original_fov, 'int'
|
626
633
|
api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
|
634
|
+
api.has_param :partnership_ad_ad_code, 'string'
|
627
635
|
api.has_param :publish_event_id, 'int'
|
628
636
|
api.has_param :referenced_sticker_id, 'string'
|
629
637
|
api.has_param :replace_video_id, 'string'
|
@@ -696,6 +704,18 @@ module FacebookAds
|
|
696
704
|
end
|
697
705
|
end
|
698
706
|
|
707
|
+
has_edge :asyncadcreatives do |edge|
|
708
|
+
edge.get 'AdAsyncRequestSet' do |api|
|
709
|
+
api.has_param :is_completed, 'bool'
|
710
|
+
end
|
711
|
+
edge.post 'AdAsyncRequestSet' do |api|
|
712
|
+
api.has_param :creative_spec, 'AdCreative'
|
713
|
+
api.has_param :name, 'string'
|
714
|
+
api.has_param :notification_mode, { enum: -> { AdAsyncRequestSet::NOTIFICATION_MODE }}
|
715
|
+
api.has_param :notification_uri, 'string'
|
716
|
+
end
|
717
|
+
end
|
718
|
+
|
699
719
|
has_edge :asyncadrequestsets do |edge|
|
700
720
|
edge.get 'AdAsyncRequestSet' do |api|
|
701
721
|
api.has_param :is_completed, 'bool'
|
@@ -787,7 +807,7 @@ module FacebookAds
|
|
787
807
|
end
|
788
808
|
|
789
809
|
has_edge :connected_instagram_accounts_with_iabp do |edge|
|
790
|
-
edge.get '
|
810
|
+
edge.get 'IgUser' do |api|
|
791
811
|
api.has_param :business_id, 'string'
|
792
812
|
end
|
793
813
|
end
|
@@ -796,10 +816,6 @@ module FacebookAds
|
|
796
816
|
edge.get 'AdsConversionGoal'
|
797
817
|
end
|
798
818
|
|
799
|
-
has_edge :cpa_guidance do |edge|
|
800
|
-
edge.get 'BespokePartnerGuidanceLaser'
|
801
|
-
end
|
802
|
-
|
803
819
|
has_edge :customaudiences do |edge|
|
804
820
|
edge.get 'CustomAudience' do |api|
|
805
821
|
api.has_param :business_id, 'string'
|
@@ -929,6 +945,7 @@ module FacebookAds
|
|
929
945
|
api.has_param :fields, { list: 'string' }
|
930
946
|
api.has_param :filtering, { list: 'object' }
|
931
947
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
948
|
+
api.has_param :limit, 'int'
|
932
949
|
api.has_param :product_id_limit, 'int'
|
933
950
|
api.has_param :sort, { list: 'string' }
|
934
951
|
api.has_param :summary, { list: 'string' }
|
@@ -952,6 +969,7 @@ module FacebookAds
|
|
952
969
|
api.has_param :fields, { list: 'string' }
|
953
970
|
api.has_param :filtering, { list: 'object' }
|
954
971
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
972
|
+
api.has_param :limit, 'int'
|
955
973
|
api.has_param :product_id_limit, 'int'
|
956
974
|
api.has_param :sort, { list: 'string' }
|
957
975
|
api.has_param :summary, { list: 'string' }
|
@@ -965,7 +983,7 @@ module FacebookAds
|
|
965
983
|
end
|
966
984
|
|
967
985
|
has_edge :instagram_accounts do |edge|
|
968
|
-
edge.get '
|
986
|
+
edge.get 'IgUser'
|
969
987
|
end
|
970
988
|
|
971
989
|
has_edge :ios_fourteen_campaign_limits do |edge|
|
@@ -974,26 +992,6 @@ module FacebookAds
|
|
974
992
|
end
|
975
993
|
end
|
976
994
|
|
977
|
-
has_edge :managed_partner_ads do |edge|
|
978
|
-
edge.post do |api|
|
979
|
-
api.has_param :campaign_group_id, 'int'
|
980
|
-
api.has_param :campaign_group_status, { enum: %w{ACTIVE ADSET_PAUSED ARCHIVED CAMPAIGN_PAUSED DELETED DISAPPROVED IN_PROCESS PAUSED PENDING_BILLING_INFO PENDING_REVIEW PREAPPROVED WITH_ISSUES }}
|
981
|
-
api.has_param :conversion_domain, 'string'
|
982
|
-
api.has_param :custom_event_type, { enum: %w{ADD_TO_CART CONTENT_VIEW PURCHASE }}
|
983
|
-
api.has_param :daily_budget, 'int'
|
984
|
-
api.has_param :dsa_beneficiary, 'string'
|
985
|
-
api.has_param :dsa_payor, 'string'
|
986
|
-
api.has_param :end_time, 'int'
|
987
|
-
api.has_param :lifetime_budget, 'int'
|
988
|
-
api.has_param :override_creative_text, 'string'
|
989
|
-
api.has_param :override_targeting_countries, { list: 'string' }
|
990
|
-
api.has_param :product_set_id, 'string'
|
991
|
-
api.has_param :start_time, 'int'
|
992
|
-
api.has_param :use_marketplace_template, 'bool'
|
993
|
-
api.has_param :use_seller_template, 'bool'
|
994
|
-
end
|
995
|
-
end
|
996
|
-
|
997
995
|
has_edge :matched_search_applications do |edge|
|
998
996
|
edge.get 'AdAccountMatchedSearchApplicationsEdgeData' do |api|
|
999
997
|
api.has_param :allow_incomplete_app, 'bool'
|
@@ -1117,6 +1115,7 @@ module FacebookAds
|
|
1117
1115
|
api.has_param :target_frequency, 'int'
|
1118
1116
|
api.has_param :target_frequency_reset_period, 'int'
|
1119
1117
|
api.has_param :target_spec, 'Targeting'
|
1118
|
+
api.has_param :trending_topics_spec, 'hash'
|
1120
1119
|
api.has_param :video_view_length_constraint, 'int'
|
1121
1120
|
end
|
1122
1121
|
end
|
@@ -1151,15 +1150,6 @@ module FacebookAds
|
|
1151
1150
|
end
|
1152
1151
|
end
|
1153
1152
|
|
1154
|
-
has_edge :suggested_product_tags do |edge|
|
1155
|
-
edge.get 'AdAccountSuggestedTag' do |api|
|
1156
|
-
api.has_param :image_hash, 'string'
|
1157
|
-
api.has_param :instagram_actor_id, 'string'
|
1158
|
-
api.has_param :is_shops_ad, 'bool'
|
1159
|
-
api.has_param :page_id, 'string'
|
1160
|
-
end
|
1161
|
-
end
|
1162
|
-
|
1163
1153
|
has_edge :targetingbrowse do |edge|
|
1164
1154
|
edge.get 'AdAccountTargetingUnified' do |api|
|
1165
1155
|
api.has_param :excluded_category, 'string'
|
@@ -1245,13 +1235,10 @@ module FacebookAds
|
|
1245
1235
|
end
|
1246
1236
|
end
|
1247
1237
|
|
1248
|
-
has_edge :value_adjustment_rules do |edge|
|
1249
|
-
edge.get 'AdsValueAdjustmentRule'
|
1250
|
-
end
|
1251
|
-
|
1252
1238
|
has_edge :value_rule_set do |edge|
|
1253
1239
|
edge.get 'AdsValueAdjustmentRuleCollection' do |api|
|
1254
1240
|
api.has_param :product_type, { enum: -> { AdsValueAdjustmentRuleCollection::PRODUCT_TYPE }}
|
1241
|
+
api.has_param :status, { enum: -> { AdsValueAdjustmentRuleCollection::STATUS }}
|
1255
1242
|
end
|
1256
1243
|
edge.post 'AdsValueAdjustmentRuleCollection' do |api|
|
1257
1244
|
api.has_param :name, 'string'
|
@@ -22,7 +22,7 @@ module FacebookAds
|
|
22
22
|
"ACCOUNT_SPEND_LIMIT",
|
23
23
|
"ACCOUNT_SPEND_LIMIT_DUPLICATION",
|
24
24
|
"ACO_TOGGLE",
|
25
|
-
"
|
25
|
+
"ADSET_BUDGET_SHARING",
|
26
26
|
"ADS_REPORTING",
|
27
27
|
"ADS_STATUS",
|
28
28
|
"ADVANCED_CAMPAIGN_BUDGET",
|
@@ -56,12 +56,19 @@ module FacebookAds
|
|
56
56
|
"AD_LIFT_RECALL_GOAL_PRECREATE",
|
57
57
|
"AD_LIFT_RECALL_OPTIMIZATION_GOAL",
|
58
58
|
"AD_OBJECTIVE",
|
59
|
+
"AD_SET_BUDGET_SHARING_GUIDANCE",
|
59
60
|
"AEM_V2_INELIGIBLE",
|
60
61
|
"AGGREGATED_BID_LIMITED",
|
61
62
|
"AGGREGATED_BUDGET_LIMITED",
|
62
63
|
"AGGREGATED_COST_LIMITED",
|
64
|
+
"APLUSC_ADD_OVERLAYS",
|
65
|
+
"APLUSC_DYNAMIC_DESCRIPTION",
|
66
|
+
"APLUSC_IMAGE_BACKGROUND_GENERATION",
|
63
67
|
"APLUSC_MUSIC",
|
68
|
+
"APLUSC_RELEVANT_COMMENTS",
|
69
|
+
"APLUSC_STANDARD_ENHANCEMENTS_BUNDLE",
|
64
70
|
"APLUSC_TEXT_IMPROVEMENTS",
|
71
|
+
"APLUSC_VISUAL_TOUCHUPS",
|
65
72
|
"APLUS_C_CATALOG_DUPLICATION",
|
66
73
|
"APP_AEM_V2_INSTALLATION_PROMOTION",
|
67
74
|
"APP_ENGAGED_VIEW_CONVERSIONS_DUPLICATION",
|
@@ -79,6 +86,7 @@ module FacebookAds
|
|
79
86
|
"AUDIENCE_EXPANSION_LOOKALIKE",
|
80
87
|
"AUDIENCE_EXPANSION_RETARGETING",
|
81
88
|
"AUDIENCE_LEARNING_LIMITED",
|
89
|
+
"AUTOBID_TO_MANUAL_BID",
|
82
90
|
"AUTOFLOW_OPT_IN",
|
83
91
|
"AUTOFLOW_OPT_IN_FALLBACK_DUPLICATION_FLOW",
|
84
92
|
"AUTOFLOW_OPT_IN_V2",
|
@@ -87,14 +95,19 @@ module FacebookAds
|
|
87
95
|
"AUTO_BID",
|
88
96
|
"AUTO_CAT_SELECTION_ENHANCEMENT",
|
89
97
|
"BACKGROUND_GENERATION",
|
98
|
+
"BID_LIMITED_SENSITIVE",
|
99
|
+
"BID_LIMITED_STARVING",
|
90
100
|
"BLENDED_ADS",
|
91
101
|
"BLENDED_ADS_DUPLICATION",
|
92
102
|
"BLENDED_ADS_FOR_SHOPS_ADS_DUPLICATION",
|
93
103
|
"BPBAA_WITH_CAPI_UPSELL",
|
94
104
|
"BROADGEO_AM_UPSELL_GUIDANCE",
|
95
105
|
"BROAD_TARGETING",
|
106
|
+
"BUDGET_AMORTIZATION",
|
96
107
|
"BUDGET_LIMITED",
|
97
108
|
"BUDGET_REALLOCATION",
|
109
|
+
"CALL_ADS_DAYPARTING_L3_RECOMMENDATION",
|
110
|
+
"CAMPAIGN_GUIDANCE_NAVIGATOR_REELS_TIPS",
|
98
111
|
"CAPI",
|
99
112
|
"CAPI_CRM_FUNNEL",
|
100
113
|
"CAPI_CRM_GUIDANCE",
|
@@ -104,6 +117,7 @@ module FacebookAds
|
|
104
117
|
"CAPI_PERFORMANCE_MATCH_KEY",
|
105
118
|
"CAPI_PERFORMANCE_MATCH_KEY_V2",
|
106
119
|
"CASH_REWARDS_OPT_IN",
|
120
|
+
"CATALOG_DYNAMIC_MEDIA",
|
107
121
|
"CATALOG_MATCH_RATE",
|
108
122
|
"COMMERCE_SHOPS_ADS_DUPLICATION",
|
109
123
|
"CONNECTED_SOURCES",
|
@@ -131,16 +145,21 @@ module FacebookAds
|
|
131
145
|
"CREATIVE_LIMITED_HOURLY",
|
132
146
|
"CREATOR_ADS_PA_CONVERSION",
|
133
147
|
"CTA",
|
148
|
+
"CTM_AD_OBJECTIVE_GROWTH",
|
149
|
+
"CTM_LEADS_OPTIMIZATION_UPSELL",
|
134
150
|
"CTX_BUDGET_OPTIMIZATION",
|
135
151
|
"CTX_CREATION_PACKAGE",
|
136
152
|
"CTX_CTA_UPGRADE_IN_DUPLICATION",
|
137
153
|
"CTX_CTMPO_UPGRADE",
|
154
|
+
"CTX_CTWAPO_UPGRADE",
|
138
155
|
"CTX_GUIDANCE",
|
139
156
|
"CTX_HVS",
|
140
157
|
"CTX_MULTI_MESSAGE_DESTINATION",
|
141
158
|
"CTX_PRECREATE",
|
159
|
+
"CTX_PRODUCT_EXTENSION_DUPLICATION",
|
142
160
|
"CTX_SABR_CBO",
|
143
161
|
"CTX_SABR_NON_CBO",
|
162
|
+
"CTX_SMART_DEFAULTING",
|
144
163
|
"CTX_ZO_CBO",
|
145
164
|
"CTX_ZO_NON_CBO",
|
146
165
|
"CUSTOM_AUDIENCE_RELAXATION",
|
@@ -154,6 +173,7 @@ module FacebookAds
|
|
154
173
|
"DELIVERY_WARNING",
|
155
174
|
"DYNAMIC_ADVANTAGE_CAMPAIGN_BUDGET",
|
156
175
|
"ECOSYSTEM_BID_REDUCE_L1_CARDINALITY",
|
176
|
+
"ENABLE_WHATS_APP_ADS_DATA_SHARING",
|
157
177
|
"ENGAGED_VIEW_CONVERSIONS_CREATION",
|
158
178
|
"EVC_APP_DUPLICATION_UPGRADE",
|
159
179
|
"EVC_WEB_DUPLICATION_UPGRADE",
|
@@ -167,8 +187,11 @@ module FacebookAds
|
|
167
187
|
"HEURISTIC_DEFAULT_DURATION",
|
168
188
|
"HIGH_COST",
|
169
189
|
"HISTORICAL_BENCHMARK",
|
190
|
+
"IAA_ROAS_OPTIMIZATION",
|
170
191
|
"IG_MULTI_ADS",
|
171
192
|
"IG_SURFACES_MANUAL_PLACEMENTS",
|
193
|
+
"INCREMENTAL_ATTRIBUTION",
|
194
|
+
"INSTANT_FORMS_LEADS",
|
172
195
|
"LANDING_PAGE_VIEW",
|
173
196
|
"LANDING_PAGE_VIEW_OPTIMIZATION_GOAL",
|
174
197
|
"LANDING_PAGE_VIEW_PRECREATE",
|
@@ -201,9 +224,11 @@ module FacebookAds
|
|
201
224
|
"OPTIMAL_BAU",
|
202
225
|
"OUTCOME_FORECASTER_BUDGET_RECOMMENDATION",
|
203
226
|
"OUTCOME_FORECASTER_SHADOW_LOGGING",
|
227
|
+
"PARTNERSHIP_ADS",
|
204
228
|
"PAYMENT_METHOD",
|
205
229
|
"PERFORMANT_CREATIVE_REELS_OPT_IN",
|
206
230
|
"PFR_L1_INLINE_MMT",
|
231
|
+
"PIXELLESS_LPV_OPTIMIZATION_GOAL",
|
207
232
|
"PIXEL_OPTIMIZATION_AAM",
|
208
233
|
"PIXEL_OPTIMIZATION_AAM_PRECREATE",
|
209
234
|
"PIXEL_OPTIMIZATION_HIE",
|
@@ -216,6 +241,7 @@ module FacebookAds
|
|
216
241
|
"PREDICTIVE_CREATIVE_LIMITED_HOURLY",
|
217
242
|
"PREPARING_STATUS",
|
218
243
|
"PRODUCT_SET_BOOSTING",
|
244
|
+
"PROMO_ADS_UPSELL_GUIDANCE",
|
219
245
|
"PURCHASE_OPTIMIZATION",
|
220
246
|
"RAPID_LEARNING_LIMITED",
|
221
247
|
"RAPID_LEARNING_PHASE",
|
@@ -228,18 +254,22 @@ module FacebookAds
|
|
228
254
|
"REELS_PERFORMANT_CREATIVE",
|
229
255
|
"REELS_PLACEMENT",
|
230
256
|
"REVERT",
|
257
|
+
"REVIEW_CREATIVE_DUPLICATED_REJECTED_ADS",
|
231
258
|
"SABR_DEFAULT_DURATION",
|
232
259
|
"SALES_CONVERSION",
|
233
260
|
"SAVED_AUDIENCE",
|
234
261
|
"SCALE_GOOD_CAMPAIGN",
|
235
262
|
"SCALE_GOOD_CAMPAIGN_DUPLICATION",
|
236
263
|
"SCALE_GOOD_CAMPAIGN_SMB",
|
264
|
+
"SCALE_GOOD_CAMPAIGN_V2_DUPLICATION",
|
237
265
|
"SCALE_GOOD_CTX_CAMPAIGN",
|
266
|
+
"SEASONAL_CAMPAIGNS",
|
238
267
|
"SEMANTIC_BASED_AUDIENCE_DUPLICATION",
|
239
268
|
"SEMANTIC_BASED_AUDIENCE_EXPANSION",
|
240
269
|
"SETUP_PIXEL",
|
241
270
|
"SHOPS_ADS",
|
242
271
|
"SHOPS_ADS_DUPLICATION",
|
272
|
+
"SHOPS_ADS_SAOFF",
|
243
273
|
"SHOPS_ADS_TRAFFIC_CAP_SETTINGS",
|
244
274
|
"SHOP_ADS_V2",
|
245
275
|
"SIGNALS_DOWN_FUNNEL_EVENT_OPTIMIZATION",
|
@@ -256,6 +286,7 @@ module FacebookAds
|
|
256
286
|
"TAILORED_LEAD_AD_CAMPAIGN",
|
257
287
|
"TAILORED_MESSAGES_CAMPAIGN",
|
258
288
|
"TARGETING_CREATIVE_FRAGMENTATION",
|
289
|
+
"THREECO_WEB_PLUS_APP_UPSELL",
|
259
290
|
"TLA_CREATION_PACKAGE",
|
260
291
|
"TOP_ADSETS_WITH_ADS_UNDER_CAP",
|
261
292
|
"TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",
|
@@ -269,6 +300,7 @@ module FacebookAds
|
|
269
300
|
"UNUSED_BUDGET",
|
270
301
|
"VALUE_DIAGNOSTICS_GUIDANCE",
|
271
302
|
"VALUE_OPTIMIZATION_GOAL",
|
303
|
+
"VALUE_RULES_GUIDANCE",
|
272
304
|
"VIDEO_LENGTH",
|
273
305
|
"VIDEO_VIEWS_UPSELL",
|
274
306
|
"VIDEO_VIEWS_UPSELL_PRECREATE",
|
@@ -276,6 +308,8 @@ module FacebookAds
|
|
276
308
|
"WA_MESSAGING_PARTNERS",
|
277
309
|
"WA_MESSAGING_PARTNERS_PRECREATE",
|
278
310
|
"WEB_ENGAGED_VIEW_CONVERSIONS",
|
311
|
+
"WTWA_UPSELL_IN_DUPLICATION",
|
312
|
+
"WTWA_UPSELL_IN_SYD_AND_AM_TABLE",
|
279
313
|
"ZERO_CONVERSION",
|
280
314
|
"ZERO_IMPRESSION",
|
281
315
|
"ZERO_OUTCOME_BUDGET",
|
@@ -0,0 +1,34 @@
|
|
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 AdAccountAgencyFeeConfig < AdObject
|
17
|
+
STATUS = [
|
18
|
+
"ACTIVE",
|
19
|
+
"ARCHIVED",
|
20
|
+
"DRAFT",
|
21
|
+
"UNKNOWN",
|
22
|
+
]
|
23
|
+
|
24
|
+
|
25
|
+
field :can_add_agency_fee_to_invoice, 'bool'
|
26
|
+
field :default_agency_fee_pct, 'double'
|
27
|
+
field :id, 'string'
|
28
|
+
field :is_agency_fee_disabled, 'bool'
|
29
|
+
field :status, { enum: -> { STATUS }}
|
30
|
+
has_no_post
|
31
|
+
has_no_delete
|
32
|
+
|
33
|
+
end
|
34
|
+
end
|
@@ -54,6 +54,7 @@ module FacebookAds
|
|
54
54
|
]
|
55
55
|
|
56
56
|
REGULATED_COUNTRIES = [
|
57
|
+
"AC",
|
57
58
|
"AD",
|
58
59
|
"AE",
|
59
60
|
"AF",
|
@@ -386,6 +387,7 @@ module FacebookAds
|
|
386
387
|
"industries",
|
387
388
|
"instagram_hashtags",
|
388
389
|
"instagram_positions",
|
390
|
+
"install_state_application",
|
389
391
|
"instream_video_skippable_excluded",
|
390
392
|
"instream_video_sponsorship_placements",
|
391
393
|
"interest_defaults_source",
|
@@ -45,6 +45,7 @@ module FacebookAds
|
|
45
45
|
field :active_ads_quick_view_created, 'bool'
|
46
46
|
field :ad_account, 'AdAccount'
|
47
47
|
field :ad_object_export_format, 'string'
|
48
|
+
field :ads_manager_footer_row_toast_impressions, 'int'
|
48
49
|
field :auto_review_video_caption, 'bool'
|
49
50
|
field :campaign_overview_columns, { list: 'string' }
|
50
51
|
field :column_suggestion_status, 'string'
|
@@ -64,7 +65,9 @@ module FacebookAds
|
|
64
65
|
field :has_seen_leads_column_flexing_experience, 'bool'
|
65
66
|
field :has_seen_shops_ads_metrics_onboarding_tour, 'bool'
|
66
67
|
field :has_seen_shops_column_flexing_experience, 'bool'
|
68
|
+
field :has_used_quick_views_panel, 'bool'
|
67
69
|
field :hidden_optimization_tips, { list: 'hash' }
|
70
|
+
field :high_performing_quick_view_created, 'bool'
|
68
71
|
field :id, 'string'
|
69
72
|
field :is_3p_auth_setting_set, 'bool'
|
70
73
|
field :is_ads_manager_footer_row_preference_set, 'bool'
|
@@ -78,6 +81,7 @@ module FacebookAds
|
|
78
81
|
field :rb_export_format, 'string'
|
79
82
|
field :rb_export_raw_data, 'bool'
|
80
83
|
field :rb_export_summary_row, 'bool'
|
84
|
+
field :recently_used_quick_views, { list: 'string' }
|
81
85
|
field :saip_advertiser_setup_optimisation_guidance_overall_state, 'string'
|
82
86
|
field :saip_advertiser_setup_optimisation_guidance_state, { list: 'hash' }
|
83
87
|
field :shops_ads_metrics_onboarding_tour_close_count, 'int'
|
@@ -99,6 +103,8 @@ module FacebookAds
|
|
99
103
|
field :syd_campaign_trends_objective, { enum: -> { SYD_CAMPAIGN_TRENDS_OBJECTIVE }}
|
100
104
|
field :syd_campaign_trends_time_range, 'string'
|
101
105
|
field :syd_landing_page_opt_in_status, 'string'
|
106
|
+
field :text_gen_persona_opt_in_type, 'string'
|
107
|
+
field :text_variations_opt_in_out_ts, 'datetime'
|
102
108
|
field :text_variations_opt_in_type, 'string'
|
103
109
|
field :user, 'User'
|
104
110
|
has_no_post
|
@@ -15,6 +15,7 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdActivity < AdObject
|
17
17
|
EVENT_TYPE = [
|
18
|
+
"accept_custom_audience_appeal",
|
18
19
|
"account_spending_limit_reached",
|
19
20
|
"ad_account_add_user_to_role",
|
20
21
|
"ad_account_billing_charge",
|
@@ -35,15 +36,19 @@ module FacebookAds
|
|
35
36
|
"adaccount_update_audience_segment",
|
36
37
|
"add_funding_source",
|
37
38
|
"add_images",
|
39
|
+
"apply_restrictions_custom_audience",
|
38
40
|
"billing_event",
|
39
41
|
"campaign_ended",
|
40
42
|
"campaign_spending_limit_reached",
|
41
43
|
"conversion_event_updated",
|
42
44
|
"create_ad",
|
43
45
|
"create_ad_set",
|
46
|
+
"create_adaccount_agency_fee",
|
44
47
|
"create_audience",
|
45
48
|
"create_campaign_group",
|
49
|
+
"create_campaign_group_agency_fee",
|
46
50
|
"create_campaign_legacy",
|
51
|
+
"create_custom_audience_appeal",
|
47
52
|
"delete_audience",
|
48
53
|
"delete_images",
|
49
54
|
"di_ad_set_learning_stage_exit",
|
@@ -55,6 +60,7 @@ module FacebookAds
|
|
55
60
|
"lifetime_budget_spent",
|
56
61
|
"merge_campaigns",
|
57
62
|
"receive_audience",
|
63
|
+
"reject_custom_audience_appeal",
|
58
64
|
"remove_funding_source",
|
59
65
|
"remove_shared_audience",
|
60
66
|
"share_audience",
|
@@ -81,6 +87,7 @@ module FacebookAds
|
|
81
87
|
"update_ad_set_spend_cap",
|
82
88
|
"update_ad_set_target_spec",
|
83
89
|
"update_ad_targets_spec",
|
90
|
+
"update_adaccount_agency_fee",
|
84
91
|
"update_adgroup_stop_delivery",
|
85
92
|
"update_audience",
|
86
93
|
"update_campaign_ad_scheduling",
|
@@ -91,6 +98,7 @@ module FacebookAds
|
|
91
98
|
"update_campaign_delivery_destination",
|
92
99
|
"update_campaign_delivery_type",
|
93
100
|
"update_campaign_group_ad_scheduling",
|
101
|
+
"update_campaign_group_agency_fee",
|
94
102
|
"update_campaign_group_budget_scheduling_state",
|
95
103
|
"update_campaign_group_delivery_type",
|
96
104
|
"update_campaign_group_high_demand_periods",
|
@@ -96,6 +96,7 @@ module FacebookAds
|
|
96
96
|
"VIDEO_CALL",
|
97
97
|
"VIEW_CART",
|
98
98
|
"VIEW_CHANNEL",
|
99
|
+
"VIEW_IN_CART",
|
99
100
|
"VIEW_PRODUCT",
|
100
101
|
"VISIT_PAGES_FEED",
|
101
102
|
"WATCH_LIVE_VIDEO",
|
@@ -131,6 +132,7 @@ module FacebookAds
|
|
131
132
|
field :reasons_to_shop, 'bool'
|
132
133
|
field :shops_bundle, 'bool'
|
133
134
|
field :titles, { list: 'AdAssetFeedSpecTitle' }
|
135
|
+
field :translations, { list: 'object' }
|
134
136
|
field :upcoming_events, { list: 'object' }
|
135
137
|
field :videos, { list: 'AdAssetFeedSpecVideo' }
|
136
138
|
has_no_id
|
@@ -0,0 +1,27 @@
|
|
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 AdCampaignGroupAgencyFeeConfigForApi < AdObject
|
17
|
+
|
18
|
+
field :agency_fee_pct, 'double'
|
19
|
+
field :is_agency_fee_disabled, 'bool'
|
20
|
+
field :is_default_agency_fee, 'bool'
|
21
|
+
has_no_id
|
22
|
+
has_no_get
|
23
|
+
has_no_post
|
24
|
+
has_no_delete
|
25
|
+
|
26
|
+
end
|
27
|
+
end
|