facebookbusiness 22.0.1 → 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/server_side/attribution_data.rb +21 -3
- data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +21 -0
- data/lib/facebook_ads/ad_objects/server_side/original_event_data.rb +39 -3
- 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 +30 -11
- data/lib/facebook_ads/ad_objects/event_tour.rb +0 -35
- data/lib/facebook_ads/ad_objects/keyword_delivery_report.rb +0 -33
@@ -86,6 +86,7 @@ module FacebookAds
|
|
86
86
|
"EXPLICIT",
|
87
87
|
"EXPLICIT_IMAGINE",
|
88
88
|
"EXPLICIT_IMAGINE_ME",
|
89
|
+
"EXPLICIT_RESTYLE",
|
89
90
|
"INVISIBLE_WATERMARK",
|
90
91
|
"IPTC",
|
91
92
|
"IPTC_METADATA_EDITED",
|
@@ -123,6 +124,7 @@ module FacebookAds
|
|
123
124
|
"PROFILE_PLUS_CREATE_CONTENT",
|
124
125
|
"PROFILE_PLUS_FACEBOOK_ACCESS",
|
125
126
|
"PROFILE_PLUS_FULL_CONTROL",
|
127
|
+
"PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT",
|
126
128
|
"PROFILE_PLUS_MANAGE",
|
127
129
|
"PROFILE_PLUS_MANAGE_LEADS",
|
128
130
|
"PROFILE_PLUS_MESSAGING",
|
@@ -152,6 +154,7 @@ module FacebookAds
|
|
152
154
|
"PROFILE_PLUS_CREATE_CONTENT",
|
153
155
|
"PROFILE_PLUS_FACEBOOK_ACCESS",
|
154
156
|
"PROFILE_PLUS_FULL_CONTROL",
|
157
|
+
"PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT",
|
155
158
|
"PROFILE_PLUS_MANAGE",
|
156
159
|
"PROFILE_PLUS_MANAGE_LEADS",
|
157
160
|
"PROFILE_PLUS_MESSAGING",
|
@@ -632,11 +635,14 @@ module FacebookAds
|
|
632
635
|
|
633
636
|
has_edge :calls do |edge|
|
634
637
|
edge.post do |api|
|
635
|
-
api.has_param :action, { enum: %w{ACCEPT CONNECT REJECT TERMINATE }}
|
638
|
+
api.has_param :action, { enum: %w{ACCEPT CONNECT MEDIA_UPDATE REJECT TERMINATE }}
|
636
639
|
api.has_param :call_id, 'string'
|
640
|
+
api.has_param :from_version, 'int'
|
637
641
|
api.has_param :platform, { enum: %w{INSTAGRAM MESSENGER }}
|
638
642
|
api.has_param :session, 'hash'
|
639
643
|
api.has_param :to, 'string'
|
644
|
+
api.has_param :to_version, 'int'
|
645
|
+
api.has_param :tracks, { list: 'hash' }
|
640
646
|
end
|
641
647
|
end
|
642
648
|
|
@@ -938,7 +944,7 @@ module FacebookAds
|
|
938
944
|
end
|
939
945
|
|
940
946
|
has_edge :instagram_accounts do |edge|
|
941
|
-
edge.get '
|
947
|
+
edge.get 'IgUser'
|
942
948
|
end
|
943
949
|
|
944
950
|
has_edge :leadgen_forms do |edge|
|
@@ -952,6 +958,7 @@ module FacebookAds
|
|
952
958
|
api.has_param :follow_up_action_url, 'string'
|
953
959
|
api.has_param :is_for_canvas, 'bool'
|
954
960
|
api.has_param :is_optimized_for_quality, 'bool'
|
961
|
+
api.has_param :is_phone_sms_verify_enabled, 'bool'
|
955
962
|
api.has_param :locale, { enum: -> { LeadgenForm::LOCALE }}
|
956
963
|
api.has_param :name, 'string'
|
957
964
|
api.has_param :privacy_policy, 'object'
|
@@ -1083,6 +1090,7 @@ module FacebookAds
|
|
1083
1090
|
api.has_param :payload, 'string'
|
1084
1091
|
api.has_param :persona_id, 'string'
|
1085
1092
|
api.has_param :recipient, 'object'
|
1093
|
+
api.has_param :reply_to, 'object'
|
1086
1094
|
api.has_param :sender_action, { enum: -> { Page::SENDER_ACTION }}
|
1087
1095
|
api.has_param :suggestion_action, { enum: -> { Page::SUGGESTION_ACTION }}
|
1088
1096
|
api.has_param :tag, 'object'
|
@@ -1098,6 +1106,8 @@ module FacebookAds
|
|
1098
1106
|
edge.get 'MessengerCallSettings'
|
1099
1107
|
edge.post 'Page' do |api|
|
1100
1108
|
api.has_param :audio_enabled, 'bool'
|
1109
|
+
api.has_param :call_hours, 'hash'
|
1110
|
+
api.has_param :call_routing, 'hash'
|
1101
1111
|
api.has_param :icon_enabled, 'bool'
|
1102
1112
|
end
|
1103
1113
|
end
|
@@ -1121,7 +1131,7 @@ module FacebookAds
|
|
1121
1131
|
|
1122
1132
|
has_edge :messenger_profile do |edge|
|
1123
1133
|
edge.delete do |api|
|
1124
|
-
api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS
|
1134
|
+
api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS PERSISTENT_MENU PLATFORM SUBJECT_TO_NEW_EU_PRIVACY_RULES TITLE WHITELISTED_DOMAINS }} }
|
1125
1135
|
api.has_param :platform, { enum: -> { Page::PLATFORM }}
|
1126
1136
|
end
|
1127
1137
|
edge.get 'MessengerProfile' do |api|
|
@@ -1134,10 +1144,8 @@ module FacebookAds
|
|
1134
1144
|
api.has_param :get_started, 'object'
|
1135
1145
|
api.has_param :greeting, { list: 'object' }
|
1136
1146
|
api.has_param :ice_breakers, { list: 'hash' }
|
1137
|
-
api.has_param :payment_settings, 'object'
|
1138
1147
|
api.has_param :persistent_menu, { list: 'object' }
|
1139
1148
|
api.has_param :platform, { enum: -> { Page::PLATFORM }}
|
1140
|
-
api.has_param :target_audience, 'object'
|
1141
1149
|
api.has_param :title, { list: 'object' }
|
1142
1150
|
api.has_param :whitelisted_domains, { list: 'string' }
|
1143
1151
|
end
|
@@ -1174,8 +1182,8 @@ module FacebookAds
|
|
1174
1182
|
end
|
1175
1183
|
|
1176
1184
|
has_edge :page_backed_instagram_accounts do |edge|
|
1177
|
-
edge.get '
|
1178
|
-
edge.post '
|
1185
|
+
edge.get 'IgUser'
|
1186
|
+
edge.post 'IgUser'
|
1179
1187
|
end
|
1180
1188
|
|
1181
1189
|
has_edge :page_whatsapp_number_verification do |edge|
|
@@ -1548,6 +1556,7 @@ module FacebookAds
|
|
1548
1556
|
api.has_param :is_boost_intended, 'bool'
|
1549
1557
|
api.has_param :is_explicit_share, 'bool'
|
1550
1558
|
api.has_param :is_group_linking_post, 'bool'
|
1559
|
+
api.has_param :is_partnership_ad, 'bool'
|
1551
1560
|
api.has_param :is_voice_clip, 'bool'
|
1552
1561
|
api.has_param :location_source_id, 'string'
|
1553
1562
|
api.has_param :manual_privacy, 'bool'
|
@@ -1560,6 +1569,7 @@ module FacebookAds
|
|
1560
1569
|
api.has_param :og_suggestion_mechanism, 'string'
|
1561
1570
|
api.has_param :original_fov, 'int'
|
1562
1571
|
api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
|
1572
|
+
api.has_param :partnership_ad_ad_code, 'string'
|
1563
1573
|
api.has_param :publish_event_id, 'int'
|
1564
1574
|
api.has_param :published, 'bool'
|
1565
1575
|
api.has_param :reference_only, 'bool'
|
@@ -27,7 +27,6 @@ module FacebookAds
|
|
27
27
|
"generic",
|
28
28
|
"home_listings",
|
29
29
|
"hotels",
|
30
|
-
"jobs",
|
31
30
|
"local_service_businesses",
|
32
31
|
"offer_items",
|
33
32
|
"offline_commerce",
|
@@ -35,6 +34,11 @@ module FacebookAds
|
|
35
34
|
"vehicles",
|
36
35
|
]
|
37
36
|
|
37
|
+
ENABLED_COLLAB_TERMS = [
|
38
|
+
"ENFORCE_CREATE_NEW_AD_ACCOUNT",
|
39
|
+
"ENFORCE_SHARE_AD_PERFORMANCE_ACCESS",
|
40
|
+
]
|
41
|
+
|
38
42
|
PERMITTED_ROLES = [
|
39
43
|
"ADMIN",
|
40
44
|
"ADVERTISER",
|
@@ -87,6 +91,13 @@ module FacebookAds
|
|
87
91
|
"WATCHES",
|
88
92
|
]
|
89
93
|
|
94
|
+
EVENT_NAME = [
|
95
|
+
"ADD_TO_CART",
|
96
|
+
"PURCHASE",
|
97
|
+
"TEST",
|
98
|
+
"VIEW_ITEM",
|
99
|
+
]
|
100
|
+
|
90
101
|
|
91
102
|
field :ad_account_to_collaborative_ads_share_settings, 'CollaborativeAdsShareSettings'
|
92
103
|
field :agency_collaborative_ads_share_settings, 'CollaborativeAdsShareSettings'
|
@@ -123,6 +134,7 @@ module FacebookAds
|
|
123
134
|
edge.get 'Business'
|
124
135
|
edge.post 'ProductCatalog' do |api|
|
125
136
|
api.has_param :business, 'string'
|
137
|
+
api.has_param :enabled_collab_terms, { list: { enum: -> { ProductCatalog::ENABLED_COLLAB_TERMS }} }
|
126
138
|
api.has_param :permitted_roles, { list: { enum: -> { ProductCatalog::PERMITTED_ROLES }} }
|
127
139
|
api.has_param :permitted_tasks, { list: { enum: -> { ProductCatalog::PERMITTED_TASKS }} }
|
128
140
|
api.has_param :skip_defaults, 'bool'
|
@@ -183,6 +195,12 @@ module FacebookAds
|
|
183
195
|
end
|
184
196
|
end
|
185
197
|
|
198
|
+
has_edge :check_marketplace_partner_sellers_status do |edge|
|
199
|
+
edge.get 'ProductCatalogCheckMarketplacePartnerSellersStatus' do |api|
|
200
|
+
api.has_param :session_id, 'string'
|
201
|
+
end
|
202
|
+
end
|
203
|
+
|
186
204
|
has_edge :collaborative_ads_lsb_image_bank do |edge|
|
187
205
|
edge.get 'CpasLsbImageBank'
|
188
206
|
end
|
@@ -251,6 +269,14 @@ module FacebookAds
|
|
251
269
|
end
|
252
270
|
end
|
253
271
|
|
272
|
+
has_edge :geolocated_items_batch do |edge|
|
273
|
+
edge.post 'ProductCatalog' do |api|
|
274
|
+
api.has_param :allow_upsert, 'bool'
|
275
|
+
api.has_param :item_type, 'string'
|
276
|
+
api.has_param :requests, 'hash'
|
277
|
+
end
|
278
|
+
end
|
279
|
+
|
254
280
|
has_edge :home_listings do |edge|
|
255
281
|
edge.get 'HomeListing' do |api|
|
256
282
|
api.has_param :bulk_pagination, 'bool'
|
@@ -336,6 +362,16 @@ module FacebookAds
|
|
336
362
|
end
|
337
363
|
end
|
338
364
|
|
365
|
+
has_edge :marketplace_partner_signals do |edge|
|
366
|
+
edge.post 'ProductCatalog' do |api|
|
367
|
+
api.has_param :event_name, { enum: -> { ProductCatalog::EVENT_NAME }}
|
368
|
+
api.has_param :event_source_url, 'string'
|
369
|
+
api.has_param :event_time, 'datetime'
|
370
|
+
api.has_param :order_data, 'hash'
|
371
|
+
api.has_param :user_data, 'hash'
|
372
|
+
end
|
373
|
+
end
|
374
|
+
|
339
375
|
has_edge :pricing_variables_batch do |edge|
|
340
376
|
edge.get 'ProductCatalogPricingVariablesBatch' do |api|
|
341
377
|
api.has_param :handle, 'string'
|
@@ -417,6 +453,7 @@ module FacebookAds
|
|
417
453
|
edge.post 'ProductItem' do |api|
|
418
454
|
api.has_param :additional_image_urls, { list: 'string' }
|
419
455
|
api.has_param :additional_variant_attributes, 'hash'
|
456
|
+
api.has_param :age_group, { enum: -> { ProductItem::AGE_GROUP }}
|
420
457
|
api.has_param :android_app_name, 'string'
|
421
458
|
api.has_param :android_class, 'string'
|
422
459
|
api.has_param :android_package, 'string'
|
@@ -495,6 +532,12 @@ module FacebookAds
|
|
495
532
|
end
|
496
533
|
end
|
497
534
|
|
535
|
+
has_edge :update_generated_image_config do |edge|
|
536
|
+
edge.post 'ProductCatalog' do |api|
|
537
|
+
api.has_param :data, { list: 'object' }
|
538
|
+
end
|
539
|
+
end
|
540
|
+
|
498
541
|
has_edge :vehicle_offers do |edge|
|
499
542
|
edge.get 'VehicleOffer' do |api|
|
500
543
|
api.has_param :bulk_pagination, 'bool'
|
@@ -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 ProductCatalogCheckMarketplacePartnerSellersStatus < AdObject
|
17
|
+
|
18
|
+
field :sample_errors, { list: 'object' }
|
19
|
+
field :session_id, 'string'
|
20
|
+
field :status, 'string'
|
21
|
+
has_no_id
|
22
|
+
has_no_get
|
23
|
+
has_no_post
|
24
|
+
has_no_delete
|
25
|
+
|
26
|
+
end
|
27
|
+
end
|
@@ -25,6 +25,7 @@ module FacebookAds
|
|
25
25
|
edge.post 'ProductItem' do |api|
|
26
26
|
api.has_param :additional_image_urls, { list: 'string' }
|
27
27
|
api.has_param :additional_variant_attributes, 'hash'
|
28
|
+
api.has_param :age_group, { enum: -> { ProductItem::AGE_GROUP }}
|
28
29
|
api.has_param :android_app_name, 'string'
|
29
30
|
api.has_param :android_class, 'string'
|
30
31
|
api.has_param :android_package, 'string'
|
@@ -329,6 +329,7 @@ module FacebookAds
|
|
329
329
|
"COMMERCE_ACCOUNT_NOT_LEGALLY_COMPLIANT",
|
330
330
|
"CRAWLED_AVAILABILITY_MISMATCH",
|
331
331
|
"DA_DISABLED_BY_USER",
|
332
|
+
"DA_POLICY_UNFIT_FOR_AUDIENCE",
|
332
333
|
"DA_POLICY_VIOLATION",
|
333
334
|
"DELETED_ITEM",
|
334
335
|
"DIGITAL_GOODS_NOT_AVAILABLE_FOR_CHECKOUT",
|
@@ -391,7 +392,11 @@ module FacebookAds
|
|
391
392
|
"ITEM_STALE_OUT_OF_STOCK",
|
392
393
|
"MARKETPLACE_DISABLED_BY_USER",
|
393
394
|
"MARKETPLACE_PARTNER_AUCTION_NO_BID_CLOSE_TIME",
|
395
|
+
"MARKETPLACE_PARTNER_CURRENCY_NOT_VALID",
|
396
|
+
"MARKETPLACE_PARTNER_LISTING_COUNTRY_NOT_MATCH_CATALOG",
|
394
397
|
"MARKETPLACE_PARTNER_LISTING_LIMIT_EXCEEDED",
|
398
|
+
"MARKETPLACE_PARTNER_MISSING_LATLONG",
|
399
|
+
"MARKETPLACE_PARTNER_MISSING_SHIPPING_COST",
|
395
400
|
"MARKETPLACE_PARTNER_NOT_LOCAL_ITEM",
|
396
401
|
"MARKETPLACE_PARTNER_NOT_SHIPPED_ITEM",
|
397
402
|
"MARKETPLACE_PARTNER_POLICY_VIOLATION",
|
@@ -475,6 +480,7 @@ module FacebookAds
|
|
475
480
|
]
|
476
481
|
|
477
482
|
ORIGIN_COUNTRY = [
|
483
|
+
"AC",
|
478
484
|
"AD",
|
479
485
|
"AE",
|
480
486
|
"AF",
|
@@ -743,6 +749,7 @@ module FacebookAds
|
|
743
749
|
field :brand, 'string'
|
744
750
|
field :bundle_items, { list: 'string' }
|
745
751
|
field :bundle_retailer_ids, { list: 'string' }
|
752
|
+
field :capabilities_disabled_by_user, { list: 'string' }
|
746
753
|
field :capability_to_review_status, { list: 'hash' }
|
747
754
|
field :category, 'string'
|
748
755
|
field :category_specific_fields, 'CatalogSubVerticalList'
|
@@ -766,6 +773,8 @@ module FacebookAds
|
|
766
773
|
field :expiration_date, 'string'
|
767
774
|
field :fb_product_category, 'string'
|
768
775
|
field :gender, { enum: -> { GENDER }}
|
776
|
+
field :generated_background_images, { list: 'AiGeneratedProductImage' }
|
777
|
+
field :generated_background_images_ad_usage, 'bool'
|
769
778
|
field :gtin, 'string'
|
770
779
|
field :id, 'string'
|
771
780
|
field :image_cdn_urls, { list: 'hash' }
|
@@ -812,6 +821,7 @@ module FacebookAds
|
|
812
821
|
field :url, 'string'
|
813
822
|
field :vendor_id, 'string'
|
814
823
|
field :video_fetch_status, { enum: -> { VIDEO_FETCH_STATUS }}
|
824
|
+
field :videos, { list: 'ProductItemVideoData' }
|
815
825
|
field :visibility, { enum: -> { VISIBILITY }}
|
816
826
|
field :wa_compliance_category, 'string'
|
817
827
|
field :android_app_name, 'string'
|
@@ -0,0 +1,26 @@
|
|
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 ProductItemVideoData < AdObject
|
17
|
+
|
18
|
+
field :tags, { list: 'string' }
|
19
|
+
field :url, 'string'
|
20
|
+
has_no_id
|
21
|
+
has_no_get
|
22
|
+
has_no_post
|
23
|
+
has_no_delete
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -22,6 +22,7 @@ module FacebookAds
|
|
22
22
|
field :init_pos, { list: 'hash' }
|
23
23
|
field :last_pos, { list: 'hash' }
|
24
24
|
field :meetup_link_hash, 'string'
|
25
|
+
field :robot_notes, 'string'
|
25
26
|
field :suite, 'string'
|
26
27
|
field :target_map_image_uri, 'string'
|
27
28
|
field :target_os_image_uri, 'string'
|
@@ -46,6 +46,9 @@ module FacebookAds
|
|
46
46
|
# Attribution woindow in days.
|
47
47
|
attr_accessor :attr_window
|
48
48
|
|
49
|
+
# The share of value generated by this click-conversion pair that is attributed to Meta.
|
50
|
+
attr_accessor :attribution_value
|
51
|
+
|
49
52
|
|
50
53
|
|
51
54
|
# @param [String] scope
|
@@ -56,7 +59,8 @@ module FacebookAds
|
|
56
59
|
# @param [Float] attribution_share
|
57
60
|
# @param [String] attribution_model
|
58
61
|
# @param [String] attr_window
|
59
|
-
|
62
|
+
# @param [Float] attribution_value
|
63
|
+
def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil, attribution_value: nil)
|
60
64
|
unless scope.nil?
|
61
65
|
self.scope = scope
|
62
66
|
end
|
@@ -81,6 +85,9 @@ module FacebookAds
|
|
81
85
|
unless attr_window.nil?
|
82
86
|
self.attr_window = attr_window
|
83
87
|
end
|
88
|
+
unless attribution_value.nil?
|
89
|
+
self.attribution_value = attribution_value
|
90
|
+
end
|
84
91
|
end
|
85
92
|
|
86
93
|
# build the object using the input hash
|
@@ -122,6 +129,10 @@ module FacebookAds
|
|
122
129
|
if attributes.has_key?(:'attr_window')
|
123
130
|
self.attr_window = attributes[:'attr_window']
|
124
131
|
end
|
132
|
+
|
133
|
+
if attributes.has_key?(:'attribution_value')
|
134
|
+
self.attribution_share = attributes[:'attribution_value']
|
135
|
+
end
|
125
136
|
end
|
126
137
|
|
127
138
|
# Checks equality by comparing each attribute.
|
@@ -135,7 +146,8 @@ module FacebookAds
|
|
135
146
|
campaign_id == o.campaign_id &&
|
136
147
|
attribution_share == o.attribution_share &&
|
137
148
|
attribution_model == o.attribution_model &&
|
138
|
-
attr_window == o.attr_window
|
149
|
+
attr_window == o.attr_window &&
|
150
|
+
attribution_value == o.attribution_value
|
139
151
|
end
|
140
152
|
|
141
153
|
# @see the `==` method
|
@@ -147,7 +159,7 @@ module FacebookAds
|
|
147
159
|
# @return [Fixnum] Hash code
|
148
160
|
def hash
|
149
161
|
[
|
150
|
-
scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window
|
162
|
+
scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value
|
151
163
|
].hash
|
152
164
|
end
|
153
165
|
|
@@ -177,6 +189,9 @@ module FacebookAds
|
|
177
189
|
unless attr_window.nil?
|
178
190
|
hash['attr_window'] = attr_window
|
179
191
|
end
|
192
|
+
unless attribution_value.nil?
|
193
|
+
hash['attribution_value'] = attribution_value
|
194
|
+
end
|
180
195
|
hash.to_s
|
181
196
|
end
|
182
197
|
|
@@ -208,6 +223,9 @@ module FacebookAds
|
|
208
223
|
unless attr_window.nil?
|
209
224
|
hash['attr_window'] = attr_window
|
210
225
|
end
|
226
|
+
unless attribution_value.nil?
|
227
|
+
hash['attribution_value'] = attribution_value
|
228
|
+
end
|
211
229
|
hash
|
212
230
|
end
|
213
231
|
|
@@ -25,6 +25,10 @@ module FacebookAds
|
|
25
25
|
# Example: 142.54.
|
26
26
|
attr_accessor :value
|
27
27
|
|
28
|
+
# A numeric net_revenue associated with this event. This could be a monetary net_revenue or a net_revenue in some other metric.
|
29
|
+
# Example: 30.54.
|
30
|
+
attr_accessor :net_revenue
|
31
|
+
|
28
32
|
# The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code.
|
29
33
|
# Example: 'usd'.
|
30
34
|
attr_accessor :currency
|
@@ -83,6 +87,7 @@ module FacebookAds
|
|
83
87
|
|
84
88
|
|
85
89
|
# @param [Float] value
|
90
|
+
# @param [Float] net_revenue
|
86
91
|
# @param [String] currency
|
87
92
|
# @param [String] content_name
|
88
93
|
# @param [String] content_category
|
@@ -98,6 +103,7 @@ module FacebookAds
|
|
98
103
|
# @param [String] item_number
|
99
104
|
# @param [String] custom_properties
|
100
105
|
def initialize(value: nil,
|
106
|
+
net_revenue: nil,
|
101
107
|
currency: nil,
|
102
108
|
content_name: nil,
|
103
109
|
content_category: nil,
|
@@ -116,6 +122,9 @@ module FacebookAds
|
|
116
122
|
unless value.nil?
|
117
123
|
self.value = value
|
118
124
|
end
|
125
|
+
unless net_revenue.nil?
|
126
|
+
self.net_revenue = net_revenue
|
127
|
+
end
|
119
128
|
unless currency.nil?
|
120
129
|
self.currency = currency
|
121
130
|
end
|
@@ -173,6 +182,10 @@ module FacebookAds
|
|
173
182
|
self.value = attributes[:'value']
|
174
183
|
end
|
175
184
|
|
185
|
+
if attributes.has_key?(:'net_revenue')
|
186
|
+
self.net_revenue = attributes[:'net_revenue']
|
187
|
+
end
|
188
|
+
|
176
189
|
if attributes.has_key?(:'currency')
|
177
190
|
self.currency = attributes[:'currency']
|
178
191
|
end
|
@@ -239,6 +252,7 @@ module FacebookAds
|
|
239
252
|
return true if self.equal?(o)
|
240
253
|
self.class == o.class &&
|
241
254
|
value == o.value &&
|
255
|
+
net_revenue == o.net_revenue &&
|
242
256
|
currency == o.currency &&
|
243
257
|
content_name == o.content_name &&
|
244
258
|
content_category == o.content_category &&
|
@@ -265,6 +279,7 @@ module FacebookAds
|
|
265
279
|
def hash
|
266
280
|
[
|
267
281
|
value,
|
282
|
+
net_revenue,
|
268
283
|
currency,
|
269
284
|
content_name,
|
270
285
|
content_category,
|
@@ -289,6 +304,9 @@ module FacebookAds
|
|
289
304
|
unless value.nil?
|
290
305
|
hash['value'] = value
|
291
306
|
end
|
307
|
+
unless net_revenue.nil?
|
308
|
+
hash['net_revenue'] = net_revenue
|
309
|
+
end
|
292
310
|
unless currency.nil?
|
293
311
|
hash['currency'] = currency
|
294
312
|
end
|
@@ -342,6 +360,9 @@ module FacebookAds
|
|
342
360
|
unless value.nil?
|
343
361
|
hash['value'] = value
|
344
362
|
end
|
363
|
+
unless net_revenue.nil?
|
364
|
+
hash['net_revenue'] = net_revenue
|
365
|
+
end
|
345
366
|
unless currency.nil?
|
346
367
|
hash['currency'] = FacebookAds::ServerSide::Util.normalize(currency, 'currency')
|
347
368
|
end
|
@@ -29,15 +29,29 @@ module FacebookAds
|
|
29
29
|
# A Unix timestamp in seconds indicating when the original event occurred.
|
30
30
|
attr_accessor :event_time
|
31
31
|
|
32
|
+
# The order ID for this transaction as a string.
|
33
|
+
attr_accessor :order_id
|
34
|
+
|
35
|
+
# A unique string chosen by the advertiser.
|
36
|
+
attr_accessor :event_id
|
37
|
+
|
32
38
|
# @param [String] event_name
|
33
39
|
# @param [int] event_time
|
34
|
-
|
40
|
+
# @param [String] order_id
|
41
|
+
# @param [String] event_id
|
42
|
+
def initialize(event_name: nil, event_time: nil, order_id: nil, event_id: nil)
|
35
43
|
unless event_name.nil?
|
36
44
|
self.event_name = event_name
|
37
45
|
end
|
38
46
|
unless event_time.nil?
|
39
47
|
self.event_time = event_time
|
40
48
|
end
|
49
|
+
unless order_id.nil?
|
50
|
+
self.order_id = order_id
|
51
|
+
end
|
52
|
+
unless event_id.nil?
|
53
|
+
self.event_id = event_id
|
54
|
+
end
|
41
55
|
end
|
42
56
|
|
43
57
|
# build the object using the input hash
|
@@ -55,6 +69,14 @@ module FacebookAds
|
|
55
69
|
if attributes.has_key?(:'event_time')
|
56
70
|
self.event_time = attributes[:'event_time']
|
57
71
|
end
|
72
|
+
|
73
|
+
if attributes.has_key?(:'order_id')
|
74
|
+
self.order_id = attributes[:'order_id']
|
75
|
+
end
|
76
|
+
|
77
|
+
if attributes.has_key?(:'event_id')
|
78
|
+
self.event_id = attributes[:'event_id']
|
79
|
+
end
|
58
80
|
end
|
59
81
|
|
60
82
|
# Checks equality by comparing each attribute.
|
@@ -62,7 +84,9 @@ module FacebookAds
|
|
62
84
|
return true if self.equal?(o)
|
63
85
|
self.class == o.class &&
|
64
86
|
event_name == o.event_name &&
|
65
|
-
event_time == o.event_time
|
87
|
+
event_time == o.event_time &&
|
88
|
+
order_id == o.order_id &&
|
89
|
+
event_id == o.event_id
|
66
90
|
end
|
67
91
|
|
68
92
|
# @see the `==` method
|
@@ -74,7 +98,7 @@ module FacebookAds
|
|
74
98
|
# @return [Fixnum] Hash code
|
75
99
|
def hash
|
76
100
|
[
|
77
|
-
event_name, event_time,
|
101
|
+
event_name, event_time, order_id, event_id,
|
78
102
|
].hash
|
79
103
|
end
|
80
104
|
|
@@ -86,6 +110,12 @@ module FacebookAds
|
|
86
110
|
unless event_time.nil?
|
87
111
|
hash['event_time'] = event_time
|
88
112
|
end
|
113
|
+
unless order_id.nil?
|
114
|
+
hash['order_id'] = order_id
|
115
|
+
end
|
116
|
+
unless event_id.nil?
|
117
|
+
hash['event_id'] = event_id
|
118
|
+
end
|
89
119
|
hash.to_s
|
90
120
|
end
|
91
121
|
|
@@ -99,6 +129,12 @@ module FacebookAds
|
|
99
129
|
unless event_time.nil?
|
100
130
|
hash['event_time'] = event_time
|
101
131
|
end
|
132
|
+
unless order_id.nil?
|
133
|
+
hash['order_id'] = order_id
|
134
|
+
end
|
135
|
+
unless event_id.nil?
|
136
|
+
hash['event_id'] = event_id
|
137
|
+
end
|
102
138
|
hash
|
103
139
|
end
|
104
140
|
|
@@ -0,0 +1,31 @@
|
|
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 ShadowIgUserCtxPartnerAppWelcomeMessageFlow < AdObject
|
17
|
+
|
18
|
+
field :compatible_platforms, { list: 'string' }
|
19
|
+
field :eligible_platforms, { list: 'string' }
|
20
|
+
field :id, 'string'
|
21
|
+
field :is_ig_only_flow, 'bool'
|
22
|
+
field :is_used_in_ad, 'bool'
|
23
|
+
field :last_update_time, 'datetime'
|
24
|
+
field :name, 'string'
|
25
|
+
field :welcome_message_flow, 'string'
|
26
|
+
has_no_get
|
27
|
+
has_no_post
|
28
|
+
has_no_delete
|
29
|
+
|
30
|
+
end
|
31
|
+
end
|