facebookbusiness 0.7.0.0 → 0.8.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_account.rb +17 -19
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +23 -0
- data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +8 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +2 -2
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +2 -3
- data/lib/facebook_ads/ad_objects/{atlas_url.rb → ad_creative_instagram_branded_content.rb} +1 -2
- data/lib/facebook_ads/ad_objects/ad_creative_interactive_components_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_report_spec.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_set.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_study.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +12 -26
- data/lib/facebook_ads/ad_objects/adgroup_activity.rb +4 -4
- data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +4 -0
- data/lib/facebook_ads/ad_objects/{ads_interest.rb → adoptable_pet.rb} +19 -5
- data/lib/facebook_ads/ad_objects/ads_insights.rb +9 -0
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +3 -0
- data/lib/facebook_ads/ad_objects/album.rb +7 -0
- data/lib/facebook_ads/ad_objects/application.rb +26 -0
- data/lib/facebook_ads/ad_objects/atlas_campaign.rb +3 -3
- data/lib/facebook_ads/ad_objects/automotive_model.rb +1 -0
- data/lib/facebook_ads/ad_objects/business.rb +66 -118
- data/lib/facebook_ads/ad_objects/{business_creative_folder_sharing_agreement.rb → business_agreement.rb} +2 -5
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +2 -3
- data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_role_request.rb +10 -0
- data/lib/facebook_ads/ad_objects/business_unit.rb +1 -1
- data/lib/facebook_ads/ad_objects/business_user.rb +10 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +258 -0
- data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +88 -0
- data/lib/facebook_ads/ad_objects/comment.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +126 -0
- data/lib/facebook_ads/ad_objects/{client_transparency_status.rb → commerce_merchant_settings_setup_status.rb} +6 -5
- data/lib/facebook_ads/ad_objects/commerce_order.rb +153 -0
- data/lib/facebook_ads/ad_objects/{business_creative.rb → commerce_order_transaction_detail.rb} +14 -12
- data/lib/facebook_ads/ad_objects/commerce_payout.rb +41 -0
- data/lib/facebook_ads/ad_objects/{creative_asset_tag.rb → connections_targeting.rb} +2 -2
- data/lib/facebook_ads/ad_objects/{brand_audience.rb → cpas_advertiser_partnership_recommendation.rb} +8 -9
- data/lib/facebook_ads/ad_objects/cpas_collaboration_request.rb +50 -0
- data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -4
- data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_conversion.rb +1 -0
- data/lib/facebook_ads/ad_objects/da_check.rb +7 -0
- data/lib/facebook_ads/ad_objects/destination.rb +1 -0
- data/lib/facebook_ads/ad_objects/event.rb +12 -1
- data/lib/facebook_ads/ad_objects/extended_credit.rb +7 -0
- data/lib/facebook_ads/ad_objects/external_event_source.rb +1 -0
- data/lib/facebook_ads/ad_objects/flight.rb +1 -0
- data/lib/facebook_ads/ad_objects/group.rb +10 -1
- data/lib/facebook_ads/ad_objects/home_listing.rb +1 -0
- data/lib/facebook_ads/ad_objects/hotel.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_media.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/life_event.rb +0 -8
- data/lib/facebook_ads/ad_objects/link.rb +0 -6
- data/lib/facebook_ads/ad_objects/live_video.rb +12 -16
- data/lib/facebook_ads/ad_objects/media_fingerprint.rb +0 -1
- data/lib/facebook_ads/ad_objects/native_offer_view.rb +0 -1
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +0 -6
- data/lib/facebook_ads/ad_objects/oracle_transaction.rb +0 -7
- data/lib/facebook_ads/ad_objects/page.rb +75 -81
- data/lib/facebook_ads/ad_objects/page_admin_note.rb +1 -0
- data/lib/facebook_ads/ad_objects/page_call_to_action.rb +8 -0
- data/lib/facebook_ads/ad_objects/page_change_proposal.rb +2 -0
- data/lib/facebook_ads/ad_objects/page_post.rb +10 -0
- data/lib/facebook_ads/ad_objects/{request_history.rb → payment_subscription.rb} +24 -15
- data/lib/facebook_ads/ad_objects/photo.rb +6 -0
- data/lib/facebook_ads/ad_objects/post.rb +12 -2
- data/lib/facebook_ads/ad_objects/product_catalog.rb +50 -0
- data/lib/facebook_ads/ad_objects/product_feed.rb +31 -0
- data/lib/facebook_ads/ad_objects/{product_feed_upload_diagnostics.rb → product_feed_upload_diagnostics_report.rb} +2 -2
- data/lib/facebook_ads/ad_objects/product_group.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +2 -0
- data/lib/facebook_ads/ad_objects/product_set.rb +4 -0
- data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → product_set_metadata.rb} +4 -3
- data/lib/facebook_ads/ad_objects/profile.rb +2 -0
- data/lib/facebook_ads/ad_objects/profile_picture_source.rb +4 -0
- data/lib/facebook_ads/ad_objects/publisher_block_list.rb +6 -0
- data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
- data/lib/facebook_ads/ad_objects/security_settings.rb +0 -1
- data/lib/facebook_ads/ad_objects/server_side/content.rb +75 -13
- data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +45 -6
- data/lib/facebook_ads/ad_objects/server_side/delivery_category.rb +33 -0
- data/lib/facebook_ads/ad_objects/server_side/event.rb +62 -3
- data/lib/facebook_ads/ad_objects/server_side/event_request.rb +86 -12
- data/lib/facebook_ads/ad_objects/{whats_app_business_profile.rb → server_side/event_request_async.rb} +9 -14
- data/lib/facebook_ads/ad_objects/server_side/user_data.rb +151 -17
- data/lib/facebook_ads/ad_objects/server_side/util.rb +216 -149
- data/lib/facebook_ads/ad_objects/system_user.rb +10 -4
- data/lib/facebook_ads/ad_objects/targeting.rb +4 -3
- data/lib/facebook_ads/ad_objects/{user_influence.rb → targeting_relaxation.rb} +2 -4
- data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb +1 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -0
- data/lib/facebook_ads/ad_objects/user.rb +9 -27
- 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/ad_objects/whats_app_business_account.rb +26 -0
- data/lib/facebook_ads/errors.rb +1 -1
- data/lib/facebook_ads/version.rb +2 -2
- metadata +67 -30
- data/lib/facebook_ads/ad_objects/business_creative_folder.rb +0 -79
- data/lib/facebook_ads/ad_objects/business_image.rb +0 -94
- data/lib/facebook_ads/ad_objects/iterative_split_test_config.rb +0 -43
- data/lib/facebook_ads/ad_objects/messenger_platform_referral.rb +0 -39
- data/lib/facebook_ads/ad_objects/open_graph_object.rb +0 -70
- data/lib/facebook_ads/ad_objects/page_about_story.rb +0 -39
- data/lib/facebook_ads/ad_objects/split_test_config.rb +0 -41
- data/lib/facebook_ads/ad_objects/streaming_reaction.rb +0 -50
- data/lib/facebook_ads/ad_objects/user_taggable_friend.rb +0 -49
- data/lib/facebook_ads/ad_objects/video_game_show.rb +0 -39
@@ -31,6 +31,8 @@ module FacebookAds
|
|
31
31
|
"BECOME_A_VOLUNTEER",
|
32
32
|
"EMAIL",
|
33
33
|
"FACEBOOK_APP",
|
34
|
+
"FOLLOW",
|
35
|
+
"MARKETPLACE_INVENTORY_PAGE",
|
34
36
|
"MESSENGER",
|
35
37
|
"MINI_SHOP",
|
36
38
|
"NONE",
|
@@ -44,6 +46,8 @@ module FacebookAds
|
|
44
46
|
"BECOME_A_VOLUNTEER",
|
45
47
|
"EMAIL",
|
46
48
|
"FACEBOOK_APP",
|
49
|
+
"FOLLOW",
|
50
|
+
"MARKETPLACE_INVENTORY_PAGE",
|
47
51
|
"MESSENGER",
|
48
52
|
"MINI_SHOP",
|
49
53
|
"NONE",
|
@@ -62,6 +66,7 @@ module FacebookAds
|
|
62
66
|
"CONTACT_US",
|
63
67
|
"DONATE_NOW",
|
64
68
|
"EMAIL",
|
69
|
+
"FOLLOW_PAGE",
|
65
70
|
"GET_DIRECTIONS",
|
66
71
|
"GET_OFFER",
|
67
72
|
"GET_OFFER_VIEW",
|
@@ -71,6 +76,7 @@ module FacebookAds
|
|
71
76
|
"LOCAL_DEV_PLATFORM",
|
72
77
|
"MESSAGE",
|
73
78
|
"OPEN_APP",
|
79
|
+
"ORDER_FOOD",
|
74
80
|
"PLAY_MUSIC",
|
75
81
|
"PLAY_NOW",
|
76
82
|
"PURCHASE_GIFT_CARDS",
|
@@ -79,6 +85,7 @@ module FacebookAds
|
|
79
85
|
"SHOP_NOW",
|
80
86
|
"SHOP_ON_FACEBOOK",
|
81
87
|
"SIGN_UP",
|
88
|
+
"VIEW_INVENTORY",
|
82
89
|
"VIEW_SHOP",
|
83
90
|
"VISIT_GROUP",
|
84
91
|
"WATCH_NOW",
|
@@ -89,6 +96,7 @@ module FacebookAds
|
|
89
96
|
"BECOME_A_VOLUNTEER",
|
90
97
|
"BECOME_SUPPORTER",
|
91
98
|
"EMAIL",
|
99
|
+
"FOLLOW",
|
92
100
|
"MESSENGER",
|
93
101
|
"NONE",
|
94
102
|
"SHOP_ON_FACEBOOK",
|
@@ -62,16 +62,21 @@ module FacebookAds
|
|
62
62
|
field :comments_mirroring_domain, 'string'
|
63
63
|
field :coordinates, 'object'
|
64
64
|
field :created_time, 'datetime'
|
65
|
+
field :delivery_growth_optimizations, { list: 'string' }
|
66
|
+
field :entities, 'object'
|
65
67
|
field :event, 'Event'
|
66
68
|
field :expanded_height, 'int'
|
67
69
|
field :expanded_width, 'int'
|
68
70
|
field :feed_targeting, 'object'
|
71
|
+
field :formatting, 'string'
|
69
72
|
field :from, 'object'
|
70
73
|
field :full_picture, 'string'
|
71
74
|
field :height, 'int'
|
72
75
|
field :icon, 'string'
|
73
76
|
field :id, 'string'
|
77
|
+
field :implicit_place, 'Place'
|
74
78
|
field :instagram_eligibility, 'string'
|
79
|
+
field :instream_eligibility, 'string'
|
75
80
|
field :is_app_share, 'bool'
|
76
81
|
field :is_eligible_for_promotion, 'bool'
|
77
82
|
field :is_expired, 'bool'
|
@@ -81,6 +86,7 @@ module FacebookAds
|
|
81
86
|
field :is_popular, 'bool'
|
82
87
|
field :is_published, 'bool'
|
83
88
|
field :is_spherical, 'bool'
|
89
|
+
field :live_video_eligibility, { list: 'string' }
|
84
90
|
field :message, 'string'
|
85
91
|
field :message_tags, { list: 'string' }
|
86
92
|
field :multi_share_end_card, 'bool'
|
@@ -89,10 +95,12 @@ module FacebookAds
|
|
89
95
|
field :permalink_url, 'object'
|
90
96
|
field :picture, 'string'
|
91
97
|
field :place, 'Place'
|
98
|
+
field :poll, 'object'
|
92
99
|
field :privacy, 'Privacy'
|
93
100
|
field :promotable_id, 'string'
|
94
101
|
field :promotion_status, 'string'
|
95
102
|
field :properties, { list: 'string' }
|
103
|
+
field :publishing_stats, 'int'
|
96
104
|
field :scheduled_publish_time, 'double'
|
97
105
|
field :shares, 'object'
|
98
106
|
field :status_type, 'string'
|
@@ -102,10 +110,12 @@ module FacebookAds
|
|
102
110
|
field :target, 'Profile'
|
103
111
|
field :targeting, 'object'
|
104
112
|
field :timeline_visibility, 'string'
|
113
|
+
field :translations, 'hash'
|
105
114
|
field :updated_time, 'datetime'
|
106
115
|
field :via, 'object'
|
107
116
|
field :video_buying_eligibility, { list: 'string' }
|
108
117
|
field :width, 'int'
|
118
|
+
field :will_be_autocropped_when_deliver_to_instagram, 'bool'
|
109
119
|
|
110
120
|
has_edge :attachments do |edge|
|
111
121
|
edge.get
|
@@ -25,23 +25,32 @@ module FacebookAds
|
|
25
25
|
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
26
|
# pull request for this class.
|
27
27
|
|
28
|
-
class
|
29
|
-
HTTP_METHOD = [
|
30
|
-
"DELETE",
|
31
|
-
"GET",
|
32
|
-
"POST",
|
33
|
-
]
|
28
|
+
class PaymentSubscription < AdObject
|
34
29
|
|
35
|
-
|
36
|
-
field :
|
30
|
+
field :amount, 'string'
|
31
|
+
field :app_param_data, 'string'
|
32
|
+
field :application, 'Profile'
|
33
|
+
field :billing_period, 'string'
|
34
|
+
field :canceled_reason, 'string'
|
37
35
|
field :created_time, 'datetime'
|
38
|
-
field :
|
39
|
-
field :
|
40
|
-
field :
|
41
|
-
field :
|
42
|
-
field :
|
43
|
-
|
44
|
-
|
36
|
+
field :currency, 'string'
|
37
|
+
field :id, 'string'
|
38
|
+
field :last_payment, 'string'
|
39
|
+
field :next_bill_time, 'datetime'
|
40
|
+
field :next_period_amount, 'string'
|
41
|
+
field :next_period_currency, 'string'
|
42
|
+
field :next_period_product, 'string'
|
43
|
+
field :payment_status, 'string'
|
44
|
+
field :pending_cancel, 'bool'
|
45
|
+
field :period_start_time, 'datetime'
|
46
|
+
field :product, 'string'
|
47
|
+
field :status, 'string'
|
48
|
+
field :test, 'int'
|
49
|
+
field :trial_amount, 'string'
|
50
|
+
field :trial_currency, 'string'
|
51
|
+
field :trial_expiry_time, 'datetime'
|
52
|
+
field :updated_time, 'datetime'
|
53
|
+
field :user, 'Profile'
|
45
54
|
has_no_post
|
46
55
|
has_no_delete
|
47
56
|
|
@@ -125,6 +125,12 @@ module FacebookAds
|
|
125
125
|
end
|
126
126
|
end
|
127
127
|
|
128
|
+
has_edge :reactions do |edge|
|
129
|
+
edge.get 'Profile' do |api|
|
130
|
+
api.has_param :type, { enum: -> { Profile::TYPE }}
|
131
|
+
end
|
132
|
+
end
|
133
|
+
|
128
134
|
has_edge :sharedposts do |edge|
|
129
135
|
edge.get 'Post'
|
130
136
|
end
|
@@ -59,17 +59,22 @@ module FacebookAds
|
|
59
59
|
field :comments_mirroring_domain, 'string'
|
60
60
|
field :coordinates, 'object'
|
61
61
|
field :created_time, 'datetime'
|
62
|
+
field :delivery_growth_optimizations, { list: 'string' }
|
62
63
|
field :description, 'string'
|
64
|
+
field :entities, 'object'
|
63
65
|
field :event, 'Event'
|
64
66
|
field :expanded_height, 'int'
|
65
67
|
field :expanded_width, 'int'
|
66
68
|
field :feed_targeting, 'object'
|
69
|
+
field :formatting, 'string'
|
67
70
|
field :from, 'object'
|
68
71
|
field :full_picture, 'string'
|
69
72
|
field :height, 'int'
|
70
73
|
field :icon, 'string'
|
71
74
|
field :id, 'string'
|
75
|
+
field :implicit_place, 'Place'
|
72
76
|
field :instagram_eligibility, 'string'
|
77
|
+
field :instream_eligibility, 'string'
|
73
78
|
field :is_app_share, 'bool'
|
74
79
|
field :is_eligible_for_promotion, 'bool'
|
75
80
|
field :is_expired, 'bool'
|
@@ -80,6 +85,7 @@ module FacebookAds
|
|
80
85
|
field :is_published, 'bool'
|
81
86
|
field :is_spherical, 'bool'
|
82
87
|
field :link, 'string'
|
88
|
+
field :live_video_eligibility, { list: 'string' }
|
83
89
|
field :message, 'string'
|
84
90
|
field :message_tags, { list: 'string' }
|
85
91
|
field :multi_share_end_card, 'bool'
|
@@ -90,10 +96,12 @@ module FacebookAds
|
|
90
96
|
field :permalink_url, 'object'
|
91
97
|
field :picture, 'string'
|
92
98
|
field :place, 'Place'
|
99
|
+
field :poll, 'object'
|
93
100
|
field :privacy, 'Privacy'
|
94
101
|
field :promotable_id, 'string'
|
95
102
|
field :promotion_status, 'string'
|
96
103
|
field :properties, { list: 'string' }
|
104
|
+
field :publishing_stats, 'int'
|
97
105
|
field :scheduled_publish_time, 'double'
|
98
106
|
field :shares, 'object'
|
99
107
|
field :source, 'string'
|
@@ -104,11 +112,13 @@ module FacebookAds
|
|
104
112
|
field :target, 'Profile'
|
105
113
|
field :targeting, 'object'
|
106
114
|
field :timeline_visibility, 'string'
|
115
|
+
field :translations, 'hash'
|
107
116
|
field :type, 'string'
|
108
117
|
field :updated_time, 'datetime'
|
109
118
|
field :via, 'object'
|
110
119
|
field :video_buying_eligibility, { list: 'string' }
|
111
120
|
field :width, 'int'
|
121
|
+
field :will_be_autocropped_when_deliver_to_instagram, 'bool'
|
112
122
|
|
113
123
|
has_edge :attachments do |edge|
|
114
124
|
edge.get
|
@@ -166,11 +176,11 @@ module FacebookAds
|
|
166
176
|
edge.post do |api|
|
167
177
|
api.has_param :ad_account_id, 'string'
|
168
178
|
api.has_param :ad_conversion_pixel_id, 'int'
|
169
|
-
api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
|
179
|
+
api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MARKETPLACE_NATIONWIDE_AUDIENCE MARKETPLACE_SAVED_AUDIENCE MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
|
170
180
|
api.has_param :audience_id, 'string'
|
171
181
|
api.has_param :bid_amount, 'int'
|
172
182
|
api.has_param :budget, 'int'
|
173
|
-
api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE SUBSCRIBE UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
|
183
|
+
api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_PAGE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SEND_A_GIFT SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE SUBSCRIBE UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
|
174
184
|
api.has_param :currency, 'string'
|
175
185
|
api.has_param :flow_id, 'string'
|
176
186
|
api.has_param :placement, 'string'
|
@@ -27,6 +27,7 @@ module FacebookAds
|
|
27
27
|
|
28
28
|
class ProductCatalog < AdObject
|
29
29
|
VERTICAL = [
|
30
|
+
"adoptable_pets",
|
30
31
|
"bookable",
|
31
32
|
"commerce",
|
32
33
|
"destinations",
|
@@ -50,19 +51,51 @@ module FacebookAds
|
|
50
51
|
PERMITTED_TASKS = [
|
51
52
|
"ADVERTISE",
|
52
53
|
"MANAGE",
|
54
|
+
"MANAGE_AR",
|
53
55
|
]
|
54
56
|
|
55
57
|
TASKS = [
|
56
58
|
"ADVERTISE",
|
57
59
|
"MANAGE",
|
60
|
+
"MANAGE_AR",
|
58
61
|
]
|
59
62
|
|
60
63
|
STANDARD = [
|
61
64
|
"google",
|
62
65
|
]
|
63
66
|
|
67
|
+
ITEM_SUB_TYPE = [
|
68
|
+
"APPLIANCES",
|
69
|
+
"BABY_FEEDING",
|
70
|
+
"BABY_TRANSPORT",
|
71
|
+
"BEAUTY",
|
72
|
+
"BEDDING",
|
73
|
+
"CAMERAS",
|
74
|
+
"CELL_PHONES_AND_SMART_WATCHES",
|
75
|
+
"CLEANING_SUPPLIES",
|
76
|
+
"CLOTHING",
|
77
|
+
"CLOTHING_ACCESSORIES",
|
78
|
+
"COMPUTERS_AND_TABLETS",
|
79
|
+
"DIAPERING_AND_POTTY_TRAINING",
|
80
|
+
"ELECTRONICS_ACCESSORIES",
|
81
|
+
"FURNITURE",
|
82
|
+
"HEALTH",
|
83
|
+
"HOME_GOODS",
|
84
|
+
"JEWELRY",
|
85
|
+
"NURSERY",
|
86
|
+
"PRINTERS_AND_SCANNERS",
|
87
|
+
"PROJECTORS",
|
88
|
+
"SHOES_AND_FOOTWEAR",
|
89
|
+
"SOFTWARE",
|
90
|
+
"TOYS",
|
91
|
+
"TVS_AND_MONITORS",
|
92
|
+
"VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES",
|
93
|
+
"WATCHES",
|
94
|
+
]
|
95
|
+
|
64
96
|
|
65
97
|
field :business, 'Business'
|
98
|
+
field :commerce_merchant_settings, 'CommerceMerchantSettings'
|
66
99
|
field :da_display_settings, 'ProductCatalogImageSettings'
|
67
100
|
field :default_image_url, 'string'
|
68
101
|
field :fallback_image_url, { list: 'string' }
|
@@ -73,8 +106,12 @@ module FacebookAds
|
|
73
106
|
field :product_count, 'int'
|
74
107
|
field :store_catalog_settings, 'StoreCatalogSettings'
|
75
108
|
field :vertical, 'string'
|
109
|
+
field :catalog_segment_filter, 'object'
|
110
|
+
field :catalog_segment_product_set_id, 'string'
|
76
111
|
field :destination_catalog_settings, 'hash'
|
77
112
|
field :flight_catalog_settings, 'hash'
|
113
|
+
field :onsite_commerce_merchant, 'object'
|
114
|
+
field :parent_catalog_id, 'string'
|
78
115
|
|
79
116
|
has_edge :agencies do |edge|
|
80
117
|
edge.delete do |api|
|
@@ -85,6 +122,7 @@ module FacebookAds
|
|
85
122
|
api.has_param :business, 'string'
|
86
123
|
api.has_param :permitted_roles, { list: { enum: -> { ProductCatalog::PERMITTED_ROLES }} }
|
87
124
|
api.has_param :permitted_tasks, { list: { enum: -> { ProductCatalog::PERMITTED_TASKS }} }
|
125
|
+
api.has_param :utm_settings, 'hash'
|
88
126
|
end
|
89
127
|
end
|
90
128
|
|
@@ -230,11 +268,18 @@ module FacebookAds
|
|
230
268
|
has_edge :items_batch do |edge|
|
231
269
|
edge.post 'ProductCatalog' do |api|
|
232
270
|
api.has_param :allow_upsert, 'bool'
|
271
|
+
api.has_param :item_sub_type, { enum: -> { ProductCatalog::ITEM_SUB_TYPE }}
|
233
272
|
api.has_param :item_type, 'string'
|
234
273
|
api.has_param :requests, 'hash'
|
235
274
|
end
|
236
275
|
end
|
237
276
|
|
277
|
+
has_edge :onsite_commerce_merchant do |edge|
|
278
|
+
edge.post 'ProductCatalog' do |api|
|
279
|
+
api.has_param :onsite_commerce_merchant, 'object'
|
280
|
+
end
|
281
|
+
end
|
282
|
+
|
238
283
|
has_edge :pricing_variables_batch do |edge|
|
239
284
|
edge.get 'ProductCatalogPricingVariablesBatch' do |api|
|
240
285
|
api.has_param :handle, 'string'
|
@@ -259,6 +304,7 @@ module FacebookAds
|
|
259
304
|
api.has_param :encoding, { enum: -> { ProductFeed::ENCODING }}
|
260
305
|
api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
|
261
306
|
api.has_param :file_name, 'string'
|
307
|
+
api.has_param :item_sub_type, { enum: -> { ProductFeed::ITEM_SUB_TYPE }}
|
262
308
|
api.has_param :name, 'string'
|
263
309
|
api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
|
264
310
|
api.has_param :override_value, 'string'
|
@@ -287,7 +333,9 @@ module FacebookAds
|
|
287
333
|
end
|
288
334
|
edge.post 'ProductSet' do |api|
|
289
335
|
api.has_param :filter, 'object'
|
336
|
+
api.has_param :metadata, 'hash'
|
290
337
|
api.has_param :name, 'string'
|
338
|
+
api.has_param :retailer_id, 'string'
|
291
339
|
end
|
292
340
|
end
|
293
341
|
|
@@ -314,6 +362,7 @@ module FacebookAds
|
|
314
362
|
api.has_param :availability, { enum: -> { ProductItem::AVAILABILITY }}
|
315
363
|
api.has_param :brand, 'string'
|
316
364
|
api.has_param :category, 'string'
|
365
|
+
api.has_param :category_specific_fields, 'hash'
|
317
366
|
api.has_param :checkout_url, 'string'
|
318
367
|
api.has_param :color, 'string'
|
319
368
|
api.has_param :commerce_tax_category, { enum: -> { ProductItem::COMMERCE_TAX_CATEGORY }}
|
@@ -327,6 +376,7 @@ module FacebookAds
|
|
327
376
|
api.has_param :custom_label_4, 'string'
|
328
377
|
api.has_param :description, 'string'
|
329
378
|
api.has_param :expiration_date, 'string'
|
379
|
+
api.has_param :fb_product_category, 'string'
|
330
380
|
api.has_param :gender, { enum: -> { ProductItem::GENDER }}
|
331
381
|
api.has_param :gtin, 'string'
|
332
382
|
api.has_param :image_url, 'string'
|
@@ -63,10 +63,40 @@ module FacebookAds
|
|
63
63
|
"MEDIA_TITLE",
|
64
64
|
"OFFER",
|
65
65
|
"PRODUCTS",
|
66
|
+
"TRANSACTABLE_ITEMS",
|
66
67
|
"VEHICLES",
|
67
68
|
"VEHICLE_OFFER",
|
68
69
|
]
|
69
70
|
|
71
|
+
ITEM_SUB_TYPE = [
|
72
|
+
"APPLIANCES",
|
73
|
+
"BABY_FEEDING",
|
74
|
+
"BABY_TRANSPORT",
|
75
|
+
"BEAUTY",
|
76
|
+
"BEDDING",
|
77
|
+
"CAMERAS",
|
78
|
+
"CELL_PHONES_AND_SMART_WATCHES",
|
79
|
+
"CLEANING_SUPPLIES",
|
80
|
+
"CLOTHING",
|
81
|
+
"CLOTHING_ACCESSORIES",
|
82
|
+
"COMPUTERS_AND_TABLETS",
|
83
|
+
"DIAPERING_AND_POTTY_TRAINING",
|
84
|
+
"ELECTRONICS_ACCESSORIES",
|
85
|
+
"FURNITURE",
|
86
|
+
"HEALTH",
|
87
|
+
"HOME_GOODS",
|
88
|
+
"JEWELRY",
|
89
|
+
"NURSERY",
|
90
|
+
"PRINTERS_AND_SCANNERS",
|
91
|
+
"PROJECTORS",
|
92
|
+
"SHOES_AND_FOOTWEAR",
|
93
|
+
"SOFTWARE",
|
94
|
+
"TOYS",
|
95
|
+
"TVS_AND_MONITORS",
|
96
|
+
"VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES",
|
97
|
+
"WATCHES",
|
98
|
+
]
|
99
|
+
|
70
100
|
OVERRIDE_TYPE = [
|
71
101
|
"CATALOG_SEGMENT_CUSTOMIZE_DEFAULT",
|
72
102
|
"COUNTRY",
|
@@ -84,6 +114,7 @@ module FacebookAds
|
|
84
114
|
field :encoding, 'string'
|
85
115
|
field :file_name, 'string'
|
86
116
|
field :id, 'string'
|
117
|
+
field :item_sub_type, 'string'
|
87
118
|
field :latest_upload, 'ProductFeedUpload'
|
88
119
|
field :name, 'string'
|
89
120
|
field :override_type, 'string'
|
@@ -25,9 +25,9 @@ module FacebookAds
|
|
25
25
|
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
26
|
# pull request for this class.
|
27
27
|
|
28
|
-
class
|
28
|
+
class ProductFeedUploadDiagnosticsReport < AdObject
|
29
29
|
|
30
|
-
field :
|
30
|
+
field :last_updated_time, 'string'
|
31
31
|
field :report_url, 'string'
|
32
32
|
has_no_id
|
33
33
|
has_no_get
|
@@ -57,6 +57,7 @@ module FacebookAds
|
|
57
57
|
api.has_param :custom_label_4, 'string'
|
58
58
|
api.has_param :description, 'string'
|
59
59
|
api.has_param :expiration_date, 'string'
|
60
|
+
api.has_param :fb_product_category, 'string'
|
60
61
|
api.has_param :gender, { enum: -> { ProductItem::GENDER }}
|
61
62
|
api.has_param :gtin, 'string'
|
62
63
|
api.has_param :image_url, 'string'
|