facebookbusiness 0.6.0.3 → 0.7.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +0 -1
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +8 -16
  4. data/lib/facebook_ads/ad_objects/ad_account_activity.rb +3 -5
  5. data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +0 -1
  6. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
  7. data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +1 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +4 -0
  9. data/lib/facebook_ads/ad_objects/ad_activity.rb +8 -0
  10. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +7 -0
  11. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +2 -2
  12. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
  13. data/lib/facebook_ads/ad_objects/ad_creative.rb +6 -3
  14. data/lib/facebook_ads/ad_objects/{user_influence.rb → ad_creative_ad_disclaimer.rb} +4 -4
  15. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +6 -0
  16. data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb +1 -0
  17. data/lib/facebook_ads/ad_objects/ad_customization_rule_spec.rb +2 -0
  18. data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +1 -0
  19. data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +1 -0
  20. data/lib/facebook_ads/ad_objects/ad_preview.rb +1 -0
  21. data/lib/facebook_ads/ad_objects/ad_report_run.rb +2 -0
  22. data/lib/facebook_ads/ad_objects/ad_set.rb +10 -2
  23. data/lib/facebook_ads/ad_objects/ad_study.rb +1 -0
  24. data/lib/facebook_ads/ad_objects/ad_video.rb +7 -26
  25. data/lib/facebook_ads/ad_objects/adgroup_activity.rb +4 -4
  26. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +5 -0
  27. data/lib/facebook_ads/ad_objects/{ads_interest.rb → adoptable_pet.rb} +18 -5
  28. data/lib/facebook_ads/ad_objects/ads_insights.rb +10 -0
  29. data/lib/facebook_ads/ad_objects/album.rb +7 -0
  30. data/lib/facebook_ads/ad_objects/application.rb +4 -12
  31. data/lib/facebook_ads/ad_objects/atlas_campaign.rb +2 -2
  32. data/lib/facebook_ads/ad_objects/automotive_model.rb +1 -0
  33. data/lib/facebook_ads/ad_objects/business.rb +24 -128
  34. data/lib/facebook_ads/ad_objects/{business_creative_folder_sharing_agreement.rb → business_agreement.rb} +2 -5
  35. data/lib/facebook_ads/ad_objects/business_asset_group.rb +0 -7
  36. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
  37. data/lib/facebook_ads/ad_objects/business_role_request.rb +6 -0
  38. data/lib/facebook_ads/ad_objects/business_user.rb +6 -0
  39. data/lib/facebook_ads/ad_objects/campaign.rb +267 -5
  40. data/lib/facebook_ads/ad_objects/{request_history.rb → catalog_item_app_links.rb} +9 -14
  41. data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb +1 -1
  42. data/lib/facebook_ads/ad_objects/comment.rb +1 -0
  43. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +107 -0
  44. data/lib/facebook_ads/ad_objects/commerce_merchant_settings_setup_status.rb +41 -0
  45. data/lib/facebook_ads/ad_objects/commerce_order.rb +147 -0
  46. data/lib/facebook_ads/ad_objects/{business_creative.rb → commerce_order_transaction_detail.rb} +10 -12
  47. data/lib/facebook_ads/ad_objects/{client_transparency_status.rb → commerce_payout.rb} +6 -5
  48. data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb +1 -0
  49. data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -4
  50. data/lib/facebook_ads/ad_objects/custom_conversion.rb +1 -0
  51. data/lib/facebook_ads/ad_objects/destination.rb +1 -0
  52. data/lib/facebook_ads/ad_objects/event.rb +11 -0
  53. data/lib/facebook_ads/ad_objects/external_event_source.rb +1 -0
  54. data/lib/facebook_ads/ad_objects/flight.rb +1 -0
  55. data/lib/facebook_ads/ad_objects/group.rb +7 -36
  56. data/lib/facebook_ads/ad_objects/home_listing.rb +1 -0
  57. data/lib/facebook_ads/ad_objects/hotel.rb +1 -1
  58. data/lib/facebook_ads/ad_objects/hotel_room.rb +1 -0
  59. data/lib/facebook_ads/ad_objects/ig_media.rb +1 -0
  60. data/lib/facebook_ads/ad_objects/ig_user.rb +2 -0
  61. data/lib/facebook_ads/ad_objects/life_event.rb +0 -4
  62. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +0 -1
  63. data/lib/facebook_ads/ad_objects/messenger_profile.rb +0 -1
  64. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +0 -6
  65. data/lib/facebook_ads/ad_objects/open_graph_context.rb +0 -12
  66. data/lib/facebook_ads/ad_objects/page.rb +50 -50
  67. data/lib/facebook_ads/ad_objects/page_admin_note.rb +1 -0
  68. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +12 -0
  69. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +2 -0
  70. data/lib/facebook_ads/ad_objects/page_post.rb +9 -0
  71. data/lib/facebook_ads/ad_objects/partner_study.rb +0 -4
  72. data/lib/facebook_ads/ad_objects/{brand_audience.rb → payment_subscription.rb} +23 -9
  73. data/lib/facebook_ads/ad_objects/post.rb +11 -2
  74. data/lib/facebook_ads/ad_objects/product_catalog.rb +12 -1
  75. data/lib/facebook_ads/ad_objects/product_feed.rb +2 -0
  76. data/lib/facebook_ads/ad_objects/product_feed_upload_diagnostics_report.rb +38 -0
  77. data/lib/facebook_ads/ad_objects/product_item.rb +1 -0
  78. data/lib/facebook_ads/ad_objects/product_set.rb +3 -0
  79. data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → product_set_metadata.rb} +3 -3
  80. data/lib/facebook_ads/ad_objects/profile.rb +2 -0
  81. data/lib/facebook_ads/ad_objects/profile_picture_source.rb +4 -0
  82. data/lib/facebook_ads/ad_objects/publisher_block_list.rb +0 -6
  83. data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +0 -4
  84. data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
  85. data/lib/facebook_ads/ad_objects/server_side/content.rb +75 -13
  86. data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +24 -6
  87. data/lib/facebook_ads/ad_objects/server_side/event.rb +62 -3
  88. data/lib/facebook_ads/ad_objects/server_side/event_request.rb +80 -6
  89. data/lib/facebook_ads/ad_objects/server_side/user_data.rb +132 -17
  90. data/lib/facebook_ads/ad_objects/server_side/util.rb +204 -150
  91. data/lib/facebook_ads/ad_objects/store_catalog_settings.rb +0 -1
  92. data/lib/facebook_ads/ad_objects/system_user.rb +6 -0
  93. data/lib/facebook_ads/ad_objects/targeting.rb +1 -0
  94. data/lib/facebook_ads/ad_objects/{creative_asset_tag.rb → targeting_relaxation.rb} +2 -2
  95. data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb +1 -0
  96. data/lib/facebook_ads/ad_objects/user.rb +6 -38
  97. data/lib/facebook_ads/ad_objects/user_taggable_friend.rb +1 -0
  98. data/lib/facebook_ads/ad_objects/vehicle.rb +1 -1
  99. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +1 -0
  100. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +4 -0
  101. data/lib/facebook_ads/ad_objects/{business_pixel_tos.rb → work_meeting_link.rb} +2 -2
  102. data/lib/facebook_ads/version.rb +2 -2
  103. metadata +45 -22
  104. data/lib/facebook_ads/ad_objects/business_creative_folder.rb +0 -79
  105. data/lib/facebook_ads/ad_objects/business_image.rb +0 -94
  106. data/lib/facebook_ads/ad_objects/instagram_comment.rb +0 -47
  107. data/lib/facebook_ads/ad_objects/messenger_platform_referral.rb +0 -39
  108. data/lib/facebook_ads/ad_objects/open_graph_object.rb +0 -70
  109. data/lib/facebook_ads/ad_objects/streaming_reaction.rb +0 -50
  110. data/lib/facebook_ads/ad_objects/video_game_show.rb +0 -43
  111. data/lib/facebook_ads/ad_objects/whats_app_business_profile.rb +0 -36
@@ -25,7 +25,7 @@ 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 BusinessCreativeFolderSharingAgreement < AdObject
28
+ class BusinessAgreement < AdObject
29
29
  REQUEST_STATUS = [
30
30
  "APPROVE",
31
31
  "DECLINE",
@@ -35,11 +35,8 @@ module FacebookAds
35
35
  ]
36
36
 
37
37
 
38
- field :folder_id, 'string'
39
38
  field :id, 'string'
40
- field :requesting_business, 'Business'
41
- field :status, 'string'
42
- has_no_post
39
+ field :request_status, 'string'
43
40
  has_no_delete
44
41
 
45
42
  end
@@ -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
 
@@ -54,10 +51,6 @@ module FacebookAds
54
51
  "MODERATE_COMMUNITY",
55
52
  "PAGES_MESSAGING",
56
53
  "PAGES_MESSAGING_SUBSCRIPTIONS",
57
- "PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES",
58
- "PLATFORM_PAGE_ADMINISTER",
59
- "PLATFORM_PAGE_BASIC_ADMIN",
60
- "PLATFORM_READ_INSIGHTS",
61
54
  "PROFILE_PLUS_ADVERTISE",
62
55
  "PROFILE_PLUS_ANALYZE",
63
56
  "PROFILE_PLUS_CREATE_CONTENT",
@@ -41,6 +41,7 @@ module FacebookAds
41
41
  field :requesting_business, 'Business'
42
42
  field :status, 'string'
43
43
  has_no_post
44
+ has_no_delete
44
45
 
45
46
  end
46
47
  end
@@ -29,9 +29,15 @@ module FacebookAds
29
29
  ROLE = [
30
30
  "ADMIN",
31
31
  "ADS_RIGHTS_REVIEWER",
32
+ "DEVELOPER",
32
33
  "EMPLOYEE",
33
34
  "FINANCE_ANALYST",
34
35
  "FINANCE_EDITOR",
36
+ "PARTNER_CENTER_ADMIN",
37
+ "PARTNER_CENTER_ANALYST",
38
+ "PARTNER_CENTER_EDUCATION",
39
+ "PARTNER_CENTER_MARKETING",
40
+ "PARTNER_CENTER_OPERATIONS",
35
41
  ]
36
42
 
37
43
 
@@ -29,9 +29,15 @@ module FacebookAds
29
29
  ROLE = [
30
30
  "ADMIN",
31
31
  "ADS_RIGHTS_REVIEWER",
32
+ "DEVELOPER",
32
33
  "EMPLOYEE",
33
34
  "FINANCE_ANALYST",
34
35
  "FINANCE_EDITOR",
36
+ "PARTNER_CENTER_ADMIN",
37
+ "PARTNER_CENTER_ANALYST",
38
+ "PARTNER_CENTER_EDUCATION",
39
+ "PARTNER_CENTER_MARKETING",
40
+ "PARTNER_CENTER_OPERATIONS",
35
41
  ]
36
42
 
37
43
 
@@ -97,21 +97,285 @@ module FacebookAds
97
97
  "POST_ENGAGEMENT",
98
98
  "PRODUCT_CATALOG_SALES",
99
99
  "REACH",
100
+ "STORE_VISITS",
100
101
  "VIDEO_VIEWS",
101
102
  ]
102
103
 
103
- SPECIAL_AD_CATEGORY = [
104
+ SPECIAL_AD_CATEGORIES = [
104
105
  "CREDIT",
105
106
  "EMPLOYMENT",
106
107
  "HOUSING",
108
+ "ISSUES_ELECTIONS_POLITICS",
107
109
  "NONE",
108
110
  ]
109
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
+
110
366
  OPERATOR = [
111
367
  "ALL",
112
368
  "ANY",
113
369
  ]
114
370
 
371
+ SPECIAL_AD_CATEGORY = [
372
+ "CREDIT",
373
+ "EMPLOYMENT",
374
+ "HOUSING",
375
+ "ISSUES_ELECTIONS_POLITICS",
376
+ "NONE",
377
+ ]
378
+
115
379
  STATUS_OPTION = [
116
380
  "ACTIVE",
117
381
  "INHERITED_FROM_SOURCE",
@@ -144,7 +408,9 @@ module FacebookAds
144
408
  field :recommendations, { list: 'AdRecommendation' }
145
409
  field :source_campaign, 'Campaign'
146
410
  field :source_campaign_id, 'string'
411
+ field :special_ad_categories, { list: 'string' }
147
412
  field :special_ad_category, 'string'
413
+ field :special_ad_category_country, { list: 'string' }
148
414
  field :spend_cap, 'string'
149
415
  field :start_time, 'datetime'
150
416
  field :status, { enum: -> { STATUS }}
@@ -175,10 +441,8 @@ module FacebookAds
175
441
 
176
442
  has_edge :ads do |edge|
177
443
  edge.get 'Ad' do |api|
178
- api.has_param :ad_draft_id, 'string'
179
444
  api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
180
445
  api.has_param :effective_status, { list: 'string' }
181
- api.has_param :include_drafts, 'bool'
182
446
  api.has_param :time_range, 'object'
183
447
  api.has_param :updated_since, 'int'
184
448
  end
@@ -186,10 +450,8 @@ module FacebookAds
186
450
 
187
451
  has_edge :adsets do |edge|
188
452
  edge.get 'AdSet' do |api|
189
- api.has_param :ad_draft_id, 'string'
190
453
  api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
191
454
  api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
192
- api.has_param :include_drafts, 'bool'
193
455
  api.has_param :is_completed, 'bool'
194
456
  api.has_param :time_range, 'object'
195
457
  end
@@ -25,21 +25,16 @@ 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 RequestHistory < AdObject
29
- HTTP_METHOD = [
30
- "DELETE",
31
- "GET",
32
- "POST",
33
- ]
28
+ class CatalogItemAppLinks < AdObject
34
29
 
35
-
36
- field :api_version, 'string'
37
- field :created_time, 'datetime'
38
- field :error_code, 'int'
39
- field :graph_path, 'string'
40
- field :http_method, { enum: -> { HTTP_METHOD }}
41
- field :post_params, 'hash'
42
- field :query_params, 'hash'
30
+ field :android, { list: 'AndroidAppLink' }
31
+ field :ios, { list: 'IosAppLink' }
32
+ field :ipad, { list: 'IosAppLink' }
33
+ field :iphone, { list: 'IosAppLink' }
34
+ field :web, 'WebAppLink'
35
+ field :windows, { list: 'WindowsAppLink' }
36
+ field :windows_phone, { list: 'WindowsPhoneAppLink' }
37
+ field :windows_universal, { list: 'WindowsAppLink' }
43
38
  has_no_id
44
39
  has_no_get
45
40
  has_no_post
@@ -30,7 +30,7 @@ module FacebookAds
30
30
  field :handle, 'string'
31
31
  field :item_id, 'int'
32
32
  field :status, 'string'
33
- field :use_cases, 'hash'
33
+ field :use_cases, { list: 'object' }
34
34
  has_no_id
35
35
  has_no_get
36
36
  has_no_post
@@ -106,6 +106,7 @@ module FacebookAds
106
106
  api.has_param :nectar_module, 'string'
107
107
  api.has_param :tracking, 'string'
108
108
  end
109
+ edge.get 'Profile'
109
110
  edge.post 'Comment' do |api|
110
111
  api.has_param :feedback_source, 'string'
111
112
  api.has_param :nectar_module, 'string'