facebookbusiness 22.0.0 → 22.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.rb +14 -1
- 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 +20 -0
- data/lib/facebook_ads/ad_objects/{instagram_carousel.rb → ad_account_amount_spent_history.rb} +7 -12
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_account_live_video_advertiser.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_account_optimization_goals_aemv2_eligibility.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_account_spend_cap_change_history.rb +28 -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 +3 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_group_advantage_state.rb +28 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +2 -1
- data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +1 -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_object_story_spec.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_creative_regional_regulation_disclaimer.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +2 -6
- data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +15 -0
- data/lib/facebook_ads/ad_objects/{ads_pixel_capi_setup_quality.rb → ads_pixel_capi_integration_quality.rb} +1 -1
- data/lib/facebook_ads/ad_objects/ads_quick_views.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_user_settings.rb +3 -0
- data/lib/facebook_ads/ad_objects/ads_value_adjustment_rule_collection.rb +8 -1
- data/lib/facebook_ads/ad_objects/application.rb +4 -0
- data/lib/facebook_ads/ad_objects/branded_content_shadow_ig_media_id.rb +1 -0
- data/lib/facebook_ads/ad_objects/business.rb +20 -8
- data/lib/facebook_ads/ad_objects/business_agreement.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +1 -0
- data/lib/facebook_ads/ad_objects/catalog_collection.rb +27 -0
- data/lib/facebook_ads/ad_objects/creative_multicell_test_config.rb +26 -0
- data/lib/facebook_ads/ad_objects/ctx_default_optimization_config.rb +26 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +10 -0
- data/lib/facebook_ads/ad_objects/custom_audience_health.rb +25 -0
- data/lib/facebook_ads/ad_objects/event.rb +1 -0
- data/lib/facebook_ads/ad_objects/home_listing.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +10 -0
- data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb +4 -1
- data/lib/facebook_ads/ad_objects/insights_value.rb +1 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +4 -0
- data/lib/facebook_ads/ad_objects/message_delivery_estimate.rb +2 -0
- data/lib/facebook_ads/ad_objects/page.rb +21 -8
- data/lib/facebook_ads/ad_objects/page_call_to_action.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +2 -0
- data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb +4 -0
- data/lib/facebook_ads/ad_objects/{instagram_comment.rb → store_location.rb} +9 -9
- data/lib/facebook_ads/ad_objects/targeting_subscriber_universe.rb +1 -0
- data/lib/facebook_ads/ad_objects/threads_user.rb +26 -0
- data/lib/facebook_ads/ad_objects/user.rb +2 -2
- data/lib/facebook_ads/ad_objects/vehicle.rb +1 -0
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +1 -0
- data/lib/facebook_ads/version.rb +1 -1
- metadata +12 -7
- data/lib/facebook_ads/ad_objects/instagram_media.rb +0 -38
- data/lib/facebook_ads/ad_objects/negative_keyword_list.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: 2ea0f2b57e450bbaa71ed68367064fba99c302b71e9267084c47565775994b84
|
4
|
+
data.tar.gz: 177aafa4c34e53682e18a223eaf1590efcbbf368de9354f4a6d4459b0ed5547b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 64ee5892db6966c936ed8506751163e3e6b8276dd670168bb539eec02069b7da7beb847e6764c007591aaab5f438eb497ce6b290031c16aa74fca482e8f0ed22
|
7
|
+
data.tar.gz: 77704ddca6c68b1af6908c7d946460dc8c83a9da46f7cfaa00e413e7049beed9ed95034ac18e9c523f857f59999e5aba900e8349eb25b45d933d20fede19976a
|
@@ -198,6 +198,7 @@ module FacebookAds
|
|
198
198
|
field :id, 'string'
|
199
199
|
field :io_number, 'string'
|
200
200
|
field :is_attribution_spec_system_default, 'bool'
|
201
|
+
field :is_ba_skip_delayed_eligible, 'bool'
|
201
202
|
field :is_direct_deals_enabled, 'bool'
|
202
203
|
field :is_in_3ds_authorization_enabled_market, 'bool'
|
203
204
|
field :is_notifications_enabled, 'bool'
|
@@ -508,6 +509,7 @@ module FacebookAds
|
|
508
509
|
api.has_param :existing_customer_budget_percentage, 'int'
|
509
510
|
api.has_param :frequency_control_specs, { list: 'object' }
|
510
511
|
api.has_param :full_funnel_exploration_mode, { enum: -> { AdSet::FULL_FUNNEL_EXPLORATION_MODE }}
|
512
|
+
api.has_param :is_ba_skip_delayed_eligible, 'bool'
|
511
513
|
api.has_param :is_dynamic_creative, 'bool'
|
512
514
|
api.has_param :is_sac_cfca_terms_certified, 'bool'
|
513
515
|
api.has_param :lifetime_budget, 'int'
|
@@ -1008,6 +1010,10 @@ module FacebookAds
|
|
1008
1010
|
edge.get 'AdAccountMaxBid'
|
1009
1011
|
end
|
1010
1012
|
|
1013
|
+
has_edge :mcmeconversions do |edge|
|
1014
|
+
edge.get 'AdsMcmeConversion'
|
1015
|
+
end
|
1016
|
+
|
1011
1017
|
has_edge :minimum_budgets do |edge|
|
1012
1018
|
edge.get 'MinimumBudget' do |api|
|
1013
1019
|
api.has_param :bid_amount, 'int'
|
@@ -1244,7 +1250,14 @@ module FacebookAds
|
|
1244
1250
|
end
|
1245
1251
|
|
1246
1252
|
has_edge :value_rule_set do |edge|
|
1247
|
-
edge.get 'AdsValueAdjustmentRuleCollection'
|
1253
|
+
edge.get 'AdsValueAdjustmentRuleCollection' do |api|
|
1254
|
+
api.has_param :product_type, { enum: -> { AdsValueAdjustmentRuleCollection::PRODUCT_TYPE }}
|
1255
|
+
end
|
1256
|
+
edge.post 'AdsValueAdjustmentRuleCollection' do |api|
|
1257
|
+
api.has_param :name, 'string'
|
1258
|
+
api.has_param :product_type, { enum: -> { AdsValueAdjustmentRuleCollection::PRODUCT_TYPE }}
|
1259
|
+
api.has_param :rules, { list: 'hash' }
|
1260
|
+
end
|
1248
1261
|
end
|
1249
1262
|
|
1250
1263
|
has_edge :video_ads do |edge|
|
@@ -22,6 +22,7 @@ module FacebookAds
|
|
22
22
|
"ACCOUNT_SPEND_LIMIT",
|
23
23
|
"ACCOUNT_SPEND_LIMIT_DUPLICATION",
|
24
24
|
"ACO_TOGGLE",
|
25
|
+
"ADOPT_CAPI_GATEWAY_FROM_TEST_DRIVE",
|
25
26
|
"ADS_REPORTING",
|
26
27
|
"ADS_STATUS",
|
27
28
|
"ADVANCED_CAMPAIGN_BUDGET",
|
@@ -44,11 +45,13 @@ module FacebookAds
|
|
44
45
|
"ADVANTAGE_PLUS_CREATIVE",
|
45
46
|
"ADVANTAGE_PLUS_CREATIVE_CATALOG",
|
46
47
|
"ADVANTAGE_PLUS_CREATIVE_SE",
|
48
|
+
"ADVANTAGE_PLUS_LEAD_CAMPAIGN",
|
47
49
|
"ADVANTAGE_PLUS_PLACEMENTS_DUPLICATION",
|
48
50
|
"ADVANTAGE_PLUS_PLACEMENTS_FRICTION",
|
49
51
|
"ADVANTAGE_PLUS_PLACEMENTS_V2_DUPLICATION",
|
50
52
|
"ADVANTAGE_SHOPPING_CAMPAIGN",
|
51
53
|
"ADVANTAGE_SHOPPING_CAMPAIGN_FRAGMENTATION",
|
54
|
+
"AD_ACCOUNT_PLACEMENT_CONTROLS_UPSELL",
|
52
55
|
"AD_LIFT_RECALL_GOAL",
|
53
56
|
"AD_LIFT_RECALL_GOAL_PRECREATE",
|
54
57
|
"AD_LIFT_RECALL_OPTIMIZATION_GOAL",
|
@@ -57,6 +60,8 @@ module FacebookAds
|
|
57
60
|
"AGGREGATED_BID_LIMITED",
|
58
61
|
"AGGREGATED_BUDGET_LIMITED",
|
59
62
|
"AGGREGATED_COST_LIMITED",
|
63
|
+
"APLUSC_MUSIC",
|
64
|
+
"APLUSC_TEXT_IMPROVEMENTS",
|
60
65
|
"APLUS_C_CATALOG_DUPLICATION",
|
61
66
|
"APP_AEM_V2_INSTALLATION_PROMOTION",
|
62
67
|
"APP_ENGAGED_VIEW_CONVERSIONS_DUPLICATION",
|
@@ -80,14 +85,21 @@ module FacebookAds
|
|
80
85
|
"AUTOMATIC_PLACEMENTS",
|
81
86
|
"AUTOMATIC_PLACEMENTS_V2",
|
82
87
|
"AUTO_BID",
|
88
|
+
"AUTO_CAT_SELECTION_ENHANCEMENT",
|
83
89
|
"BACKGROUND_GENERATION",
|
84
90
|
"BLENDED_ADS",
|
85
91
|
"BLENDED_ADS_DUPLICATION",
|
86
92
|
"BLENDED_ADS_FOR_SHOPS_ADS_DUPLICATION",
|
93
|
+
"BPBAA_WITH_CAPI_UPSELL",
|
94
|
+
"BROADGEO_AM_UPSELL_GUIDANCE",
|
87
95
|
"BROAD_TARGETING",
|
88
96
|
"BUDGET_LIMITED",
|
97
|
+
"BUDGET_REALLOCATION",
|
89
98
|
"CAPI",
|
99
|
+
"CAPI_CRM_FUNNEL",
|
90
100
|
"CAPI_CRM_GUIDANCE",
|
101
|
+
"CAPI_CRM_SETUP",
|
102
|
+
"CAPI_EVENT_COVERAGE",
|
91
103
|
"CAPI_PENETRATION",
|
92
104
|
"CAPI_PERFORMANCE_MATCH_KEY",
|
93
105
|
"CAPI_PERFORMANCE_MATCH_KEY_V2",
|
@@ -99,6 +111,7 @@ module FacebookAds
|
|
99
111
|
"CONNECT_FACEBOOK_PAGE_TO_INSTAGRAM",
|
100
112
|
"CONNECT_FACEBOOK_PAGE_TO_WHATSAPP",
|
101
113
|
"CONVERSION_LEADS_OPTIMIZATION",
|
114
|
+
"CONVERSION_LEADS_OPTIMIZATION_DUPLICATION",
|
102
115
|
"CONVERSION_LEAD_ADS",
|
103
116
|
"COST_GOAL",
|
104
117
|
"COST_GOAL_BUDGET_LIMITED",
|
@@ -123,6 +136,8 @@ module FacebookAds
|
|
123
136
|
"CTX_CTA_UPGRADE_IN_DUPLICATION",
|
124
137
|
"CTX_CTMPO_UPGRADE",
|
125
138
|
"CTX_GUIDANCE",
|
139
|
+
"CTX_HVS",
|
140
|
+
"CTX_MULTI_MESSAGE_DESTINATION",
|
126
141
|
"CTX_PRECREATE",
|
127
142
|
"CTX_SABR_CBO",
|
128
143
|
"CTX_SABR_NON_CBO",
|
@@ -134,6 +149,7 @@ module FacebookAds
|
|
134
149
|
"DEAD_LINK",
|
135
150
|
"DEFRAGMENTATION_ACB",
|
136
151
|
"DEFRAGMENTATION_ACB_DUPLICATION",
|
152
|
+
"DEFRAGMENTATION_USING_VALUE_RULES_TEST_V2",
|
137
153
|
"DELIVERY_ERROR",
|
138
154
|
"DELIVERY_WARNING",
|
139
155
|
"DYNAMIC_ADVANTAGE_CAMPAIGN_BUDGET",
|
@@ -199,6 +215,7 @@ module FacebookAds
|
|
199
215
|
"PREDICTIVE_CREATIVE_LIMITED",
|
200
216
|
"PREDICTIVE_CREATIVE_LIMITED_HOURLY",
|
201
217
|
"PREPARING_STATUS",
|
218
|
+
"PRODUCT_SET_BOOSTING",
|
202
219
|
"PURCHASE_OPTIMIZATION",
|
203
220
|
"RAPID_LEARNING_LIMITED",
|
204
221
|
"RAPID_LEARNING_PHASE",
|
@@ -238,6 +255,7 @@ module FacebookAds
|
|
238
255
|
"SYD_TEST_MODE",
|
239
256
|
"TAILORED_LEAD_AD_CAMPAIGN",
|
240
257
|
"TAILORED_MESSAGES_CAMPAIGN",
|
258
|
+
"TARGETING_CREATIVE_FRAGMENTATION",
|
241
259
|
"TLA_CREATION_PACKAGE",
|
242
260
|
"TOP_ADSETS_WITH_ADS_UNDER_CAP",
|
243
261
|
"TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",
|
@@ -250,9 +268,11 @@ module FacebookAds
|
|
250
268
|
"UNIFIED_INBOX",
|
251
269
|
"UNUSED_BUDGET",
|
252
270
|
"VALUE_DIAGNOSTICS_GUIDANCE",
|
271
|
+
"VALUE_OPTIMIZATION_GOAL",
|
253
272
|
"VIDEO_LENGTH",
|
254
273
|
"VIDEO_VIEWS_UPSELL",
|
255
274
|
"VIDEO_VIEWS_UPSELL_PRECREATE",
|
275
|
+
"VO_VT_1D_DEFAULTING",
|
256
276
|
"WA_MESSAGING_PARTNERS",
|
257
277
|
"WA_MESSAGING_PARTNERS_PRECREATE",
|
258
278
|
"WEB_ENGAGED_VIEW_CONVERSIONS",
|
data/lib/facebook_ads/ad_objects/{instagram_carousel.rb → ad_account_amount_spent_history.rb}
RENAMED
@@ -13,19 +13,14 @@ 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 AdAccountAmountSpentHistory < AdObject
|
17
17
|
|
18
|
-
field :
|
19
|
-
field :
|
20
|
-
field :
|
21
|
-
field :
|
22
|
-
|
23
|
-
|
24
|
-
field :like_count, 'int'
|
25
|
-
field :owner_instagram_user, 'InstagramUser'
|
26
|
-
field :permalink, 'string'
|
27
|
-
field :taken_at, 'datetime'
|
28
|
-
field :video_url, 'string'
|
18
|
+
field :amount_spent, 'int'
|
19
|
+
field :spend_cap, 'int'
|
20
|
+
field :time_start, 'string'
|
21
|
+
field :time_stop, 'string'
|
22
|
+
has_no_id
|
23
|
+
has_no_get
|
29
24
|
has_no_post
|
30
25
|
has_no_delete
|
31
26
|
|
@@ -15,6 +15,7 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdAccountDeliveryEstimate < AdObject
|
17
17
|
OPTIMIZATION_GOAL = [
|
18
|
+
"ADVERTISER_SILOED_VALUE",
|
18
19
|
"AD_RECALL_LIFT",
|
19
20
|
"APP_INSTALLS",
|
20
21
|
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
@@ -34,6 +35,7 @@ module FacebookAds
|
|
34
35
|
"OFFSITE_CONVERSIONS",
|
35
36
|
"PAGE_LIKES",
|
36
37
|
"POST_ENGAGEMENT",
|
38
|
+
"PROFILE_AND_PAGE_ENGAGEMENT",
|
37
39
|
"PROFILE_VISIT",
|
38
40
|
"QUALITY_CALL",
|
39
41
|
"QUALITY_LEAD",
|
@@ -15,6 +15,7 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdAccountOptimizationGoalsAemv2Eligibility < AdObject
|
17
17
|
OPTIMIZATION_GOAL = [
|
18
|
+
"ADVERTISER_SILOED_VALUE",
|
18
19
|
"AD_RECALL_LIFT",
|
19
20
|
"APP_INSTALLS",
|
20
21
|
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
@@ -34,6 +35,7 @@ module FacebookAds
|
|
34
35
|
"OFFSITE_CONVERSIONS",
|
35
36
|
"PAGE_LIKES",
|
36
37
|
"POST_ENGAGEMENT",
|
38
|
+
"PROFILE_AND_PAGE_ENGAGEMENT",
|
37
39
|
"PROFILE_VISIT",
|
38
40
|
"QUALITY_CALL",
|
39
41
|
"QUALITY_LEAD",
|
@@ -0,0 +1,28 @@
|
|
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 AdAccountSpendCapChangeHistory < AdObject
|
17
|
+
|
18
|
+
field :action, 'string'
|
19
|
+
field :spend_cap, 'int'
|
20
|
+
field :time_start, 'string'
|
21
|
+
field :time_stop, 'string'
|
22
|
+
has_no_id
|
23
|
+
has_no_get
|
24
|
+
has_no_post
|
25
|
+
has_no_delete
|
26
|
+
|
27
|
+
end
|
28
|
+
end
|
@@ -380,6 +380,7 @@ module FacebookAds
|
|
380
380
|
"home_type",
|
381
381
|
"home_value",
|
382
382
|
"household_composition",
|
383
|
+
"household_income",
|
383
384
|
"id",
|
384
385
|
"income",
|
385
386
|
"industries",
|
@@ -429,6 +430,7 @@ module FacebookAds
|
|
429
430
|
"topic",
|
430
431
|
"trending",
|
431
432
|
"user_adclusters",
|
433
|
+
"user_age_unknown",
|
432
434
|
"user_device",
|
433
435
|
"user_event",
|
434
436
|
"user_os",
|
@@ -48,6 +48,7 @@ module FacebookAds
|
|
48
48
|
field :auto_review_video_caption, 'bool'
|
49
49
|
field :campaign_overview_columns, { list: 'string' }
|
50
50
|
field :column_suggestion_status, 'string'
|
51
|
+
field :conditional_formatting_rules, { list: 'string' }
|
51
52
|
field :default_account_overview_agegender_metrics, { list: 'string' }
|
52
53
|
field :default_account_overview_location_metrics, { list: 'string' }
|
53
54
|
field :default_account_overview_metrics, { list: 'string' }
|
@@ -66,6 +67,8 @@ module FacebookAds
|
|
66
67
|
field :hidden_optimization_tips, { list: 'hash' }
|
67
68
|
field :id, 'string'
|
68
69
|
field :is_3p_auth_setting_set, 'bool'
|
70
|
+
field :is_ads_manager_footer_row_preference_set, 'bool'
|
71
|
+
field :is_ads_manager_footer_row_shown, 'bool'
|
69
72
|
field :is_text_variation_nux_close, 'bool'
|
70
73
|
field :last_used_columns, 'object'
|
71
74
|
field :last_used_pe_filters, { list: 'object' }
|
@@ -15,6 +15,7 @@ module FacebookAds
|
|
15
15
|
|
16
16
|
class AdCampaignDeliveryEstimate < AdObject
|
17
17
|
OPTIMIZATION_GOAL = [
|
18
|
+
"ADVERTISER_SILOED_VALUE",
|
18
19
|
"AD_RECALL_LIFT",
|
19
20
|
"APP_INSTALLS",
|
20
21
|
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
@@ -34,6 +35,7 @@ module FacebookAds
|
|
34
35
|
"OFFSITE_CONVERSIONS",
|
35
36
|
"PAGE_LIKES",
|
36
37
|
"POST_ENGAGEMENT",
|
38
|
+
"PROFILE_AND_PAGE_ENGAGEMENT",
|
37
39
|
"PROFILE_VISIT",
|
38
40
|
"QUALITY_CALL",
|
39
41
|
"QUALITY_LEAD",
|
@@ -0,0 +1,28 @@
|
|
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 AdCampaignGroupAdvantageState < AdObject
|
17
|
+
|
18
|
+
field :advantage_audience_state, 'string'
|
19
|
+
field :advantage_budget_state, 'string'
|
20
|
+
field :advantage_placement_state, 'string'
|
21
|
+
field :advantage_state, 'string'
|
22
|
+
has_no_id
|
23
|
+
has_no_get
|
24
|
+
has_no_post
|
25
|
+
has_no_delete
|
26
|
+
|
27
|
+
end
|
28
|
+
end
|
@@ -94,6 +94,7 @@ module FacebookAds
|
|
94
94
|
"USE_MOBILE_APP",
|
95
95
|
"VIDEO_ANNOTATION",
|
96
96
|
"VIDEO_CALL",
|
97
|
+
"VIEW_CART",
|
97
98
|
"VIEW_CHANNEL",
|
98
99
|
"VIEW_PRODUCT",
|
99
100
|
"VISIT_PAGES_FEED",
|
@@ -176,6 +177,7 @@ module FacebookAds
|
|
176
177
|
field :branded_content, 'AdCreativeBrandedContentAds'
|
177
178
|
field :branded_content_sponsor_page_id, 'string'
|
178
179
|
field :bundle_folder_id, 'string'
|
180
|
+
field :call_to_action, 'AdCreativeLinkDataCallToAction'
|
179
181
|
field :call_to_action_type, { enum: -> { CALL_TO_ACTION_TYPE }}
|
180
182
|
field :categorization_criteria, 'string'
|
181
183
|
field :category_media_source, 'string'
|
@@ -232,7 +234,6 @@ module FacebookAds
|
|
232
234
|
field :url_tags, 'string'
|
233
235
|
field :use_page_actor_override, 'bool'
|
234
236
|
field :video_id, 'string'
|
235
|
-
field :call_to_action, 'object'
|
236
237
|
field :image_file, 'string'
|
237
238
|
field :is_dco_internal, 'bool'
|
238
239
|
|
@@ -22,7 +22,6 @@ module FacebookAds
|
|
22
22
|
field :product_data, { list: 'AdCreativeProductData' }
|
23
23
|
field :template_data, 'AdCreativeLinkData'
|
24
24
|
field :text_data, 'AdCreativeTextData'
|
25
|
-
field :threads_user_id, 'string'
|
26
25
|
field :video_data, 'AdCreativeVideoData'
|
27
26
|
has_no_id
|
28
27
|
has_no_get
|
@@ -16,6 +16,8 @@ module FacebookAds
|
|
16
16
|
class AdCreativeRegionalRegulationDisclaimer < AdObject
|
17
17
|
|
18
18
|
field :australia_finserv, 'object'
|
19
|
+
field :india_finserv, 'object'
|
20
|
+
field :singapore_universal, 'object'
|
19
21
|
field :taiwan_finserv, 'object'
|
20
22
|
field :taiwan_universal, 'object'
|
21
23
|
has_no_id
|
@@ -53,6 +53,7 @@ module FacebookAds
|
|
53
53
|
]
|
54
54
|
|
55
55
|
OPTIMIZATION_GOAL = [
|
56
|
+
"ADVERTISER_SILOED_VALUE",
|
56
57
|
"AD_RECALL_LIFT",
|
57
58
|
"APP_INSTALLS",
|
58
59
|
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
@@ -72,6 +73,7 @@ module FacebookAds
|
|
72
73
|
"OFFSITE_CONVERSIONS",
|
73
74
|
"PAGE_LIKES",
|
74
75
|
"POST_ENGAGEMENT",
|
76
|
+
"PROFILE_AND_PAGE_ENGAGEMENT",
|
75
77
|
"PROFILE_VISIT",
|
76
78
|
"QUALITY_CALL",
|
77
79
|
"QUALITY_LEAD",
|
@@ -173,6 +175,7 @@ module FacebookAds
|
|
173
175
|
"2",
|
174
176
|
"3",
|
175
177
|
"4",
|
178
|
+
"5",
|
176
179
|
]
|
177
180
|
|
178
181
|
TUNE_FOR_CATEGORY = [
|
@@ -230,6 +233,7 @@ module FacebookAds
|
|
230
233
|
field :full_funnel_exploration_mode, 'string'
|
231
234
|
field :id, 'string'
|
232
235
|
field :instagram_user_id, 'string'
|
236
|
+
field :is_ba_skip_delayed_eligible, 'bool'
|
233
237
|
field :is_budget_schedule_enabled, 'bool'
|
234
238
|
field :is_dynamic_creative, 'bool'
|
235
239
|
field :issues_info, { list: 'AdCampaignIssuesInfo' }
|
@@ -41,6 +41,7 @@ module FacebookAds
|
|
41
41
|
"COPYRIGHT_REFERENCE_IG_XPOST_VIDEO",
|
42
42
|
"COPYRIGHT_REFERENCE_VIDEO",
|
43
43
|
"CREATION_ML_PRECREATION",
|
44
|
+
"CREATOR_FAN_CHALLENGE",
|
44
45
|
"CREATOR_STOREFRONT_PERSONALIZED_VIDEO",
|
45
46
|
"DATAGENIX_VIDEO",
|
46
47
|
"DCO_AD_ASSET_FEED",
|
@@ -88,8 +89,6 @@ module FacebookAds
|
|
88
89
|
"INSTANT_APPLICATION_PREVIEW",
|
89
90
|
"INSTANT_ARTICLE",
|
90
91
|
"ISSUE_MODULE",
|
91
|
-
"JOBS_CAREERS",
|
92
|
-
"JOBS_VISUAL_INTRO_ENTRY",
|
93
92
|
"LEARN",
|
94
93
|
"LEGACY",
|
95
94
|
"LEGACY_CONTAINED_POST_BROADCAST",
|
@@ -101,7 +100,6 @@ module FacebookAds
|
|
101
100
|
"LOOK_NOW_DEPRECATED",
|
102
101
|
"MARKETPLACE_LISTING_VIDEO",
|
103
102
|
"MARKETPLACE_PRE_RECORDED_VIDEO",
|
104
|
-
"MESSENGER_WATCH_TOGETHER",
|
105
103
|
"MOMENTS_VIDEO",
|
106
104
|
"MUSIC_CLIP",
|
107
105
|
"MUSIC_CLIP_IN_COMMENT",
|
@@ -112,11 +110,9 @@ module FacebookAds
|
|
112
110
|
"NEO_ASYNC_GAME_VIDEO",
|
113
111
|
"NEW_CONTAINED_POST_BROADCAST",
|
114
112
|
"NO_STORY",
|
115
|
-
"NO_STORY_WITH_ENTPOST",
|
116
113
|
"NPE_COLLAB_COPYRIGHT_CHECK",
|
117
114
|
"OCULUS_CREATOR_PORTAL",
|
118
115
|
"OCULUS_VENUES_BROADCAST",
|
119
|
-
"OFFERS_VIDEO",
|
120
116
|
"ORIGINALITY_SELF_ADVOCACY",
|
121
117
|
"PAGES_COVER_VIDEO",
|
122
118
|
"PAGE_REVIEW_SCREENCAST",
|
@@ -150,7 +146,6 @@ module FacebookAds
|
|
150
146
|
"QUICK_PROMOTION",
|
151
147
|
"REPLACE_VIDEO",
|
152
148
|
"SALES_CLIENT_INTERACTION",
|
153
|
-
"SAY_THANKS_DEPRECATED",
|
154
149
|
"SHOWREEL_NATIVE_DUMMY_VIDEO",
|
155
150
|
"SLIDESHOW_ANIMOTO",
|
156
151
|
"SLIDESHOW_SHAKR",
|
@@ -168,6 +163,7 @@ module FacebookAds
|
|
168
163
|
"TAROT_DIGEST",
|
169
164
|
"TEMPORARY_UNLISTED",
|
170
165
|
"TEMP_MULTIMEDIA_POST",
|
166
|
+
"TEMP_VIDEO_COPYRIGHT_SCAN",
|
171
167
|
"UNLISTED",
|
172
168
|
"UNLISTED_HORIZON",
|
173
169
|
"UNLISTED_OCULUS",
|
@@ -29,7 +29,11 @@ module FacebookAds
|
|
29
29
|
"dda",
|
30
30
|
"default",
|
31
31
|
"skan_click",
|
32
|
+
"skan_click_second_postback",
|
33
|
+
"skan_click_third_postback",
|
32
34
|
"skan_view",
|
35
|
+
"skan_view_second_postback",
|
36
|
+
"skan_view_third_postback",
|
33
37
|
]
|
34
38
|
|
35
39
|
ACTION_BREAKDOWNS = [
|
@@ -202,6 +206,8 @@ module FacebookAds
|
|
202
206
|
field :conversions, { list: 'AdsActionStats' }
|
203
207
|
field :converted_product_quantity, { list: 'AdsActionStats' }
|
204
208
|
field :converted_product_value, { list: 'AdsActionStats' }
|
209
|
+
field :converted_promoted_product_quantity, { list: 'AdsActionStats' }
|
210
|
+
field :converted_promoted_product_value, { list: 'AdsActionStats' }
|
205
211
|
field :cost_per_15_sec_video_view, { list: 'AdsActionStats' }
|
206
212
|
field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
|
207
213
|
field :cost_per_action_type, { list: 'AdsActionStats' }
|
@@ -256,13 +262,22 @@ module FacebookAds
|
|
256
262
|
field :location, 'string'
|
257
263
|
field :marketing_messages_cost_per_delivered, 'string'
|
258
264
|
field :marketing_messages_cost_per_link_btn_click, 'string'
|
265
|
+
field :marketing_messages_delivered, 'string'
|
259
266
|
field :marketing_messages_delivery_rate, 'string'
|
267
|
+
field :marketing_messages_link_btn_click, 'string'
|
260
268
|
field :marketing_messages_link_btn_click_rate, 'string'
|
261
269
|
field :marketing_messages_media_view_rate, 'string'
|
262
270
|
field :marketing_messages_phone_call_btn_click_rate, 'string'
|
271
|
+
field :marketing_messages_quick_reply_btn_click, 'string'
|
263
272
|
field :marketing_messages_quick_reply_btn_click_rate, 'string'
|
273
|
+
field :marketing_messages_read, 'string'
|
264
274
|
field :marketing_messages_read_rate, 'string'
|
275
|
+
field :marketing_messages_sent, 'string'
|
265
276
|
field :marketing_messages_spend, 'string'
|
277
|
+
field :marketing_messages_spend_currency, 'string'
|
278
|
+
field :marketing_messages_website_add_to_cart, 'string'
|
279
|
+
field :marketing_messages_website_initiate_checkout, 'string'
|
280
|
+
field :marketing_messages_website_purchase, 'string'
|
266
281
|
field :marketing_messages_website_purchase_values, 'string'
|
267
282
|
field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
|
268
283
|
field :objective, 'string'
|
@@ -13,7 +13,7 @@ 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 AdsPixelCapiIntegrationQuality < AdObject
|
17
17
|
|
18
18
|
field :event_match_quality, 'object'
|
19
19
|
field :event_name, 'string'
|
@@ -26,6 +26,7 @@ module FacebookAds
|
|
26
26
|
field :aplusc_epa_opt_in_status, 'string'
|
27
27
|
field :aplusc_local_store_extension_opt_in_status, 'string'
|
28
28
|
field :aplusc_opt_out_friction, { list: 'string' }
|
29
|
+
field :aplusc_videofilter_opt_in_status, 'string'
|
29
30
|
field :autoflow_lite_opt_in_status, 'string'
|
30
31
|
field :autoflow_lite_should_opt_in, 'bool'
|
31
32
|
field :blended_ads_creation_defaulting_opt_in_status, 'string'
|
@@ -55,6 +56,8 @@ module FacebookAds
|
|
55
56
|
field :open_tabs, { list: 'string' }
|
56
57
|
field :previously_seen_recommendations, { list: 'string' }
|
57
58
|
field :product_extensions_opt_in, 'string'
|
59
|
+
field :sa_off_conv_loc_seen, 'string'
|
60
|
+
field :saon_migr_l1_seen_status, 'string'
|
58
61
|
field :selected_ad_account, 'AdAccount'
|
59
62
|
field :selected_comparison_timerange, 'object'
|
60
63
|
field :selected_metric_cic, 'string'
|
@@ -14,11 +14,18 @@ module FacebookAds
|
|
14
14
|
# pull request for this class.
|
15
15
|
|
16
16
|
class AdsValueAdjustmentRuleCollection < AdObject
|
17
|
+
PRODUCT_TYPE = [
|
18
|
+
"AUDIENCE",
|
19
|
+
"LEADGEN_ADS",
|
20
|
+
"OMNI_CHANNEL",
|
21
|
+
]
|
22
|
+
|
17
23
|
|
18
24
|
field :id, 'string'
|
19
25
|
field :is_default_setting, 'bool'
|
20
26
|
field :name, 'string'
|
21
|
-
|
27
|
+
field :product_type, 'string'
|
28
|
+
field :rules, { list: 'hash' }
|
22
29
|
has_no_delete
|
23
30
|
|
24
31
|
has_edge :rules do |edge|
|
@@ -227,6 +227,7 @@ module FacebookAds
|
|
227
227
|
api.has_param :app_user_id, 'string'
|
228
228
|
api.has_param :application_tracking_enabled, 'bool'
|
229
229
|
api.has_param :attribution, 'string'
|
230
|
+
api.has_param :attribution_referrer, 'string'
|
230
231
|
api.has_param :attribution_sources, { list: 'hash' }
|
231
232
|
api.has_param :auto_publish, 'bool'
|
232
233
|
api.has_param :bundle_id, 'string'
|
@@ -244,13 +245,16 @@ module FacebookAds
|
|
244
245
|
api.has_param :event, { enum: %w{CUSTOM_APP_EVENTS DEFERRED_APP_LINK MOBILE_APP_INSTALL }}
|
245
246
|
api.has_param :event_id, 'string'
|
246
247
|
api.has_param :extinfo, 'object'
|
248
|
+
api.has_param :google_install_referrer, 'string'
|
247
249
|
api.has_param :include_dwell_data, 'bool'
|
248
250
|
api.has_param :include_video_data, 'bool'
|
251
|
+
api.has_param :install_id, 'string'
|
249
252
|
api.has_param :install_referrer, 'string'
|
250
253
|
api.has_param :install_timestamp, 'int'
|
251
254
|
api.has_param :installer_package, 'string'
|
252
255
|
api.has_param :is_fb, 'bool'
|
253
256
|
api.has_param :limited_data_use, 'bool'
|
257
|
+
api.has_param :meta_install_referrer, 'string'
|
254
258
|
api.has_param :migration_bundle, 'string'
|
255
259
|
api.has_param :operational_parameters, { list: 'hash' }
|
256
260
|
api.has_param :page_id, 'int'
|