facebookbusiness 22.0.1 → 23.0.0
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 +3 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +23 -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 +31 -1
- data/lib/facebook_ads/ad_objects/ad_account_agency_fee_config.rb +34 -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 +4 -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/{shadow_ig_media_boosted_insights_result.rb → ad_campaign_group_agency_fee_config_for_api.rb} +4 -7
- data/lib/facebook_ads/ad_objects/ad_creative.rb +2 -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 +7 -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_account_suggested_tag.rb → ad_creative_media_sourcing_spec.rb} +1 -4
- data/lib/facebook_ads/ad_objects/ad_creative_site_links_spec.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +2 -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 +22 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +3 -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 +47 -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 +10 -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_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 +24 -0
- data/lib/facebook_ads/ad_objects/application.rb +17 -0
- data/lib/facebook_ads/ad_objects/audio_sub_label.rb +29 -0
- data/lib/facebook_ads/ad_objects/business.rb +25 -7
- data/lib/facebook_ads/ad_objects/business_role_request.rb +19 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +19 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +2 -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/commerce_merchant_settings.rb +4 -0
- data/lib/facebook_ads/ad_objects/content_delivery_report.rb +2 -0
- 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/event.rb +3 -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 +7 -1
- data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.rb +23 -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/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/managed_partner_business.rb +544 -0
- data/lib/facebook_ads/ad_objects/management_site_link.rb +31 -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/open_bridge_configuration.rb +4 -0
- data/lib/facebook_ads/ad_objects/organization.rb +0 -2
- data/lib/facebook_ads/ad_objects/page.rb +11 -7
- data/lib/facebook_ads/ad_objects/product_catalog.rb +38 -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 +8 -0
- data/lib/facebook_ads/ad_objects/product_item_video_data.rb +26 -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/targeting.rb +2 -0
- data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/user.rb +4 -1
- 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 +6 -3
- 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 +28 -10
- 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",
|
@@ -632,7 +633,7 @@ module FacebookAds
|
|
632
633
|
|
633
634
|
has_edge :calls do |edge|
|
634
635
|
edge.post do |api|
|
635
|
-
api.has_param :action, { enum: %w{ACCEPT CONNECT REJECT TERMINATE }}
|
636
|
+
api.has_param :action, { enum: %w{ACCEPT CONNECT MEDIA_UPDATE REJECT TERMINATE }}
|
636
637
|
api.has_param :call_id, 'string'
|
637
638
|
api.has_param :platform, { enum: %w{INSTAGRAM MESSENGER }}
|
638
639
|
api.has_param :session, 'hash'
|
@@ -938,7 +939,7 @@ module FacebookAds
|
|
938
939
|
end
|
939
940
|
|
940
941
|
has_edge :instagram_accounts do |edge|
|
941
|
-
edge.get '
|
942
|
+
edge.get 'IgUser'
|
942
943
|
end
|
943
944
|
|
944
945
|
has_edge :leadgen_forms do |edge|
|
@@ -1083,6 +1084,7 @@ module FacebookAds
|
|
1083
1084
|
api.has_param :payload, 'string'
|
1084
1085
|
api.has_param :persona_id, 'string'
|
1085
1086
|
api.has_param :recipient, 'object'
|
1087
|
+
api.has_param :reply_to, 'string'
|
1086
1088
|
api.has_param :sender_action, { enum: -> { Page::SENDER_ACTION }}
|
1087
1089
|
api.has_param :suggestion_action, { enum: -> { Page::SUGGESTION_ACTION }}
|
1088
1090
|
api.has_param :tag, 'object'
|
@@ -1098,6 +1100,8 @@ module FacebookAds
|
|
1098
1100
|
edge.get 'MessengerCallSettings'
|
1099
1101
|
edge.post 'Page' do |api|
|
1100
1102
|
api.has_param :audio_enabled, 'bool'
|
1103
|
+
api.has_param :call_hours, 'hash'
|
1104
|
+
api.has_param :call_routing, 'hash'
|
1101
1105
|
api.has_param :icon_enabled, 'bool'
|
1102
1106
|
end
|
1103
1107
|
end
|
@@ -1121,7 +1125,7 @@ module FacebookAds
|
|
1121
1125
|
|
1122
1126
|
has_edge :messenger_profile do |edge|
|
1123
1127
|
edge.delete do |api|
|
1124
|
-
api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS
|
1128
|
+
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
1129
|
api.has_param :platform, { enum: -> { Page::PLATFORM }}
|
1126
1130
|
end
|
1127
1131
|
edge.get 'MessengerProfile' do |api|
|
@@ -1134,10 +1138,8 @@ module FacebookAds
|
|
1134
1138
|
api.has_param :get_started, 'object'
|
1135
1139
|
api.has_param :greeting, { list: 'object' }
|
1136
1140
|
api.has_param :ice_breakers, { list: 'hash' }
|
1137
|
-
api.has_param :payment_settings, 'object'
|
1138
1141
|
api.has_param :persistent_menu, { list: 'object' }
|
1139
1142
|
api.has_param :platform, { enum: -> { Page::PLATFORM }}
|
1140
|
-
api.has_param :target_audience, 'object'
|
1141
1143
|
api.has_param :title, { list: 'object' }
|
1142
1144
|
api.has_param :whitelisted_domains, { list: 'string' }
|
1143
1145
|
end
|
@@ -1174,8 +1176,8 @@ module FacebookAds
|
|
1174
1176
|
end
|
1175
1177
|
|
1176
1178
|
has_edge :page_backed_instagram_accounts do |edge|
|
1177
|
-
edge.get '
|
1178
|
-
edge.post '
|
1179
|
+
edge.get 'IgUser'
|
1180
|
+
edge.post 'IgUser'
|
1179
1181
|
end
|
1180
1182
|
|
1181
1183
|
has_edge :page_whatsapp_number_verification do |edge|
|
@@ -1548,6 +1550,7 @@ module FacebookAds
|
|
1548
1550
|
api.has_param :is_boost_intended, 'bool'
|
1549
1551
|
api.has_param :is_explicit_share, 'bool'
|
1550
1552
|
api.has_param :is_group_linking_post, 'bool'
|
1553
|
+
api.has_param :is_partnership_ad, 'bool'
|
1551
1554
|
api.has_param :is_voice_clip, 'bool'
|
1552
1555
|
api.has_param :location_source_id, 'string'
|
1553
1556
|
api.has_param :manual_privacy, 'bool'
|
@@ -1560,6 +1563,7 @@ module FacebookAds
|
|
1560
1563
|
api.has_param :og_suggestion_mechanism, 'string'
|
1561
1564
|
api.has_param :original_fov, 'int'
|
1562
1565
|
api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
|
1566
|
+
api.has_param :partnership_ad_ad_code, 'string'
|
1563
1567
|
api.has_param :publish_event_id, 'int'
|
1564
1568
|
api.has_param :published, 'bool'
|
1565
1569
|
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",
|
@@ -87,6 +86,13 @@ module FacebookAds
|
|
87
86
|
"WATCHES",
|
88
87
|
]
|
89
88
|
|
89
|
+
EVENT_NAME = [
|
90
|
+
"ADD_TO_CART",
|
91
|
+
"PURCHASE",
|
92
|
+
"TEST",
|
93
|
+
"VIEW_ITEM",
|
94
|
+
]
|
95
|
+
|
90
96
|
|
91
97
|
field :ad_account_to_collaborative_ads_share_settings, 'CollaborativeAdsShareSettings'
|
92
98
|
field :agency_collaborative_ads_share_settings, 'CollaborativeAdsShareSettings'
|
@@ -183,6 +189,12 @@ module FacebookAds
|
|
183
189
|
end
|
184
190
|
end
|
185
191
|
|
192
|
+
has_edge :check_marketplace_partner_sellers_status do |edge|
|
193
|
+
edge.get 'ProductCatalogCheckMarketplacePartnerSellersStatus' do |api|
|
194
|
+
api.has_param :session_id, 'string'
|
195
|
+
end
|
196
|
+
end
|
197
|
+
|
186
198
|
has_edge :collaborative_ads_lsb_image_bank do |edge|
|
187
199
|
edge.get 'CpasLsbImageBank'
|
188
200
|
end
|
@@ -251,6 +263,14 @@ module FacebookAds
|
|
251
263
|
end
|
252
264
|
end
|
253
265
|
|
266
|
+
has_edge :geolocated_items_batch do |edge|
|
267
|
+
edge.post 'ProductCatalog' do |api|
|
268
|
+
api.has_param :allow_upsert, 'bool'
|
269
|
+
api.has_param :item_type, 'string'
|
270
|
+
api.has_param :requests, 'hash'
|
271
|
+
end
|
272
|
+
end
|
273
|
+
|
254
274
|
has_edge :home_listings do |edge|
|
255
275
|
edge.get 'HomeListing' do |api|
|
256
276
|
api.has_param :bulk_pagination, 'bool'
|
@@ -336,6 +356,16 @@ module FacebookAds
|
|
336
356
|
end
|
337
357
|
end
|
338
358
|
|
359
|
+
has_edge :marketplace_partner_signals do |edge|
|
360
|
+
edge.post 'ProductCatalog' do |api|
|
361
|
+
api.has_param :event_name, { enum: -> { ProductCatalog::EVENT_NAME }}
|
362
|
+
api.has_param :event_source_url, 'string'
|
363
|
+
api.has_param :event_time, 'datetime'
|
364
|
+
api.has_param :order_data, 'hash'
|
365
|
+
api.has_param :user_data, 'hash'
|
366
|
+
end
|
367
|
+
end
|
368
|
+
|
339
369
|
has_edge :pricing_variables_batch do |edge|
|
340
370
|
edge.get 'ProductCatalogPricingVariablesBatch' do |api|
|
341
371
|
api.has_param :handle, 'string'
|
@@ -417,6 +447,7 @@ module FacebookAds
|
|
417
447
|
edge.post 'ProductItem' do |api|
|
418
448
|
api.has_param :additional_image_urls, { list: 'string' }
|
419
449
|
api.has_param :additional_variant_attributes, 'hash'
|
450
|
+
api.has_param :age_group, { enum: -> { ProductItem::AGE_GROUP }}
|
420
451
|
api.has_param :android_app_name, 'string'
|
421
452
|
api.has_param :android_class, 'string'
|
422
453
|
api.has_param :android_package, 'string'
|
@@ -495,6 +526,12 @@ module FacebookAds
|
|
495
526
|
end
|
496
527
|
end
|
497
528
|
|
529
|
+
has_edge :update_generated_image_config do |edge|
|
530
|
+
edge.post 'ProductCatalog' do |api|
|
531
|
+
api.has_param :data, { list: 'object' }
|
532
|
+
end
|
533
|
+
end
|
534
|
+
|
498
535
|
has_edge :vehicle_offers do |edge|
|
499
536
|
edge.get 'VehicleOffer' do |api|
|
500
537
|
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",
|
@@ -766,6 +771,8 @@ module FacebookAds
|
|
766
771
|
field :expiration_date, 'string'
|
767
772
|
field :fb_product_category, 'string'
|
768
773
|
field :gender, { enum: -> { GENDER }}
|
774
|
+
field :generated_background_images, { list: 'AiGeneratedProductImage' }
|
775
|
+
field :generated_background_images_ad_usage, 'bool'
|
769
776
|
field :gtin, 'string'
|
770
777
|
field :id, 'string'
|
771
778
|
field :image_cdn_urls, { list: 'hash' }
|
@@ -812,6 +819,7 @@ module FacebookAds
|
|
812
819
|
field :url, 'string'
|
813
820
|
field :vendor_id, 'string'
|
814
821
|
field :video_fetch_status, { enum: -> { VIDEO_FETCH_STATUS }}
|
822
|
+
field :videos, { list: 'ProductItemVideoData' }
|
815
823
|
field :visibility, { enum: -> { VISIBILITY }}
|
816
824
|
field :wa_compliance_category, 'string'
|
817
825
|
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
|
@@ -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
|
@@ -55,6 +55,7 @@ module FacebookAds
|
|
55
55
|
field :effective_instagram_positions, { list: 'string' }
|
56
56
|
field :effective_messenger_positions, { list: 'string' }
|
57
57
|
field :effective_publisher_platforms, { list: 'string' }
|
58
|
+
field :effective_threads_positions, { list: 'string' }
|
58
59
|
field :engagement_specs, { list: 'TargetingDynamicRule' }
|
59
60
|
field :ethnic_affinity, { list: 'IdName' }
|
60
61
|
field :exclude_reached_since, { list: 'string' }
|
@@ -109,6 +110,7 @@ module FacebookAds
|
|
109
110
|
field :targeting_automation, 'TargetingAutomation'
|
110
111
|
field :targeting_optimization, 'string'
|
111
112
|
field :targeting_relaxation_types, 'TargetingRelaxation'
|
113
|
+
field :threads_positions, { list: 'string' }
|
112
114
|
field :user_adclusters, { list: 'IdName' }
|
113
115
|
field :user_device, { list: 'string' }
|
114
116
|
field :user_event, { list: 'int' }
|
@@ -40,6 +40,7 @@ module FacebookAds
|
|
40
40
|
field :age_range, 'AgeRange'
|
41
41
|
field :avatar_2d_profile_picture, 'AvatarProfilePicture'
|
42
42
|
field :birthday, 'string'
|
43
|
+
field :client_business_id, 'string'
|
43
44
|
field :community, 'Group'
|
44
45
|
field :cover, 'UserCoverPhoto'
|
45
46
|
field :currency, 'Currency'
|
@@ -53,7 +54,6 @@ module FacebookAds
|
|
53
54
|
field :id, 'string'
|
54
55
|
field :id_for_avatars, 'string'
|
55
56
|
field :inspirational_people, { list: 'Experience' }
|
56
|
-
field :instagram_user_self_asset, 'InstagramUser'
|
57
57
|
field :install_type, 'string'
|
58
58
|
field :installed, 'bool'
|
59
59
|
field :is_guest_user, 'bool'
|
@@ -535,6 +535,7 @@ module FacebookAds
|
|
535
535
|
api.has_param :proxied_app_id, 'string'
|
536
536
|
api.has_param :published, 'bool'
|
537
537
|
api.has_param :qn, 'string'
|
538
|
+
api.has_param :scheduled_publish_time, 'int'
|
538
539
|
api.has_param :spherical_metadata, 'hash'
|
539
540
|
api.has_param :sponsor_id, 'string'
|
540
541
|
api.has_param :sponsor_relationship, 'int'
|
@@ -621,6 +622,7 @@ module FacebookAds
|
|
621
622
|
api.has_param :is_boost_intended, 'bool'
|
622
623
|
api.has_param :is_explicit_share, 'bool'
|
623
624
|
api.has_param :is_group_linking_post, 'bool'
|
625
|
+
api.has_param :is_partnership_ad, 'bool'
|
624
626
|
api.has_param :is_voice_clip, 'bool'
|
625
627
|
api.has_param :location_source_id, 'string'
|
626
628
|
api.has_param :manual_privacy, 'bool'
|
@@ -632,6 +634,7 @@ module FacebookAds
|
|
632
634
|
api.has_param :og_suggestion_mechanism, 'string'
|
633
635
|
api.has_param :original_fov, 'int'
|
634
636
|
api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
|
637
|
+
api.has_param :partnership_ad_ad_code, 'string'
|
635
638
|
api.has_param :privacy, 'string'
|
636
639
|
api.has_param :publish_event_id, 'int'
|
637
640
|
api.has_param :referenced_sticker_id, 'string'
|
@@ -32,6 +32,7 @@ module FacebookAds
|
|
32
32
|
"AVAILABLE",
|
33
33
|
"NOT_AVAILABLE",
|
34
34
|
"PENDING",
|
35
|
+
"UNKNOWN",
|
35
36
|
]
|
36
37
|
|
37
38
|
BODY_STYLE = [
|
@@ -120,6 +121,8 @@ module FacebookAds
|
|
120
121
|
field :address, 'object'
|
121
122
|
field :applinks, 'CatalogItemAppLinks'
|
122
123
|
field :availability, 'string'
|
124
|
+
field :availability_circle_radius, 'double'
|
125
|
+
field :availability_circle_radius_unit, 'string'
|
123
126
|
field :body_style, 'string'
|
124
127
|
field :category_specific_fields, 'CatalogSubVerticalList'
|
125
128
|
field :condition, 'string'
|
@@ -13,15 +13,11 @@ 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 WebsiteCreativeInfo < AdObject
|
17
17
|
|
18
|
-
field :budget, 'int'
|
19
|
-
field :early_winner_declaration_enabled, 'bool'
|
20
|
-
field :end_time, 'datetime'
|
21
|
-
field :splits, { list: 'int' }
|
22
|
-
field :start_time, 'datetime'
|
23
|
-
field :test_variable, 'string'
|
24
18
|
field :id, 'string'
|
19
|
+
field :image_urls, { list: 'string' }
|
20
|
+
field :link_url, 'string'
|
25
21
|
has_no_post
|
26
22
|
has_no_delete
|
27
23
|
|