facebookbusiness 0.7.0.2 → 0.7.0.3

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.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad_account.rb +5 -6
  3. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
  4. data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +1 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +1 -0
  6. data/lib/facebook_ads/ad_objects/ad_activity.rb +7 -0
  7. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +1 -0
  8. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +2 -2
  9. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
  10. data/lib/facebook_ads/ad_objects/ad_creative.rb +1 -0
  11. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +1 -0
  12. data/lib/facebook_ads/ad_objects/ad_preview.rb +0 -1
  13. data/lib/facebook_ads/ad_objects/ad_set.rb +2 -0
  14. data/lib/facebook_ads/ad_objects/ad_study.rb +1 -0
  15. data/lib/facebook_ads/ad_objects/ad_video.rb +5 -27
  16. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +4 -0
  17. data/lib/facebook_ads/ad_objects/{ads_interest.rb → adoptable_pet.rb} +18 -5
  18. data/lib/facebook_ads/ad_objects/ads_insights.rb +4 -0
  19. data/lib/facebook_ads/ad_objects/application.rb +4 -0
  20. data/lib/facebook_ads/ad_objects/atlas_campaign.rb +2 -2
  21. data/lib/facebook_ads/ad_objects/business.rb +1 -121
  22. data/lib/facebook_ads/ad_objects/business_asset_group.rb +0 -3
  23. data/lib/facebook_ads/ad_objects/business_role_request.rb +5 -0
  24. data/lib/facebook_ads/ad_objects/business_user.rb +5 -0
  25. data/lib/facebook_ads/ad_objects/campaign.rb +257 -0
  26. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +8 -0
  27. data/lib/facebook_ads/ad_objects/event.rb +11 -0
  28. data/lib/facebook_ads/ad_objects/external_event_source.rb +1 -0
  29. data/lib/facebook_ads/ad_objects/group.rb +5 -0
  30. data/lib/facebook_ads/ad_objects/ig_media.rb +1 -0
  31. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +0 -1
  32. data/lib/facebook_ads/ad_objects/page.rb +5 -2
  33. data/lib/facebook_ads/ad_objects/page_admin_note.rb +1 -0
  34. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +3 -0
  35. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +2 -0
  36. data/lib/facebook_ads/ad_objects/{brand_audience.rb → payment_subscription.rb} +23 -9
  37. data/lib/facebook_ads/ad_objects/post.rb +1 -1
  38. data/lib/facebook_ads/ad_objects/product_catalog.rb +2 -0
  39. data/lib/facebook_ads/ad_objects/product_feed.rb +1 -0
  40. data/lib/facebook_ads/ad_objects/product_set.rb +3 -0
  41. data/lib/facebook_ads/ad_objects/{user_influence.rb → product_set_metadata.rb} +4 -4
  42. data/lib/facebook_ads/ad_objects/profile.rb +1 -0
  43. data/lib/facebook_ads/ad_objects/profile_picture_source.rb +4 -0
  44. data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
  45. data/lib/facebook_ads/ad_objects/server_side/content.rb +75 -13
  46. data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +24 -6
  47. data/lib/facebook_ads/ad_objects/server_side/event_request.rb +80 -6
  48. data/lib/facebook_ads/ad_objects/server_side/user_data.rb +126 -17
  49. data/lib/facebook_ads/ad_objects/server_side/util.rb +204 -150
  50. data/lib/facebook_ads/ad_objects/system_user.rb +5 -0
  51. data/lib/facebook_ads/ad_objects/targeting.rb +1 -0
  52. data/lib/facebook_ads/ad_objects/{creative_asset_tag.rb → targeting_relaxation.rb} +2 -2
  53. data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb +1 -0
  54. data/lib/facebook_ads/ad_objects/user.rb +8 -4
  55. data/lib/facebook_ads/ad_objects/user_taggable_friend.rb +1 -0
  56. data/lib/facebook_ads/ad_objects/{whats_app_business_profile.rb → work_meeting_link.rb} +3 -3
  57. data/lib/facebook_ads/version.rb +1 -1
  58. metadata +36 -16
  59. data/lib/facebook_ads/ad_objects/business_creative.rb +0 -50
  60. data/lib/facebook_ads/ad_objects/business_creative_folder.rb +0 -79
  61. data/lib/facebook_ads/ad_objects/business_creative_folder_sharing_agreement.rb +0 -46
  62. data/lib/facebook_ads/ad_objects/business_image.rb +0 -95
  63. data/lib/facebook_ads/ad_objects/client_transparency_status.rb +0 -40
  64. data/lib/facebook_ads/ad_objects/messenger_platform_referral.rb +0 -39
  65. data/lib/facebook_ads/ad_objects/streaming_reaction.rb +0 -51
@@ -29,9 +29,6 @@ module FacebookAds
29
29
  ADACCOUNT_TASKS = [
30
30
  "ADVERTISE",
31
31
  "ANALYZE",
32
- "CREATIVE",
33
- "DRAFT",
34
- "FB_EMPLOYEE_DSO_ADVERTISE",
35
32
  "MANAGE",
36
33
  ]
37
34
 
@@ -33,6 +33,11 @@ module FacebookAds
33
33
  "EMPLOYEE",
34
34
  "FINANCE_ANALYST",
35
35
  "FINANCE_EDITOR",
36
+ "PARTNER_CENTER_ADMIN",
37
+ "PARTNER_CENTER_ANALYST",
38
+ "PARTNER_CENTER_EDUCATION",
39
+ "PARTNER_CENTER_MARKETING",
40
+ "PARTNER_CENTER_OPERATIONS",
36
41
  ]
37
42
 
38
43
 
@@ -33,6 +33,11 @@ module FacebookAds
33
33
  "EMPLOYEE",
34
34
  "FINANCE_ANALYST",
35
35
  "FINANCE_EDITOR",
36
+ "PARTNER_CENTER_ADMIN",
37
+ "PARTNER_CENTER_ANALYST",
38
+ "PARTNER_CENTER_EDUCATION",
39
+ "PARTNER_CENTER_MARKETING",
40
+ "PARTNER_CENTER_OPERATIONS",
36
41
  ]
37
42
 
38
43
 
@@ -105,9 +105,264 @@ module FacebookAds
105
105
  "CREDIT",
106
106
  "EMPLOYMENT",
107
107
  "HOUSING",
108
+ "ISSUES_ELECTIONS_POLITICS",
108
109
  "NONE",
109
110
  ]
110
111
 
112
+ SPECIAL_AD_CATEGORY_COUNTRY = [
113
+ "AD",
114
+ "AE",
115
+ "AF",
116
+ "AG",
117
+ "AI",
118
+ "AL",
119
+ "AM",
120
+ "AN",
121
+ "AO",
122
+ "AQ",
123
+ "AR",
124
+ "AS",
125
+ "AT",
126
+ "AU",
127
+ "AW",
128
+ "AX",
129
+ "AZ",
130
+ "BA",
131
+ "BB",
132
+ "BD",
133
+ "BE",
134
+ "BF",
135
+ "BG",
136
+ "BH",
137
+ "BI",
138
+ "BJ",
139
+ "BL",
140
+ "BM",
141
+ "BN",
142
+ "BO",
143
+ "BQ",
144
+ "BR",
145
+ "BS",
146
+ "BT",
147
+ "BV",
148
+ "BW",
149
+ "BY",
150
+ "BZ",
151
+ "CA",
152
+ "CC",
153
+ "CD",
154
+ "CF",
155
+ "CG",
156
+ "CH",
157
+ "CI",
158
+ "CK",
159
+ "CL",
160
+ "CM",
161
+ "CN",
162
+ "CO",
163
+ "CR",
164
+ "CU",
165
+ "CV",
166
+ "CW",
167
+ "CX",
168
+ "CY",
169
+ "CZ",
170
+ "DE",
171
+ "DJ",
172
+ "DK",
173
+ "DM",
174
+ "DO",
175
+ "DZ",
176
+ "EC",
177
+ "EE",
178
+ "EG",
179
+ "EH",
180
+ "ER",
181
+ "ES",
182
+ "ET",
183
+ "FI",
184
+ "FJ",
185
+ "FK",
186
+ "FM",
187
+ "FO",
188
+ "FR",
189
+ "GA",
190
+ "GB",
191
+ "GD",
192
+ "GE",
193
+ "GF",
194
+ "GG",
195
+ "GH",
196
+ "GI",
197
+ "GL",
198
+ "GM",
199
+ "GN",
200
+ "GP",
201
+ "GQ",
202
+ "GR",
203
+ "GS",
204
+ "GT",
205
+ "GU",
206
+ "GW",
207
+ "GY",
208
+ "HK",
209
+ "HM",
210
+ "HN",
211
+ "HR",
212
+ "HT",
213
+ "HU",
214
+ "ID",
215
+ "IE",
216
+ "IL",
217
+ "IM",
218
+ "IN",
219
+ "IO",
220
+ "IQ",
221
+ "IR",
222
+ "IS",
223
+ "IT",
224
+ "JE",
225
+ "JM",
226
+ "JO",
227
+ "JP",
228
+ "KE",
229
+ "KG",
230
+ "KH",
231
+ "KI",
232
+ "KM",
233
+ "KN",
234
+ "KP",
235
+ "KR",
236
+ "KW",
237
+ "KY",
238
+ "KZ",
239
+ "LA",
240
+ "LB",
241
+ "LC",
242
+ "LI",
243
+ "LK",
244
+ "LR",
245
+ "LS",
246
+ "LT",
247
+ "LU",
248
+ "LV",
249
+ "LY",
250
+ "MA",
251
+ "MC",
252
+ "MD",
253
+ "ME",
254
+ "MF",
255
+ "MG",
256
+ "MH",
257
+ "MK",
258
+ "ML",
259
+ "MM",
260
+ "MN",
261
+ "MO",
262
+ "MP",
263
+ "MQ",
264
+ "MR",
265
+ "MS",
266
+ "MT",
267
+ "MU",
268
+ "MV",
269
+ "MW",
270
+ "MX",
271
+ "MY",
272
+ "MZ",
273
+ "NA",
274
+ "NC",
275
+ "NE",
276
+ "NF",
277
+ "NG",
278
+ "NI",
279
+ "NL",
280
+ "NO",
281
+ "NP",
282
+ "NR",
283
+ "NU",
284
+ "NZ",
285
+ "OM",
286
+ "PA",
287
+ "PE",
288
+ "PF",
289
+ "PG",
290
+ "PH",
291
+ "PK",
292
+ "PL",
293
+ "PM",
294
+ "PN",
295
+ "PR",
296
+ "PS",
297
+ "PT",
298
+ "PW",
299
+ "PY",
300
+ "QA",
301
+ "RE",
302
+ "RO",
303
+ "RS",
304
+ "RU",
305
+ "RW",
306
+ "SA",
307
+ "SB",
308
+ "SC",
309
+ "SD",
310
+ "SE",
311
+ "SG",
312
+ "SH",
313
+ "SI",
314
+ "SJ",
315
+ "SK",
316
+ "SL",
317
+ "SM",
318
+ "SN",
319
+ "SO",
320
+ "SR",
321
+ "SS",
322
+ "ST",
323
+ "SV",
324
+ "SX",
325
+ "SY",
326
+ "SZ",
327
+ "TC",
328
+ "TD",
329
+ "TF",
330
+ "TG",
331
+ "TH",
332
+ "TJ",
333
+ "TK",
334
+ "TL",
335
+ "TM",
336
+ "TN",
337
+ "TO",
338
+ "TR",
339
+ "TT",
340
+ "TV",
341
+ "TW",
342
+ "TZ",
343
+ "UA",
344
+ "UG",
345
+ "UM",
346
+ "US",
347
+ "UY",
348
+ "UZ",
349
+ "VA",
350
+ "VC",
351
+ "VE",
352
+ "VG",
353
+ "VI",
354
+ "VN",
355
+ "VU",
356
+ "WF",
357
+ "WS",
358
+ "XK",
359
+ "YE",
360
+ "YT",
361
+ "ZA",
362
+ "ZM",
363
+ "ZW",
364
+ ]
365
+
111
366
  OPERATOR = [
112
367
  "ALL",
113
368
  "ANY",
@@ -117,6 +372,7 @@ module FacebookAds
117
372
  "CREDIT",
118
373
  "EMPLOYMENT",
119
374
  "HOUSING",
375
+ "ISSUES_ELECTIONS_POLITICS",
120
376
  "NONE",
121
377
  ]
122
378
 
@@ -154,6 +410,7 @@ module FacebookAds
154
410
  field :source_campaign_id, 'string'
155
411
  field :special_ad_categories, { list: 'string' }
156
412
  field :special_ad_category, 'string'
413
+ field :special_ad_category_country, { list: 'string' }
157
414
  field :spend_cap, 'string'
158
415
  field :start_time, 'datetime'
159
416
  field :status, { enum: -> { STATUS }}
@@ -53,6 +53,7 @@ module FacebookAds
53
53
  field :supported_card_types, { list: 'string' }
54
54
  field :terms, 'string'
55
55
  field :terms_url_by_locale, 'hash'
56
+ field :whatsapp_channel, 'object'
56
57
  has_no_delete
57
58
 
58
59
  has_edge :facebook_channel do |edge|
@@ -95,5 +96,12 @@ module FacebookAds
95
96
  edge.get
96
97
  end
97
98
 
99
+ has_edge :whatsapp_channel do |edge|
100
+ edge.post do |api|
101
+ api.has_param :op, { enum: %w{ADD REMOVE }}
102
+ api.has_param :whatsapp_business_accounts, { list: 'string' }
103
+ end
104
+ end
105
+
98
106
  end
99
107
  end
@@ -54,8 +54,17 @@ module FacebookAds
54
54
  "WORKSHOP",
55
55
  ]
56
56
 
57
+ ONLINE_EVENT_FORMAT = [
58
+ "fb_live",
59
+ "messenger_room",
60
+ "none",
61
+ "other",
62
+ "third_party",
63
+ ]
64
+
57
65
  TYPE = [
58
66
  "community",
67
+ "friends",
59
68
  "group",
60
69
  "private",
61
70
  "public",
@@ -93,6 +102,8 @@ module FacebookAds
93
102
  field :maybe_count, 'int'
94
103
  field :name, 'string'
95
104
  field :noreply_count, 'int'
105
+ field :online_event_format, { enum: -> { ONLINE_EVENT_FORMAT }}
106
+ field :online_event_third_party_url, 'string'
96
107
  field :owner, 'object'
97
108
  field :parent_group, 'Group'
98
109
  field :place, 'Place'
@@ -30,6 +30,7 @@ module FacebookAds
30
30
  field :id, 'string'
31
31
  field :name, 'string'
32
32
  field :source_type, 'string'
33
+ has_no_get
33
34
  has_no_post
34
35
  has_no_delete
35
36
 
@@ -84,6 +84,7 @@ module FacebookAds
84
84
  "WORK_MENTORSHIP",
85
85
  "WORK_MULTI_COMPANY",
86
86
  "WORK_RECRUITING",
87
+ "WORK_RESUME_REVIEW",
87
88
  "WORK_SOCIAL",
88
89
  "WORK_TEAM",
89
90
  "WORK_TEAMWORK",
@@ -136,6 +137,7 @@ module FacebookAds
136
137
  "WORK_MENTORSHIP",
137
138
  "WORK_MULTI_COMPANY",
138
139
  "WORK_RECRUITING",
140
+ "WORK_RESUME_REVIEW",
139
141
  "WORK_SOCIAL",
140
142
  "WORK_TEAM",
141
143
  "WORK_TEAMWORK",
@@ -450,6 +452,7 @@ module FacebookAds
450
452
 
451
453
  has_edge :picture do |edge|
452
454
  edge.get 'ProfilePictureSource' do |api|
455
+ api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
453
456
  api.has_param :height, 'int'
454
457
  api.has_param :redirect, 'bool'
455
458
  api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
@@ -477,6 +480,7 @@ module FacebookAds
477
480
  api.has_param :composer_type, 'string'
478
481
  api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
479
482
  api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
483
+ api.has_param :creative_tools, 'string'
480
484
  api.has_param :description, 'string'
481
485
  api.has_param :embeddable, 'bool'
482
486
  api.has_param :end_offset, 'int'
@@ -532,6 +536,7 @@ module FacebookAds
532
536
  api.has_param :upload_session_id, 'string'
533
537
  api.has_param :upload_setting_properties, 'string'
534
538
  api.has_param :video_file_chunk, 'string'
539
+ api.has_param :video_id_original, 'string'
535
540
  api.has_param :video_start_time_ms, 'int'
536
541
  api.has_param :waterfall_id, 'string'
537
542
  end
@@ -27,6 +27,7 @@ module FacebookAds
27
27
 
28
28
  class IgMedia < AdObject
29
29
 
30
+ field :alt_text, 'string'
30
31
  field :caption, 'string'
31
32
  field :comments_count, 'int'
32
33
  field :id, 'string'
@@ -42,7 +42,6 @@ module FacebookAds
42
42
  field :metadata, 'object'
43
43
  field :title, 'string'
44
44
  field :universal_content_id, 'string'
45
- has_no_post
46
45
 
47
46
  end
48
47
  end
@@ -257,7 +257,6 @@ module FacebookAds
257
257
  "branded_camera",
258
258
  "category",
259
259
  "checkins",
260
- "commerce_order",
261
260
  "company_overview",
262
261
  "conversations",
263
262
  "culinary_team",
@@ -293,6 +292,7 @@ module FacebookAds
293
292
  "messaging_checkout_updates",
294
293
  "messaging_direct_sends",
295
294
  "messaging_fblogin_account_linking",
295
+ "messaging_feedback",
296
296
  "messaging_game_plays",
297
297
  "messaging_handovers",
298
298
  "messaging_optins",
@@ -1051,6 +1051,7 @@ module FacebookAds
1051
1051
 
1052
1052
  has_edge :nlp_configs do |edge|
1053
1053
  edge.post 'Page' do |api|
1054
+ api.has_param :api_version, 'object'
1054
1055
  api.has_param :custom_token, 'string'
1055
1056
  api.has_param :model, { enum: -> { Page::MODEL }}
1056
1057
  api.has_param :n_best, 'int'
@@ -1123,7 +1124,6 @@ module FacebookAds
1123
1124
  api.has_param :initial_view_heading_override_degrees, 'int'
1124
1125
  api.has_param :initial_view_pitch_override_degrees, 'int'
1125
1126
  api.has_param :initial_view_vertical_fov_override_degrees, 'int'
1126
- api.has_param :instagram_product_tags, { list: 'hash' }
1127
1127
  api.has_param :ios_bundle_id, 'string'
1128
1128
  api.has_param :is_explicit_location, 'bool'
1129
1129
  api.has_param :is_explicit_place, 'bool'
@@ -1167,6 +1167,7 @@ module FacebookAds
1167
1167
 
1168
1168
  has_edge :picture do |edge|
1169
1169
  edge.get 'ProfilePictureSource' do |api|
1170
+ api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
1170
1171
  api.has_param :height, 'int'
1171
1172
  api.has_param :redirect, 'bool'
1172
1173
  api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
@@ -1399,6 +1400,7 @@ module FacebookAds
1399
1400
  api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
1400
1401
  api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
1401
1402
  api.has_param :content_tags, { list: 'string' }
1403
+ api.has_param :creative_tools, 'string'
1402
1404
  api.has_param :crossposted_video_id, 'string'
1403
1405
  api.has_param :custom_labels, { list: 'string' }
1404
1406
  api.has_param :description, 'string'
@@ -1471,6 +1473,7 @@ module FacebookAds
1471
1473
  api.has_param :upload_setting_properties, 'string'
1472
1474
  api.has_param :video_asset_id, 'string'
1473
1475
  api.has_param :video_file_chunk, 'string'
1476
+ api.has_param :video_id_original, 'string'
1474
1477
  api.has_param :video_start_time_ms, 'int'
1475
1478
  api.has_param :waterfall_id, 'string'
1476
1479
  end