facebookbusiness 18.0.1 → 18.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 679d7ce7444c13349808ee9d6e6d683835d23102a84e60db05b75ac83c0595b1
4
- data.tar.gz: 5c5129bf9e8b248b966d220b9a465efa1f942fc52cf192e6150841f846c0daa6
3
+ metadata.gz: ca63f4ca6026ec9a8e4a9b6009325aa4e91bbc175603f8c3ae63b116e0ace2f4
4
+ data.tar.gz: 77202b89e94da77923a096440801c9f4a762904325f55bf496b082f501bbc272
5
5
  SHA512:
6
- metadata.gz: bb7988a876b2c863a16ef0feca6fb6eb3f46cc631e489425279343ba3822f738bfc3dc4e01dd447d1f4f98b41bbc87064ce7274fd5b08272238dfbfe39eaf9ed
7
- data.tar.gz: 859b24031636c1a4e8b815ec0b065dcd6f89cea910d6be2a584e33b6e5af6694f68b649daf598323ce2c6cc8593bddc2c2b73fce6bb4c97eac6f8459d072870e
6
+ metadata.gz: 10a45a1bf364404c7a886b7deed6b2d7eca616ea2a5934d9429746e6c4790a55f6b14419f1aea3d2474699c67c0d32b058ee4e2734272ea4a79a3a355b78b13f
7
+ data.tar.gz: 938a29a5c03af70a9afd25e28748ee701cf2f9c732571b3794ad1e9d7045371e6d5544502f4bb27b2933fbc68c8c7f9e662630289be0f07edd807ad465ae94ec
@@ -420,18 +420,6 @@ module FacebookAds
420
420
  end
421
421
  end
422
422
 
423
- has_edge :ads_conversion_goal do |edge|
424
- edge.post do |api|
425
- api.has_param :conversion_event_value_source, { enum: %w{DATA_SOURCE VALUE_RULE }}
426
- api.has_param :description, 'string'
427
- api.has_param :goal_creation_method, { enum: %w{ADVERTISER_CREATED_UI AUTO_MIGRATION L2_ENHANCE_API_MIGRATION }}
428
- api.has_param :goal_name, 'string'
429
- api.has_param :performance_goal, { enum: %w{AD_OPTIMIZATION_GOAL_AD_RECALL_LIFT AD_OPTIMIZATION_GOAL_APP_DOWNLOADS AD_OPTIMIZATION_GOAL_APP_INSTALLS AD_OPTIMIZATION_GOAL_APP_INSTALLS_AND_OFFSITE_CONVERSIONS AD_OPTIMIZATION_GOAL_BRAND_AWARENESS AD_OPTIMIZATION_GOAL_CLICKS AD_OPTIMIZATION_GOAL_COMPLETED_VIDEO_VIEWS AD_OPTIMIZATION_GOAL_CONVERSATIONS AD_OPTIMIZATION_GOAL_DERIVED_EVENTS AD_OPTIMIZATION_GOAL_DWELLS AD_OPTIMIZATION_GOAL_ENGAGED_REACH AD_OPTIMIZATION_GOAL_ENGAGED_USERS AD_OPTIMIZATION_GOAL_EVENT_RESPONSES AD_OPTIMIZATION_GOAL_EXTERNAL AD_OPTIMIZATION_GOAL_IMPRESSIONS AD_OPTIMIZATION_GOAL_INCREMENTAL_OFFSITE_CONVERSIONS AD_OPTIMIZATION_GOAL_IN_APP_VALUE AD_OPTIMIZATION_GOAL_JOB_APPLICATIONS AD_OPTIMIZATION_GOAL_LANDING_PAGE_VIEWS AD_OPTIMIZATION_GOAL_LEAD_GENERATION AD_OPTIMIZATION_GOAL_MEDIA_DOWNLOADS AD_OPTIMIZATION_GOAL_MESSAGING_APPOINTMENT_CONVERSION AD_OPTIMIZATION_GOAL_MESSAGING_DEEP_CONVERSATION_AND_FOLLOW AD_OPTIMIZATION_GOAL_MESSAGING_DEEP_CONVERSATION_AND_REPLY AD_OPTIMIZATION_GOAL_MESSAGING_PURCHASE_CONVERSION AD_OPTIMIZATION_GOAL_MID_FUNNEL_EVENT AD_OPTIMIZATION_GOAL_MRC_VIDEO_VIEWS AD_OPTIMIZATION_GOAL_MULTI_CONVERSIONS AD_OPTIMIZATION_GOAL_NONE AD_OPTIMIZATION_GOAL_OFFER_CLAIMS AD_OPTIMIZATION_GOAL_OFFLINE_CONVERSIONS AD_OPTIMIZATION_GOAL_OFFSITE_CLICKS AD_OPTIMIZATION_GOAL_OFFSITE_CONVERSIONS AD_OPTIMIZATION_GOAL_ONSITE_CONVERSIONS AD_OPTIMIZATION_GOAL_PAGE_ENGAGEMENT AD_OPTIMIZATION_GOAL_PAGE_FOLLOWS AD_OPTIMIZATION_GOAL_PAGE_LIKES AD_OPTIMIZATION_GOAL_POST_ENGAGEMENT AD_OPTIMIZATION_GOAL_QUALITY_CALL AD_OPTIMIZATION_GOAL_QUALITY_LEAD AD_OPTIMIZATION_GOAL_REACH AD_OPTIMIZATION_GOAL_REMINDERS_SET AD_OPTIMIZATION_GOAL_REPLIES AD_OPTIMIZATION_GOAL_RESEARCH_POLL_RESPONSES AD_OPTIMIZATION_GOAL_RETENTION AD_OPTIMIZATION_GOAL_RETURN_ON_AD_SPEND AD_OPTIMIZATION_GOAL_SOCIAL_IMPRESSIONS AD_OPTIMIZATION_GOAL_STORE_VISITS AD_OPTIMIZATION_GOAL_SUBSCRIBERS AD_OPTIMIZATION_GOAL_TICKET_PURCHASE AD_OPTIMIZATION_GOAL_VALUE AD_OPTIMIZATION_GOAL_VIDEO_LONG_VIEWS AD_OPTIMIZATION_GOAL_VIDEO_VIEWS AD_OPTIMIZATION_GOAL_VIDEO_VIEWS_15S AD_OPTIMIZATION_GOAL_VISIT_INSTAGRAM_PROFILE AD_OPTIMIZATION_GOAL_VISIT_INSTAGRAM_PROFILE_AND_PROFILE_ACTIONS }}
430
- api.has_param :single_channel_conversion_events, { list: 'hash' }
431
- api.has_param :value_adjustment_rule, 'hash'
432
- end
433
- end
434
-
435
423
  has_edge :ads_reporting_mmm_reports do |edge|
436
424
  edge.get do |api|
437
425
  api.has_param :filtering, { list: 'hash' }
@@ -19,6 +19,9 @@ module FacebookAds
19
19
  "ACO_TOGGLE",
20
20
  "ADS_REPORTING",
21
21
  "ADVANCED_CAMPAIGN_BUDGET",
22
+ "ADVANTAGE_CUSTOM_AUDIENCE_UPSELL",
23
+ "ADVANTAGE_PLUS_AUDIENCE_FRICTION",
24
+ "ADVANTAGE_PLUS_AUDIENCE_TOGGLE",
22
25
  "ADVANTAGE_PLUS_CREATIVE",
23
26
  "ADVANTAGE_PLUS_CREATIVE_CATALOG",
24
27
  "ADVANTAGE_SHOPPING_CAMPAIGN",
@@ -54,6 +57,7 @@ module FacebookAds
54
57
  "CREATIVE_LIMITED_HOURLY",
55
58
  "CREATOR_ADS_PA_CONVERSION",
56
59
  "CTA",
60
+ "DA_ADVANTAGE_PLUS_CREATIVE_INFO_LABELS",
57
61
  "DEAD_LINK",
58
62
  "DYNAMIC_ADVANTAGE_CAMPAIGN_BUDGET",
59
63
  "ECOSYSTEM_BID_REDUCE_L1_CARDINALITY",
@@ -61,14 +65,16 @@ module FacebookAds
61
65
  "GES_TEST",
62
66
  "GUIDANCE_CENTER_CODE_GEN",
63
67
  "LEARNING_LIMITED",
68
+ "LEARNING_PAUSE_FRICTION",
64
69
  "LOW_OUTCOME",
65
70
  "MERLIN_GUIDANCE",
71
+ "MIXED_PA_COMBINE_ADSETS",
66
72
  "MMT_CAROUSEL_TO_VIDEO",
67
73
  "MOBILE_FIRST_VIDEO",
68
74
  "MR_AEMV2SUB_KCONSOLIDATION",
69
75
  "MULTI_TEXT",
70
76
  "MUSIC",
71
- "OPTIMAL_SPEND",
77
+ "OPTIMAL_BAU",
72
78
  "PAYMENT_METHOD",
73
79
  "PERFORMANT_CREATIVE_REELS_OPT_IN",
74
80
  "PFR_L1_INLINE_MMT",
@@ -85,6 +85,7 @@ module FacebookAds
85
85
  "update_campaign_budget",
86
86
  "update_campaign_budget_optimization_toggling_status",
87
87
  "update_campaign_budget_scheduling_state",
88
+ "update_campaign_conversion_goal",
88
89
  "update_campaign_delivery_type",
89
90
  "update_campaign_group_ad_scheduling",
90
91
  "update_campaign_group_budget_scheduling_state",
@@ -26,6 +26,7 @@ module FacebookAds
26
26
  "CALL",
27
27
  "CALL_ME",
28
28
  "CALL_NOW",
29
+ "CONFIRM",
29
30
  "CONTACT",
30
31
  "CONTACT_US",
31
32
  "DONATE",
@@ -26,6 +26,7 @@ module FacebookAds
26
26
  "CALL",
27
27
  "CALL_ME",
28
28
  "CALL_NOW",
29
+ "CONFIRM",
29
30
  "CONTACT",
30
31
  "CONTACT_US",
31
32
  "DONATE",
@@ -26,6 +26,7 @@ module FacebookAds
26
26
  "CALL",
27
27
  "CALL_ME",
28
28
  "CALL_NOW",
29
+ "CONFIRM",
29
30
  "CONTACT",
30
31
  "CONTACT_US",
31
32
  "DONATE",
@@ -69,7 +69,6 @@ module FacebookAds
69
69
  field :product_item_id, 'string'
70
70
  field :product_set_id, 'string'
71
71
  field :retention_days, 'string'
72
- field :whats_app_business_phone_number_id, 'object'
73
72
  has_no_id
74
73
  has_no_get
75
74
  has_no_post
@@ -70,6 +70,7 @@ module FacebookAds
70
70
  "is_conversion_id_modeled",
71
71
  "link_url_asset",
72
72
  "marketing_messages_btn_name",
73
+ "mdsa_landing_destination",
73
74
  "media_asset_url",
74
75
  "media_creator",
75
76
  "media_destination_url",
@@ -99,6 +99,12 @@ module FacebookAds
99
99
  edge.get 'Business'
100
100
  end
101
101
 
102
+ has_edge :ahp_configs do |edge|
103
+ edge.post do |api|
104
+ api.has_param :applink_autosetup, 'bool'
105
+ end
106
+ end
107
+
102
108
  has_edge :assigned_users do |edge|
103
109
  edge.get 'AssignedUser' do |api|
104
110
  api.has_param :business, 'string'
@@ -744,6 +744,8 @@ module FacebookAds
744
744
  api.has_param :access_key, 'string'
745
745
  api.has_param :active, 'bool'
746
746
  api.has_param :endpoint, 'string'
747
+ api.has_param :fallback_domain, 'string'
748
+ api.has_param :fallback_domain_enabled, 'bool'
747
749
  api.has_param :host_business_id, 'int'
748
750
  api.has_param :host_external_id, 'string'
749
751
  api.has_param :pixel_id, 'int'
@@ -800,6 +802,7 @@ module FacebookAds
800
802
  edge.get 'Page'
801
803
  edge.post 'Business' do |api|
802
804
  api.has_param :code, 'string'
805
+ api.has_param :entry_point, 'string'
803
806
  api.has_param :page_id, 'int'
804
807
  end
805
808
  end
@@ -137,13 +137,6 @@ module FacebookAds
137
137
  end
138
138
  end
139
139
 
140
- has_edge :attachment_surfaces do |edge|
141
- edge.get
142
- edge.post do |api|
143
- api.has_param :title, 'hash'
144
- end
145
- end
146
-
147
140
  has_edge :docs do |edge|
148
141
  edge.get
149
142
  end
@@ -17,6 +17,7 @@ module FacebookAds
17
17
 
18
18
  field :caption, 'string'
19
19
  field :comments_count, 'int'
20
+ field :copyright_check_information, 'IgVideoCopyrightCheckMatchesInformation'
20
21
  field :id, 'string'
21
22
  field :ig_id, 'string'
22
23
  field :is_comment_enabled, 'bool'
@@ -37,6 +38,10 @@ module FacebookAds
37
38
  edge.get 'IgMedia'
38
39
  end
39
40
 
41
+ has_edge :collaborators do |edge|
42
+ edge.get 'ShadowIgMediaCollaborators'
43
+ end
44
+
40
45
  has_edge :comments do |edge|
41
46
  edge.get 'IgComment'
42
47
  edge.post 'IgComment' do |api|
@@ -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 IgVideoCopyrightCheckMatchesInformation < AdObject
17
+
18
+ field :copyright_matches, { list: 'object' }
19
+ field :status, 'IgVideoCopyrightCheckStatus'
20
+ has_no_id
21
+ has_no_get
22
+ has_no_post
23
+ has_no_delete
24
+
25
+ end
26
+ end
@@ -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 IgVideoCopyrightCheckStatus < AdObject
17
+
18
+ field :matches_found, 'bool'
19
+ field :status, '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 :instagram_user, 'InstagramUser'
23
23
  field :mentioned_instagram_users, { list: 'InstagramUser' }
24
24
  field :message, 'string'
25
+ field :username, 'string'
25
26
 
26
27
  has_edge :replies do |edge|
27
28
  edge.get 'InstagramComment'
@@ -18,6 +18,8 @@ module FacebookAds
18
18
  field :access_key, 'string'
19
19
  field :active, 'bool'
20
20
  field :endpoint, 'string'
21
+ field :fallback_domain, 'string'
22
+ field :fallback_domain_enabled, 'bool'
21
23
  field :host_business_id, 'string'
22
24
  field :host_external_id, 'string'
23
25
  field :id, 'string'
@@ -418,6 +418,7 @@ module FacebookAds
418
418
  field :directed_by, 'string'
419
419
  field :display_subtext, 'string'
420
420
  field :displayed_message_response_time, 'string'
421
+ field :does_viewer_have_page_permission_link_ig, 'bool'
421
422
  field :emails, { list: 'string' }
422
423
  field :engagement, 'Engagement'
423
424
  field :fan_count, 'int'
@@ -446,6 +447,7 @@ module FacebookAds
446
447
  field :is_chain, 'bool'
447
448
  field :is_community_page, 'bool'
448
449
  field :is_eligible_for_branded_content, 'bool'
450
+ field :is_eligible_for_disable_connect_ig_btn_for_non_page_admin_am_web, 'bool'
449
451
  field :is_messenger_bot_get_started_enabled, 'bool'
450
452
  field :is_messenger_platform_bot, 'bool'
451
453
  field :is_owned, 'bool'
@@ -465,7 +467,6 @@ module FacebookAds
465
467
  field :merchant_review_status, 'string'
466
468
  field :messaging_feature_status, 'MessagingFeatureStatus'
467
469
  field :messenger_ads_default_icebreakers, { list: 'string' }
468
- field :messenger_ads_default_page_welcome_message, 'MessengerDestinationPageWelcomeMessage'
469
470
  field :messenger_ads_default_quick_replies, { list: 'string' }
470
471
  field :messenger_ads_quick_replies_type, 'string'
471
472
  field :mini_shop_storefront, 'Shop'
@@ -1015,8 +1016,8 @@ module FacebookAds
1015
1016
 
1016
1017
  has_edge :locations do |edge|
1017
1018
  edge.delete do |api|
1018
- api.has_param :location_page_id, 'string'
1019
- api.has_param :store_number, 'int'
1019
+ api.has_param :location_page_ids, { list: 'string' }
1020
+ api.has_param :store_numbers, { list: 'int' }
1020
1021
  end
1021
1022
  edge.get 'Page'
1022
1023
  edge.post 'Page' do |api|
@@ -96,6 +96,7 @@ module FacebookAds
96
96
  "LANGUAGE",
97
97
  "LANGUAGE_AND_COUNTRY",
98
98
  "LOCAL",
99
+ "SMART_PIXEL_LANGUAGE_OR_COUNTRY",
99
100
  ]
100
101
 
101
102
 
@@ -15,6 +15,7 @@ module FacebookAds
15
15
 
16
16
  class ShadowIgMediaBuilder < AdObject
17
17
 
18
+ field :copyright_check_status, 'IgVideoCopyrightCheckStatus'
18
19
  field :id, 'string'
19
20
  field :status, 'string'
20
21
  field :status_code, 'string'
@@ -13,14 +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 MessengerDestinationPageWelcomeMessage < AdObject
16
+ class ShadowIgMediaCollaborators < AdObject
17
17
 
18
18
  field :id, 'string'
19
- field :page_welcome_message_body, 'string'
20
- field :page_welcome_message_type, 'string'
21
- field :template_name, 'string'
22
- field :time_created, 'datetime'
23
- field :time_last_used, 'datetime'
19
+ field :invite_status, 'string'
20
+ field :username, 'string'
24
21
  has_no_get
25
22
  has_no_post
26
23
  has_no_delete
@@ -19,7 +19,11 @@ module FacebookAds
19
19
  "MANAGE",
20
20
  "MANAGE_EXTENSIONS",
21
21
  "MANAGE_PHONE",
22
+ "MANAGE_PHONE_ASSETS",
23
+ "MANAGE_TEMPLATES",
22
24
  "VIEW_COST",
25
+ "VIEW_PHONE_ASSETS",
26
+ "VIEW_TEMPLATES",
23
27
  ]
24
28
 
25
29
  CATEGORY = [
@@ -90,6 +94,7 @@ module FacebookAds
90
94
  has_edge :extensions do |edge|
91
95
  edge.get
92
96
  edge.post do |api|
97
+ api.has_param :categories, { list: { enum: %w{APPOINTMENT_BOOKING CONTACT_US CUSTOMER_SUPPORT LEAD_GENERATION OTHER SIGN_IN SIGN_UP SURVEY }} }
93
98
  api.has_param :clone_extension_id, 'string'
94
99
  api.has_param :clone_template, 'string'
95
100
  api.has_param :data_channel_uri, 'string'
@@ -100,6 +105,7 @@ module FacebookAds
100
105
  has_edge :flows do |edge|
101
106
  edge.get
102
107
  edge.post do |api|
108
+ api.has_param :categories, { list: { enum: %w{APPOINTMENT_BOOKING CONTACT_US CUSTOMER_SUPPORT LEAD_GENERATION OTHER SIGN_IN SIGN_UP SURVEY }} }
103
109
  api.has_param :clone_flow_id, 'string'
104
110
  api.has_param :clone_template, 'string'
105
111
  api.has_param :data_channel_uri, 'string'
@@ -7,6 +7,6 @@
7
7
  # FB:AUTOGEN
8
8
 
9
9
  module FacebookAds
10
- VERSION = '18.0.1'
10
+ VERSION = '18.0.2'
11
11
  API_VERSION = '18.0'
12
12
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: facebookbusiness
3
3
  version: !ruby/object:Gem::Version
4
- version: 18.0.1
4
+ version: 18.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Facebook
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-26 00:00:00.000000000 Z
11
+ date: 2023-10-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: concurrent-ruby
@@ -509,6 +509,8 @@ files:
509
509
  - lib/facebook_ads/ad_objects/ig_shopping_review_status_onsite_eligibility.rb
510
510
  - lib/facebook_ads/ad_objects/ig_shopping_review_status_reason_with_help_message.rb
511
511
  - lib/facebook_ads/ad_objects/ig_user.rb
512
+ - lib/facebook_ads/ad_objects/ig_video_copyright_check_matches_information.rb
513
+ - lib/facebook_ads/ad_objects/ig_video_copyright_check_status.rb
512
514
  - lib/facebook_ads/ad_objects/igbc_ads_permission.rb
513
515
  - lib/facebook_ads/ad_objects/image_copyright.rb
514
516
  - lib/facebook_ads/ad_objects/insights_result.rb
@@ -561,7 +563,6 @@ files:
561
563
  - lib/facebook_ads/ad_objects/messaging_feature_review.rb
562
564
  - lib/facebook_ads/ad_objects/messaging_feature_status.rb
563
565
  - lib/facebook_ads/ad_objects/messenger_ads_partial_automated_step_list.rb
564
- - lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb
565
566
  - lib/facebook_ads/ad_objects/messenger_profile.rb
566
567
  - lib/facebook_ads/ad_objects/minimum_budget.rb
567
568
  - lib/facebook_ads/ad_objects/music_video_copyright.rb
@@ -678,6 +679,7 @@ files:
678
679
  - lib/facebook_ads/ad_objects/server_side/util.rb
679
680
  - lib/facebook_ads/ad_objects/shadow_ig_hashtag.rb
680
681
  - lib/facebook_ads/ad_objects/shadow_ig_media_builder.rb
682
+ - lib/facebook_ads/ad_objects/shadow_ig_media_collaborators.rb
681
683
  - lib/facebook_ads/ad_objects/shadow_ig_media_product_tags.rb
682
684
  - lib/facebook_ads/ad_objects/shadow_ig_user_catalog_product_search.rb
683
685
  - lib/facebook_ads/ad_objects/shadow_ig_user_catalog_product_variant.rb