facebookbusiness 0.3.2.12 → 0.3.2.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad.rb +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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2e2040138f3feb05c6d419e5244b10512ece382334ee3302a3cd6fd47026ce7c
|
4
|
+
data.tar.gz: 12e662ed2efb70b85de7b66c4f7f2ef66dfd6ed073fd568d21c5a2f3322f4b05
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c3a765f3ece1cc0390ff3972c03c8ca25f63c532ab20584ac1eb915d8537ca2a8e8a722036cc1dd75f36d757257b301be0f0f6103901d071915aee74c14eed41
|
7
|
+
data.tar.gz: 7b1010e2ba79f26393a715829de69bc4664687240efb21a269d5525139ecfe2b55b0ee75e7adca146f0df523878788da8ac05c7146ab1796c6412434b33926fd
|
@@ -105,12 +105,12 @@ module FacebookAds
|
|
105
105
|
field :account_id, 'string'
|
106
106
|
field :ad_review_feedback, 'AdgroupReviewFeedback'
|
107
107
|
field :adlabels, { list: 'AdLabel' }
|
108
|
-
field :adset, '
|
108
|
+
field :adset, 'AdSet'
|
109
109
|
field :adset_id, 'string'
|
110
110
|
field :bid_amount, 'int'
|
111
111
|
field :bid_info, 'map<string, unsigned int>'
|
112
112
|
field :bid_type, { enum: -> { BID_TYPE }}
|
113
|
-
field :campaign, '
|
113
|
+
field :campaign, 'Campaign'
|
114
114
|
field :campaign_id, 'string'
|
115
115
|
field :configured_status, { enum: -> { CONFIGURED_STATUS }}
|
116
116
|
field :conversion_specs, { list: 'ConversionActionQuery' }
|
@@ -127,19 +127,19 @@ module FacebookAds
|
|
127
127
|
field :name, 'string'
|
128
128
|
field :priority, 'int'
|
129
129
|
field :recommendations, { list: 'AdRecommendation' }
|
130
|
-
field :source_ad, '
|
130
|
+
field :source_ad, 'Ad'
|
131
131
|
field :source_ad_id, 'string'
|
132
132
|
field :status, { enum: -> { STATUS }}
|
133
133
|
field :targeting, 'Targeting'
|
134
134
|
field :tracking_and_conversion_with_defaults, 'TrackingAndConversionWithDefaults'
|
135
135
|
field :tracking_specs, { list: 'ConversionActionQuery' }
|
136
136
|
field :updated_time, 'datetime'
|
137
|
+
field :adset_spec, 'AdSet'
|
137
138
|
field :audience_id, 'string'
|
138
139
|
field :date_format, 'string'
|
139
|
-
field :include_demolink_hashes, 'bool'
|
140
|
-
field :adset_spec, 'AdSet'
|
141
140
|
field :draft_adgroup_id, 'string'
|
142
141
|
field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
|
142
|
+
field :include_demolink_hashes, 'bool'
|
143
143
|
|
144
144
|
has_edge :adcreatives do |edge|
|
145
145
|
edge.get 'AdCreative'
|
@@ -164,9 +164,9 @@ module FacebookAds
|
|
164
164
|
|
165
165
|
has_edge :copies do |edge|
|
166
166
|
edge.get 'Ad' do |api|
|
167
|
-
api.has_param :include_deleted, 'bool'
|
168
|
-
api.has_param :effective_status, { list: 'string' }
|
169
167
|
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
168
|
+
api.has_param :effective_status, { list: 'string' }
|
169
|
+
api.has_param :include_deleted, 'bool'
|
170
170
|
api.has_param :time_range, 'object'
|
171
171
|
api.has_param :updated_since, 'int'
|
172
172
|
end
|
@@ -179,21 +179,21 @@ module FacebookAds
|
|
179
179
|
|
180
180
|
has_edge :insights do |edge|
|
181
181
|
edge.get 'AdsInsights' do |api|
|
182
|
-
api.has_param :default_summary, 'bool'
|
183
|
-
api.has_param :fields, { list: 'string' }
|
184
|
-
api.has_param :filtering, { list: 'object' }
|
185
|
-
api.has_param :summary, { list: 'string' }
|
186
|
-
api.has_param :sort, { list: 'string' }
|
187
182
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
188
183
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
189
184
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
190
185
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
191
186
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
187
|
+
api.has_param :default_summary, 'bool'
|
192
188
|
api.has_param :export_columns, { list: 'string' }
|
193
189
|
api.has_param :export_format, 'string'
|
194
190
|
api.has_param :export_name, 'string'
|
191
|
+
api.has_param :fields, { list: 'string' }
|
192
|
+
api.has_param :filtering, { list: 'object' }
|
195
193
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
196
194
|
api.has_param :product_id_limit, 'int'
|
195
|
+
api.has_param :sort, { list: 'string' }
|
196
|
+
api.has_param :summary, { list: 'string' }
|
197
197
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
198
198
|
api.has_param :time_increment, 'string'
|
199
199
|
api.has_param :time_range, 'object'
|
@@ -201,21 +201,21 @@ module FacebookAds
|
|
201
201
|
api.has_param :use_account_attribution_setting, 'bool'
|
202
202
|
end
|
203
203
|
edge.post 'AdReportRun' do |api|
|
204
|
-
api.has_param :default_summary, 'bool'
|
205
|
-
api.has_param :fields, { list: 'string' }
|
206
|
-
api.has_param :filtering, { list: 'object' }
|
207
|
-
api.has_param :summary, { list: 'string' }
|
208
|
-
api.has_param :sort, { list: 'string' }
|
209
204
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
210
205
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
211
206
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
212
207
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
213
208
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
209
|
+
api.has_param :default_summary, 'bool'
|
214
210
|
api.has_param :export_columns, { list: 'string' }
|
215
211
|
api.has_param :export_format, 'string'
|
216
212
|
api.has_param :export_name, 'string'
|
213
|
+
api.has_param :fields, { list: 'string' }
|
214
|
+
api.has_param :filtering, { list: 'object' }
|
217
215
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
218
216
|
api.has_param :product_id_limit, 'int'
|
217
|
+
api.has_param :sort, { list: 'string' }
|
218
|
+
api.has_param :summary, { list: 'string' }
|
219
219
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
220
220
|
api.has_param :time_increment, 'string'
|
221
221
|
api.has_param :time_range, 'object'
|
@@ -233,28 +233,28 @@ module FacebookAds
|
|
233
233
|
has_edge :leads do |edge|
|
234
234
|
edge.get 'Lead'
|
235
235
|
edge.post 'Lead' do |api|
|
236
|
-
api.has_param :start_time, 'datetime'
|
237
236
|
api.has_param :end_time, 'datetime'
|
238
237
|
api.has_param :session_id, 'string'
|
238
|
+
api.has_param :start_time, 'datetime'
|
239
239
|
end
|
240
240
|
end
|
241
241
|
|
242
242
|
has_edge :previews do |edge|
|
243
243
|
edge.get 'AdPreview' do |api|
|
244
244
|
api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
|
245
|
+
api.has_param :dynamic_asset_label, 'string'
|
245
246
|
api.has_param :dynamic_creative_spec, 'object'
|
246
247
|
api.has_param :dynamic_customization, 'object'
|
247
|
-
api.has_param :
|
248
|
-
api.has_param :interactive, 'bool'
|
249
|
-
api.has_param :post, 'object'
|
248
|
+
api.has_param :end_date, 'datetime'
|
250
249
|
api.has_param :height, 'int'
|
251
|
-
api.has_param :
|
250
|
+
api.has_param :interactive, 'bool'
|
251
|
+
api.has_param :locale, 'string'
|
252
252
|
api.has_param :place_page_id, 'int'
|
253
|
+
api.has_param :post, 'object'
|
253
254
|
api.has_param :product_item_ids, { list: 'string' }
|
254
|
-
api.has_param :start_date, 'datetime'
|
255
|
-
api.has_param :end_date, 'datetime'
|
256
|
-
api.has_param :locale, 'string'
|
257
255
|
api.has_param :render_type, { enum: -> { AdPreview::RENDER_TYPE }}
|
256
|
+
api.has_param :start_date, 'datetime'
|
257
|
+
api.has_param :width, 'int'
|
258
258
|
end
|
259
259
|
end
|
260
260
|
|
@@ -265,8 +265,8 @@ module FacebookAds
|
|
265
265
|
has_edge :trackingtag do |edge|
|
266
266
|
edge.delete
|
267
267
|
edge.post do |api|
|
268
|
-
api.has_param :url, 'string'
|
269
268
|
api.has_param :add_template_param, 'bool'
|
269
|
+
api.has_param :url, 'string'
|
270
270
|
end
|
271
271
|
end
|
272
272
|
|
@@ -161,7 +161,6 @@ module FacebookAds
|
|
161
161
|
field :disable_reason, 'int'
|
162
162
|
field :end_advertiser, 'string'
|
163
163
|
field :end_advertiser_name, 'string'
|
164
|
-
field :extended_credit_invoice_group, 'ExtendedCreditInvoiceGroup'
|
165
164
|
field :failed_delivery_checks, { list: 'DeliveryCheck' }
|
166
165
|
field :fb_entity, 'int'
|
167
166
|
field :funding_source, 'string'
|
@@ -202,24 +201,24 @@ module FacebookAds
|
|
202
201
|
|
203
202
|
has_edge :activities do |edge|
|
204
203
|
edge.get 'AdActivity' do |api|
|
204
|
+
api.has_param :add_children, 'bool'
|
205
205
|
api.has_param :after, 'string'
|
206
|
+
api.has_param :business_id, 'string'
|
207
|
+
api.has_param :category, { enum: -> { AdActivity::CATEGORY }}
|
208
|
+
api.has_param :extra_oids, { list: 'string' }
|
206
209
|
api.has_param :limit, 'int'
|
210
|
+
api.has_param :oid, 'string'
|
207
211
|
api.has_param :since, 'datetime'
|
208
|
-
api.has_param :category, { enum: -> { AdActivity::CATEGORY }}
|
209
|
-
api.has_param :until, 'datetime'
|
210
212
|
api.has_param :uid, 'int'
|
211
|
-
api.has_param :
|
212
|
-
api.has_param :oid, 'string'
|
213
|
-
api.has_param :extra_oids, { list: 'string' }
|
214
|
-
api.has_param :add_children, 'bool'
|
213
|
+
api.has_param :until, 'datetime'
|
215
214
|
end
|
216
215
|
end
|
217
216
|
|
218
217
|
has_edge :ad_place_page_sets do |edge|
|
219
218
|
edge.get 'AdPlacePageSet'
|
220
219
|
edge.post 'AdPlacePageSet' do |api|
|
221
|
-
api.has_param :name, 'string'
|
222
220
|
api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
|
221
|
+
api.has_param :name, 'string'
|
223
222
|
api.has_param :parent_page, 'string'
|
224
223
|
api.has_param :targeted_area_type, { enum: -> { AdPlacePageSet::TARGETED_AREA_TYPE }}
|
225
224
|
end
|
@@ -241,15 +240,14 @@ module FacebookAds
|
|
241
240
|
api.has_param :applink_treatment, { enum: -> { AdCreative::APPLINK_TREATMENT }}
|
242
241
|
api.has_param :asset_feed_spec, 'object'
|
243
242
|
api.has_param :authorization_category, { enum: -> { AdCreative::AUTHORIZATION_CATEGORY }}
|
244
|
-
api.has_param :is_dco_internal, 'bool'
|
245
243
|
api.has_param :body, 'string'
|
246
244
|
api.has_param :branded_content_sponsor_page_id, 'string'
|
247
245
|
api.has_param :bundle_folder_id, 'string'
|
246
|
+
api.has_param :call_to_action, 'object'
|
248
247
|
api.has_param :categorization_criteria, { enum: -> { AdCreative::CATEGORIZATION_CRITERIA }}
|
249
248
|
api.has_param :category_media_source, { enum: -> { AdCreative::CATEGORY_MEDIA_SOURCE }}
|
250
|
-
api.has_param :call_to_action, 'object'
|
251
|
-
api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
|
252
249
|
api.has_param :destination_set_id, 'string'
|
250
|
+
api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
|
253
251
|
api.has_param :enable_direct_install, 'bool'
|
254
252
|
api.has_param :enable_launch_instant_app, 'bool'
|
255
253
|
api.has_param :image_crops, 'hash'
|
@@ -258,27 +256,28 @@ module FacebookAds
|
|
258
256
|
api.has_param :image_url, 'string'
|
259
257
|
api.has_param :instagram_actor_id, 'string'
|
260
258
|
api.has_param :instagram_permalink_url, 'string'
|
261
|
-
api.has_param :portrait_customizations, 'hash'
|
262
259
|
api.has_param :interactive_components_spec, 'hash'
|
260
|
+
api.has_param :is_dco_internal, 'bool'
|
263
261
|
api.has_param :link_og_id, 'string'
|
264
262
|
api.has_param :link_url, 'string'
|
263
|
+
api.has_param :messenger_sponsored_message, 'string'
|
265
264
|
api.has_param :name, 'string'
|
266
265
|
api.has_param :object_id, 'int'
|
267
266
|
api.has_param :object_story_id, 'string'
|
267
|
+
api.has_param :object_story_spec, 'AdCreativeObjectStorySpec'
|
268
268
|
api.has_param :object_type, 'string'
|
269
269
|
api.has_param :object_url, 'string'
|
270
270
|
api.has_param :platform_customizations, 'object'
|
271
271
|
api.has_param :playable_asset_id, 'string'
|
272
|
+
api.has_param :portrait_customizations, 'hash'
|
272
273
|
api.has_param :product_set_id, 'string'
|
273
274
|
api.has_param :recommender_settings, 'hash'
|
274
|
-
api.has_param :messenger_sponsored_message, 'string'
|
275
275
|
api.has_param :template_url, 'string'
|
276
276
|
api.has_param :template_url_spec, 'object'
|
277
277
|
api.has_param :thumbnail_url, 'string'
|
278
278
|
api.has_param :title, 'string'
|
279
279
|
api.has_param :url_tags, 'string'
|
280
280
|
api.has_param :use_page_actor_override, 'bool'
|
281
|
-
api.has_param :object_story_spec, 'AdCreativeObjectStorySpec'
|
282
281
|
end
|
283
282
|
end
|
284
283
|
|
@@ -301,12 +300,12 @@ module FacebookAds
|
|
301
300
|
api.has_param :hash, 'string'
|
302
301
|
end
|
303
302
|
edge.get 'AdImage' do |api|
|
303
|
+
api.has_param :biz_tag_id, 'int'
|
304
|
+
api.has_param :business_id, 'string'
|
304
305
|
api.has_param :hashes, { list: 'string' }
|
305
|
-
api.has_param :minwidth, 'int'
|
306
306
|
api.has_param :minheight, 'int'
|
307
|
+
api.has_param :minwidth, 'int'
|
307
308
|
api.has_param :name, 'string'
|
308
|
-
api.has_param :biz_tag_id, 'int'
|
309
|
-
api.has_param :business_id, 'string'
|
310
309
|
end
|
311
310
|
edge.post list: 'AdImage' do |api|
|
312
311
|
api.has_param :bytes, 'object'
|
@@ -325,11 +324,11 @@ module FacebookAds
|
|
325
324
|
has_edge :adplayables do |edge|
|
326
325
|
edge.get 'PlayableContent'
|
327
326
|
edge.post 'PlayableContent' do |api|
|
327
|
+
api.has_param :app_id, 'string'
|
328
328
|
api.has_param :name, 'string'
|
329
329
|
api.has_param :source, 'file'
|
330
330
|
api.has_param :source_url, 'string'
|
331
331
|
api.has_param :source_zip, 'file'
|
332
|
-
api.has_param :app_id, 'string'
|
333
332
|
end
|
334
333
|
end
|
335
334
|
|
@@ -341,68 +340,68 @@ module FacebookAds
|
|
341
340
|
has_edge :adreportschedules do |edge|
|
342
341
|
edge.get
|
343
342
|
edge.post do |api|
|
344
|
-
api.has_param :
|
345
|
-
api.has_param :user_columns, { list: 'string' }
|
346
|
-
api.has_param :user_attribution_windows, { list: 'string' }
|
347
|
-
api.has_param :builtin_column_set, { enum: %w{ APP_ENGAGEMENT AUDIENCE_DIRECT BIDDING_AND_OPTIMIZATION CAROUSEL_ENGAGEMENT CROSS_DEVICE DELIVERY ENGAGEMENT HOUSEHOLD MESSAGING_ENGAGEMENT MESSENGER OFFLINE_CONVERSIONS PERFORMANCE PERFORMANCE_LEGACY TARGETING_AND_CREATIVE VALIDATION_VIEW VIDEO_ENGAGEMENT }}
|
348
|
-
api.has_param :normalized_filter, { list: 'object' }
|
349
|
-
api.has_param :user_filter, { list: 'object' }
|
350
|
-
api.has_param :sort, { list: 'object' }
|
343
|
+
api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_converted_product_id action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type interactive_component_sticker_id interactive_component_sticker_response }} }
|
351
344
|
api.has_param :breakdowns, { list: 'string' }
|
352
|
-
api.has_param :
|
353
|
-
api.has_param :level, { enum: %w{account ad adgroup campaign campaign_group politicalad }}
|
354
|
-
api.has_param :date_preset, { enum: %w{last_14d last_28d last_30d last_3d last_7d last_90d last_month last_quarter last_week_mon_sun last_week_sun_sat last_year lifetime this_month this_quarter this_week_mon_today this_week_sun_today this_year today yesterday }}
|
355
|
-
api.has_param :date_interval, 'object'
|
356
|
-
api.has_param :format_version, 'int'
|
345
|
+
api.has_param :builtin_column_set, { enum: %w{ APP_ENGAGEMENT AUDIENCE_DIRECT BIDDING_AND_OPTIMIZATION CAROUSEL_ENGAGEMENT CROSS_DEVICE DELIVERY ENGAGEMENT HOUSEHOLD MESSAGING_ENGAGEMENT MESSENGER OFFLINE_CONVERSIONS PERFORMANCE PERFORMANCE_LEGACY TARGETING_AND_CREATIVE VALIDATION_VIEW VIDEO_ENGAGEMENT }}
|
357
346
|
api.has_param :creation_source, { enum: %w{adsExcelAddin adsManagerReporting newAdsManager }}
|
358
|
-
api.has_param :actions_group_by, { list: { enum: %w{action_canvas_component_id action_canvas_component_name action_carousel_card_id action_carousel_card_name action_converted_product_id action_destination action_device action_event_channel action_target_id action_type action_video_sound action_video_type interactive_component_sticker_id interactive_component_sticker_response }} }
|
359
347
|
api.has_param :custom_column_set_id, 'string'
|
360
348
|
api.has_param :data_columns, { list: 'string' }
|
349
|
+
api.has_param :date_interval, 'object'
|
350
|
+
api.has_param :date_preset, { enum: %w{last_14d last_28d last_30d last_3d last_7d last_90d last_month last_quarter last_week_mon_sun last_week_sun_sat last_year lifetime this_month this_quarter this_week_mon_today this_week_sun_today this_year today yesterday }}
|
361
351
|
api.has_param :emails, { list: 'string' }
|
362
352
|
api.has_param :export_columns, 'object'
|
363
353
|
api.has_param :filters, { list: 'object' }
|
354
|
+
api.has_param :format_version, 'int'
|
355
|
+
api.has_param :insights_section, 'object'
|
356
|
+
api.has_param :level, { enum: %w{account ad adgroup campaign campaign_group politicalad }}
|
357
|
+
api.has_param :name, 'string'
|
358
|
+
api.has_param :normalized_filter, { list: 'object' }
|
364
359
|
api.has_param :schedule_frequency, { enum: %w{daily monthly weekly }}
|
360
|
+
api.has_param :sort, { list: 'object' }
|
365
361
|
api.has_param :sort_by, 'string'
|
366
362
|
api.has_param :sort_dir, 'string'
|
367
363
|
api.has_param :start_date, 'object'
|
368
364
|
api.has_param :status, { enum: %w{Active Deleted Paused }}
|
369
365
|
api.has_param :subscribers, { list: 'int' }
|
370
366
|
api.has_param :time_increment, 'string'
|
367
|
+
api.has_param :user_attribution_windows, { list: 'string' }
|
368
|
+
api.has_param :user_columns, { list: 'string' }
|
369
|
+
api.has_param :user_filter, { list: 'object' }
|
371
370
|
end
|
372
371
|
end
|
373
372
|
|
374
373
|
has_edge :adreportspecs do |edge|
|
375
374
|
edge.post 'AdReportSpec' do |api|
|
376
|
-
api.has_param :time_ranges, { list: 'string' }
|
377
|
-
api.has_param :data_columns, { list: 'string' }
|
378
375
|
api.has_param :actions_group_by, { list: { enum: -> { AdReportSpec::ACTIONS_GROUP_BY }} }
|
376
|
+
api.has_param :business_id, 'string'
|
377
|
+
api.has_param :bypass_async, 'bool'
|
378
|
+
api.has_param :creation_source, { enum: -> { AdReportSpec::CREATION_SOURCE }}
|
379
|
+
api.has_param :data_columns, { list: 'string' }
|
380
|
+
api.has_param :date_preset, { enum: -> { AdReportSpec::DATE_PRESET }}
|
381
|
+
api.has_param :export_columns, 'object'
|
379
382
|
api.has_param :filters, { list: 'object' }
|
383
|
+
api.has_param :format, { enum: -> { AdReportSpec::FORMAT }}
|
384
|
+
api.has_param :format_version, 'int'
|
385
|
+
api.has_param :insights_section, 'object'
|
386
|
+
api.has_param :limit, 'int'
|
387
|
+
api.has_param :name, 'string'
|
388
|
+
api.has_param :report_run_id, 'string'
|
389
|
+
api.has_param :report_schedule_id, 'string'
|
380
390
|
api.has_param :sort_by, 'string'
|
381
391
|
api.has_param :sort_dir, 'string'
|
382
392
|
api.has_param :time_increment, 'string'
|
383
393
|
api.has_param :time_interval, 'object'
|
384
|
-
api.has_param :
|
385
|
-
api.has_param :format, { enum: -> { AdReportSpec::FORMAT }}
|
386
|
-
api.has_param :export_columns, 'object'
|
387
|
-
api.has_param :report_run_id, 'string'
|
388
|
-
api.has_param :name, 'string'
|
394
|
+
api.has_param :time_ranges, { list: 'string' }
|
389
395
|
api.has_param :user_report, 'bool'
|
390
|
-
api.has_param :business_id, 'string'
|
391
|
-
api.has_param :limit, 'int'
|
392
|
-
api.has_param :bypass_async, 'bool'
|
393
|
-
api.has_param :report_schedule_id, 'string'
|
394
|
-
api.has_param :insights_section, 'object'
|
395
|
-
api.has_param :creation_source, { enum: -> { AdReportSpec::CREATION_SOURCE }}
|
396
|
-
api.has_param :format_version, 'int'
|
397
396
|
end
|
398
397
|
end
|
399
398
|
|
400
399
|
has_edge :adrules_history do |edge|
|
401
400
|
edge.get 'AdAccountAdRulesHistory' do |api|
|
402
|
-
api.has_param :object_id, 'string'
|
403
401
|
api.has_param :action, { enum: -> { AdAccountAdRulesHistory::ACTION }}
|
404
|
-
api.has_param :hide_no_changes, 'bool'
|
405
402
|
api.has_param :evaluation_type, { enum: -> { AdAccountAdRulesHistory::EVALUATION_TYPE }}
|
403
|
+
api.has_param :hide_no_changes, 'bool'
|
404
|
+
api.has_param :object_id, 'string'
|
406
405
|
end
|
407
406
|
end
|
408
407
|
|
@@ -412,46 +411,46 @@ module FacebookAds
|
|
412
411
|
api.has_param :account_id, 'string'
|
413
412
|
api.has_param :evaluation_spec, 'object'
|
414
413
|
api.has_param :execution_spec, 'object'
|
415
|
-
api.has_param :schedule_spec, 'object'
|
416
414
|
api.has_param :name, 'string'
|
415
|
+
api.has_param :schedule_spec, 'object'
|
417
416
|
api.has_param :status, { enum: -> { AdRule::STATUS }}
|
418
417
|
end
|
419
418
|
end
|
420
419
|
|
421
420
|
has_edge :ads do |edge|
|
422
421
|
edge.delete do |api|
|
423
|
-
api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
|
424
|
-
api.has_param :object_count, 'int'
|
425
422
|
api.has_param :before_date, 'datetime'
|
426
423
|
api.has_param :delete_offset, 'int'
|
424
|
+
api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
|
425
|
+
api.has_param :object_count, 'int'
|
427
426
|
end
|
428
427
|
edge.get 'Ad' do |api|
|
428
|
+
api.has_param :ad_draft_id, 'string'
|
429
429
|
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
430
430
|
api.has_param :effective_status, { list: 'string' }
|
431
431
|
api.has_param :include_deleted, 'bool'
|
432
|
+
api.has_param :include_drafts, 'bool'
|
432
433
|
api.has_param :time_range, 'object'
|
433
434
|
api.has_param :updated_since, 'int'
|
434
|
-
api.has_param :ad_draft_id, 'string'
|
435
|
-
api.has_param :include_drafts, 'bool'
|
436
435
|
end
|
437
436
|
edge.post 'Ad' do |api|
|
438
|
-
api.has_param :
|
437
|
+
api.has_param :adlabels, { list: 'object' }
|
439
438
|
api.has_param :adset_id, 'int'
|
440
|
-
api.has_param :
|
441
|
-
api.has_param :
|
439
|
+
api.has_param :adset_spec, 'AdSet'
|
440
|
+
api.has_param :audience_id, 'string'
|
441
|
+
api.has_param :bid_amount, 'int'
|
442
442
|
api.has_param :creative, 'AdCreative'
|
443
|
-
api.has_param :
|
444
|
-
api.has_param :status, { enum: -> { Ad::STATUS }}
|
445
|
-
api.has_param :priority, 'int'
|
446
|
-
api.has_param :tracking_specs, 'object'
|
443
|
+
api.has_param :date_format, 'string'
|
447
444
|
api.has_param :display_sequence, 'int'
|
448
|
-
api.has_param :engagement_audience, 'bool'
|
449
|
-
api.has_param :adset_spec, 'AdSet'
|
450
445
|
api.has_param :draft_adgroup_id, 'string'
|
446
|
+
api.has_param :engagement_audience, 'bool'
|
451
447
|
api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
|
452
|
-
api.has_param :
|
453
|
-
api.has_param :
|
448
|
+
api.has_param :include_demolink_hashes, 'bool'
|
449
|
+
api.has_param :name, 'string'
|
450
|
+
api.has_param :priority, 'int'
|
454
451
|
api.has_param :source_ad_id, 'string'
|
452
|
+
api.has_param :status, { enum: -> { Ad::STATUS }}
|
453
|
+
api.has_param :tracking_specs, 'object'
|
455
454
|
api.accepts_files!
|
456
455
|
end
|
457
456
|
end
|
@@ -465,32 +464,32 @@ module FacebookAds
|
|
465
464
|
|
466
465
|
has_edge :adsets do |edge|
|
467
466
|
edge.delete do |api|
|
468
|
-
api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
|
469
|
-
api.has_param :object_count, 'int'
|
470
467
|
api.has_param :before_date, 'datetime'
|
471
468
|
api.has_param :delete_offset, 'int'
|
469
|
+
api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
|
470
|
+
api.has_param :object_count, 'int'
|
472
471
|
end
|
473
472
|
edge.get 'AdSet' do |api|
|
474
|
-
api.has_param :
|
473
|
+
api.has_param :ad_draft_id, 'string'
|
475
474
|
api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
|
475
|
+
api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
|
476
476
|
api.has_param :include_deleted, 'bool'
|
477
|
+
api.has_param :include_drafts, 'bool'
|
477
478
|
api.has_param :is_completed, 'bool'
|
478
479
|
api.has_param :time_range, 'object'
|
479
|
-
api.has_param :ad_draft_id, 'string'
|
480
|
-
api.has_param :include_drafts, 'bool'
|
481
480
|
end
|
482
481
|
edge.post 'AdSet' do |api|
|
483
482
|
api.has_param :ad_keywords, 'object'
|
484
483
|
api.has_param :adlabels, { list: 'object' }
|
485
|
-
api.has_param :
|
484
|
+
api.has_param :adset_schedule, { list: 'object' }
|
485
|
+
api.has_param :attribution_spec, { list: 'hash' }
|
486
486
|
api.has_param :bid_adjustments, 'object'
|
487
|
+
api.has_param :bid_amount, 'int'
|
487
488
|
api.has_param :bid_constraints, 'hash'
|
488
489
|
api.has_param :bid_strategy, { enum: -> { AdSet::BID_STRATEGY }}
|
489
490
|
api.has_param :billing_event, { enum: -> { AdSet::BILLING_EVENT }}
|
490
491
|
api.has_param :campaign_id, 'string'
|
491
492
|
api.has_param :campaign_spec, 'object'
|
492
|
-
api.has_param :adset_schedule, { list: 'object' }
|
493
|
-
api.has_param :status, { enum: -> { AdSet::STATUS }}
|
494
493
|
api.has_param :creative_sequence, { list: 'string' }
|
495
494
|
api.has_param :daily_budget, 'int'
|
496
495
|
api.has_param :daily_imps, 'int'
|
@@ -501,6 +500,7 @@ module FacebookAds
|
|
501
500
|
api.has_param :end_time, 'datetime'
|
502
501
|
api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
|
503
502
|
api.has_param :frequency_control_specs, { list: 'object' }
|
503
|
+
api.has_param :full_funnel_exploration_mode, { enum: -> { AdSet::FULL_FUNNEL_EXPLORATION_MODE }}
|
504
504
|
api.has_param :is_dynamic_creative, 'bool'
|
505
505
|
api.has_param :lifetime_budget, 'int'
|
506
506
|
api.has_param :lifetime_imps, 'int'
|
@@ -515,6 +515,7 @@ module FacebookAds
|
|
515
515
|
api.has_param :rf_prediction_id, 'string'
|
516
516
|
api.has_param :source_adset_id, 'string'
|
517
517
|
api.has_param :start_time, 'datetime'
|
518
|
+
api.has_param :status, { enum: -> { AdSet::STATUS }}
|
518
519
|
api.has_param :targeting, 'Targeting'
|
519
520
|
api.has_param :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
|
520
521
|
api.has_param :time_based_ad_rotation_intervals, { list: 'int' }
|
@@ -522,8 +523,6 @@ module FacebookAds
|
|
522
523
|
api.has_param :time_stop, 'datetime'
|
523
524
|
api.has_param :topline_id, 'string'
|
524
525
|
api.has_param :upstream_events, 'hash'
|
525
|
-
api.has_param :full_funnel_exploration_mode, { enum: -> { AdSet::FULL_FUNNEL_EXPLORATION_MODE }}
|
526
|
-
api.has_param :attribution_spec, { list: 'hash' }
|
527
526
|
end
|
528
527
|
end
|
529
528
|
|
@@ -560,87 +559,87 @@ module FacebookAds
|
|
560
559
|
|
561
560
|
has_edge :advideos do |edge|
|
562
561
|
edge.get 'AdVideo' do |api|
|
563
|
-
api.has_param :
|
564
|
-
api.has_param :minlength, 'int'
|
565
|
-
api.has_param :maxlength, 'int'
|
566
|
-
api.has_param :minheight, 'int'
|
562
|
+
api.has_param :max_aspect_ratio, 'double'
|
567
563
|
api.has_param :maxheight, 'int'
|
568
|
-
api.has_param :
|
564
|
+
api.has_param :maxlength, 'int'
|
569
565
|
api.has_param :maxwidth, 'int'
|
570
566
|
api.has_param :min_aspect_ratio, 'double'
|
571
|
-
api.has_param :
|
567
|
+
api.has_param :minheight, 'int'
|
568
|
+
api.has_param :minlength, 'int'
|
569
|
+
api.has_param :minwidth, 'int'
|
570
|
+
api.has_param :title, 'string'
|
572
571
|
end
|
573
572
|
edge.post 'AdVideo' do |api|
|
574
|
-
api.has_param :title, 'string'
|
575
|
-
api.has_param :unpublished_content_type, { enum: -> { AdVideo::UNPUBLISHED_CONTENT_TYPE }}
|
576
|
-
api.has_param :time_since_original_post, 'int'
|
577
|
-
api.has_param :file_url, 'string'
|
578
|
-
api.has_param :composer_session_id, 'string'
|
579
|
-
api.has_param :waterfall_id, 'string'
|
580
|
-
api.has_param :og_action_type_id, 'string'
|
581
|
-
api.has_param :og_object_id, 'string'
|
582
|
-
api.has_param :og_phrase, 'string'
|
583
|
-
api.has_param :og_icon_id, 'string'
|
584
|
-
api.has_param :og_suggestion_mechanism, 'string'
|
585
|
-
api.has_param :thumb, 'file'
|
586
|
-
api.has_param :spherical, 'bool'
|
587
|
-
api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
|
588
|
-
api.has_param :initial_heading, 'int'
|
589
|
-
api.has_param :initial_pitch, 'int'
|
590
|
-
api.has_param :fov, 'int'
|
591
|
-
api.has_param :original_fov, 'int'
|
592
|
-
api.has_param :fisheye_video_cropped, 'bool'
|
593
|
-
api.has_param :front_z_rotation, 'double'
|
594
|
-
api.has_param :guide_enabled, 'bool'
|
595
|
-
api.has_param :guide, { list: { list: 'int' } }
|
596
|
-
api.has_param :audio_story_wave_animation_handle, 'string'
|
597
573
|
api.has_param :adaptive_type, 'string'
|
598
574
|
api.has_param :animated_effect_id, 'int'
|
575
|
+
api.has_param :application_id, 'string'
|
599
576
|
api.has_param :asked_fun_fact_prompt_id, 'int'
|
577
|
+
api.has_param :attribution_app_id, 'string'
|
578
|
+
api.has_param :audio_story_wave_animation_handle, 'string'
|
579
|
+
api.has_param :chunk_session_id, 'string'
|
600
580
|
api.has_param :composer_entry_picker, 'string'
|
601
581
|
api.has_param :composer_entry_point, 'string'
|
602
582
|
api.has_param :composer_entry_time, 'int'
|
603
583
|
api.has_param :composer_session_events_log, 'string'
|
584
|
+
api.has_param :composer_session_id, 'string'
|
604
585
|
api.has_param :composer_source_surface, 'string'
|
605
586
|
api.has_param :composer_type, 'string'
|
587
|
+
api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
|
588
|
+
api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
|
589
|
+
api.has_param :description, 'string'
|
590
|
+
api.has_param :embeddable, 'bool'
|
591
|
+
api.has_param :end_offset, 'int'
|
592
|
+
api.has_param :fbuploader_video_file_chunk, 'string'
|
593
|
+
api.has_param :file_size, 'int'
|
594
|
+
api.has_param :file_url, 'string'
|
595
|
+
api.has_param :fisheye_video_cropped, 'bool'
|
606
596
|
api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
|
597
|
+
api.has_param :fov, 'int'
|
598
|
+
api.has_param :front_z_rotation, 'double'
|
607
599
|
api.has_param :fun_fact_prompt_id, 'int'
|
608
600
|
api.has_param :fun_fact_toastee_id, 'int'
|
609
|
-
api.has_param :
|
601
|
+
api.has_param :guide, { list: { list: 'int' } }
|
602
|
+
api.has_param :guide_enabled, 'bool'
|
610
603
|
api.has_param :has_nickname, 'bool'
|
611
604
|
api.has_param :holiday_card, 'string'
|
605
|
+
api.has_param :initial_heading, 'int'
|
606
|
+
api.has_param :initial_pitch, 'int'
|
612
607
|
api.has_param :instant_game_entry_point_data, 'string'
|
613
608
|
api.has_param :is_boost_intended, 'bool'
|
609
|
+
api.has_param :is_group_linking_post, 'bool'
|
610
|
+
api.has_param :is_voice_clip, 'bool'
|
614
611
|
api.has_param :location_source_id, 'string'
|
615
|
-
api.has_param :
|
612
|
+
api.has_param :name, 'string'
|
616
613
|
api.has_param :offer_like_post_id, 'int'
|
614
|
+
api.has_param :og_action_type_id, 'string'
|
615
|
+
api.has_param :og_icon_id, 'string'
|
616
|
+
api.has_param :og_object_id, 'string'
|
617
|
+
api.has_param :og_phrase, 'string'
|
618
|
+
api.has_param :og_suggestion_mechanism, 'string'
|
619
|
+
api.has_param :original_fov, 'int'
|
620
|
+
api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
|
617
621
|
api.has_param :publish_event_id, 'int'
|
618
622
|
api.has_param :react_mode_metadata, 'string'
|
623
|
+
api.has_param :referenced_sticker_id, 'string'
|
624
|
+
api.has_param :replace_video_id, 'string'
|
619
625
|
api.has_param :sales_promo_id, 'int'
|
626
|
+
api.has_param :slideshow_spec, 'hash'
|
627
|
+
api.has_param :spherical, 'bool'
|
628
|
+
api.has_param :start_offset, 'int'
|
629
|
+
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
620
630
|
api.has_param :text_format_metadata, 'string'
|
621
631
|
api.has_param :throwback_camera_roll_media, 'string'
|
622
|
-
api.has_param :
|
623
|
-
api.has_param :
|
632
|
+
api.has_param :thumb, 'file'
|
633
|
+
api.has_param :time_since_original_post, 'int'
|
634
|
+
api.has_param :title, 'string'
|
635
|
+
api.has_param :transcode_setting_properties, 'string'
|
636
|
+
api.has_param :unpublished_content_type, { enum: -> { AdVideo::UNPUBLISHED_CONTENT_TYPE }}
|
624
637
|
api.has_param :upload_phase, { enum: -> { AdVideo::UPLOAD_PHASE }}
|
625
|
-
api.has_param :file_size, 'int'
|
626
|
-
api.has_param :start_offset, 'int'
|
627
|
-
api.has_param :end_offset, 'int'
|
628
|
-
api.has_param :video_file_chunk, 'string'
|
629
|
-
api.has_param :fbuploader_video_file_chunk, 'string'
|
630
638
|
api.has_param :upload_session_id, 'string'
|
631
|
-
api.has_param :is_voice_clip, 'bool'
|
632
|
-
api.has_param :attribution_app_id, 'string'
|
633
|
-
api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
|
634
|
-
api.has_param :embeddable, 'bool'
|
635
|
-
api.has_param :slideshow_spec, 'hash'
|
636
639
|
api.has_param :upload_setting_properties, 'string'
|
637
|
-
api.has_param :
|
638
|
-
api.has_param :
|
639
|
-
api.has_param :
|
640
|
-
api.has_param :replace_video_id, 'string'
|
641
|
-
api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
|
642
|
-
api.has_param :name, 'string'
|
643
|
-
api.has_param :chunk_session_id, 'string'
|
640
|
+
api.has_param :video_file_chunk, 'string'
|
641
|
+
api.has_param :video_start_time_ms, 'int'
|
642
|
+
api.has_param :waterfall_id, 'string'
|
644
643
|
api.accepts_files!
|
645
644
|
end
|
646
645
|
end
|
@@ -672,15 +671,15 @@ module FacebookAds
|
|
672
671
|
api.has_param :business, 'string'
|
673
672
|
end
|
674
673
|
edge.post 'AdAccount' do |api|
|
675
|
-
api.has_param :user, 'int'
|
676
674
|
api.has_param :tasks, { list: { enum: -> { AdAccount::TASKS }} }
|
675
|
+
api.has_param :user, 'int'
|
677
676
|
end
|
678
677
|
end
|
679
678
|
|
680
679
|
has_edge :async_batch_requests do |edge|
|
681
680
|
edge.post 'Campaign' do |api|
|
682
|
-
api.has_param :name, 'string'
|
683
681
|
api.has_param :adbatch, { list: 'object' }
|
682
|
+
api.has_param :name, 'string'
|
684
683
|
end
|
685
684
|
end
|
686
685
|
|
@@ -698,15 +697,15 @@ module FacebookAds
|
|
698
697
|
edge.post 'AdAsyncRequestSet' do |api|
|
699
698
|
api.has_param :ad_specs, { list: 'hash' }
|
700
699
|
api.has_param :name, 'string'
|
701
|
-
api.has_param :notification_uri, 'string'
|
702
700
|
api.has_param :notification_mode, { enum: -> { AdAsyncRequestSet::NOTIFICATION_MODE }}
|
701
|
+
api.has_param :notification_uri, 'string'
|
703
702
|
end
|
704
703
|
end
|
705
704
|
|
706
705
|
has_edge :audiencereplace do |edge|
|
707
706
|
edge.post do |api|
|
708
|
-
api.has_param :session, 'object'
|
709
707
|
api.has_param :payload, 'object'
|
708
|
+
api.has_param :session, 'object'
|
710
709
|
end
|
711
710
|
end
|
712
711
|
|
@@ -731,10 +730,10 @@ module FacebookAds
|
|
731
730
|
has_edge :brand_audiences do |edge|
|
732
731
|
edge.get 'BrandAudience'
|
733
732
|
edge.post 'BrandAudience' do |api|
|
733
|
+
api.has_param :description, 'string'
|
734
734
|
api.has_param :name, 'string'
|
735
|
-
api.has_param :targeting, 'object'
|
736
735
|
api.has_param :target_size, 'int'
|
737
|
-
api.has_param :
|
736
|
+
api.has_param :targeting, 'object'
|
738
737
|
end
|
739
738
|
end
|
740
739
|
|
@@ -762,35 +761,37 @@ module FacebookAds
|
|
762
761
|
|
763
762
|
has_edge :campaigns do |edge|
|
764
763
|
edge.delete do |api|
|
765
|
-
api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
|
766
|
-
api.has_param :object_count, 'int'
|
767
764
|
api.has_param :before_date, 'datetime'
|
768
765
|
api.has_param :delete_offset, 'int'
|
766
|
+
api.has_param :delete_strategy, { enum: %w{DELETE_ANY DELETE_ARCHIVED_BEFORE DELETE_OLDEST }}
|
767
|
+
api.has_param :object_count, 'int'
|
769
768
|
end
|
770
769
|
edge.get 'Campaign' do |api|
|
771
|
-
api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
|
772
770
|
api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
|
771
|
+
api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
|
772
|
+
api.has_param :include_drafts, 'bool'
|
773
773
|
api.has_param :is_completed, 'bool'
|
774
774
|
api.has_param :time_range, 'object'
|
775
|
+
api.has_param :use_employee_draft, 'bool'
|
775
776
|
end
|
776
777
|
edge.post 'Campaign' do |api|
|
777
|
-
api.has_param :
|
778
|
-
api.has_param :objective, { enum: -> { Campaign::OBJECTIVE }}
|
779
|
-
api.has_param :status, { enum: -> { Campaign::STATUS }}
|
778
|
+
api.has_param :adlabels, { list: 'object' }
|
780
779
|
api.has_param :bid_strategy, { enum: -> { Campaign::BID_STRATEGY }}
|
781
780
|
api.has_param :budget_rebalance_flag, 'bool'
|
782
781
|
api.has_param :buying_type, 'string'
|
783
782
|
api.has_param :daily_budget, 'int'
|
783
|
+
api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
|
784
|
+
api.has_param :iterative_split_test_configs, { list: 'object' }
|
784
785
|
api.has_param :lifetime_budget, 'int'
|
786
|
+
api.has_param :name, 'string'
|
787
|
+
api.has_param :objective, { enum: -> { Campaign::OBJECTIVE }}
|
785
788
|
api.has_param :pacing_type, { list: 'string' }
|
786
789
|
api.has_param :promoted_object, 'object'
|
787
|
-
api.has_param :
|
790
|
+
api.has_param :source_campaign_id, 'string'
|
788
791
|
api.has_param :spend_cap, 'int'
|
789
|
-
api.has_param :
|
792
|
+
api.has_param :status, { enum: -> { Campaign::STATUS }}
|
793
|
+
api.has_param :topline_id, 'string'
|
790
794
|
api.has_param :upstream_events, 'hash'
|
791
|
-
api.has_param :adlabels, { list: 'object' }
|
792
|
-
api.has_param :source_campaign_id, 'string'
|
793
|
-
api.has_param :iterative_split_test_configs, { list: 'object' }
|
794
795
|
end
|
795
796
|
end
|
796
797
|
|
@@ -813,59 +814,59 @@ module FacebookAds
|
|
813
814
|
|
814
815
|
has_edge :customaudiences do |edge|
|
815
816
|
edge.get 'CustomAudience' do |api|
|
816
|
-
api.has_param :
|
817
|
+
api.has_param :business_id, 'string'
|
817
818
|
api.has_param :fields, { list: 'string' }
|
818
819
|
api.has_param :filtering, { list: 'object' }
|
819
|
-
api.has_param :
|
820
|
+
api.has_param :pixel_id, 'string'
|
820
821
|
end
|
821
822
|
edge.post 'CustomAudience' do |api|
|
823
|
+
api.has_param :accountid, 'string'
|
824
|
+
api.has_param :additionalmetadata, 'string'
|
825
|
+
api.has_param :allowed_domains, { list: 'string' }
|
826
|
+
api.has_param :associated_audience_id, 'int'
|
827
|
+
api.has_param :claim_objective, { enum: -> { CustomAudience::CLAIM_OBJECTIVE }}
|
828
|
+
api.has_param :content_type, { enum: -> { CustomAudience::CONTENT_TYPE }}
|
829
|
+
api.has_param :countries, 'string'
|
822
830
|
api.has_param :creation_params, 'hash'
|
831
|
+
api.has_param :customer_file_source, { enum: -> { CustomAudience::CUSTOMER_FILE_SOURCE }}
|
832
|
+
api.has_param :dataset_id, 'string'
|
823
833
|
api.has_param :description, 'string'
|
824
|
-
api.has_param :
|
825
|
-
api.has_param :
|
826
|
-
api.has_param :
|
827
|
-
api.has_param :
|
828
|
-
api.has_param :
|
829
|
-
api.has_param :
|
830
|
-
api.has_param :
|
834
|
+
api.has_param :details, 'string'
|
835
|
+
api.has_param :enable_fetch_or_create, 'bool'
|
836
|
+
api.has_param :event_source_group, 'string'
|
837
|
+
api.has_param :event_sources, { list: 'hash' }
|
838
|
+
api.has_param :exclusions, { list: 'object' }
|
839
|
+
api.has_param :expectedsize, 'int'
|
840
|
+
api.has_param :gender, 'string'
|
841
|
+
api.has_param :inclusions, { list: 'object' }
|
842
|
+
api.has_param :isprivate, 'bool'
|
831
843
|
api.has_param :is_household, 'bool'
|
832
844
|
api.has_param :is_household_exclusion, 'bool'
|
833
|
-
api.has_param :is_value_based, 'bool'
|
834
|
-
api.has_param :allowed_domains, { list: 'string' }
|
835
845
|
api.has_param :is_snapshot, 'bool'
|
846
|
+
api.has_param :is_value_based, 'bool'
|
847
|
+
api.has_param :list_of_accounts, { list: 'int' }
|
836
848
|
api.has_param :lookalike_spec, 'string'
|
849
|
+
api.has_param :maxage, 'int'
|
850
|
+
api.has_param :minage, 'int'
|
851
|
+
api.has_param :name, 'string'
|
852
|
+
api.has_param :opt_out_link, 'string'
|
853
|
+
api.has_param :origin_audience_id, 'string'
|
854
|
+
api.has_param :parent_audience_id, 'int'
|
855
|
+
api.has_param :partnerid, 'string'
|
856
|
+
api.has_param :partner_reference_key, 'string'
|
857
|
+
api.has_param :pixel_id, 'string'
|
858
|
+
api.has_param :prefill, 'bool'
|
859
|
+
api.has_param :product_set_id, 'string'
|
837
860
|
api.has_param :retention_days, 'int'
|
838
|
-
api.has_param :customer_file_source, { enum: -> { CustomAudience::CUSTOMER_FILE_SOURCE }}
|
839
861
|
api.has_param :rev_share_policy_id, 'int'
|
840
|
-
api.has_param :partner_reference_key, 'string'
|
841
862
|
api.has_param :rule, 'string'
|
842
|
-
api.has_param :prefill, 'bool'
|
843
|
-
api.has_param :pixel_id, 'string'
|
844
863
|
api.has_param :rule_aggregation, 'string'
|
845
|
-
api.has_param :
|
846
|
-
api.has_param :exclusions, { list: 'object' }
|
847
|
-
api.has_param :countries, 'string'
|
848
|
-
api.has_param :origin_audience_id, 'string'
|
849
|
-
api.has_param :details, 'string'
|
864
|
+
api.has_param :seed_audience, 'int'
|
850
865
|
api.has_param :source, 'string'
|
851
|
-
api.has_param :isprivate, 'bool'
|
852
|
-
api.has_param :additionalmetadata, 'string'
|
853
|
-
api.has_param :minage, 'int'
|
854
|
-
api.has_param :maxage, 'int'
|
855
|
-
api.has_param :expectedsize, 'int'
|
856
|
-
api.has_param :gender, 'string'
|
857
|
-
api.has_param :partnerid, 'string'
|
858
|
-
api.has_param :accountid, 'string'
|
859
|
-
api.has_param :claim_objective, { enum: -> { CustomAudience::CLAIM_OBJECTIVE }}
|
860
|
-
api.has_param :content_type, { enum: -> { CustomAudience::CONTENT_TYPE }}
|
861
|
-
api.has_param :event_source_group, 'string'
|
862
|
-
api.has_param :product_set_id, 'string'
|
863
|
-
api.has_param :event_sources, { list: 'hash' }
|
864
|
-
api.has_param :enable_fetch_or_create, 'bool'
|
865
|
-
api.has_param :video_group_ids, { list: 'string' }
|
866
866
|
api.has_param :study_spec, 'hash'
|
867
|
-
api.has_param :
|
868
|
-
api.has_param :
|
867
|
+
api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
|
868
|
+
api.has_param :tags, { list: 'string' }
|
869
|
+
api.has_param :video_group_ids, { list: 'string' }
|
869
870
|
end
|
870
871
|
end
|
871
872
|
|
@@ -876,13 +877,13 @@ module FacebookAds
|
|
876
877
|
has_edge :customconversions do |edge|
|
877
878
|
edge.get 'CustomConversion'
|
878
879
|
edge.post 'CustomConversion' do |api|
|
879
|
-
api.has_param :
|
880
|
+
api.has_param :advanced_rule, 'string'
|
881
|
+
api.has_param :custom_event_type, { enum: -> { CustomConversion::CUSTOM_EVENT_TYPE }}
|
882
|
+
api.has_param :default_conversion_value, 'double'
|
880
883
|
api.has_param :description, 'string'
|
881
884
|
api.has_param :event_source_id, 'string'
|
885
|
+
api.has_param :name, 'string'
|
882
886
|
api.has_param :rule, 'string'
|
883
|
-
api.has_param :default_conversion_value, 'double'
|
884
|
-
api.has_param :custom_event_type, { enum: -> { CustomConversion::CUSTOM_EVENT_TYPE }}
|
885
|
-
api.has_param :advanced_rule, 'string'
|
886
887
|
end
|
887
888
|
end
|
888
889
|
|
@@ -892,9 +893,9 @@ module FacebookAds
|
|
892
893
|
|
893
894
|
has_edge :delivery_estimate do |edge|
|
894
895
|
edge.get 'AdAccountDeliveryEstimate' do |api|
|
895
|
-
api.has_param :targeting_spec, 'Targeting'
|
896
896
|
api.has_param :optimization_goal, { enum: -> { AdAccountDeliveryEstimate::OPTIMIZATION_GOAL }}
|
897
897
|
api.has_param :promoted_object, 'object'
|
898
|
+
api.has_param :targeting_spec, 'Targeting'
|
898
899
|
end
|
899
900
|
end
|
900
901
|
|
@@ -924,20 +925,20 @@ module FacebookAds
|
|
924
925
|
has_edge :generatepreviews do |edge|
|
925
926
|
edge.get 'AdPreview' do |api|
|
926
927
|
api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
|
928
|
+
api.has_param :creative, 'AdCreative'
|
929
|
+
api.has_param :dynamic_asset_label, 'string'
|
927
930
|
api.has_param :dynamic_creative_spec, 'object'
|
928
931
|
api.has_param :dynamic_customization, 'object'
|
929
|
-
api.has_param :
|
930
|
-
api.has_param :interactive, 'bool'
|
931
|
-
api.has_param :post, 'object'
|
932
|
+
api.has_param :end_date, 'datetime'
|
932
933
|
api.has_param :height, 'int'
|
933
|
-
api.has_param :
|
934
|
+
api.has_param :interactive, 'bool'
|
935
|
+
api.has_param :locale, 'string'
|
934
936
|
api.has_param :place_page_id, 'int'
|
937
|
+
api.has_param :post, 'object'
|
935
938
|
api.has_param :product_item_ids, { list: 'string' }
|
936
|
-
api.has_param :start_date, 'datetime'
|
937
|
-
api.has_param :end_date, 'datetime'
|
938
|
-
api.has_param :locale, 'string'
|
939
939
|
api.has_param :render_type, { enum: -> { AdPreview::RENDER_TYPE }}
|
940
|
-
api.has_param :
|
940
|
+
api.has_param :start_date, 'datetime'
|
941
|
+
api.has_param :width, 'int'
|
941
942
|
end
|
942
943
|
end
|
943
944
|
|
@@ -947,21 +948,21 @@ module FacebookAds
|
|
947
948
|
|
948
949
|
has_edge :insights do |edge|
|
949
950
|
edge.get 'AdsInsights' do |api|
|
950
|
-
api.has_param :default_summary, 'bool'
|
951
|
-
api.has_param :fields, { list: 'string' }
|
952
|
-
api.has_param :filtering, { list: 'object' }
|
953
|
-
api.has_param :summary, { list: 'string' }
|
954
|
-
api.has_param :sort, { list: 'string' }
|
955
951
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
956
952
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
957
953
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
958
954
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
959
955
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
956
|
+
api.has_param :default_summary, 'bool'
|
960
957
|
api.has_param :export_columns, { list: 'string' }
|
961
958
|
api.has_param :export_format, 'string'
|
962
959
|
api.has_param :export_name, 'string'
|
960
|
+
api.has_param :fields, { list: 'string' }
|
961
|
+
api.has_param :filtering, { list: 'object' }
|
963
962
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
964
963
|
api.has_param :product_id_limit, 'int'
|
964
|
+
api.has_param :sort, { list: 'string' }
|
965
|
+
api.has_param :summary, { list: 'string' }
|
965
966
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
966
967
|
api.has_param :time_increment, 'string'
|
967
968
|
api.has_param :time_range, 'object'
|
@@ -969,21 +970,21 @@ module FacebookAds
|
|
969
970
|
api.has_param :use_account_attribution_setting, 'bool'
|
970
971
|
end
|
971
972
|
edge.post 'AdReportRun' do |api|
|
972
|
-
api.has_param :default_summary, 'bool'
|
973
|
-
api.has_param :fields, { list: 'string' }
|
974
|
-
api.has_param :filtering, { list: 'object' }
|
975
|
-
api.has_param :summary, { list: 'string' }
|
976
|
-
api.has_param :sort, { list: 'string' }
|
977
973
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
978
974
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
979
975
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
980
976
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
981
977
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
978
|
+
api.has_param :default_summary, 'bool'
|
982
979
|
api.has_param :export_columns, { list: 'string' }
|
983
980
|
api.has_param :export_format, 'string'
|
984
981
|
api.has_param :export_name, 'string'
|
982
|
+
api.has_param :fields, { list: 'string' }
|
983
|
+
api.has_param :filtering, { list: 'object' }
|
985
984
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
986
985
|
api.has_param :product_id_limit, 'int'
|
986
|
+
api.has_param :sort, { list: 'string' }
|
987
|
+
api.has_param :summary, { list: 'string' }
|
987
988
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
988
989
|
api.has_param :time_increment, 'string'
|
989
990
|
api.has_param :time_range, 'object'
|
@@ -1010,11 +1011,11 @@ module FacebookAds
|
|
1010
1011
|
|
1011
1012
|
has_edge :matched_search_applications do |edge|
|
1012
1013
|
edge.get 'AdAccountMatchedSearchApplicationsEdgeData' do |api|
|
1014
|
+
api.has_param :allow_incomplete_app, 'bool'
|
1013
1015
|
api.has_param :app_store, { enum: -> { AdAccountMatchedSearchApplicationsEdgeData::APP_STORE }}
|
1014
1016
|
api.has_param :app_store_country, 'string'
|
1015
1017
|
api.has_param :business_id, 'string'
|
1016
1018
|
api.has_param :query_term, 'string'
|
1017
|
-
api.has_param :allow_incomplete_app, 'bool'
|
1018
1019
|
end
|
1019
1020
|
end
|
1020
1021
|
|
@@ -1031,8 +1032,8 @@ module FacebookAds
|
|
1031
1032
|
has_edge :mockups do |edge|
|
1032
1033
|
edge.post do |api|
|
1033
1034
|
api.has_param :mockup_access_token, 'string'
|
1034
|
-
api.has_param :source_mockup_id, 'string'
|
1035
1035
|
api.has_param :page_id, 'string'
|
1036
|
+
api.has_param :source_mockup_id, 'string'
|
1036
1037
|
end
|
1037
1038
|
end
|
1038
1039
|
|
@@ -1063,33 +1064,33 @@ module FacebookAds
|
|
1063
1064
|
|
1064
1065
|
has_edge :partnercategories do |edge|
|
1065
1066
|
edge.get 'PartnerCategory' do |api|
|
1066
|
-
api.has_param :targeting_type, 'string'
|
1067
|
-
api.has_param :private_or_public, { enum: -> { PartnerCategory::PRIVATE_OR_PUBLIC }}
|
1068
1067
|
api.has_param :hide_pc, 'bool'
|
1069
|
-
api.has_param :limit, 'int'
|
1070
1068
|
api.has_param :is_exclusion, 'bool'
|
1069
|
+
api.has_param :limit, 'int'
|
1070
|
+
api.has_param :private_or_public, { enum: -> { PartnerCategory::PRIVATE_OR_PUBLIC }}
|
1071
|
+
api.has_param :targeting_type, 'string'
|
1071
1072
|
end
|
1072
1073
|
end
|
1073
1074
|
|
1074
1075
|
has_edge :partnerdata do |edge|
|
1075
1076
|
edge.post 'AdAccount' do |api|
|
1076
|
-
api.has_param :upload_id, 'int'
|
1077
|
-
api.has_param :type, 'string'
|
1078
|
-
api.has_param :start_new_upload, 'bool'
|
1079
|
-
api.has_param :total_expected, 'int'
|
1080
|
-
api.has_param :upload_metadata, 'string'
|
1081
|
-
api.has_param :upload_complete, 'bool'
|
1082
|
-
api.has_param :ignore_count_check, 'bool'
|
1083
1077
|
api.has_param :abandon_upload, 'bool'
|
1078
|
+
api.has_param :ignore_count_check, 'bool'
|
1084
1079
|
api.has_param :payload, { list: 'string' }
|
1085
1080
|
api.has_param :payload_type, 'string'
|
1081
|
+
api.has_param :start_new_upload, 'bool'
|
1082
|
+
api.has_param :total_expected, 'int'
|
1083
|
+
api.has_param :type, 'string'
|
1084
|
+
api.has_param :upload_complete, 'bool'
|
1085
|
+
api.has_param :upload_id, 'int'
|
1086
|
+
api.has_param :upload_metadata, 'string'
|
1086
1087
|
end
|
1087
1088
|
end
|
1088
1089
|
|
1089
1090
|
has_edge :partnerrequests do |edge|
|
1090
1091
|
edge.post do |api|
|
1091
|
-
api.has_param :category_ids, { list: 'string' }
|
1092
1092
|
api.has_param :account_ids, { list: 'int' }
|
1093
|
+
api.has_param :category_ids, { list: 'string' }
|
1093
1094
|
api.has_param :type, { enum: %w{SHARE_PC }}
|
1094
1095
|
end
|
1095
1096
|
end
|
@@ -1100,29 +1101,29 @@ module FacebookAds
|
|
1100
1101
|
|
1101
1102
|
has_edge :product_audiences do |edge|
|
1102
1103
|
edge.post 'CustomAudience' do |api|
|
1104
|
+
api.has_param :allowed_domains, { list: 'string' }
|
1105
|
+
api.has_param :associated_audience_id, 'int'
|
1106
|
+
api.has_param :claim_objective, { enum: -> { AdAccount::CLAIM_OBJECTIVE }}
|
1107
|
+
api.has_param :content_type, { enum: -> { AdAccount::CONTENT_TYPE }}
|
1103
1108
|
api.has_param :creation_params, 'hash'
|
1104
1109
|
api.has_param :description, 'string'
|
1105
|
-
api.has_param :
|
1106
|
-
api.has_param :
|
1107
|
-
api.has_param :
|
1108
|
-
api.has_param :
|
1109
|
-
api.has_param :
|
1110
|
-
api.has_param :tags, { list: 'string' }
|
1111
|
-
api.has_param :associated_audience_id, 'int'
|
1110
|
+
api.has_param :enable_fetch_or_create, 'bool'
|
1111
|
+
api.has_param :event_source_group, 'string'
|
1112
|
+
api.has_param :event_sources, { list: 'hash' }
|
1113
|
+
api.has_param :exclusions, { list: 'object' }
|
1114
|
+
api.has_param :inclusions, { list: 'object' }
|
1112
1115
|
api.has_param :is_household, 'bool'
|
1113
1116
|
api.has_param :is_household_exclusion, 'bool'
|
1114
|
-
api.has_param :is_value_based, 'bool'
|
1115
|
-
api.has_param :allowed_domains, { list: 'string' }
|
1116
1117
|
api.has_param :is_snapshot, 'bool'
|
1117
|
-
api.has_param :
|
1118
|
-
api.has_param :
|
1119
|
-
api.has_param :
|
1118
|
+
api.has_param :is_value_based, 'bool'
|
1119
|
+
api.has_param :name, 'string'
|
1120
|
+
api.has_param :opt_out_link, 'string'
|
1121
|
+
api.has_param :parent_audience_id, 'int'
|
1120
1122
|
api.has_param :product_set_id, 'string'
|
1121
1123
|
api.has_param :rev_share_policy_id, 'int'
|
1122
|
-
api.has_param :
|
1123
|
-
api.has_param :
|
1124
|
-
api.has_param :
|
1125
|
-
api.has_param :exclusions, { list: 'object' }
|
1124
|
+
api.has_param :seed_audience, 'int'
|
1125
|
+
api.has_param :subtype, { enum: -> { AdAccount::SUBTYPE }}
|
1126
|
+
api.has_param :tags, { list: 'string' }
|
1126
1127
|
end
|
1127
1128
|
end
|
1128
1129
|
|
@@ -1139,13 +1140,13 @@ module FacebookAds
|
|
1139
1140
|
|
1140
1141
|
has_edge :reachestimate do |edge|
|
1141
1142
|
edge.get 'ReachEstimate' do |api|
|
1142
|
-
api.has_param :targeting_spec, 'Targeting'
|
1143
|
-
api.has_param :is_debug, 'bool'
|
1144
|
-
api.has_param :creative_action_spec, 'string'
|
1145
1143
|
api.has_param :adgroup_ids, { list: 'string' }
|
1146
|
-
api.has_param :concepts, 'string'
|
1147
1144
|
api.has_param :caller_id, 'string'
|
1145
|
+
api.has_param :concepts, 'string'
|
1146
|
+
api.has_param :creative_action_spec, 'string'
|
1147
|
+
api.has_param :is_debug, 'bool'
|
1148
1148
|
api.has_param :object_store_url, 'string'
|
1149
|
+
api.has_param :targeting_spec, 'Targeting'
|
1149
1150
|
end
|
1150
1151
|
end
|
1151
1152
|
|
@@ -1154,42 +1155,42 @@ module FacebookAds
|
|
1154
1155
|
edge.post 'ReachFrequencyPrediction' do |api|
|
1155
1156
|
api.has_param :action, { enum: -> { ReachFrequencyPrediction::ACTION }}
|
1156
1157
|
api.has_param :ad_formats, { list: 'hash' }
|
1157
|
-
api.has_param :
|
1158
|
-
api.has_param :start_time, 'int'
|
1159
|
-
api.has_param :stop_time, 'int'
|
1160
|
-
api.has_param :end_time, 'int'
|
1161
|
-
api.has_param :reach, 'int'
|
1162
|
-
api.has_param :impression, 'int'
|
1163
|
-
api.has_param :frequency_cap, 'int'
|
1158
|
+
api.has_param :auction_entry_option_index, 'int'
|
1164
1159
|
api.has_param :budget, 'int'
|
1165
|
-
api.has_param :
|
1160
|
+
api.has_param :buying_type, { enum: -> { ReachFrequencyPrediction::BUYING_TYPE }}
|
1161
|
+
api.has_param :campaign_group_id, 'string'
|
1162
|
+
api.has_param :day_parting_schedule, { list: 'object' }
|
1166
1163
|
api.has_param :deal_id, 'string'
|
1167
1164
|
api.has_param :destination_id, 'int'
|
1168
1165
|
api.has_param :destination_ids, { list: 'string' }
|
1169
|
-
api.has_param :
|
1170
|
-
api.has_param :
|
1171
|
-
api.has_param :
|
1172
|
-
api.has_param :
|
1173
|
-
api.has_param :
|
1174
|
-
api.has_param :rf_prediction_id, 'string'
|
1175
|
-
api.has_param :rf_prediction_id_to_release, 'string'
|
1176
|
-
api.has_param :rf_prediction_id_to_share, 'string'
|
1177
|
-
api.has_param :num_curve_points, 'int'
|
1178
|
-
api.has_param :interval_frequency_cap_reset_period, 'int'
|
1179
|
-
api.has_param :campaign_group_id, 'string'
|
1166
|
+
api.has_param :end_time, 'int'
|
1167
|
+
api.has_param :exceptions, 'bool'
|
1168
|
+
api.has_param :existing_campaign_id, 'string'
|
1169
|
+
api.has_param :expiration_time, 'int'
|
1170
|
+
api.has_param :frequency_cap, 'int'
|
1180
1171
|
api.has_param :grp_buying, 'bool'
|
1172
|
+
api.has_param :impression, 'int'
|
1181
1173
|
api.has_param :instream_packages, { list: { enum: -> { ReachFrequencyPrediction::INSTREAM_PACKAGES }} }
|
1174
|
+
api.has_param :interval_frequency_cap_reset_period, 'int'
|
1182
1175
|
api.has_param :is_bonus_media, 'bool'
|
1183
1176
|
api.has_param :is_conversion_goal, 'bool'
|
1184
1177
|
api.has_param :is_full_view, 'bool'
|
1185
1178
|
api.has_param :is_higher_average_frequency, 'bool'
|
1186
1179
|
api.has_param :is_reach_and_frequency_io_buying, 'bool'
|
1187
1180
|
api.has_param :is_reserved_buying, 'bool'
|
1188
|
-
api.has_param :
|
1189
|
-
api.has_param :
|
1181
|
+
api.has_param :num_curve_points, 'int'
|
1182
|
+
api.has_param :objective, 'string'
|
1183
|
+
api.has_param :prediction_mode, 'int'
|
1184
|
+
api.has_param :reach, 'int'
|
1185
|
+
api.has_param :rf_prediction_id, 'string'
|
1186
|
+
api.has_param :rf_prediction_id_to_release, 'string'
|
1187
|
+
api.has_param :rf_prediction_id_to_share, 'string'
|
1188
|
+
api.has_param :start_time, 'int'
|
1189
|
+
api.has_param :stop_time, 'int'
|
1190
|
+
api.has_param :story_event_type, 'int'
|
1191
|
+
api.has_param :target_cpm, 'int'
|
1192
|
+
api.has_param :target_spec, 'Targeting'
|
1190
1193
|
api.has_param :video_view_length_constraint, 'int'
|
1191
|
-
api.has_param :auction_entry_option_index, 'int'
|
1192
|
-
api.has_param :exceptions, 'bool'
|
1193
1194
|
end
|
1194
1195
|
end
|
1195
1196
|
|
@@ -1211,80 +1212,80 @@ module FacebookAds
|
|
1211
1212
|
|
1212
1213
|
has_edge :roas do |edge|
|
1213
1214
|
edge.get 'AdAccountRoas' do |api|
|
1214
|
-
api.has_param :time_increment, 'string'
|
1215
|
-
api.has_param :time_range, 'object'
|
1216
1215
|
api.has_param :fields, { list: 'string' }
|
1217
1216
|
api.has_param :filtering, { list: 'object' }
|
1217
|
+
api.has_param :time_increment, 'string'
|
1218
|
+
api.has_param :time_range, 'object'
|
1218
1219
|
end
|
1219
1220
|
end
|
1220
1221
|
|
1221
1222
|
has_edge :saved_audiences do |edge|
|
1222
1223
|
edge.get 'SavedAudience' do |api|
|
1224
|
+
api.has_param :business_id, 'string'
|
1223
1225
|
api.has_param :fields, { list: 'string' }
|
1224
1226
|
api.has_param :filtering, { list: 'object' }
|
1225
|
-
api.has_param :business_id, 'string'
|
1226
1227
|
end
|
1227
1228
|
end
|
1228
1229
|
|
1229
1230
|
has_edge :sponsored_message_ads do |edge|
|
1230
1231
|
edge.post do |api|
|
1231
|
-
api.has_param :message_creative_id, 'string'
|
1232
|
-
api.has_param :daily_budget, 'int'
|
1233
1232
|
api.has_param :bid_amount, 'int'
|
1233
|
+
api.has_param :daily_budget, 'int'
|
1234
|
+
api.has_param :message_creative_id, 'string'
|
1234
1235
|
api.has_param :targeting, 'Targeting'
|
1235
1236
|
end
|
1236
1237
|
end
|
1237
1238
|
|
1238
1239
|
has_edge :targetingbrowse do |edge|
|
1239
1240
|
edge.get 'AdAccountTargetingUnified' do |api|
|
1240
|
-
api.has_param :include_nodes, 'bool'
|
1241
1241
|
api.has_param :excluded_category, 'string'
|
1242
|
-
api.has_param :
|
1242
|
+
api.has_param :include_nodes, 'bool'
|
1243
1243
|
api.has_param :is_exclusion, 'bool'
|
1244
|
+
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
1244
1245
|
api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
|
1245
1246
|
end
|
1246
1247
|
end
|
1247
1248
|
|
1248
1249
|
has_edge :targetingsearch do |edge|
|
1249
1250
|
edge.get 'AdAccountTargetingUnified' do |api|
|
1250
|
-
api.has_param :
|
1251
|
-
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
1252
|
-
api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
|
1251
|
+
api.has_param :countries, { list: 'string' }
|
1253
1252
|
api.has_param :is_exclusion, 'bool'
|
1253
|
+
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
1254
|
+
api.has_param :q, 'string'
|
1254
1255
|
api.has_param :session_id, 'int'
|
1255
1256
|
api.has_param :targeting_list, { list: 'object' }
|
1256
|
-
api.has_param :
|
1257
|
+
api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
|
1257
1258
|
end
|
1258
1259
|
end
|
1259
1260
|
|
1260
1261
|
has_edge :targetingsentencelines do |edge|
|
1261
1262
|
edge.get 'TargetingSentenceLine' do |api|
|
1262
|
-
api.has_param :targeting_spec, 'Targeting'
|
1263
1263
|
api.has_param :discard_ages, 'bool'
|
1264
1264
|
api.has_param :discard_placements, 'bool'
|
1265
1265
|
api.has_param :hide_targeting_spec_from_return, 'bool'
|
1266
|
+
api.has_param :targeting_spec, 'Targeting'
|
1266
1267
|
end
|
1267
1268
|
end
|
1268
1269
|
|
1269
1270
|
has_edge :targetingsuggestions do |edge|
|
1270
1271
|
edge.get 'AdAccountTargetingUnified' do |api|
|
1271
|
-
api.has_param :
|
1272
|
-
api.has_param :objective, { enum: -> { AdAccountTargetingUnified::OBJECTIVE }}
|
1273
|
-
api.has_param :objects, 'object'
|
1272
|
+
api.has_param :countries, { list: 'string' }
|
1274
1273
|
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
1275
1274
|
api.has_param :mode, { enum: -> { AdAccountTargetingUnified::MODE }}
|
1275
|
+
api.has_param :objective, { enum: -> { AdAccountTargetingUnified::OBJECTIVE }}
|
1276
|
+
api.has_param :objects, 'object'
|
1276
1277
|
api.has_param :session_id, 'int'
|
1278
|
+
api.has_param :targeting_list, { list: 'object' }
|
1277
1279
|
api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
|
1278
|
-
api.has_param :countries, { list: 'string' }
|
1279
1280
|
end
|
1280
1281
|
end
|
1281
1282
|
|
1282
1283
|
has_edge :targetingvalidation do |edge|
|
1283
1284
|
edge.get 'AdAccountTargetingUnified' do |api|
|
1284
|
-
api.has_param :targeting_list, { list: 'object' }
|
1285
1285
|
api.has_param :id_list, { list: 'int' }
|
1286
|
-
api.has_param :name_list, { list: 'string' }
|
1287
1286
|
api.has_param :is_exclusion, 'bool'
|
1287
|
+
api.has_param :name_list, { list: 'string' }
|
1288
|
+
api.has_param :targeting_list, { list: 'object' }
|
1288
1289
|
end
|
1289
1290
|
end
|
1290
1291
|
|
@@ -1306,16 +1307,16 @@ module FacebookAds
|
|
1306
1307
|
|
1307
1308
|
has_edge :usermatch do |edge|
|
1308
1309
|
edge.delete do |api|
|
1309
|
-
api.has_param :payload, 'object'
|
1310
|
-
api.has_param :namespace, 'string'
|
1311
1310
|
api.has_param :bidirectional, 'bool'
|
1311
|
+
api.has_param :namespace, 'string'
|
1312
|
+
api.has_param :payload, 'object'
|
1312
1313
|
end
|
1313
1314
|
edge.post do |api|
|
1314
|
-
api.has_param :payload, 'object'
|
1315
1315
|
api.has_param :action, 'string'
|
1316
|
+
api.has_param :bidirectional, 'bool'
|
1316
1317
|
api.has_param :namespace, 'string'
|
1318
|
+
api.has_param :payload, 'object'
|
1317
1319
|
api.has_param :retention, 'string'
|
1318
|
-
api.has_param :bidirectional, 'bool'
|
1319
1320
|
end
|
1320
1321
|
end
|
1321
1322
|
|
@@ -1326,16 +1327,16 @@ module FacebookAds
|
|
1326
1327
|
end
|
1327
1328
|
edge.get 'AdAccountUser'
|
1328
1329
|
edge.post 'AdAccount' do |api|
|
1329
|
-
api.has_param :uid, 'int'
|
1330
1330
|
api.has_param :tasks, { list: { enum: -> { AdAccount::TASKS }} }
|
1331
|
+
api.has_param :uid, 'int'
|
1331
1332
|
end
|
1332
1333
|
end
|
1333
1334
|
|
1334
1335
|
has_edge :usersofanyaudience do |edge|
|
1335
1336
|
edge.delete do |api|
|
1336
|
-
api.has_param :session, 'object'
|
1337
|
-
api.has_param :payload, 'object'
|
1338
1337
|
api.has_param :namespace, 'string'
|
1338
|
+
api.has_param :payload, 'object'
|
1339
|
+
api.has_param :session, 'object'
|
1339
1340
|
end
|
1340
1341
|
end
|
1341
1342
|
|