facebookbusiness 0.3.2.12 → 0.3.2.13
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 +26 -26
- data/lib/facebook_ads/ad_objects/ad_account.rb +282 -281
- data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +13 -13
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +11 -9
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
- data/lib/facebook_ads/ad_objects/{legacy_business_ad_account_request.rb → ad_creative_optimization_spec.rb} +5 -4
- data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +5 -5
- data/lib/facebook_ads/ad_objects/ad_report_spec.rb +3 -3
- data/lib/facebook_ads/ad_objects/ad_rule.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_set.rb +25 -25
- data/lib/facebook_ads/ad_objects/ad_study.rb +13 -13
- data/lib/facebook_ads/ad_objects/ad_video.rb +64 -61
- data/lib/facebook_ads/ad_objects/ads_insights.rb +0 -3
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +5 -5
- data/lib/facebook_ads/ad_objects/album.rb +49 -49
- data/lib/facebook_ads/ad_objects/application.rb +99 -122
- data/lib/facebook_ads/ad_objects/business.rb +94 -93
- data/lib/facebook_ads/ad_objects/calibrator_existing_rule.rb +1 -1
- data/lib/facebook_ads/ad_objects/campaign.rb +21 -21
- data/lib/facebook_ads/ad_objects/comment.rb +5 -5
- data/lib/facebook_ads/ad_objects/custom_audience.rb +34 -34
- data/lib/facebook_ads/ad_objects/custom_conversion.rb +4 -4
- data/lib/facebook_ads/ad_objects/direct_deal.rb +1 -1
- data/lib/facebook_ads/ad_objects/event.rb +188 -188
- data/lib/facebook_ads/ad_objects/event_source_group.rb +1 -1
- data/lib/facebook_ads/ad_objects/extended_credit.rb +3 -3
- data/lib/facebook_ads/ad_objects/group.rb +217 -217
- data/lib/facebook_ads/ad_objects/hotel.rb +6 -6
- data/lib/facebook_ads/ad_objects/ig_comment.rb +1 -1
- data/lib/facebook_ads/ad_objects/ig_media.rb +1 -1
- data/lib/facebook_ads/ad_objects/ig_user.rb +6 -6
- data/lib/facebook_ads/ad_objects/instagram_user.rb +2 -2
- data/lib/facebook_ads/ad_objects/instant_article.rb +1 -1
- data/lib/facebook_ads/ad_objects/leadgen_form.rb +2 -2
- data/lib/facebook_ads/ad_objects/life_event.rb +7 -7
- data/lib/facebook_ads/ad_objects/link.rb +11 -11
- data/lib/facebook_ads/ad_objects/live_encoder.rb +20 -20
- data/lib/facebook_ads/ad_objects/live_video.rb +5 -5
- data/lib/facebook_ads/ad_objects/native_offer.rb +9 -9
- data/lib/facebook_ads/ad_objects/native_offer_view.rb +3 -3
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +16 -16
- data/lib/facebook_ads/ad_objects/open_graph_object.rb +47 -47
- data/lib/facebook_ads/ad_objects/owned_domain.rb +0 -1
- data/lib/facebook_ads/ad_objects/page.rb +405 -407
- data/lib/facebook_ads/ad_objects/page_post.rb +24 -23
- data/lib/facebook_ads/ad_objects/partner_integration_linked.rb +1 -0
- data/lib/facebook_ads/ad_objects/permission.rb +0 -1
- data/lib/facebook_ads/ad_objects/photo.rb +56 -56
- data/lib/facebook_ads/ad_objects/playable_content.rb +1 -1
- data/lib/facebook_ads/ad_objects/post.rb +61 -60
- data/lib/facebook_ads/ad_objects/product_catalog.rb +153 -133
- data/lib/facebook_ads/ad_objects/product_group.rb +32 -32
- data/lib/facebook_ads/ad_objects/product_item.rb +20 -20
- data/lib/facebook_ads/ad_objects/profile.rb +2 -2
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +9 -10
- data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +1 -1
- data/lib/facebook_ads/ad_objects/split_test_config.rb +0 -1
- data/lib/facebook_ads/ad_objects/status.rb +11 -11
- data/lib/facebook_ads/ad_objects/unified_thread.rb +5 -5
- data/lib/facebook_ads/ad_objects/user.rb +307 -305
- data/lib/facebook_ads/ad_objects/user_invitable_friend.rb +2 -2
- data/lib/facebook_ads/ad_objects/user_taggable_friend.rb +2 -2
- data/lib/facebook_ads/ad_objects/vehicle.rb +1 -0
- data/lib/facebook_ads/ad_objects/video_game_show.rb +2 -2
- data/lib/facebook_ads/ad_objects/video_list.rb +6 -6
- data/lib/facebook_ads/version.rb +1 -1
- metadata +3 -5
- data/lib/facebook_ads/ad_objects/ads_post.rb +0 -56
- data/lib/facebook_ads/ad_objects/favorite_request.rb +0 -69
@@ -222,9 +222,9 @@ module FacebookAds
|
|
222
222
|
field :subvertical, 'string'
|
223
223
|
field :time_created, 'datetime'
|
224
224
|
field :vertical, 'string'
|
225
|
+
field :advertiser_business_id, 'string'
|
225
226
|
field :business_registration, 'file'
|
226
227
|
field :promotable_page_urls, { list: 'string' }
|
227
|
-
field :advertiser_business_id, 'string'
|
228
228
|
|
229
229
|
has_edge :adaccounts do |edge|
|
230
230
|
edge.get 'AdAccount'
|
@@ -233,23 +233,23 @@ module FacebookAds
|
|
233
233
|
has_edge :vietnam do |edge|
|
234
234
|
edge.post 'AdAccountCreationRequest' do |api|
|
235
235
|
api.has_param :ad_accounts_info, { list: 'object' }
|
236
|
+
api.has_param :additional_comment, 'string'
|
237
|
+
api.has_param :address_in_english, 'object'
|
238
|
+
api.has_param :address_in_local_language, 'string'
|
239
|
+
api.has_param :advertiser_business_id, 'string'
|
236
240
|
api.has_param :business_registration, 'file'
|
237
|
-
api.has_param :
|
241
|
+
api.has_param :business_registration_id, 'string'
|
242
|
+
api.has_param :contact, 'object'
|
238
243
|
api.has_param :english_legal_entity_name, 'string'
|
239
|
-
api.has_param :
|
244
|
+
api.has_param :legal_entity_name_in_local_language, 'string'
|
240
245
|
api.has_param :official_website_url, 'string'
|
241
|
-
api.has_param :
|
242
|
-
api.has_param :vertical, { enum: -> { AdAccountCreationRequest::VERTICAL }}
|
243
|
-
api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
|
244
|
-
api.has_param :promotable_page_urls, { list: 'string' }
|
245
|
-
api.has_param :promotable_page_ids, { list: 'int' }
|
246
|
+
api.has_param :planning_agency_business_id, 'string'
|
246
247
|
api.has_param :promotable_app_ids, { list: 'string' }
|
248
|
+
api.has_param :promotable_page_ids, { list: 'int' }
|
249
|
+
api.has_param :promotable_page_urls, { list: 'string' }
|
247
250
|
api.has_param :promotable_urls, { list: 'string' }
|
248
|
-
api.has_param :
|
249
|
-
api.has_param :
|
250
|
-
api.has_param :advertiser_business_id, 'string'
|
251
|
-
api.has_param :address_in_local_language, 'string'
|
252
|
-
api.has_param :legal_entity_name_in_local_language, 'string'
|
251
|
+
api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
|
252
|
+
api.has_param :vertical, { enum: -> { AdAccountCreationRequest::VERTICAL }}
|
253
253
|
end
|
254
254
|
end
|
255
255
|
|
@@ -41,11 +41,13 @@ module FacebookAds
|
|
41
41
|
"BUY_TICKETS",
|
42
42
|
"CALL",
|
43
43
|
"CALL_ME",
|
44
|
+
"CONTACT",
|
44
45
|
"CONTACT_US",
|
45
46
|
"DONATE",
|
46
47
|
"DONATE_NOW",
|
47
48
|
"DOWNLOAD",
|
48
49
|
"EVENT_RSVP",
|
50
|
+
"FIND_A_GROUP",
|
49
51
|
"FOLLOW_NEWS_STORYLINE",
|
50
52
|
"GET_DIRECTIONS",
|
51
53
|
"GET_OFFER",
|
@@ -159,6 +161,7 @@ module FacebookAds
|
|
159
161
|
field :instagram_actor_id, 'string'
|
160
162
|
field :instagram_permalink_url, 'string'
|
161
163
|
field :instagram_story_id, 'string'
|
164
|
+
field :interactive_components_spec, 'AdCreativeInteractiveComponentsSpec'
|
162
165
|
field :link_deep_link_url, 'string'
|
163
166
|
field :link_og_id, 'string'
|
164
167
|
field :link_url, 'string'
|
@@ -184,10 +187,9 @@ module FacebookAds
|
|
184
187
|
field :url_tags, 'string'
|
185
188
|
field :use_page_actor_override, 'bool'
|
186
189
|
field :video_id, 'string'
|
187
|
-
field :is_dco_internal, 'bool'
|
188
190
|
field :call_to_action, 'object'
|
189
191
|
field :image_file, 'string'
|
190
|
-
field :
|
192
|
+
field :is_dco_internal, 'bool'
|
191
193
|
field :mockup_id, 'string'
|
192
194
|
field :page_id, 'string'
|
193
195
|
|
@@ -203,19 +205,19 @@ module FacebookAds
|
|
203
205
|
has_edge :previews do |edge|
|
204
206
|
edge.get 'AdPreview' do |api|
|
205
207
|
api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
|
208
|
+
api.has_param :dynamic_asset_label, 'string'
|
206
209
|
api.has_param :dynamic_creative_spec, 'object'
|
207
210
|
api.has_param :dynamic_customization, 'object'
|
208
|
-
api.has_param :
|
209
|
-
api.has_param :interactive, 'bool'
|
210
|
-
api.has_param :post, 'object'
|
211
|
+
api.has_param :end_date, 'datetime'
|
211
212
|
api.has_param :height, 'int'
|
212
|
-
api.has_param :
|
213
|
+
api.has_param :interactive, 'bool'
|
214
|
+
api.has_param :locale, 'string'
|
213
215
|
api.has_param :place_page_id, 'int'
|
216
|
+
api.has_param :post, 'object'
|
214
217
|
api.has_param :product_item_ids, { list: 'string' }
|
215
|
-
api.has_param :start_date, 'datetime'
|
216
|
-
api.has_param :end_date, 'datetime'
|
217
|
-
api.has_param :locale, 'string'
|
218
218
|
api.has_param :render_type, { enum: -> { AdPreview::RENDER_TYPE }}
|
219
|
+
api.has_param :start_date, 'datetime'
|
220
|
+
api.has_param :width, 'int'
|
219
221
|
end
|
220
222
|
end
|
221
223
|
|
@@ -25,11 +25,12 @@ 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 AdCreativeOptimizationSpec < AdObject
|
29
29
|
|
30
|
-
field :
|
31
|
-
field :
|
32
|
-
field :
|
30
|
+
field :bodies, { list: 'string' }
|
31
|
+
field :descriptions, { list: 'string' }
|
32
|
+
field :titles, { list: 'string' }
|
33
|
+
has_no_id
|
33
34
|
has_no_get
|
34
35
|
has_no_post
|
35
36
|
has_no_delete
|
@@ -46,9 +46,9 @@ module FacebookAds
|
|
46
46
|
edge.post 'AdMonetizationProperty' do |api|
|
47
47
|
api.has_param :aggregation_period, { enum: -> { AdNetworkAnalyticsSyncQueryResult::AGGREGATION_PERIOD }}
|
48
48
|
api.has_param :breakdowns, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::BREAKDOWNS }} }
|
49
|
-
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
50
49
|
api.has_param :filters, { list: 'object' }
|
51
50
|
api.has_param :limit, 'int'
|
51
|
+
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
52
52
|
api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
|
53
53
|
api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
|
54
54
|
api.has_param :since, 'datetime'
|
@@ -40,21 +40,21 @@ module FacebookAds
|
|
40
40
|
field :schedule_id, 'string'
|
41
41
|
field :time_completed, 'int'
|
42
42
|
field :time_ref, 'int'
|
43
|
-
field :default_summary, 'bool'
|
44
|
-
field :fields, { list: 'string' }
|
45
|
-
field :filtering, { list: 'object' }
|
46
|
-
field :summary, { list: 'string' }
|
47
|
-
field :sort, { list: 'string' }
|
48
43
|
field :action_attribution_windows, { list: 'adaccountinsights_action_attribution_windows_enum_param' }
|
49
44
|
field :action_breakdowns, { list: 'adaccountinsights_action_breakdowns_enum_param' }
|
50
45
|
field :action_report_time, 'adaccountinsights_action_report_time_enum_param'
|
51
46
|
field :breakdowns, { list: 'adaccountinsights_breakdowns_enum_param' }
|
52
47
|
field :date_preset, 'adaccountinsights_date_preset_enum_param'
|
48
|
+
field :default_summary, 'bool'
|
53
49
|
field :export_columns, { list: 'string' }
|
54
50
|
field :export_format, 'string'
|
55
51
|
field :export_name, 'string'
|
52
|
+
field :fields, { list: 'string' }
|
53
|
+
field :filtering, { list: 'object' }
|
56
54
|
field :level, 'adaccountinsights_level_enum_param'
|
57
55
|
field :product_id_limit, 'int'
|
56
|
+
field :sort, { list: 'string' }
|
57
|
+
field :summary, { list: 'string' }
|
58
58
|
field :summary_action_breakdowns, { list: 'adaccountinsights_summary_action_breakdowns_enum_param' }
|
59
59
|
field :time_increment, 'string'
|
60
60
|
field :time_range, 'object'
|
@@ -97,12 +97,12 @@ module FacebookAds
|
|
97
97
|
field :time_increment, 'string'
|
98
98
|
field :time_interval, 'object'
|
99
99
|
field :time_ranges, { list: 'object' }
|
100
|
+
field :business_id, 'string'
|
101
|
+
field :bypass_async, 'bool'
|
100
102
|
field :format, { enum: -> { FORMAT }}
|
103
|
+
field :limit, 'int'
|
101
104
|
field :report_run_id, 'string'
|
102
105
|
field :user_report, 'bool'
|
103
|
-
field :business_id, 'string'
|
104
|
-
field :limit, 'int'
|
105
|
-
field :bypass_async, 'bool'
|
106
106
|
|
107
107
|
end
|
108
108
|
end
|
@@ -50,9 +50,9 @@ module FacebookAds
|
|
50
50
|
|
51
51
|
has_edge :history do |edge|
|
52
52
|
edge.get 'AdRuleHistory' do |api|
|
53
|
-
api.has_param :object_id, 'string'
|
54
53
|
api.has_param :action, { enum: -> { AdRuleHistory::ACTION }}
|
55
54
|
api.has_param :hide_no_changes, 'bool'
|
55
|
+
api.has_param :object_id, 'string'
|
56
56
|
end
|
57
57
|
end
|
58
58
|
|
@@ -168,7 +168,7 @@ module FacebookAds
|
|
168
168
|
field :bid_strategy, { enum: -> { BID_STRATEGY }}
|
169
169
|
field :billing_event, { enum: -> { BILLING_EVENT }}
|
170
170
|
field :budget_remaining, 'string'
|
171
|
-
field :campaign, '
|
171
|
+
field :campaign, 'Campaign'
|
172
172
|
field :campaign_id, 'string'
|
173
173
|
field :configured_status, { enum: -> { CONFIGURED_STATUS }}
|
174
174
|
field :created_time, 'datetime'
|
@@ -197,7 +197,7 @@ module FacebookAds
|
|
197
197
|
field :recurring_budget_semantics, 'bool'
|
198
198
|
field :review_feedback, 'string'
|
199
199
|
field :rf_prediction_id, 'string'
|
200
|
-
field :source_adset, '
|
200
|
+
field :source_adset, 'AdSet'
|
201
201
|
field :source_adset_id, 'string'
|
202
202
|
field :start_time, 'datetime'
|
203
203
|
field :status, { enum: -> { STATUS }}
|
@@ -220,12 +220,12 @@ module FacebookAds
|
|
220
220
|
has_edge :activities do |edge|
|
221
221
|
edge.get 'AdActivity' do |api|
|
222
222
|
api.has_param :after, 'string'
|
223
|
+
api.has_param :business_id, 'string'
|
224
|
+
api.has_param :category, { enum: -> { AdActivity::CATEGORY }}
|
223
225
|
api.has_param :limit, 'int'
|
224
226
|
api.has_param :since, 'datetime'
|
225
|
-
api.has_param :category, { enum: -> { AdActivity::CATEGORY }}
|
226
|
-
api.has_param :until, 'datetime'
|
227
227
|
api.has_param :uid, 'int'
|
228
|
-
api.has_param :
|
228
|
+
api.has_param :until, 'datetime'
|
229
229
|
end
|
230
230
|
end
|
231
231
|
|
@@ -256,13 +256,13 @@ module FacebookAds
|
|
256
256
|
|
257
257
|
has_edge :ads do |edge|
|
258
258
|
edge.get 'Ad' do |api|
|
259
|
-
api.has_param :
|
260
|
-
api.has_param :effective_status, { list: 'string' }
|
259
|
+
api.has_param :ad_draft_id, 'string'
|
261
260
|
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
261
|
+
api.has_param :effective_status, { list: 'string' }
|
262
|
+
api.has_param :include_deleted, 'bool'
|
263
|
+
api.has_param :include_drafts, 'bool'
|
262
264
|
api.has_param :time_range, 'object'
|
263
265
|
api.has_param :updated_since, 'int'
|
264
|
-
api.has_param :ad_draft_id, 'string'
|
265
|
-
api.has_param :include_drafts, 'bool'
|
266
266
|
end
|
267
267
|
end
|
268
268
|
|
@@ -274,47 +274,47 @@ module FacebookAds
|
|
274
274
|
|
275
275
|
has_edge :copies do |edge|
|
276
276
|
edge.get 'AdSet' do |api|
|
277
|
-
api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
|
278
277
|
api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
|
278
|
+
api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
|
279
279
|
api.has_param :is_completed, 'bool'
|
280
280
|
api.has_param :time_range, 'object'
|
281
281
|
end
|
282
282
|
edge.post 'AdSet' do |api|
|
283
|
-
api.has_param :deep_copy, 'bool'
|
284
283
|
api.has_param :campaign_id, 'string'
|
284
|
+
api.has_param :create_dco_adset, 'bool'
|
285
|
+
api.has_param :deep_copy, 'bool'
|
286
|
+
api.has_param :end_time, 'datetime'
|
285
287
|
api.has_param :rename_options, 'object'
|
286
|
-
api.has_param :status_option, { enum: -> { AdSet::STATUS_OPTION }}
|
287
288
|
api.has_param :start_time, 'datetime'
|
288
|
-
api.has_param :
|
289
|
-
api.has_param :create_dco_adset, 'bool'
|
289
|
+
api.has_param :status_option, { enum: -> { AdSet::STATUS_OPTION }}
|
290
290
|
end
|
291
291
|
end
|
292
292
|
|
293
293
|
has_edge :delivery_estimate do |edge|
|
294
294
|
edge.get 'AdCampaignDeliveryEstimate' do |api|
|
295
|
-
api.has_param :targeting_spec, 'Targeting'
|
296
295
|
api.has_param :optimization_goal, { enum: -> { AdCampaignDeliveryEstimate::OPTIMIZATION_GOAL }}
|
297
296
|
api.has_param :promoted_object, 'object'
|
297
|
+
api.has_param :targeting_spec, 'Targeting'
|
298
298
|
end
|
299
299
|
end
|
300
300
|
|
301
301
|
has_edge :insights do |edge|
|
302
302
|
edge.get 'AdsInsights' do |api|
|
303
|
-
api.has_param :default_summary, 'bool'
|
304
|
-
api.has_param :fields, { list: 'string' }
|
305
|
-
api.has_param :filtering, { list: 'object' }
|
306
|
-
api.has_param :summary, { list: 'string' }
|
307
|
-
api.has_param :sort, { list: 'string' }
|
308
303
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
309
304
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
310
305
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
311
306
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
312
307
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
308
|
+
api.has_param :default_summary, 'bool'
|
313
309
|
api.has_param :export_columns, { list: 'string' }
|
314
310
|
api.has_param :export_format, 'string'
|
315
311
|
api.has_param :export_name, 'string'
|
312
|
+
api.has_param :fields, { list: 'string' }
|
313
|
+
api.has_param :filtering, { list: 'object' }
|
316
314
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
317
315
|
api.has_param :product_id_limit, 'int'
|
316
|
+
api.has_param :sort, { list: 'string' }
|
317
|
+
api.has_param :summary, { list: 'string' }
|
318
318
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
319
319
|
api.has_param :time_increment, 'string'
|
320
320
|
api.has_param :time_range, 'object'
|
@@ -322,21 +322,21 @@ module FacebookAds
|
|
322
322
|
api.has_param :use_account_attribution_setting, 'bool'
|
323
323
|
end
|
324
324
|
edge.post 'AdReportRun' do |api|
|
325
|
-
api.has_param :default_summary, 'bool'
|
326
|
-
api.has_param :fields, { list: 'string' }
|
327
|
-
api.has_param :filtering, { list: 'object' }
|
328
|
-
api.has_param :summary, { list: 'string' }
|
329
|
-
api.has_param :sort, { list: 'string' }
|
330
325
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
331
326
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
332
327
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
333
328
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
334
329
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
330
|
+
api.has_param :default_summary, 'bool'
|
335
331
|
api.has_param :export_columns, { list: 'string' }
|
336
332
|
api.has_param :export_format, 'string'
|
337
333
|
api.has_param :export_name, 'string'
|
334
|
+
api.has_param :fields, { list: 'string' }
|
335
|
+
api.has_param :filtering, { list: 'object' }
|
338
336
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
339
337
|
api.has_param :product_id_limit, 'int'
|
338
|
+
api.has_param :sort, { list: 'string' }
|
339
|
+
api.has_param :summary, { list: 'string' }
|
340
340
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
341
341
|
api.has_param :time_increment, 'string'
|
342
342
|
api.has_param :time_range, 'object'
|
@@ -59,10 +59,10 @@ module FacebookAds
|
|
59
59
|
field :updated_by, 'User'
|
60
60
|
field :updated_time, 'datetime'
|
61
61
|
field :cells, { list: 'object' }
|
62
|
+
field :client_business, 'string'
|
63
|
+
field :confidence_level, 'double'
|
62
64
|
field :objectives, { list: 'object' }
|
63
65
|
field :viewers, { list: 'int' }
|
64
|
-
field :confidence_level, 'double'
|
65
|
-
field :client_business, 'string'
|
66
66
|
|
67
67
|
has_edge :cells do |edge|
|
68
68
|
edge.get 'AdStudyCell'
|
@@ -70,11 +70,11 @@ module FacebookAds
|
|
70
70
|
|
71
71
|
has_edge :customaudiences do |edge|
|
72
72
|
edge.post 'AdStudy' do |api|
|
73
|
-
api.has_param :cell_id, 'string'
|
74
|
-
api.has_param :objective_id, 'string'
|
75
73
|
api.has_param :account_id, 'string'
|
76
74
|
api.has_param :audience_name, 'string'
|
77
75
|
api.has_param :audience_type, { enum: -> { AdStudy::AUDIENCE_TYPE }}
|
76
|
+
api.has_param :cell_id, 'string'
|
77
|
+
api.has_param :objective_id, 'string'
|
78
78
|
end
|
79
79
|
end
|
80
80
|
|
@@ -85,30 +85,30 @@ module FacebookAds
|
|
85
85
|
has_edge :objectives do |edge|
|
86
86
|
edge.get 'AdStudyObjective'
|
87
87
|
edge.post 'AdStudyObjective' do |api|
|
88
|
-
api.has_param :is_primary, 'bool'
|
89
|
-
api.has_param :name, 'string'
|
90
|
-
api.has_param :type, { enum: -> { AdStudyObjective::TYPE }}
|
91
88
|
api.has_param :adspixels, { list: 'object' }
|
92
|
-
api.has_param :customconversions, { list: 'object' }
|
93
89
|
api.has_param :applications, { list: 'object' }
|
94
|
-
api.has_param :
|
90
|
+
api.has_param :customconversions, { list: 'object' }
|
91
|
+
api.has_param :is_primary, 'bool'
|
92
|
+
api.has_param :name, 'string'
|
95
93
|
api.has_param :offline_conversion_data_sets, { list: 'object' }
|
94
|
+
api.has_param :offsitepixels, { list: 'object' }
|
96
95
|
api.has_param :product_sets, { list: 'object' }
|
96
|
+
api.has_param :type, { enum: -> { AdStudyObjective::TYPE }}
|
97
97
|
end
|
98
98
|
end
|
99
99
|
|
100
100
|
has_edge :userpermissions do |edge|
|
101
101
|
edge.delete do |api|
|
102
|
-
api.has_param :user, 'int'
|
103
|
-
api.has_param :email, 'string'
|
104
102
|
api.has_param :business, 'string'
|
103
|
+
api.has_param :email, 'string'
|
104
|
+
api.has_param :user, 'int'
|
105
105
|
end
|
106
106
|
edge.get 'AdStudyAdsAssetUserPermissions'
|
107
107
|
edge.post 'AdStudy' do |api|
|
108
|
-
api.has_param :
|
108
|
+
api.has_param :business, 'string'
|
109
109
|
api.has_param :email, 'string'
|
110
110
|
api.has_param :role, { enum: -> { AdStudy::ROLE }}
|
111
|
-
api.has_param :
|
111
|
+
api.has_param :user, 'int'
|
112
112
|
end
|
113
113
|
end
|
114
114
|
|
@@ -41,6 +41,7 @@ module FacebookAds
|
|
41
41
|
"BROADCAST",
|
42
42
|
"CANDIDATE_VIDEOS",
|
43
43
|
"CANVAS",
|
44
|
+
"CFC_VIDEO",
|
44
45
|
"CIVIC_PROPOSAL_COVER_VIDEO",
|
45
46
|
"CONTAINED_POST_ATTACHMENT",
|
46
47
|
"CONTAINED_POST_AUDIO_BROADCAST",
|
@@ -104,6 +105,7 @@ module FacebookAds
|
|
104
105
|
"PROTON",
|
105
106
|
"QUICK_PROMOTION",
|
106
107
|
"REPLACE_VIDEO",
|
108
|
+
"SALES_CLIENT_INTERACTION",
|
107
109
|
"SAY_THANKS_DEPRECATED",
|
108
110
|
"SLIDESHOW_ANIMOTO",
|
109
111
|
"SLIDESHOW_SHAKR",
|
@@ -111,6 +113,7 @@ module FacebookAds
|
|
111
113
|
"STORYLINE",
|
112
114
|
"STORYLINE_WITH_EXTERNAL_MUSIC",
|
113
115
|
"STORY_ARCHIVE_VIDEO",
|
116
|
+
"STORY_CARD_TEMPLATE",
|
114
117
|
"TAROT_DIGEST",
|
115
118
|
"TEMP_MULTIMEDIA_POST",
|
116
119
|
"UNLISTED",
|
@@ -223,73 +226,73 @@ module FacebookAds
|
|
223
226
|
field :tv_banner_ad, 'object'
|
224
227
|
field :universal_video_id, 'string'
|
225
228
|
field :updated_time, 'datetime'
|
226
|
-
field :unpublished_content_type, { enum: -> { UNPUBLISHED_CONTENT_TYPE }}
|
227
|
-
field :time_since_original_post, 'int'
|
228
|
-
field :file_url, 'string'
|
229
|
-
field :composer_session_id, 'string'
|
230
|
-
field :waterfall_id, 'string'
|
231
|
-
field :og_action_type_id, 'string'
|
232
|
-
field :og_object_id, 'string'
|
233
|
-
field :og_phrase, 'string'
|
234
|
-
field :og_icon_id, 'string'
|
235
|
-
field :og_suggestion_mechanism, 'string'
|
236
|
-
field :thumb, 'file'
|
237
|
-
field :original_projection_type, { enum: -> { ORIGINAL_PROJECTION_TYPE }}
|
238
|
-
field :initial_heading, 'int'
|
239
|
-
field :initial_pitch, 'int'
|
240
|
-
field :fov, 'int'
|
241
|
-
field :original_fov, 'int'
|
242
|
-
field :fisheye_video_cropped, 'bool'
|
243
|
-
field :front_z_rotation, 'double'
|
244
|
-
field :guide_enabled, 'bool'
|
245
|
-
field :guide, { list: { list: 'int' } }
|
246
|
-
field :audio_story_wave_animation_handle, 'string'
|
247
229
|
field :adaptive_type, 'string'
|
248
230
|
field :animated_effect_id, 'int'
|
231
|
+
field :application_id, 'string'
|
249
232
|
field :asked_fun_fact_prompt_id, 'int'
|
233
|
+
field :attribution_app_id, 'string'
|
234
|
+
field :audio_story_wave_animation_handle, 'string'
|
235
|
+
field :chunk_session_id, 'string'
|
250
236
|
field :composer_entry_picker, 'string'
|
251
237
|
field :composer_entry_point, 'string'
|
252
238
|
field :composer_entry_time, 'int'
|
253
239
|
field :composer_session_events_log, 'string'
|
240
|
+
field :composer_session_id, 'string'
|
254
241
|
field :composer_source_surface, 'string'
|
255
242
|
field :composer_type, 'string'
|
243
|
+
field :container_type, { enum: -> { CONTAINER_TYPE }}
|
244
|
+
field :end_offset, 'int'
|
245
|
+
field :fbuploader_video_file_chunk, 'string'
|
246
|
+
field :file_size, 'int'
|
247
|
+
field :file_url, 'string'
|
248
|
+
field :fisheye_video_cropped, 'bool'
|
256
249
|
field :formatting, { enum: -> { FORMATTING }}
|
250
|
+
field :fov, 'int'
|
251
|
+
field :front_z_rotation, 'double'
|
257
252
|
field :fun_fact_prompt_id, 'int'
|
258
253
|
field :fun_fact_toastee_id, 'int'
|
259
|
-
field :
|
254
|
+
field :guide, { list: { list: 'int' } }
|
255
|
+
field :guide_enabled, 'bool'
|
260
256
|
field :has_nickname, 'bool'
|
261
257
|
field :holiday_card, 'string'
|
258
|
+
field :initial_heading, 'int'
|
259
|
+
field :initial_pitch, 'int'
|
262
260
|
field :instant_game_entry_point_data, 'string'
|
263
261
|
field :is_boost_intended, 'bool'
|
262
|
+
field :is_group_linking_post, 'bool'
|
263
|
+
field :is_voice_clip, 'bool'
|
264
264
|
field :location_source_id, 'string'
|
265
|
+
field :name, 'string'
|
265
266
|
field :offer_like_post_id, 'int'
|
267
|
+
field :og_action_type_id, 'string'
|
268
|
+
field :og_icon_id, 'string'
|
269
|
+
field :og_object_id, 'string'
|
270
|
+
field :og_phrase, 'string'
|
271
|
+
field :og_suggestion_mechanism, 'string'
|
272
|
+
field :original_fov, 'int'
|
273
|
+
field :original_projection_type, { enum: -> { ORIGINAL_PROJECTION_TYPE }}
|
266
274
|
field :publish_event_id, 'int'
|
267
275
|
field :react_mode_metadata, 'string'
|
276
|
+
field :referenced_sticker_id, 'string'
|
277
|
+
field :replace_video_id, 'string'
|
268
278
|
field :sales_promo_id, 'int'
|
279
|
+
field :slideshow_spec, 'hash'
|
280
|
+
field :start_offset, 'int'
|
281
|
+
field :swap_mode, { enum: -> { SWAP_MODE }}
|
269
282
|
field :text_format_metadata, 'string'
|
270
283
|
field :throwback_camera_roll_media, 'string'
|
271
|
-
field :
|
272
|
-
field :
|
284
|
+
field :thumb, 'file'
|
285
|
+
field :time_since_original_post, 'int'
|
286
|
+
field :transcode_setting_properties, 'string'
|
287
|
+
field :unpublished_content_type, { enum: -> { UNPUBLISHED_CONTENT_TYPE }}
|
273
288
|
field :upload_phase, { enum: -> { UPLOAD_PHASE }}
|
274
|
-
field :file_size, 'int'
|
275
|
-
field :start_offset, 'int'
|
276
|
-
field :end_offset, 'int'
|
277
|
-
field :video_file_chunk, 'string'
|
278
|
-
field :fbuploader_video_file_chunk, 'string'
|
279
289
|
field :upload_session_id, 'string'
|
280
|
-
field :is_voice_clip, 'bool'
|
281
|
-
field :attribution_app_id, 'string'
|
282
|
-
field :slideshow_spec, 'hash'
|
283
290
|
field :upload_setting_properties, 'string'
|
284
|
-
field :
|
285
|
-
field :
|
286
|
-
field :
|
287
|
-
field :replace_video_id, 'string'
|
288
|
-
field :swap_mode, { enum: -> { SWAP_MODE }}
|
289
|
-
field :name, 'string'
|
290
|
-
field :chunk_session_id, 'string'
|
291
|
-
field :manual_privacy, 'bool'
|
291
|
+
field :video_file_chunk, 'string'
|
292
|
+
field :video_start_time_ms, 'int'
|
293
|
+
field :waterfall_id, 'string'
|
292
294
|
field :is_explicit_share, 'bool'
|
295
|
+
field :manual_privacy, 'bool'
|
293
296
|
|
294
297
|
has_edge :auto_generated_captions do |edge|
|
295
298
|
edge.get
|
@@ -297,15 +300,15 @@ module FacebookAds
|
|
297
300
|
|
298
301
|
has_edge :auto_trims do |edge|
|
299
302
|
edge.post 'AdVideo' do |api|
|
300
|
-
api.has_param :target_id, 'int'
|
301
303
|
api.has_param :auto_trim_type, 'string'
|
304
|
+
api.has_param :target_id, 'int'
|
302
305
|
end
|
303
306
|
end
|
304
307
|
|
305
308
|
has_edge :blocked_users do |edge|
|
306
309
|
edge.post 'AdVideo' do |api|
|
307
|
-
api.has_param :uid, 'object'
|
308
310
|
api.has_param :remove_block, 'bool'
|
311
|
+
api.has_param :uid, 'object'
|
309
312
|
end
|
310
313
|
end
|
311
314
|
|
@@ -315,8 +318,8 @@ module FacebookAds
|
|
315
318
|
end
|
316
319
|
edge.get
|
317
320
|
edge.post 'AdVideo' do |api|
|
318
|
-
api.has_param :default_locale, 'string'
|
319
321
|
api.has_param :captions_file, 'file'
|
322
|
+
api.has_param :default_locale, 'string'
|
320
323
|
api.has_param :locales_to_delete, { list: 'string' }
|
321
324
|
end
|
322
325
|
end
|
@@ -324,22 +327,22 @@ module FacebookAds
|
|
324
327
|
has_edge :comments do |edge|
|
325
328
|
edge.get 'Comment' do |api|
|
326
329
|
api.has_param :filter, { enum: -> { Comment::FILTER }}
|
327
|
-
api.has_param :order, { enum: -> { Comment::ORDER }}
|
328
330
|
api.has_param :live_filter, { enum: -> { Comment::LIVE_FILTER }}
|
331
|
+
api.has_param :order, { enum: -> { Comment::ORDER }}
|
329
332
|
api.has_param :since, 'datetime'
|
330
333
|
end
|
331
334
|
edge.post 'Comment' do |api|
|
332
|
-
api.has_param :object_id, 'string'
|
333
|
-
api.has_param :parent_comment_id, 'object'
|
334
|
-
api.has_param :nectar_module, 'string'
|
335
335
|
api.has_param :attachment_id, 'string'
|
336
|
-
api.has_param :attachment_url, 'string'
|
337
336
|
api.has_param :attachment_share_url, 'string'
|
338
|
-
api.has_param :
|
337
|
+
api.has_param :attachment_url, 'string'
|
338
|
+
api.has_param :comment_privacy_value, { enum: -> { Comment::COMMENT_PRIVACY_VALUE }}
|
339
339
|
api.has_param :facepile_mentioned_ids, { list: 'string' }
|
340
|
+
api.has_param :feedback_source, 'string'
|
340
341
|
api.has_param :is_offline, 'bool'
|
341
|
-
api.has_param :comment_privacy_value, { enum: -> { Comment::COMMENT_PRIVACY_VALUE }}
|
342
342
|
api.has_param :message, 'string'
|
343
|
+
api.has_param :nectar_module, 'string'
|
344
|
+
api.has_param :object_id, 'string'
|
345
|
+
api.has_param :parent_comment_id, 'object'
|
343
346
|
api.has_param :text, 'string'
|
344
347
|
api.has_param :tracking, 'string'
|
345
348
|
end
|
@@ -351,30 +354,30 @@ module FacebookAds
|
|
351
354
|
|
352
355
|
has_edge :likes do |edge|
|
353
356
|
edge.delete do |api|
|
354
|
-
api.has_param :
|
357
|
+
api.has_param :feedback_source, 'string'
|
355
358
|
api.has_param :nectar_module, 'string'
|
356
359
|
api.has_param :notify, 'bool'
|
357
|
-
api.has_param :
|
360
|
+
api.has_param :tracking, 'string'
|
358
361
|
end
|
359
362
|
edge.get 'Profile'
|
360
363
|
edge.post 'AdVideo' do |api|
|
361
|
-
api.has_param :
|
364
|
+
api.has_param :feedback_source, 'string'
|
362
365
|
api.has_param :nectar_module, 'string'
|
363
366
|
api.has_param :notify, 'bool'
|
364
|
-
api.has_param :
|
367
|
+
api.has_param :tracking, 'string'
|
365
368
|
end
|
366
369
|
end
|
367
370
|
|
368
371
|
has_edge :polls do |edge|
|
369
372
|
edge.get 'VideoPoll'
|
370
373
|
edge.post 'VideoPoll' do |api|
|
371
|
-
api.has_param :
|
372
|
-
api.has_param :options, { list: 'string' }
|
374
|
+
api.has_param :close_after_voting, 'bool'
|
373
375
|
api.has_param :correct_option, 'int'
|
374
376
|
api.has_param :default_open, 'bool'
|
375
|
-
api.has_param :
|
377
|
+
api.has_param :options, { list: 'string' }
|
378
|
+
api.has_param :question, 'string'
|
376
379
|
api.has_param :show_gradient, 'bool'
|
377
|
-
api.has_param :
|
380
|
+
api.has_param :show_results, 'bool'
|
378
381
|
end
|
379
382
|
end
|
380
383
|
|
@@ -394,25 +397,25 @@ module FacebookAds
|
|
394
397
|
|
395
398
|
has_edge :summarizations do |edge|
|
396
399
|
edge.post 'AdVideo' do |api|
|
397
|
-
api.has_param :target_id, 'int'
|
398
400
|
api.has_param :summarization_type, 'string'
|
401
|
+
api.has_param :target_id, 'int'
|
399
402
|
end
|
400
403
|
end
|
401
404
|
|
402
405
|
has_edge :tags do |edge|
|
403
406
|
edge.get 'TaggableSubject'
|
404
407
|
edge.post 'AdVideo' do |api|
|
408
|
+
api.has_param :tag_uid, 'int'
|
405
409
|
api.has_param :uid, 'int'
|
406
410
|
api.has_param :vid, 'string'
|
407
|
-
api.has_param :tag_uid, 'int'
|
408
411
|
end
|
409
412
|
end
|
410
413
|
|
411
414
|
has_edge :thumbnails do |edge|
|
412
415
|
edge.get 'VideoThumbnail'
|
413
416
|
edge.post 'AdVideo' do |api|
|
414
|
-
api.has_param :source, 'file'
|
415
417
|
api.has_param :is_preferred, 'bool'
|
418
|
+
api.has_param :source, 'file'
|
416
419
|
end
|
417
420
|
end
|
418
421
|
|