facebookbusiness 0.13.0.0 → 18.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (549) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -2
  3. data/lib/facebook_ads/ad_object.rb +5 -17
  4. data/lib/facebook_ads/ad_objects/ad.rb +14 -22
  5. data/lib/facebook_ads/ad_objects/ad_account.rb +111 -59
  6. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +7 -17
  7. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +91 -17
  8. data/lib/facebook_ads/ad_objects/ad_account_business_constraints.rb +26 -0
  9. data/lib/facebook_ads/ad_objects/ad_account_default_destination.rb +5 -17
  10. data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb +21 -27
  11. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +10 -18
  12. data/lib/facebook_ads/ad_objects/ad_account_dsa_recommendations.rb +25 -0
  13. data/lib/facebook_ads/ad_objects/ad_account_ios_fourteen_campaign_limits.rb +5 -17
  14. data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +8 -17
  15. data/lib/facebook_ads/ad_objects/ad_account_max_bid.rb +5 -17
  16. data/lib/facebook_ads/ad_objects/ad_account_promotable_objects.rb +5 -17
  17. data/lib/facebook_ads/ad_objects/ad_account_reach_estimate.rb +5 -17
  18. data/lib/facebook_ads/ad_objects/ad_account_recommended_camapaign_budget.rb +5 -17
  19. data/lib/facebook_ads/ad_objects/ad_account_subscribed_apps.rb +5 -17
  20. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +275 -17
  21. data/lib/facebook_ads/ad_objects/ad_account_tracking_data.rb +5 -17
  22. data/lib/facebook_ads/ad_objects/ad_account_user.rb +5 -17
  23. data/lib/facebook_ads/ad_objects/ad_activity.rb +11 -17
  24. data/lib/facebook_ads/ad_objects/ad_asset_customization_rule_customization_spec.rb +39 -0
  25. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +20 -20
  26. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_asset_customization_rule.rb +37 -0
  27. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_asset_label.rb +5 -17
  28. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_body.rb +5 -17
  29. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_caption.rb +5 -17
  30. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_description.rb +5 -17
  31. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_group_rule.rb +5 -17
  32. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_image.rb +5 -17
  33. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_link_url.rb +5 -17
  34. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_title.rb +5 -17
  35. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_video.rb +5 -17
  36. data/lib/facebook_ads/ad_objects/ad_asset_message_extensions.rb +25 -0
  37. data/lib/facebook_ads/ad_objects/ad_asset_target_rule_targeting.rb +37 -0
  38. data/lib/facebook_ads/ad_objects/ad_async_request.rb +5 -17
  39. data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +5 -17
  40. data/lib/facebook_ads/ad_objects/ad_async_request_set_notification_result.rb +5 -17
  41. data/lib/facebook_ads/ad_objects/ad_bid_adjustments.rb +5 -17
  42. data/lib/facebook_ads/ad_objects/ad_campaign_bid_constraint.rb +5 -17
  43. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +10 -18
  44. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats_unsupported_reasons.rb +6 -18
  45. data/lib/facebook_ads/ad_objects/ad_campaign_frequency_control_specs.rb +5 -17
  46. data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb +5 -17
  47. data/lib/facebook_ads/ad_objects/ad_campaign_learning_stage_info.rb +5 -17
  48. data/lib/facebook_ads/ad_objects/ad_campaign_optimization_event.rb +5 -17
  49. data/lib/facebook_ads/ad_objects/ad_campaign_paced_bid_info.rb +5 -17
  50. data/lib/facebook_ads/ad_objects/ad_creative.rb +21 -24
  51. data/lib/facebook_ads/ad_objects/ad_creative_ad_disclaimer.rb +5 -17
  52. data/lib/facebook_ads/ad_objects/ad_creative_branded_content_ads.rb +30 -0
  53. data/lib/facebook_ads/ad_objects/ad_creative_collection_thumbnail_info.rb +5 -17
  54. data/lib/facebook_ads/ad_objects/ad_creative_degrees_of_freedom_spec.rb +32 -0
  55. data/lib/facebook_ads/ad_objects/ad_creative_facebook_branded_content.rb +27 -0
  56. data/lib/facebook_ads/ad_objects/ad_creative_feature_details.rb +25 -0
  57. data/lib/facebook_ads/ad_objects/ad_creative_features_spec.rb +51 -0
  58. data/lib/facebook_ads/ad_objects/ad_creative_insights.rb +6 -18
  59. data/lib/facebook_ads/ad_objects/ad_creative_instagram_branded_content.rb +25 -0
  60. data/lib/facebook_ads/ad_objects/ad_creative_interactive_components_spec.rb +5 -17
  61. data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +7 -23
  62. data/lib/facebook_ads/ad_objects/ad_creative_link_data_app_link_spec.rb +5 -17
  63. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +14 -18
  64. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +5 -17
  65. data/lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb +5 -17
  66. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_layer_spec.rb +5 -17
  67. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +6 -17
  68. data/lib/facebook_ads/ad_objects/ad_creative_link_data_sponsorship_info_spec.rb +5 -17
  69. data/lib/facebook_ads/ad_objects/ad_creative_link_data_template_video_spec.rb +6 -18
  70. data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +5 -17
  71. data/lib/facebook_ads/ad_objects/ad_creative_omnichannel_link_spec.rb +5 -17
  72. data/lib/facebook_ads/ad_objects/ad_creative_photo_data.rb +5 -17
  73. data/lib/facebook_ads/ad_objects/ad_creative_photo_data_media_elements.rb +5 -17
  74. data/lib/facebook_ads/ad_objects/ad_creative_place_data.rb +5 -17
  75. data/lib/facebook_ads/ad_objects/ad_creative_platform_customization.rb +5 -17
  76. data/lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb +5 -17
  77. data/lib/facebook_ads/ad_objects/ad_creative_post_click_configuration.rb +5 -17
  78. data/lib/facebook_ads/ad_objects/ad_creative_recommender_settings.rb +5 -17
  79. data/lib/facebook_ads/ad_objects/ad_creative_sourcing_spec.rb +25 -0
  80. data/lib/facebook_ads/ad_objects/ad_creative_static_fallback_spec.rb +5 -17
  81. data/lib/facebook_ads/ad_objects/ad_creative_template_url_spec.rb +5 -17
  82. data/lib/facebook_ads/ad_objects/ad_creative_text_data.rb +5 -17
  83. data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb +5 -17
  84. data/lib/facebook_ads/ad_objects/ad_customization_rule_spec.rb +5 -17
  85. data/lib/facebook_ads/ad_objects/ad_dynamic_creative.rb +5 -17
  86. data/lib/facebook_ads/ad_objects/ad_entity_target_spend.rb +5 -17
  87. data/lib/facebook_ads/ad_objects/ad_image.rb +7 -18
  88. data/lib/facebook_ads/ad_objects/ad_keywords.rb +5 -17
  89. data/lib/facebook_ads/ad_objects/ad_label.rb +5 -17
  90. data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +6 -17
  91. data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_result.rb +6 -17
  92. data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +6 -18
  93. data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +5 -17
  94. data/lib/facebook_ads/ad_objects/ad_place_page_set_metadata.rb +5 -17
  95. data/lib/facebook_ads/ad_objects/ad_placement.rb +6 -17
  96. data/lib/facebook_ads/ad_objects/ad_preview.rb +24 -18
  97. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +10 -17
  98. data/lib/facebook_ads/ad_objects/ad_recommendation.rb +5 -17
  99. data/lib/facebook_ads/ad_objects/ad_recommendation_data.rb +5 -17
  100. data/lib/facebook_ads/ad_objects/ad_report_run.rb +7 -19
  101. data/lib/facebook_ads/ad_objects/ad_rule.rb +12 -18
  102. data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb +5 -17
  103. data/lib/facebook_ads/ad_objects/ad_rule_execution_options.rb +5 -17
  104. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +6 -17
  105. data/lib/facebook_ads/ad_objects/ad_rule_filters.rb +5 -17
  106. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +7 -17
  107. data/lib/facebook_ads/ad_objects/ad_rule_history_result.rb +5 -17
  108. data/lib/facebook_ads/ad_objects/ad_rule_history_result_action.rb +5 -17
  109. data/lib/facebook_ads/ad_objects/ad_rule_schedule.rb +5 -17
  110. data/lib/facebook_ads/ad_objects/ad_rule_schedule_spec.rb +5 -17
  111. data/lib/facebook_ads/ad_objects/ad_rule_trigger.rb +5 -17
  112. data/lib/facebook_ads/ad_objects/ad_set.rb +42 -36
  113. data/lib/facebook_ads/ad_objects/ad_study.rb +19 -18
  114. data/lib/facebook_ads/ad_objects/ad_study_cell.rb +6 -17
  115. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +13 -17
  116. data/lib/facebook_ads/ad_objects/ad_study_objective_id.rb +5 -17
  117. data/lib/facebook_ads/ad_objects/ad_study_objective_offsite_datasets.rb +5 -17
  118. data/lib/facebook_ads/ad_objects/ad_video.rb +71 -23
  119. data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb +5 -17
  120. data/lib/facebook_ads/ad_objects/adgroup_metadata.rb +29 -0
  121. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +6 -17
  122. data/lib/facebook_ads/ad_objects/adgroup_review_feedback.rb +5 -17
  123. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +6 -17
  124. data/lib/facebook_ads/ad_objects/ads_histogram_stats.rb +56 -0
  125. data/lib/facebook_ads/ad_objects/ads_image_crops.rb +5 -17
  126. data/lib/facebook_ads/ad_objects/ads_insights.rb +39 -26
  127. data/lib/facebook_ads/ad_objects/ads_optimal_delivery_growth_opportunity.rb +6 -18
  128. data/lib/facebook_ads/ad_objects/ads_pixel.rb +58 -18
  129. data/lib/facebook_ads/ad_objects/ads_pixel_stats.rb +5 -17
  130. data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb +5 -17
  131. data/lib/facebook_ads/ad_objects/age_range.rb +5 -17
  132. data/lib/facebook_ads/ad_objects/agency_client_declaration.rb +5 -17
  133. data/lib/facebook_ads/ad_objects/album.rb +7 -19
  134. data/lib/facebook_ads/ad_objects/android_app_link.rb +5 -17
  135. data/lib/facebook_ads/ad_objects/app_request.rb +5 -17
  136. data/lib/facebook_ads/ad_objects/app_request_former_recipient.rb +5 -17
  137. data/lib/facebook_ads/ad_objects/application.rb +55 -75
  138. data/lib/facebook_ads/ad_objects/assigned_user.rb +5 -17
  139. data/lib/facebook_ads/ad_objects/async_request.rb +5 -17
  140. data/lib/facebook_ads/ad_objects/async_session.rb +5 -17
  141. data/lib/facebook_ads/ad_objects/attribution_spec.rb +5 -17
  142. data/lib/facebook_ads/ad_objects/audience_permission_for_actions.rb +5 -17
  143. data/lib/facebook_ads/ad_objects/audio_copyright.rb +9 -17
  144. data/lib/facebook_ads/ad_objects/automotive_model.rb +10 -42
  145. data/lib/facebook_ads/ad_objects/avatar.rb +34 -0
  146. data/lib/facebook_ads/ad_objects/avatar_profile_picture.rb +24 -0
  147. data/lib/facebook_ads/ad_objects/brand_request.rb +43 -0
  148. data/lib/facebook_ads/ad_objects/brand_safety_block_list_usage.rb +5 -17
  149. data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +5 -17
  150. data/lib/facebook_ads/ad_objects/business.rb +416 -45
  151. data/lib/facebook_ads/ad_objects/business_ad_account_request.rb +5 -17
  152. data/lib/facebook_ads/ad_objects/business_application_request.rb +5 -17
  153. data/lib/facebook_ads/ad_objects/business_asset_group.rb +8 -17
  154. data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +7 -17
  155. data/lib/facebook_ads/ad_objects/business_creative_folder.rb +31 -0
  156. data/lib/facebook_ads/ad_objects/business_image.rb +35 -17
  157. data/lib/facebook_ads/ad_objects/business_managed_partner_eligibility.rb +5 -17
  158. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +7 -17
  159. data/lib/facebook_ads/ad_objects/business_page_request.rb +5 -17
  160. data/lib/facebook_ads/ad_objects/business_partner_premium_options.rb +27 -0
  161. data/lib/facebook_ads/ad_objects/business_role_request.rb +5 -17
  162. data/lib/facebook_ads/ad_objects/business_user.rb +9 -18
  163. data/lib/facebook_ads/ad_objects/business_video.rb +27 -0
  164. data/lib/facebook_ads/ad_objects/campaign.rb +28 -35
  165. data/lib/facebook_ads/ad_objects/campaign_group_brand_configuration.rb +5 -17
  166. data/lib/facebook_ads/ad_objects/campaign_group_collaborative_ads_partner_info.rb +5 -17
  167. data/lib/facebook_ads/ad_objects/canvas.rb +7 -18
  168. data/lib/facebook_ads/ad_objects/canvas_ad_settings.rb +5 -17
  169. data/lib/facebook_ads/ad_objects/canvas_body_element.rb +5 -17
  170. data/lib/facebook_ads/ad_objects/canvas_collection_thumbnail.rb +5 -17
  171. data/lib/facebook_ads/ad_objects/canvas_dynamic_setting.rb +25 -0
  172. data/lib/facebook_ads/ad_objects/catalog_based_targeting.rb +5 -17
  173. data/lib/facebook_ads/ad_objects/catalog_item_app_links.rb +5 -17
  174. data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb +14 -18
  175. data/lib/facebook_ads/ad_objects/catalog_item_channels_to_integrity_status.rb +5 -17
  176. data/lib/facebook_ads/ad_objects/catalog_segment_all_match_count_laser.rb +30 -0
  177. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +5 -17
  178. data/lib/facebook_ads/ad_objects/chat_plugin.rb +5 -17
  179. data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +11 -17
  180. data/lib/facebook_ads/ad_objects/child_event.rb +5 -17
  181. data/lib/facebook_ads/ad_objects/cloud_game.rb +5 -17
  182. data/lib/facebook_ads/ad_objects/collaborative_ads_partner_info_list_item.rb +5 -17
  183. data/lib/facebook_ads/ad_objects/collaborative_ads_share_settings.rb +6 -17
  184. data/lib/facebook_ads/ad_objects/comment.rb +6 -18
  185. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +18 -20
  186. data/lib/facebook_ads/ad_objects/commerce_merchant_settings_setup_status.rb +5 -17
  187. data/lib/facebook_ads/ad_objects/commerce_order.rb +13 -17
  188. data/lib/facebook_ads/ad_objects/commerce_order_transaction_detail.rb +5 -17
  189. data/lib/facebook_ads/ad_objects/commerce_payout.rb +5 -17
  190. data/lib/facebook_ads/ad_objects/commerce_settings.rb +5 -17
  191. data/lib/facebook_ads/ad_objects/connections_targeting.rb +5 -17
  192. data/lib/facebook_ads/ad_objects/content_publishing_limit_response.rb +26 -0
  193. data/lib/facebook_ads/ad_objects/contextual_bundling_spec.rb +5 -17
  194. data/lib/facebook_ads/ad_objects/conversion_action_query.rb +5 -17
  195. data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +5 -17
  196. data/lib/facebook_ads/ad_objects/cover_photo.rb +5 -17
  197. data/lib/facebook_ads/ad_objects/cpas_advertiser_partnership_recommendation.rb +5 -17
  198. data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +8 -19
  199. data/lib/facebook_ads/ad_objects/cpas_collaboration_request.rb +5 -17
  200. data/lib/facebook_ads/ad_objects/cpas_merchant_config.rb +7 -19
  201. data/lib/facebook_ads/ad_objects/creative_history.rb +5 -17
  202. data/lib/facebook_ads/ad_objects/credit_card.rb +43 -0
  203. data/lib/facebook_ads/ad_objects/credit_partition_action_options.rb +5 -17
  204. data/lib/facebook_ads/ad_objects/crm_address.rb +36 -0
  205. data/lib/facebook_ads/ad_objects/ctx_partner_app_welcome_message_flow.rb +29 -0
  206. data/lib/facebook_ads/ad_objects/currency.rb +5 -17
  207. data/lib/facebook_ads/ad_objects/currency_amount.rb +5 -17
  208. data/lib/facebook_ads/ad_objects/custom_audience.rb +11 -17
  209. data/lib/facebook_ads/ad_objects/custom_audience_ad_account.rb +5 -17
  210. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +9 -17
  211. data/lib/facebook_ads/ad_objects/custom_audience_group.rb +27 -0
  212. data/lib/facebook_ads/ad_objects/custom_audience_session.rb +5 -17
  213. data/lib/facebook_ads/ad_objects/custom_audience_sharing_status.rb +5 -17
  214. data/lib/facebook_ads/ad_objects/custom_audience_status.rb +5 -17
  215. data/lib/facebook_ads/ad_objects/custom_audiences_tos.rb +5 -17
  216. data/lib/facebook_ads/ad_objects/custom_audienceshared_account_info.rb +5 -17
  217. data/lib/facebook_ads/ad_objects/custom_conversion.rb +5 -17
  218. data/lib/facebook_ads/ad_objects/custom_conversion_stats_result.rb +5 -17
  219. data/lib/facebook_ads/ad_objects/custom_user_settings.rb +5 -17
  220. data/lib/facebook_ads/ad_objects/da_check.rb +5 -17
  221. data/lib/facebook_ads/ad_objects/dataset.rb +24 -0
  222. data/lib/facebook_ads/ad_objects/day_part.rb +5 -17
  223. data/lib/facebook_ads/ad_objects/delivery_check.rb +5 -17
  224. data/lib/facebook_ads/ad_objects/delivery_check_extra_info.rb +5 -17
  225. data/lib/facebook_ads/ad_objects/delivery_window.rb +5 -17
  226. data/lib/facebook_ads/ad_objects/destination.rb +12 -18
  227. data/lib/facebook_ads/ad_objects/destination_catalog_settings.rb +5 -17
  228. data/lib/facebook_ads/ad_objects/dynamic_post_child_attachment.rb +5 -17
  229. data/lib/facebook_ads/ad_objects/dynamic_price_config_by_date.rb +5 -17
  230. data/lib/facebook_ads/ad_objects/dynamic_video_metadata.rb +26 -0
  231. data/lib/facebook_ads/ad_objects/engagement.rb +5 -17
  232. data/lib/facebook_ads/ad_objects/entity_at_text_range.rb +5 -17
  233. data/lib/facebook_ads/ad_objects/event.rb +35 -52
  234. data/lib/facebook_ads/ad_objects/event_source_group.rb +6 -17
  235. data/lib/facebook_ads/ad_objects/experience.rb +6 -18
  236. data/lib/facebook_ads/ad_objects/extended_credit.rb +8 -17
  237. data/lib/facebook_ads/ad_objects/extended_credit_allocation_config.rb +6 -17
  238. data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +8 -17
  239. data/lib/facebook_ads/ad_objects/external_event_source.rb +5 -17
  240. data/lib/facebook_ads/ad_objects/fame_export_config.rb +5 -17
  241. data/lib/facebook_ads/ad_objects/flexible_targeting.rb +5 -17
  242. data/lib/facebook_ads/ad_objects/flight.rb +12 -18
  243. data/lib/facebook_ads/ad_objects/funding_source_details.rb +5 -17
  244. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +5 -17
  245. data/lib/facebook_ads/ad_objects/fundraiser_person_to_charity.rb +9 -17
  246. data/lib/facebook_ads/ad_objects/game_item.rb +36 -0
  247. data/lib/facebook_ads/ad_objects/group.rb +12 -96
  248. data/lib/facebook_ads/ad_objects/has_lead_access.rb +33 -0
  249. data/lib/facebook_ads/ad_objects/helpers/custom_audience_helpers.rb +7 -19
  250. data/lib/facebook_ads/ad_objects/high_demand_period.rb +33 -0
  251. data/lib/facebook_ads/ad_objects/high_demand_period_time_suggestion_weekly_segment.rb +28 -0
  252. data/lib/facebook_ads/ad_objects/home_listing.rb +16 -19
  253. data/lib/facebook_ads/ad_objects/hotel.rb +12 -18
  254. data/lib/facebook_ads/ad_objects/hotel_room.rb +6 -17
  255. data/lib/facebook_ads/ad_objects/id_name.rb +5 -17
  256. data/lib/facebook_ads/ad_objects/ig_comment.rb +6 -18
  257. data/lib/facebook_ads/ad_objects/ig_comment_from_user.rb +25 -0
  258. data/lib/facebook_ads/ad_objects/ig_media.rb +24 -17
  259. data/lib/facebook_ads/ad_objects/ig_shopping_product_appeal.rb +29 -0
  260. data/lib/facebook_ads/ad_objects/ig_shopping_review_status.rb +27 -0
  261. data/lib/facebook_ads/ad_objects/ig_shopping_review_status_onsite_eligibility.rb +26 -0
  262. data/lib/facebook_ads/ad_objects/ig_shopping_review_status_reason_with_help_message.rb +27 -0
  263. data/lib/facebook_ads/ad_objects/ig_user.rb +46 -19
  264. data/lib/facebook_ads/ad_objects/ig_video_copyright_check_matches_information.rb +26 -0
  265. data/lib/facebook_ads/ad_objects/ig_video_copyright_check_status.rb +26 -0
  266. data/lib/facebook_ads/ad_objects/igbc_ads_permission.rb +25 -0
  267. data/lib/facebook_ads/ad_objects/image_copyright.rb +6 -17
  268. data/lib/facebook_ads/ad_objects/insights_result.rb +6 -17
  269. data/lib/facebook_ads/ad_objects/instagram_carousel.rb +40 -0
  270. data/lib/facebook_ads/ad_objects/instagram_comment.rb +36 -0
  271. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +36 -17
  272. data/lib/facebook_ads/ad_objects/instagram_insights_value.rb +5 -17
  273. data/lib/facebook_ads/ad_objects/instagram_media.rb +45 -0
  274. data/lib/facebook_ads/ad_objects/instagram_shopping_merchant_review_message.rb +26 -0
  275. data/lib/facebook_ads/ad_objects/instagram_user.rb +10 -17
  276. data/lib/facebook_ads/ad_objects/instagram_video_metadata.rb +27 -0
  277. data/lib/facebook_ads/ad_objects/instant_articles_stats.rb +8 -20
  278. data/lib/facebook_ads/ad_objects/ios_app_link.rb +5 -17
  279. data/lib/facebook_ads/ad_objects/job_opening.rb +79 -0
  280. data/lib/facebook_ads/ad_objects/key_value.rb +5 -17
  281. data/lib/facebook_ads/ad_objects/lead.rb +7 -17
  282. data/lib/facebook_ads/ad_objects/lead_gen_appointment_booking_info.rb +6 -18
  283. data/lib/facebook_ads/ad_objects/lead_gen_appointment_slots_by_day.rb +26 -0
  284. data/lib/facebook_ads/ad_objects/lead_gen_appointment_time_slot.rb +26 -0
  285. data/lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group_choices.rb +5 -17
  286. data/lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group_questions.rb +5 -17
  287. data/lib/facebook_ads/ad_objects/lead_gen_context_card.rb +29 -0
  288. data/lib/facebook_ads/ad_objects/lead_gen_custom_disclaimer.rb +27 -0
  289. data/lib/facebook_ads/ad_objects/lead_gen_custom_disclaimer_body.rb +26 -0
  290. data/lib/facebook_ads/ad_objects/lead_gen_draft_question.rb +5 -17
  291. data/lib/facebook_ads/ad_objects/lead_gen_legal_content.rb +26 -0
  292. data/lib/facebook_ads/ad_objects/lead_gen_legal_content_checkbox.rb +28 -0
  293. data/lib/facebook_ads/ad_objects/lead_gen_post_submission_check_result.rb +5 -17
  294. data/lib/facebook_ads/ad_objects/lead_gen_privacy_policy.rb +26 -0
  295. data/lib/facebook_ads/ad_objects/lead_gen_question.rb +5 -17
  296. data/lib/facebook_ads/ad_objects/lead_gen_question_option.rb +5 -17
  297. data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page.rb +34 -0
  298. data/lib/facebook_ads/ad_objects/lead_gen_url_entity_at_ranges.rb +27 -0
  299. data/lib/facebook_ads/ad_objects/leadgen_form.rb +11 -21
  300. data/lib/facebook_ads/ad_objects/life_event.rb +5 -17
  301. data/lib/facebook_ads/ad_objects/link.rb +5 -17
  302. data/lib/facebook_ads/ad_objects/live_video.rb +24 -36
  303. data/lib/facebook_ads/ad_objects/live_video_ad_break_config.rb +5 -17
  304. data/lib/facebook_ads/ad_objects/live_video_error.rb +5 -17
  305. data/lib/facebook_ads/ad_objects/live_video_input_stream.rb +5 -17
  306. data/lib/facebook_ads/ad_objects/live_video_recommended_encoder_settings.rb +5 -17
  307. data/lib/facebook_ads/ad_objects/live_video_targeting.rb +5 -17
  308. data/lib/facebook_ads/ad_objects/local_service_business.rb +19 -17
  309. data/lib/facebook_ads/ad_objects/location.rb +5 -17
  310. data/lib/facebook_ads/ad_objects/lookalike_spec.rb +5 -17
  311. data/lib/facebook_ads/ad_objects/mailing_address.rb +5 -17
  312. data/lib/facebook_ads/ad_objects/managed_partner_business.rb +6 -18
  313. data/lib/facebook_ads/ad_objects/managed_partner_extended_credit.rb +26 -0
  314. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +5 -17
  315. data/lib/facebook_ads/ad_objects/media_title.rb +73 -0
  316. data/lib/facebook_ads/ad_objects/messaging_feature_review.rb +5 -17
  317. data/lib/facebook_ads/ad_objects/messaging_feature_status.rb +7 -17
  318. data/lib/facebook_ads/ad_objects/messenger_ads_partial_automated_step_list.rb +33 -0
  319. data/lib/facebook_ads/ad_objects/messenger_profile.rb +5 -17
  320. data/lib/facebook_ads/ad_objects/minimum_budget.rb +5 -17
  321. data/lib/facebook_ads/ad_objects/music_video_copyright.rb +5 -17
  322. data/lib/facebook_ads/ad_objects/null_node.rb +5 -17
  323. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +31 -25
  324. data/lib/facebook_ads/ad_objects/offline_conversion_data_set_permissions.rb +5 -17
  325. data/lib/facebook_ads/ad_objects/offline_conversion_data_set_upload.rb +5 -17
  326. data/lib/facebook_ads/ad_objects/offline_conversion_data_set_usage.rb +5 -17
  327. data/lib/facebook_ads/ad_objects/offsite_pixel.rb +5 -17
  328. data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +5 -17
  329. data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb +29 -0
  330. data/lib/facebook_ads/ad_objects/open_graph_context.rb +5 -17
  331. data/lib/facebook_ads/ad_objects/outcome_prediction_point.rb +5 -17
  332. data/lib/facebook_ads/ad_objects/page.rb +219 -118
  333. data/lib/facebook_ads/ad_objects/page_about_story.rb +29 -0
  334. data/lib/facebook_ads/ad_objects/page_about_story_composed_block.rb +29 -0
  335. data/lib/facebook_ads/ad_objects/page_about_story_composed_block_entity_ranges.rb +27 -0
  336. data/lib/facebook_ads/ad_objects/page_about_story_composed_block_inline_style.rb +27 -0
  337. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +5 -17
  338. data/lib/facebook_ads/ad_objects/page_category.rb +5 -17
  339. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +5 -17
  340. data/lib/facebook_ads/ad_objects/page_commerce_eligibility.rb +5 -17
  341. data/lib/facebook_ads/ad_objects/page_parking.rb +5 -17
  342. data/lib/facebook_ads/ad_objects/page_payment_options.rb +5 -17
  343. data/lib/facebook_ads/ad_objects/page_post.rb +8 -20
  344. data/lib/facebook_ads/ad_objects/page_post_experiment.rb +56 -0
  345. data/lib/facebook_ads/ad_objects/page_restaurant_services.rb +5 -17
  346. data/lib/facebook_ads/ad_objects/page_restaurant_specialties.rb +5 -17
  347. data/lib/facebook_ads/ad_objects/page_saved_filter.rb +5 -17
  348. data/lib/facebook_ads/ad_objects/page_settings.rb +5 -17
  349. data/lib/facebook_ads/ad_objects/page_start_info.rb +5 -17
  350. data/lib/facebook_ads/ad_objects/page_thread_owner.rb +5 -17
  351. data/lib/facebook_ads/ad_objects/page_upcoming_change.rb +6 -17
  352. data/lib/facebook_ads/ad_objects/page_user_message_thread_label.rb +5 -17
  353. data/lib/facebook_ads/ad_objects/partner_study.rb +5 -17
  354. data/lib/facebook_ads/ad_objects/payment_engine_payment.rb +5 -17
  355. data/lib/facebook_ads/ad_objects/payment_pricepoints.rb +5 -17
  356. data/lib/facebook_ads/ad_objects/payment_subscription.rb +5 -17
  357. data/lib/facebook_ads/ad_objects/permission.rb +5 -17
  358. data/lib/facebook_ads/ad_objects/persona.rb +5 -17
  359. data/lib/facebook_ads/ad_objects/photo.rb +5 -17
  360. data/lib/facebook_ads/ad_objects/place.rb +5 -17
  361. data/lib/facebook_ads/ad_objects/place_topic.rb +5 -17
  362. data/lib/facebook_ads/ad_objects/platform_image_source.rb +5 -17
  363. data/lib/facebook_ads/ad_objects/playable_content.rb +5 -17
  364. data/lib/facebook_ads/ad_objects/post.rb +9 -28
  365. data/lib/facebook_ads/ad_objects/privacy.rb +5 -17
  366. data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +10 -17
  367. data/lib/facebook_ads/ad_objects/product_catalog.rb +33 -57
  368. data/lib/facebook_ads/ad_objects/product_catalog_category.rb +6 -18
  369. data/lib/facebook_ads/ad_objects/product_catalog_data_source.rb +34 -0
  370. data/lib/facebook_ads/ad_objects/product_catalog_diagnostic_group.rb +23 -17
  371. data/lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb +5 -17
  372. data/lib/facebook_ads/ad_objects/product_catalog_image_settings.rb +5 -17
  373. data/lib/facebook_ads/ad_objects/product_catalog_image_settings_operation.rb +5 -17
  374. data/lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb +5 -17
  375. data/lib/facebook_ads/ad_objects/product_catalog_product_sets_batch.rb +5 -17
  376. data/lib/facebook_ads/ad_objects/product_event_stat.rb +5 -17
  377. data/lib/facebook_ads/ad_objects/product_feed.rb +24 -27
  378. data/lib/facebook_ads/ad_objects/product_feed_missing_feed_item_replacement.rb +5 -18
  379. data/lib/facebook_ads/ad_objects/product_feed_rule.rb +14 -18
  380. data/lib/facebook_ads/ad_objects/product_feed_rule_suggestion.rb +6 -18
  381. data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +6 -28
  382. data/lib/facebook_ads/ad_objects/product_feed_upload.rb +8 -18
  383. data/lib/facebook_ads/ad_objects/product_feed_upload_error.rb +11 -17
  384. data/lib/facebook_ads/ad_objects/product_feed_upload_error_report.rb +5 -17
  385. data/lib/facebook_ads/ad_objects/product_feed_upload_error_sample.rb +5 -17
  386. data/lib/facebook_ads/ad_objects/product_group.rb +12 -24
  387. data/lib/facebook_ads/ad_objects/product_image.rb +7 -17
  388. data/lib/facebook_ads/ad_objects/product_item.rb +135 -23
  389. data/lib/facebook_ads/ad_objects/product_item_commerce_insights.rb +5 -17
  390. data/lib/facebook_ads/ad_objects/product_item_error.rb +28 -0
  391. data/lib/facebook_ads/ad_objects/product_item_importer_address.rb +5 -17
  392. data/lib/facebook_ads/ad_objects/product_item_local_info.rb +31 -0
  393. data/lib/facebook_ads/ad_objects/product_item_local_info_lat_long_shape.rb +26 -0
  394. data/lib/facebook_ads/ad_objects/product_set.rb +14 -17
  395. data/lib/facebook_ads/ad_objects/product_set_metadata.rb +5 -17
  396. data/lib/facebook_ads/ad_objects/product_variant.rb +5 -17
  397. data/lib/facebook_ads/ad_objects/profile.rb +5 -17
  398. data/lib/facebook_ads/ad_objects/profile_picture_source.rb +5 -17
  399. data/lib/facebook_ads/ad_objects/publisher_block_list.rb +5 -17
  400. data/lib/facebook_ads/ad_objects/raw_custom_audience.rb +5 -17
  401. data/lib/facebook_ads/ad_objects/reach_frequency_activity.rb +5 -17
  402. data/lib/facebook_ads/ad_objects/reach_frequency_ad_format.rb +5 -17
  403. data/lib/facebook_ads/ad_objects/reach_frequency_curve_lower_confidence_range.rb +5 -17
  404. data/lib/facebook_ads/ad_objects/reach_frequency_curve_upper_confidence_range.rb +5 -17
  405. data/lib/facebook_ads/ad_objects/reach_frequency_day_part.rb +5 -17
  406. data/lib/facebook_ads/ad_objects/reach_frequency_estimates_curve.rb +5 -17
  407. data/lib/facebook_ads/ad_objects/reach_frequency_estimates_placement_breakdown.rb +9 -17
  408. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +16 -21
  409. data/lib/facebook_ads/ad_objects/reach_frequency_spec.rb +5 -17
  410. data/lib/facebook_ads/ad_objects/recommendation.rb +5 -17
  411. data/lib/facebook_ads/ad_objects/rev_share_policy.rb +5 -17
  412. data/lib/facebook_ads/ad_objects/rich_media_element.rb +5 -17
  413. data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +5 -17
  414. data/lib/facebook_ads/ad_objects/saved_audience.rb +6 -18
  415. data/lib/facebook_ads/ad_objects/saved_message_response.rb +5 -17
  416. data/lib/facebook_ads/ad_objects/security_settings.rb +5 -17
  417. data/lib/facebook_ads/ad_objects/server_side/app_data.rb +269 -0
  418. data/lib/facebook_ads/ad_objects/server_side/event.rb +44 -4
  419. data/lib/facebook_ads/ad_objects/server_side/event_request.rb +10 -2
  420. data/lib/facebook_ads/ad_objects/server_side/extended_device_info.rb +344 -0
  421. data/lib/facebook_ads/ad_objects/server_side/user_data.rb +67 -2
  422. data/lib/facebook_ads/ad_objects/shadow_ig_hashtag.rb +36 -0
  423. data/lib/facebook_ads/ad_objects/shadow_ig_media_builder.rb +26 -0
  424. data/lib/facebook_ads/ad_objects/shadow_ig_media_collaborators.rb +26 -0
  425. data/lib/facebook_ads/ad_objects/shadow_ig_media_product_tags.rb +35 -0
  426. data/lib/facebook_ads/ad_objects/shadow_ig_user_catalog_product_search.rb +32 -0
  427. data/lib/facebook_ads/ad_objects/shadow_ig_user_catalog_product_variant.rb +26 -0
  428. data/lib/facebook_ads/ad_objects/shop.rb +8 -17
  429. data/lib/facebook_ads/ad_objects/split_test_winner.rb +6 -18
  430. data/lib/facebook_ads/ad_objects/store_catalog_settings.rb +6 -17
  431. data/lib/facebook_ads/ad_objects/stories.rb +35 -0
  432. data/lib/facebook_ads/ad_objects/system_user.rb +8 -18
  433. data/lib/facebook_ads/ad_objects/tab.rb +5 -17
  434. data/lib/facebook_ads/ad_objects/targeting.rb +6 -17
  435. data/lib/facebook_ads/ad_objects/targeting_dynamic_rule.rb +5 -17
  436. data/lib/facebook_ads/ad_objects/targeting_geo_location.rb +5 -17
  437. data/lib/facebook_ads/ad_objects/targeting_geo_location_city.rb +5 -17
  438. data/lib/facebook_ads/ad_objects/targeting_geo_location_custom_location.rb +5 -17
  439. data/lib/facebook_ads/ad_objects/targeting_geo_location_electoral_district.rb +6 -17
  440. data/lib/facebook_ads/ad_objects/targeting_geo_location_geo_entities.rb +5 -17
  441. data/lib/facebook_ads/ad_objects/targeting_geo_location_location_cluster.rb +5 -17
  442. data/lib/facebook_ads/ad_objects/targeting_geo_location_location_expansion.rb +5 -17
  443. data/lib/facebook_ads/ad_objects/targeting_geo_location_market.rb +5 -17
  444. data/lib/facebook_ads/ad_objects/targeting_geo_location_place.rb +5 -17
  445. data/lib/facebook_ads/ad_objects/targeting_geo_location_political_district.rb +5 -17
  446. data/lib/facebook_ads/ad_objects/targeting_geo_location_region.rb +5 -17
  447. data/lib/facebook_ads/ad_objects/targeting_geo_location_zip.rb +5 -17
  448. data/lib/facebook_ads/ad_objects/targeting_product_audience_spec.rb +5 -17
  449. data/lib/facebook_ads/ad_objects/targeting_product_audience_sub_spec.rb +5 -17
  450. data/lib/facebook_ads/ad_objects/targeting_prospecting_audience.rb +5 -17
  451. data/lib/facebook_ads/ad_objects/targeting_relaxation.rb +6 -17
  452. data/lib/facebook_ads/ad_objects/targeting_sentence_line.rb +5 -17
  453. data/lib/facebook_ads/ad_objects/text_with_entities.rb +5 -17
  454. data/lib/facebook_ads/ad_objects/tracking_and_conversion_with_defaults.rb +5 -17
  455. data/lib/facebook_ads/ad_objects/unified_thread.rb +7 -17
  456. data/lib/facebook_ads/ad_objects/url.rb +5 -19
  457. data/lib/facebook_ads/ad_objects/user.rb +32 -23
  458. data/lib/facebook_ads/ad_objects/user_available_catalogs.rb +28 -0
  459. data/lib/facebook_ads/ad_objects/user_cover_photo.rb +5 -17
  460. data/lib/facebook_ads/ad_objects/user_device.rb +5 -17
  461. data/lib/facebook_ads/ad_objects/user_id_for_app.rb +5 -17
  462. data/lib/facebook_ads/ad_objects/user_id_for_page.rb +5 -17
  463. data/lib/facebook_ads/ad_objects/user_lead_gen_disclaimer_response.rb +5 -17
  464. data/lib/facebook_ads/ad_objects/user_lead_gen_field_data.rb +5 -17
  465. data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +33 -0
  466. data/lib/facebook_ads/ad_objects/user_payment_mobile_pricepoints.rb +5 -17
  467. data/lib/facebook_ads/ad_objects/value_based_eligible_source.rb +5 -17
  468. data/lib/facebook_ads/ad_objects/vehicle.rb +12 -18
  469. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +20 -18
  470. data/lib/facebook_ads/ad_objects/video_copyright.rb +9 -17
  471. data/lib/facebook_ads/ad_objects/video_copyright_condition_group.rb +5 -17
  472. data/lib/facebook_ads/ad_objects/video_copyright_geo_gate.rb +5 -17
  473. data/lib/facebook_ads/ad_objects/video_copyright_rule.rb +5 -17
  474. data/lib/facebook_ads/ad_objects/video_copyright_segment.rb +5 -17
  475. data/lib/facebook_ads/ad_objects/video_list.rb +5 -17
  476. data/lib/facebook_ads/ad_objects/video_poll.rb +5 -17
  477. data/lib/facebook_ads/ad_objects/video_thumbnail.rb +5 -17
  478. data/lib/facebook_ads/ad_objects/video_upload_limits.rb +5 -17
  479. data/lib/facebook_ads/ad_objects/voip_info.rb +5 -17
  480. data/lib/facebook_ads/ad_objects/web_app_link.rb +5 -17
  481. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +106 -34
  482. data/lib/facebook_ads/ad_objects/whats_app_business_pre_verified_phone_number.rb +50 -0
  483. data/lib/facebook_ads/ad_objects/whats_app_business_profile.rb +5 -17
  484. data/lib/facebook_ads/ad_objects/windows_app_link.rb +5 -17
  485. data/lib/facebook_ads/ad_objects/windows_phone_app_link.rb +5 -17
  486. data/lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb +5 -17
  487. data/lib/facebook_ads/ad_objects/work_user_frontline.rb +5 -17
  488. data/lib/facebook_ads/api_request.rb +5 -17
  489. data/lib/facebook_ads/api_response.rb +5 -17
  490. data/lib/facebook_ads/batch_api/batch.rb +5 -17
  491. data/lib/facebook_ads/batch_api/batch_proxy.rb +5 -17
  492. data/lib/facebook_ads/config.rb +5 -17
  493. data/lib/facebook_ads/crash_logger.rb +5 -17
  494. data/lib/facebook_ads/edge.rb +6 -18
  495. data/lib/facebook_ads/errors.rb +5 -17
  496. data/lib/facebook_ads/field_types/ad_object.rb +5 -17
  497. data/lib/facebook_ads/field_types/base.rb +5 -17
  498. data/lib/facebook_ads/field_types/boolean.rb +5 -17
  499. data/lib/facebook_ads/field_types/datetime.rb +6 -18
  500. data/lib/facebook_ads/field_types/double.rb +5 -17
  501. data/lib/facebook_ads/field_types/enum.rb +5 -17
  502. data/lib/facebook_ads/field_types/integer.rb +5 -17
  503. data/lib/facebook_ads/field_types/list.rb +5 -17
  504. data/lib/facebook_ads/field_types/object.rb +5 -17
  505. data/lib/facebook_ads/field_types/string_type.rb +5 -17
  506. data/lib/facebook_ads/field_types/upload_file.rb +7 -19
  507. data/lib/facebook_ads/field_types.rb +5 -17
  508. data/lib/facebook_ads/fields.rb +5 -17
  509. data/lib/facebook_ads/helpers/edge_helpers.rb +5 -17
  510. data/lib/facebook_ads/helpers/node_helpers.rb +5 -17
  511. data/lib/facebook_ads/helpers/shortcuts.rb +6 -18
  512. data/lib/facebook_ads/param_set.rb +5 -17
  513. data/lib/facebook_ads/ruby2patch.rb +6 -18
  514. data/lib/facebook_ads/session.rb +5 -17
  515. data/lib/facebook_ads/test/base.rb +6 -18
  516. data/lib/facebook_ads/test/config.rb +7 -19
  517. data/lib/facebook_ads/test/errors.rb +6 -18
  518. data/lib/facebook_ads/test/exit_codes.rb +6 -18
  519. data/lib/facebook_ads/test/exit_hook.rb +6 -18
  520. data/lib/facebook_ads/test/fixtures.rb +5 -17
  521. data/lib/facebook_ads/test.rb +5 -17
  522. data/lib/facebook_ads/utils/utils.rb +5 -17
  523. data/lib/facebook_ads/version.rb +7 -19
  524. data/lib/facebook_ads/videos/video_io.rb +7 -17
  525. data/lib/facebook_ads/videos/video_request.rb +5 -17
  526. data/lib/facebook_ads.rb +5 -17
  527. data/lib/facebookbusiness.rb +5 -17
  528. metadata +116 -62
  529. data/LICENSE.txt +0 -17
  530. data/lib/facebook_ads/ad_objects/ad_account_activity.rb +0 -63
  531. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +0 -182
  532. data/lib/facebook_ads/ad_objects/ad_campaign_group_activity.rb +0 -99
  533. data/lib/facebook_ads/ad_objects/adgroup_activity.rb +0 -128
  534. data/lib/facebook_ads/ad_objects/adoptable_pet.rb +0 -85
  535. data/lib/facebook_ads/ad_objects/ar_effects_batch_status.rb +0 -39
  536. data/lib/facebook_ads/ad_objects/canvas_template.rb +0 -48
  537. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +0 -92
  538. data/lib/facebook_ads/ad_objects/copyright_audio_asset.rb +0 -38
  539. data/lib/facebook_ads/ad_objects/dynamic_content_set.rb +0 -37
  540. data/lib/facebook_ads/ad_objects/instant_article.rb +0 -52
  541. data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +0 -60
  542. data/lib/facebook_ads/ad_objects/jobs_job.rb +0 -72
  543. data/lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb +0 -41
  544. data/lib/facebook_ads/ad_objects/native_offer.rb +0 -122
  545. data/lib/facebook_ads/ad_objects/native_offer_discount.rb +0 -42
  546. data/lib/facebook_ads/ad_objects/native_offer_view.rb +0 -53
  547. data/lib/facebook_ads/ad_objects/page_admin_note.rb +0 -39
  548. data/lib/facebook_ads/ad_objects/product_item_ar_data.rb +0 -59
  549. data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb +0 -38
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2d1235a032c2cc0a192c80e31c798acafbd61375459abe53d0bf7845c14ea2be
4
- data.tar.gz: beef64f3c6b445dcc3487951561bf051c2932c3b902634aec95ed9f091a005da
3
+ metadata.gz: d38d786e3dd87b85f3669dd1a07b9f584011ed94150b7b482ccbdbc12ce72f26
4
+ data.tar.gz: 1a369b784247afaf3650b0724526815a4477ef445781ffdaf52e0a31e7322f7a
5
5
  SHA512:
6
- metadata.gz: 2fac47bc2e3b4ba64305719940f01029b6e7a99345fff1f6554c7ed28fcf9cf448d2a5fae94efe31dd590355f5135869b6c2540045a2b440de737ec14cbb21b0
7
- data.tar.gz: 48ba92279762768a30a9e70740dfad7aef81c6ab71ac720dbcd4dce72d3b611720488a4abba78772684ad91e897d35b167b0a41bb8f66d7afed34aebcfeddc18
6
+ metadata.gz: 559c3ee005ed8efc3b38ea380bc9fd3747ba8850bbaaa086ca88d0b06305f9224bed757d4eda5376a34ff3cd4af0100381bded573c9861cd06ee9ee454a3b6b2
7
+ data.tar.gz: 9b747f559714ed8dea7b65706d316bc8251f12cdb5ed612cc5da4bbfae9890219e8ed974ae63395b74619bab5cb25eb8e4ccc6c648ebc5e33d2999013dbe682c
data/README.md CHANGED
@@ -1,8 +1,12 @@
1
1
  # Facebook Business SDK for Ruby
2
2
 
3
+ [![Packagist](https://img.shields.io/gem/v/facebookbusiness)](https://rubygems.org/gems/facebookbusiness)
4
+ [![License](https://img.shields.io/badge/license-Facebook%20Platform-blue.svg?style=flat-square)](https://github.com/facebook/facebook-ruby-business-sdk/blob/main/LICENSE.txt)
5
+ [![Build Status](https://img.shields.io/github/actions/workflow/status/facebook/facebook-ruby-business-sdk/ci.yml)](https://github.com/facebook/facebook-ruby-business-sdk/actions/workflows/ci.yml)
6
+
3
7
  ### Introduction
4
8
 
5
- The Facebook <a href="https://developers.facebook.com/docs/business-sdk" target="_blank">Business SDK</a> is a one-stop shop to help our partners better serve their businesses. Partners are using multiple Facebook API's to server the needs of their clients. Adopting all these API's and keeping them up to date across the various platforms can be time consuming and ultimately prohibitive. For this reason Facebook has developed the Business SDK bundling many of its APIs into one SDK to ease implementation and upkeep. The Business SDK is an upgraded version of the Marketing API SDK that includes the Marketing API as well as many Facebook APIs from different platforms such as Pages, Business Manager, Instagram, etc.
9
+ The Facebook <a href="https://developers.facebook.com/docs/business-sdk" target="_blank">Business SDK</a> is a one-stop shop to help our partners better serve their businesses. Partners are using multiple Facebook API's to serve the needs of their clients. Adopting all these API's and keeping them up to date across the various platforms can be time consuming and ultimately prohibitive. For this reason Facebook has developed the Business SDK bundling many of its APIs into one SDK to ease implementation and upkeep. The Business SDK is an upgraded version of the Marketing API SDK that includes the Marketing API as well as many Facebook APIs from different platforms such as Pages, Business Manager, Instagram, etc.
6
10
 
7
11
  ## Quick Start
8
12
 
@@ -11,7 +15,7 @@ Business SDK <a href="https://developers.facebook.com/docs/business-sdk/getting-
11
15
  ## Pre-requisites
12
16
 
13
17
  ### Ruby Version
14
- We developed this SDK using Ruby 2.0, and supports Ruby 2.0+, however, the SDK is not thread-safe at the moment.
18
+ The minimum version supported is Ruby 3.0.
15
19
 
16
20
  ### Register An App
17
21
 
@@ -1,20 +1,8 @@
1
- # Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
2
- #
3
- # You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
4
- # copy, modify, and distribute this software in source code or binary form for use
5
- # in connection with the web services and APIs provided by Facebook.
6
- #
7
- # As with any software that integrates with the Facebook platform, your use of
8
- # this software is subject to the Facebook Platform Policy
9
- # [http://developers.facebook.com/policy/]. This copyright notice shall be
10
- # included in all copies or substantial portions of the software.
11
- #
12
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
14
- # FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
15
- # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
16
- # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
17
- # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+
4
+ # This source code is licensed under the license found in the
5
+ # LICENSE file in the root directory of this source tree.
18
6
 
19
7
  require 'json'
20
8
  require 'facebook_ads/api_request'
@@ -1,20 +1,8 @@
1
- # Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
2
- #
3
- # You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
4
- # copy, modify, and distribute this software in source code or binary form for use
5
- # in connection with the web services and APIs provided by Facebook.
6
- #
7
- # As with any software that integrates with the Facebook platform, your use of
8
- # this software is subject to the Facebook Platform Policy
9
- # [http://developers.facebook.com/policy/]. This copyright notice shall be
10
- # included in all copies or substantial portions of the software.
11
- #
12
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
14
- # FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
15
- # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
16
- # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
17
- # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+
4
+ # This source code is licensed under the license found in the
5
+ # LICENSE file in the root directory of this source tree.
18
6
 
19
7
  # FB:AUTOGEN
20
8
 
@@ -105,7 +93,10 @@ module FacebookAds
105
93
 
106
94
 
107
95
  field :account_id, 'string'
96
+ field :ad_active_time, 'string'
108
97
  field :ad_review_feedback, 'AdgroupReviewFeedback'
98
+ field :ad_schedule_end_time, 'datetime'
99
+ field :ad_schedule_start_time, 'datetime'
109
100
  field :adlabels, { list: 'AdLabel' }
110
101
  field :adset, 'AdSet'
111
102
  field :adset_id, 'string'
@@ -166,7 +157,7 @@ module FacebookAds
166
157
  edge.get 'Ad' do |api|
167
158
  api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
168
159
  api.has_param :effective_status, { list: 'string' }
169
- api.has_param :time_range, 'object'
160
+ api.has_param :time_range, 'hash'
170
161
  api.has_param :updated_since, 'int'
171
162
  end
172
163
  edge.post 'Ad' do |api|
@@ -195,8 +186,8 @@ module FacebookAds
195
186
  api.has_param :summary, { list: 'string' }
196
187
  api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
197
188
  api.has_param :time_increment, 'string'
198
- api.has_param :time_range, 'object'
199
- api.has_param :time_ranges, { list: 'object' }
189
+ api.has_param :time_range, 'hash'
190
+ api.has_param :time_ranges, { list: 'hash' }
200
191
  api.has_param :use_account_attribution_setting, 'bool'
201
192
  api.has_param :use_unified_attribution_setting, 'bool'
202
193
  end
@@ -218,8 +209,8 @@ module FacebookAds
218
209
  api.has_param :summary, { list: 'string' }
219
210
  api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
220
211
  api.has_param :time_increment, 'string'
221
- api.has_param :time_range, 'object'
222
- api.has_param :time_ranges, { list: 'object' }
212
+ api.has_param :time_range, 'hash'
213
+ api.has_param :time_ranges, { list: 'hash' }
223
214
  api.has_param :use_account_attribution_setting, 'bool'
224
215
  api.has_param :use_unified_attribution_setting, 'bool'
225
216
  end
@@ -232,6 +223,7 @@ module FacebookAds
232
223
  has_edge :previews do |edge|
233
224
  edge.get 'AdPreview' do |api|
234
225
  api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
226
+ api.has_param :creative_feature, { enum: -> { AdPreview::CREATIVE_FEATURE }}
235
227
  api.has_param :dynamic_asset_label, 'string'
236
228
  api.has_param :dynamic_creative_spec, 'object'
237
229
  api.has_param :dynamic_customization, 'object'
@@ -1,20 +1,8 @@
1
- # Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
2
- #
3
- # You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
4
- # copy, modify, and distribute this software in source code or binary form for use
5
- # in connection with the web services and APIs provided by Facebook.
6
- #
7
- # As with any software that integrates with the Facebook platform, your use of
8
- # this software is subject to the Facebook Platform Policy
9
- # [http://developers.facebook.com/policy/]. This copyright notice shall be
10
- # included in all copies or substantial portions of the software.
11
- #
12
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
14
- # FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
15
- # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
16
- # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
17
- # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+
4
+ # This source code is licensed under the license found in the
5
+ # LICENSE file in the root directory of this source tree.
18
6
 
19
7
  # FB:AUTOGEN
20
8
 
@@ -56,6 +44,7 @@ module FacebookAds
56
44
  "JPY",
57
45
  "KES",
58
46
  "KRW",
47
+ "LKR",
59
48
  "MOP",
60
49
  "MXN",
61
50
  "MYR",
@@ -121,6 +110,7 @@ module FacebookAds
121
110
  SUBTYPE = [
122
111
  "APP",
123
112
  "BAG_OF_ACCOUNTS",
113
+ "BIDDING",
124
114
  "CLAIM",
125
115
  "CUSTOM",
126
116
  "ENGAGEMENT",
@@ -130,18 +120,26 @@ module FacebookAds
130
120
  "MEASUREMENT",
131
121
  "OFFLINE_CONVERSION",
132
122
  "PARTNER",
123
+ "PRIMARY",
133
124
  "REGULATED_CATEGORIES_AUDIENCE",
134
125
  "STUDY_RULE_AUDIENCE",
126
+ "SUBSCRIBER_SEGMENT",
135
127
  "VIDEO",
136
128
  "WEBSITE",
137
129
  ]
138
130
 
131
+ ACTION_SOURCE = [
132
+ "PHYSICAL_STORE",
133
+ "WEBSITE",
134
+ ]
135
+
139
136
 
140
137
  field :account_id, 'string'
141
138
  field :account_status, 'int'
142
139
  field :ad_account_promotable_objects, 'AdAccountPromotableObjects'
143
140
  field :age, 'double'
144
141
  field :agency_client_declaration, 'AgencyClientDeclaration'
142
+ field :all_capabilities, { list: 'string' }
145
143
  field :amount_spent, 'string'
146
144
  field :attribution_spec, { list: 'AttributionSpec' }
147
145
  field :balance, 'string'
@@ -157,6 +155,9 @@ module FacebookAds
157
155
  field :capabilities, { list: 'string' }
158
156
  field :created_time, 'datetime'
159
157
  field :currency, 'string'
158
+ field :custom_audience_info, 'CustomAudienceGroup'
159
+ field :default_dsa_beneficiary, 'string'
160
+ field :default_dsa_payor, 'string'
160
161
  field :disable_reason, 'int'
161
162
  field :end_advertiser, 'string'
162
163
  field :end_advertiser_name, 'string'
@@ -166,7 +167,6 @@ module FacebookAds
166
167
  field :fb_entity, 'int'
167
168
  field :funding_source, 'string'
168
169
  field :funding_source_details, 'FundingSourceDetails'
169
- field :has_advertiser_opted_in_odax, 'bool'
170
170
  field :has_migrated_permissions, 'bool'
171
171
  field :has_page_authorized_adaccount, 'bool'
172
172
  field :id, 'string'
@@ -178,6 +178,7 @@ module FacebookAds
178
178
  field :is_personal, 'int'
179
179
  field :is_prepay_account, 'bool'
180
180
  field :is_tax_id_required, 'bool'
181
+ field :liable_address, 'CrmAddress'
181
182
  field :line_numbers, { list: 'int' }
182
183
  field :media_agency, 'string'
183
184
  field :min_campaign_group_spend_cap, 'string'
@@ -185,9 +186,12 @@ module FacebookAds
185
186
  field :name, 'string'
186
187
  field :offsite_pixels_tos_accepted, 'bool'
187
188
  field :owner, 'string'
189
+ field :owner_business, 'Business'
188
190
  field :partner, 'string'
189
191
  field :rf_spec, 'ReachFrequencySpec'
192
+ field :send_bill_to_address, 'CrmAddress'
190
193
  field :show_checkout_experience, 'bool'
194
+ field :sold_to_address, 'CrmAddress'
191
195
  field :spend_cap, 'string'
192
196
  field :tax_id, 'string'
193
197
  field :tax_id_status, 'int'
@@ -196,10 +200,20 @@ module FacebookAds
196
200
  field :timezone_name, 'string'
197
201
  field :timezone_offset_hours_utc, 'double'
198
202
  field :tos_accepted, 'hash'
203
+ field :user_access_expire_time, 'datetime'
199
204
  field :user_tasks, { list: 'string' }
200
205
  field :user_tos_accepted, 'hash'
206
+ field :viewable_business, 'Business'
201
207
  has_no_delete
202
208
 
209
+ has_edge :account_controls do |edge|
210
+ edge.get 'AdAccountBusinessConstraints'
211
+ edge.post 'AdAccountBusinessConstraints' do |api|
212
+ api.has_param :audience_controls, 'object'
213
+ api.has_param :placement_controls, 'object'
214
+ end
215
+ end
216
+
203
217
  has_edge :activities do |edge|
204
218
  edge.get 'AdActivity' do |api|
205
219
  api.has_param :add_children, 'bool'
@@ -235,6 +249,12 @@ module FacebookAds
235
249
  end
236
250
  end
237
251
 
252
+ has_edge :ad_saved_keywords do |edge|
253
+ edge.get do |api|
254
+ api.has_param :fields, { list: 'string' }
255
+ end
256
+ end
257
+
238
258
  has_edge :ad_studies do |edge|
239
259
  edge.get 'AdStudy'
240
260
  end
@@ -252,22 +272,25 @@ module FacebookAds
252
272
  api.has_param :asset_feed_spec, 'object'
253
273
  api.has_param :authorization_category, { enum: -> { AdCreative::AUTHORIZATION_CATEGORY }}
254
274
  api.has_param :body, 'string'
275
+ api.has_param :branded_content, 'hash'
255
276
  api.has_param :branded_content_sponsor_page_id, 'string'
256
277
  api.has_param :bundle_folder_id, 'string'
257
278
  api.has_param :call_to_action, 'object'
258
279
  api.has_param :categorization_criteria, { enum: -> { AdCreative::CATEGORIZATION_CRITERIA }}
259
280
  api.has_param :category_media_source, { enum: -> { AdCreative::CATEGORY_MEDIA_SOURCE }}
281
+ api.has_param :degrees_of_freedom_spec, 'hash'
260
282
  api.has_param :destination_set_id, 'string'
261
283
  api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
262
284
  api.has_param :enable_launch_instant_app, 'bool'
285
+ api.has_param :facebook_branded_content, 'hash'
263
286
  api.has_param :image_crops, 'hash'
264
287
  api.has_param :image_file, 'string'
265
288
  api.has_param :image_hash, 'string'
266
289
  api.has_param :image_url, 'string'
267
290
  api.has_param :instagram_actor_id, 'string'
291
+ api.has_param :instagram_branded_content, 'hash'
268
292
  api.has_param :instagram_permalink_url, 'string'
269
293
  api.has_param :instagram_user_id, 'string'
270
- api.has_param :instant_checkout_setting, { enum: -> { AdCreative::INSTANT_CHECKOUT_SETTING }}
271
294
  api.has_param :interactive_components_spec, 'hash'
272
295
  api.has_param :is_dco_internal, 'bool'
273
296
  api.has_param :link_og_id, 'string'
@@ -288,7 +311,7 @@ module FacebookAds
288
311
  api.has_param :recommender_settings, 'hash'
289
312
  api.has_param :source_instagram_media_id, 'string'
290
313
  api.has_param :template_url, 'string'
291
- api.has_param :template_url_spec, 'object'
314
+ api.has_param :template_url_spec, 'string'
292
315
  api.has_param :thumbnail_url, 'string'
293
316
  api.has_param :title, 'string'
294
317
  api.has_param :url_tags, 'string'
@@ -314,9 +337,10 @@ module FacebookAds
314
337
  api.has_param :minheight, 'int'
315
338
  api.has_param :minwidth, 'int'
316
339
  api.has_param :name, 'string'
340
+ api.has_param :selected_hashes, { list: 'string' }
317
341
  end
318
342
  edge.post list: 'AdImage' do |api|
319
- api.has_param :bytes, 'object'
343
+ api.has_param :bytes, 'string'
320
344
  api.has_param :copy_from, 'object'
321
345
  api.accepts_files!
322
346
  end
@@ -367,10 +391,12 @@ module FacebookAds
367
391
  edge.get 'Ad' do |api|
368
392
  api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
369
393
  api.has_param :effective_status, { list: 'string' }
370
- api.has_param :time_range, 'object'
394
+ api.has_param :time_range, 'hash'
371
395
  api.has_param :updated_since, 'int'
372
396
  end
373
397
  edge.post 'Ad' do |api|
398
+ api.has_param :ad_schedule_end_time, 'datetime'
399
+ api.has_param :ad_schedule_start_time, 'datetime'
374
400
  api.has_param :adlabels, { list: 'object' }
375
401
  api.has_param :adset_id, 'int'
376
402
  api.has_param :adset_spec, 'AdSet'
@@ -393,6 +419,16 @@ module FacebookAds
393
419
  end
394
420
  end
395
421
 
422
+ has_edge :ads_reporting_mmm_reports do |edge|
423
+ edge.get do |api|
424
+ api.has_param :filtering, { list: 'hash' }
425
+ end
426
+ end
427
+
428
+ has_edge :ads_reporting_mmm_schedulers do |edge|
429
+ edge.get
430
+ end
431
+
396
432
  has_edge :ads_volume do |edge|
397
433
  edge.get 'AdAccountAdVolume' do |api|
398
434
  api.has_param :page_id, 'int'
@@ -413,17 +449,19 @@ module FacebookAds
413
449
  api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
414
450
  api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
415
451
  api.has_param :is_completed, 'bool'
416
- api.has_param :time_range, 'object'
452
+ api.has_param :time_range, 'hash'
453
+ api.has_param :updated_since, 'int'
417
454
  end
418
- edge.post do |api|
455
+ edge.post 'AdSet' do |api|
419
456
  api.has_param :adlabels, { list: 'object' }
420
457
  api.has_param :adset_schedule, { list: 'object' }
421
458
  api.has_param :attribution_spec, { list: 'hash' }
422
459
  api.has_param :bid_adjustments, 'object'
423
460
  api.has_param :bid_amount, 'int'
424
461
  api.has_param :bid_constraints, 'hash'
425
- api.has_param :bid_strategy, { enum: %w{COST_CAP LOWEST_COST_WITHOUT_CAP LOWEST_COST_WITH_BID_CAP }}
426
- api.has_param :billing_event, { enum: %w{APP_INSTALLS CLICKS IMPRESSIONS LINK_CLICKS LISTING_INTERACTION NONE OFFER_CLAIMS PAGE_LIKES POST_ENGAGEMENT PURCHASE THRUPLAY }}
462
+ api.has_param :bid_strategy, { enum: -> { AdSet::BID_STRATEGY }}
463
+ api.has_param :billing_event, { enum: -> { AdSet::BILLING_EVENT }}
464
+ api.has_param :campaign_attribution, 'object'
427
465
  api.has_param :campaign_id, 'string'
428
466
  api.has_param :campaign_spec, 'object'
429
467
  api.has_param :creative_sequence, { list: 'string' }
@@ -432,37 +470,38 @@ module FacebookAds
432
470
  api.has_param :daily_min_spend_target, 'int'
433
471
  api.has_param :daily_spend_cap, 'int'
434
472
  api.has_param :date_format, 'string'
435
- api.has_param :destination_type, { enum: %w{APP APPLINKS_AUTOMATIC FACEBOOK MESSENGER UNDEFINED WEBSITE }}
473
+ api.has_param :destination_type, { enum: -> { AdSet::DESTINATION_TYPE }}
474
+ api.has_param :dsa_beneficiary, 'string'
475
+ api.has_param :dsa_payor, 'string'
436
476
  api.has_param :end_time, 'datetime'
437
- api.has_param :execution_options, { list: { enum: %w{include_recommendations validate_only }} }
477
+ api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
438
478
  api.has_param :existing_customer_budget_percentage, 'int'
439
479
  api.has_param :frequency_control_specs, { list: 'object' }
440
- api.has_param :full_funnel_exploration_mode, { enum: %w{EXTENDED_EXPLORATION LIMITED_EXPLORATION NONE_EXPLORATION }}
480
+ api.has_param :full_funnel_exploration_mode, { enum: -> { AdSet::FULL_FUNNEL_EXPLORATION_MODE }}
441
481
  api.has_param :is_dynamic_creative, 'bool'
442
482
  api.has_param :lifetime_budget, 'int'
443
483
  api.has_param :lifetime_imps, 'int'
444
484
  api.has_param :lifetime_min_spend_target, 'int'
445
485
  api.has_param :lifetime_spend_cap, 'int'
446
486
  api.has_param :line_number, 'int'
447
- api.has_param :multi_optimization_goal_weight, { enum: %w{BALANCED PREFER_EVENT PREFER_INSTALL UNDEFINED }}
487
+ api.has_param :multi_optimization_goal_weight, { enum: -> { AdSet::MULTI_OPTIMIZATION_GOAL_WEIGHT }}
448
488
  api.has_param :name, 'string'
449
- api.has_param :optimization_goal, { enum: %w{AD_RECALL_LIFT APP_INSTALLS APP_INSTALLS_AND_OFFSITE_CONVERSIONS CONVERSATIONS DERIVED_EVENTS ENGAGED_USERS EVENT_RESPONSES IMPRESSIONS IN_APP_VALUE LANDING_PAGE_VIEWS LEAD_GENERATION LINK_CLICKS NONE OFFSITE_CONVERSIONS PAGE_LIKES POST_ENGAGEMENT QUALITY_CALL QUALITY_LEAD REACH THRUPLAY VALUE VISIT_INSTAGRAM_PROFILE }}
450
- api.has_param :optimization_sub_event, { enum: %w{NONE TRAVEL_INTENT TRAVEL_INTENT_BUCKET_01 TRAVEL_INTENT_BUCKET_02 TRAVEL_INTENT_BUCKET_03 TRAVEL_INTENT_BUCKET_04 TRAVEL_INTENT_BUCKET_05 TRAVEL_INTENT_NO_DESTINATION_INTENT TRIP_CONSIDERATION VIDEO_SOUND_ON }}
489
+ api.has_param :optimization_goal, { enum: -> { AdSet::OPTIMIZATION_GOAL }}
490
+ api.has_param :optimization_sub_event, { enum: -> { AdSet::OPTIMIZATION_SUB_EVENT }}
451
491
  api.has_param :pacing_type, { list: 'string' }
452
492
  api.has_param :promoted_object, 'object'
453
493
  api.has_param :rb_prediction_id, 'string'
454
494
  api.has_param :rf_prediction_id, 'string'
455
495
  api.has_param :source_adset_id, 'string'
456
496
  api.has_param :start_time, 'datetime'
457
- api.has_param :status, { enum: %w{ACTIVE ARCHIVED DELETED PAUSED }}
497
+ api.has_param :status, { enum: -> { AdSet::STATUS }}
458
498
  api.has_param :targeting, 'Targeting'
459
499
  api.has_param :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
460
500
  api.has_param :time_based_ad_rotation_intervals, { list: 'int' }
461
501
  api.has_param :time_start, 'datetime'
462
502
  api.has_param :time_stop, 'datetime'
463
503
  api.has_param :topline_id, 'string'
464
- api.has_param :tune_for_category, { enum: %w{CREDIT EMPLOYMENT HOUSING ISSUES_ELECTIONS_POLITICS NONE ONLINE_GAMBLING_AND_GAMING }}
465
- api.has_param :upstream_events, 'hash'
504
+ api.has_param :tune_for_category, { enum: -> { AdSet::TUNE_FOR_CATEGORY }}
466
505
  end
467
506
  end
468
507
 
@@ -477,7 +516,7 @@ module FacebookAds
477
516
  edge.get 'AdsPixel' do |api|
478
517
  api.has_param :sort_by, { enum: -> { AdsPixel::SORT_BY }}
479
518
  end
480
- edge.post do |api|
519
+ edge.post 'AdsPixel' do |api|
481
520
  api.has_param :name, 'string'
482
521
  end
483
522
  end
@@ -647,6 +686,12 @@ module FacebookAds
647
686
  end
648
687
  end
649
688
 
689
+ has_edge :businessprojects do |edge|
690
+ edge.get do |api|
691
+ api.has_param :business, 'string'
692
+ end
693
+ end
694
+
650
695
  has_edge :campaigns do |edge|
651
696
  edge.delete do |api|
652
697
  api.has_param :before_date, 'datetime'
@@ -658,7 +703,7 @@ module FacebookAds
658
703
  api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
659
704
  api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
660
705
  api.has_param :is_completed, 'bool'
661
- api.has_param :time_range, 'object'
706
+ api.has_param :time_range, 'hash'
662
707
  end
663
708
  edge.post 'Campaign' do |api|
664
709
  api.has_param :adlabels, { list: 'object' }
@@ -682,7 +727,6 @@ module FacebookAds
682
727
  api.has_param :status, { enum: -> { Campaign::STATUS }}
683
728
  api.has_param :stop_time, 'datetime'
684
729
  api.has_param :topline_id, 'string'
685
- api.has_param :upstream_events, 'hash'
686
730
  end
687
731
  end
688
732
 
@@ -697,28 +741,14 @@ module FacebookAds
697
741
  edge.get 'IgUser'
698
742
  end
699
743
 
700
- has_edge :content_delivery_report do |edge|
701
- edge.get 'ContentDeliveryReport' do |api|
702
- api.has_param :end_date, 'datetime'
703
- api.has_param :page_id, 'int'
704
- api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
705
- api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
706
- api.has_param :start_date, 'datetime'
707
- api.has_param :summary, 'bool'
708
- end
709
- end
710
-
711
- has_edge :create_and_apply_publisher_block_list do |edge|
712
- edge.post do |api|
713
- api.has_param :is_auto_blocking_on, 'bool'
714
- api.has_param :name, 'string'
715
- api.has_param :publisher_urls, { list: 'string' }
716
- end
744
+ has_edge :conversion_goals do |edge|
745
+ edge.get
717
746
  end
718
747
 
719
748
  has_edge :customaudiences do |edge|
720
749
  edge.get 'CustomAudience' do |api|
721
750
  api.has_param :business_id, 'string'
751
+ api.has_param :fetch_primary_audience, 'bool'
722
752
  api.has_param :fields, { list: 'string' }
723
753
  api.has_param :filtering, { list: 'object' }
724
754
  api.has_param :pixel_id, 'string'
@@ -756,7 +786,9 @@ module FacebookAds
756
786
  api.has_param :rule, 'string'
757
787
  api.has_param :rule_aggregation, 'string'
758
788
  api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
789
+ api.has_param :use_in_campaigns, 'bool'
759
790
  api.has_param :video_group_ids, { list: 'string' }
791
+ api.has_param :whats_app_business_phone_number_id, 'string'
760
792
  end
761
793
  end
762
794
 
@@ -795,10 +827,15 @@ module FacebookAds
795
827
  end
796
828
  end
797
829
 
830
+ has_edge :dsa_recommendations do |edge|
831
+ edge.get 'AdAccountDsaRecommendations'
832
+ end
833
+
798
834
  has_edge :generatepreviews do |edge|
799
835
  edge.get 'AdPreview' do |api|
800
836
  api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
801
837
  api.has_param :creative, 'AdCreative'
838
+ api.has_param :creative_feature, { enum: -> { AdPreview::CREATIVE_FEATURE }}
802
839
  api.has_param :dynamic_asset_label, 'string'
803
840
  api.has_param :dynamic_creative_spec, 'object'
804
841
  api.has_param :dynamic_customization, 'object'
@@ -837,8 +874,8 @@ module FacebookAds
837
874
  api.has_param :summary, { list: 'string' }
838
875
  api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
839
876
  api.has_param :time_increment, 'string'
840
- api.has_param :time_range, 'object'
841
- api.has_param :time_ranges, { list: 'object' }
877
+ api.has_param :time_range, 'hash'
878
+ api.has_param :time_ranges, { list: 'hash' }
842
879
  api.has_param :use_account_attribution_setting, 'bool'
843
880
  api.has_param :use_unified_attribution_setting, 'bool'
844
881
  end
@@ -860,8 +897,8 @@ module FacebookAds
860
897
  api.has_param :summary, { list: 'string' }
861
898
  api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
862
899
  api.has_param :time_increment, 'string'
863
- api.has_param :time_range, 'object'
864
- api.has_param :time_ranges, { list: 'object' }
900
+ api.has_param :time_range, 'hash'
901
+ api.has_param :time_ranges, { list: 'hash' }
865
902
  api.has_param :use_account_attribution_setting, 'bool'
866
903
  api.has_param :use_unified_attribution_setting, 'bool'
867
904
  end
@@ -882,6 +919,10 @@ module FacebookAds
882
919
  api.has_param :campaign_group_id, 'int'
883
920
  api.has_param :campaign_group_status, { enum: %w{ACTIVE ADSET_PAUSED ARCHIVED CAMPAIGN_PAUSED DELETED DISAPPROVED IN_PROCESS PAUSED PENDING_BILLING_INFO PENDING_REVIEW PREAPPROVED WITH_ISSUES }}
884
921
  api.has_param :conversion_domain, 'string'
922
+ api.has_param :custom_event_type, { enum: %w{ADD_TO_CART CONTENT_VIEW PURCHASE }}
923
+ api.has_param :daily_budget, 'int'
924
+ api.has_param :dsa_beneficiary, 'string'
925
+ api.has_param :dsa_payor, 'string'
885
926
  api.has_param :end_time, 'int'
886
927
  api.has_param :lifetime_budget, 'int'
887
928
  api.has_param :override_creative_text, 'string'
@@ -994,6 +1035,7 @@ module FacebookAds
994
1035
  api.has_param :impression, 'int'
995
1036
  api.has_param :instream_packages, { list: { enum: -> { ReachFrequencyPrediction::INSTREAM_PACKAGES }} }
996
1037
  api.has_param :interval_frequency_cap_reset_period, 'int'
1038
+ api.has_param :is_balanced_frequency, 'bool'
997
1039
  api.has_param :is_bonus_media, 'bool'
998
1040
  api.has_param :is_conversion_goal, 'bool'
999
1041
  api.has_param :is_full_view, 'bool'
@@ -1002,6 +1044,7 @@ module FacebookAds
1002
1044
  api.has_param :is_reserved_buying, 'bool'
1003
1045
  api.has_param :num_curve_points, 'int'
1004
1046
  api.has_param :objective, 'string'
1047
+ api.has_param :optimization_goal, 'string'
1005
1048
  api.has_param :prediction_mode, 'int'
1006
1049
  api.has_param :reach, 'int'
1007
1050
  api.has_param :rf_prediction_id, 'string'
@@ -1011,6 +1054,8 @@ module FacebookAds
1011
1054
  api.has_param :stop_time, 'int'
1012
1055
  api.has_param :story_event_type, 'int'
1013
1056
  api.has_param :target_cpm, 'int'
1057
+ api.has_param :target_frequency, 'int'
1058
+ api.has_param :target_frequency_reset_period, 'int'
1014
1059
  api.has_param :target_spec, 'Targeting'
1015
1060
  api.has_param :video_view_length_constraint, 'int'
1016
1061
  end
@@ -1041,6 +1086,7 @@ module FacebookAds
1041
1086
  api.has_param :is_exclusion, 'bool'
1042
1087
  api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
1043
1088
  api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
1089
+ api.has_param :regulated_countries, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_COUNTRIES }} }
1044
1090
  api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
1045
1091
  end
1046
1092
  end
@@ -1056,6 +1102,7 @@ module FacebookAds
1056
1102
  api.has_param :promoted_object, 'object'
1057
1103
  api.has_param :q, 'string'
1058
1104
  api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
1105
+ api.has_param :regulated_countries, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_COUNTRIES }} }
1059
1106
  api.has_param :session_id, 'int'
1060
1107
  api.has_param :targeting_list, { list: 'object' }
1061
1108
  api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
@@ -1080,6 +1127,7 @@ module FacebookAds
1080
1127
  api.has_param :objective, { enum: -> { AdAccountTargetingUnified::OBJECTIVE }}
1081
1128
  api.has_param :objects, 'object'
1082
1129
  api.has_param :regulated_categories, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_CATEGORIES }} }
1130
+ api.has_param :regulated_countries, { list: { enum: -> { AdAccountTargetingUnified::REGULATED_COUNTRIES }} }
1083
1131
  api.has_param :session_id, 'int'
1084
1132
  api.has_param :targeting_list, { list: 'object' }
1085
1133
  api.has_param :whitelisted_types, { list: { enum: -> { AdAccountTargetingUnified::WHITELISTED_TYPES }} }
@@ -1114,5 +1162,9 @@ module FacebookAds
1114
1162
  end
1115
1163
  end
1116
1164
 
1165
+ has_edge :value_adjustment_rules do |edge|
1166
+ edge.get
1167
+ end
1168
+
1117
1169
  end
1118
1170
  end
@@ -1,20 +1,8 @@
1
- # Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
2
- #
3
- # You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
4
- # copy, modify, and distribute this software in source code or binary form for use
5
- # in connection with the web services and APIs provided by Facebook.
6
- #
7
- # As with any software that integrates with the Facebook platform, your use of
8
- # this software is subject to the Facebook Platform Policy
9
- # [http://developers.facebook.com/policy/]. This copyright notice shall be
10
- # included in all copies or substantial portions of the software.
11
- #
12
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
14
- # FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
15
- # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
16
- # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
17
- # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+
4
+ # This source code is licensed under the license found in the
5
+ # LICENSE file in the root directory of this source tree.
18
6
 
19
7
  # FB:AUTOGEN
20
8
 
@@ -31,6 +19,8 @@ module FacebookAds
31
19
  "CHANGED_BID",
32
20
  "CHANGED_BUDGET",
33
21
  "EMAIL",
22
+ "ENABLE_ADVANTAGE_PLUS_CREATIVE",
23
+ "ENABLE_AUTOFLOW",
34
24
  "ENDPOINT_PINGED",
35
25
  "ERROR",
36
26
  "FACEBOOK_NOTIFICATION_SENT",