facebookbusiness 0.3.1.0 → 0.14.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (355) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -0
  3. data/lib/facebook_ads/ad_objects/ad.rb +58 -46
  4. data/lib/facebook_ads/ad_objects/ad_account.rb +462 -117
  5. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +5 -0
  6. data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +71 -0
  7. data/lib/facebook_ads/ad_objects/ad_account_default_destination.rb +38 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb +80 -0
  9. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +15 -12
  10. data/lib/facebook_ads/ad_objects/ad_account_ios_fourteen_campaign_limits.rb +39 -0
  11. data/lib/facebook_ads/ad_objects/{business_matched_search_applications_edge_data.rb → ad_account_matched_search_applications_edge_data.rb} +20 -8
  12. data/lib/facebook_ads/ad_objects/ad_account_max_bid.rb +37 -0
  13. data/lib/facebook_ads/ad_objects/ad_account_promotable_objects.rb +39 -0
  14. data/lib/facebook_ads/ad_objects/{reach_estimate.rb → ad_account_reach_estimate.rb} +3 -3
  15. data/lib/facebook_ads/ad_objects/ad_account_recommended_camapaign_budget.rb +39 -0
  16. data/lib/facebook_ads/ad_objects/ad_account_subscribed_apps.rb +38 -0
  17. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +201 -82
  18. data/lib/facebook_ads/ad_objects/ad_account_tracking_data.rb +37 -0
  19. data/lib/facebook_ads/ad_objects/ad_activity.rb +65 -46
  20. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +61 -36
  21. data/lib/facebook_ads/ad_objects/ad_async_request.rb +9 -18
  22. data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -9
  23. data/lib/facebook_ads/ad_objects/ad_bid_adjustments.rb +39 -0
  24. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +184 -0
  25. data/lib/facebook_ads/ad_objects/ad_campaign_bid_constraint.rb +37 -0
  26. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +15 -12
  27. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats_unsupported_reasons.rb +38 -0
  28. data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb +41 -0
  29. data/lib/facebook_ads/ad_objects/ad_campaign_learning_stage_info.rb +40 -0
  30. data/lib/facebook_ads/ad_objects/{audience_permission.rb → ad_campaign_optimization_event.rb} +4 -4
  31. data/lib/facebook_ads/ad_objects/ad_campaign_paced_bid_info.rb +37 -0
  32. data/lib/facebook_ads/ad_objects/ad_creative.rb +126 -53
  33. data/lib/facebook_ads/ad_objects/ad_creative_ad_disclaimer.rb +39 -0
  34. data/lib/facebook_ads/ad_objects/ad_creative_insights.rb +37 -0
  35. data/lib/facebook_ads/ad_objects/ad_creative_interactive_components_spec.rb +38 -0
  36. data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +7 -5
  37. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +57 -36
  38. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +1 -0
  39. data/lib/facebook_ads/ad_objects/{ad_creative_link_data_custom_overlay_spec.rb → ad_creative_link_data_image_layer_spec.rb} +52 -51
  40. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +24 -19
  41. data/lib/facebook_ads/ad_objects/ad_creative_link_data_sponsorship_info_spec.rb +38 -0
  42. data/lib/facebook_ads/ad_objects/ad_creative_link_data_template_video_spec.rb +39 -0
  43. data/lib/facebook_ads/ad_objects/ad_creative_omnichannel_link_spec.rb +38 -0
  44. data/lib/facebook_ads/ad_objects/ad_creative_photo_data.rb +0 -1
  45. data/lib/facebook_ads/ad_objects/ad_creative_photo_data_media_elements.rb +40 -0
  46. data/lib/facebook_ads/ad_objects/ad_creative_platform_customization.rb +37 -0
  47. data/lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb +38 -0
  48. data/lib/facebook_ads/ad_objects/ad_creative_recommender_settings.rb +38 -0
  49. data/lib/facebook_ads/ad_objects/ad_creative_static_fallback_spec.rb +42 -0
  50. data/lib/facebook_ads/ad_objects/ad_creative_template_url_spec.rb +43 -0
  51. data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb +1 -1
  52. data/lib/facebook_ads/ad_objects/ad_customization_rule_spec.rb +46 -0
  53. data/lib/facebook_ads/ad_objects/ad_dynamic_creative.rb +37 -0
  54. data/lib/facebook_ads/ad_objects/ad_entity_target_spend.rb +41 -0
  55. data/lib/facebook_ads/ad_objects/ad_image.rb +1 -0
  56. data/lib/facebook_ads/ad_objects/ad_keywords.rb +40 -0
  57. data/lib/facebook_ads/ad_objects/ad_label.rb +0 -4
  58. data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +66 -0
  59. data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +63 -0
  60. data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +9 -1
  61. data/lib/facebook_ads/ad_objects/ad_place_page_set_metadata.rb +40 -0
  62. data/lib/facebook_ads/ad_objects/ad_placement.rb +43 -0
  63. data/lib/facebook_ads/ad_objects/ad_preview.rb +43 -13
  64. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +29 -10
  65. data/lib/facebook_ads/ad_objects/ad_recommendation.rb +2 -2
  66. data/lib/facebook_ads/ad_objects/ad_report_run.rb +3 -2
  67. data/lib/facebook_ads/ad_objects/ad_rule.rb +38 -2
  68. data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb +1 -2
  69. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +13 -5
  70. data/lib/facebook_ads/ad_objects/ad_rule_filters.rb +9 -9
  71. data/lib/facebook_ads/ad_objects/ad_rule_history_result.rb +2 -2
  72. data/lib/facebook_ads/ad_objects/ad_rule_trigger.rb +11 -11
  73. data/lib/facebook_ads/ad_objects/ad_set.rb +135 -47
  74. data/lib/facebook_ads/ad_objects/ad_study.rb +10 -41
  75. data/lib/facebook_ads/ad_objects/ad_study_cell.rb +16 -5
  76. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +29 -14
  77. data/lib/facebook_ads/ad_objects/ad_study_objective_id.rb +38 -0
  78. data/lib/facebook_ads/ad_objects/ad_study_objective_offsite_datasets.rb +37 -0
  79. data/lib/facebook_ads/ad_objects/ad_video.rb +477 -0
  80. data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb +41 -0
  81. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +22 -0
  82. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +12 -0
  83. data/lib/facebook_ads/ad_objects/ads_insights.rb +98 -47
  84. data/lib/facebook_ads/ad_objects/ads_optimal_delivery_growth_opportunity.rb +39 -0
  85. data/lib/facebook_ads/ad_objects/ads_pixel.rb +85 -6
  86. data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb +9 -2
  87. data/lib/facebook_ads/ad_objects/age_range.rb +38 -0
  88. data/lib/facebook_ads/ad_objects/album.rb +55 -2
  89. data/lib/facebook_ads/ad_objects/app_request.rb +42 -0
  90. data/lib/facebook_ads/ad_objects/app_request_former_recipient.rb +37 -0
  91. data/lib/facebook_ads/ad_objects/application.rb +614 -0
  92. data/lib/facebook_ads/ad_objects/{adgroup_relevance_score.rb → ar_effects_batch_status.rb} +3 -4
  93. data/lib/facebook_ads/ad_objects/assigned_user.rb +1 -0
  94. data/lib/facebook_ads/ad_objects/async_request.rb +52 -0
  95. data/lib/facebook_ads/ad_objects/async_session.rb +49 -0
  96. data/lib/facebook_ads/ad_objects/{custom_audience_permission.rb → audience_permission_for_actions.rb} +1 -1
  97. data/lib/facebook_ads/ad_objects/audio_copyright.rb +5 -0
  98. data/lib/facebook_ads/ad_objects/automotive_model.rb +84 -0
  99. data/lib/facebook_ads/ad_objects/brand_safety_block_list_usage.rb +41 -0
  100. data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +2 -1
  101. data/lib/facebook_ads/ad_objects/business.rb +338 -188
  102. data/lib/facebook_ads/ad_objects/business_application_request.rb +1 -1
  103. data/lib/facebook_ads/ad_objects/business_asset_group.rb +182 -0
  104. data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +48 -0
  105. data/lib/facebook_ads/ad_objects/{business_project.rb → business_image.rb} +8 -9
  106. data/lib/facebook_ads/ad_objects/business_managed_partner_eligibility.rb +39 -0
  107. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +48 -0
  108. data/lib/facebook_ads/ad_objects/business_role_request.rb +14 -11
  109. data/lib/facebook_ads/ad_objects/business_user.rb +31 -4
  110. data/lib/facebook_ads/ad_objects/campaign.rb +347 -42
  111. data/lib/facebook_ads/ad_objects/campaign_group_brand_configuration.rb +39 -0
  112. data/lib/facebook_ads/ad_objects/campaign_group_collaborative_ads_partner_info.rb +36 -0
  113. data/lib/facebook_ads/ad_objects/canvas.rb +19 -6
  114. data/lib/facebook_ads/ad_objects/canvas_ad_settings.rb +43 -0
  115. data/lib/facebook_ads/ad_objects/canvas_collection_thumbnail.rb +39 -0
  116. data/lib/facebook_ads/ad_objects/canvas_template.rb +48 -0
  117. data/lib/facebook_ads/ad_objects/catalog_based_targeting.rb +37 -0
  118. data/lib/facebook_ads/ad_objects/{app_links.rb → catalog_item_app_links.rb} +3 -2
  119. data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb +40 -0
  120. data/lib/facebook_ads/ad_objects/catalog_item_channels_to_integrity_status.rb +38 -0
  121. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +90 -0
  122. data/lib/facebook_ads/ad_objects/chat_plugin.rb +48 -0
  123. data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +9 -0
  124. data/lib/facebook_ads/ad_objects/{legacy_business_ad_account_request.rb → child_event.rb} +4 -3
  125. data/lib/facebook_ads/ad_objects/cloud_game.rb +43 -0
  126. data/lib/facebook_ads/ad_objects/collaborative_ads_partner_info_list_item.rb +36 -0
  127. data/lib/facebook_ads/ad_objects/collaborative_ads_share_settings.rb +39 -0
  128. data/lib/facebook_ads/ad_objects/comment.rb +128 -0
  129. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +142 -0
  130. data/lib/facebook_ads/ad_objects/{copyright_attribution_insights.rb → commerce_merchant_settings_setup_status.rb} +7 -6
  131. data/lib/facebook_ads/ad_objects/commerce_order.rb +170 -0
  132. data/lib/facebook_ads/ad_objects/commerce_order_transaction_detail.rb +52 -0
  133. data/lib/facebook_ads/ad_objects/commerce_payout.rb +41 -0
  134. data/lib/facebook_ads/ad_objects/commerce_settings.rb +38 -0
  135. data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → connections_targeting.rb} +2 -2
  136. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +93 -0
  137. data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → contextual_bundling_spec.rb} +1 -3
  138. data/lib/facebook_ads/ad_objects/copyright_audio_asset.rb +39 -0
  139. data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +47 -0
  140. data/lib/facebook_ads/ad_objects/cpas_advertiser_partnership_recommendation.rb +43 -0
  141. data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +43 -0
  142. data/lib/facebook_ads/ad_objects/cpas_collaboration_request.rb +50 -0
  143. data/lib/facebook_ads/ad_objects/cpas_merchant_config.rb +41 -0
  144. data/lib/facebook_ads/ad_objects/creative_history.rb +38 -0
  145. data/lib/facebook_ads/ad_objects/credit_card.rb +55 -0
  146. data/lib/facebook_ads/ad_objects/credit_partition_action_options.rb +39 -0
  147. data/lib/facebook_ads/ad_objects/currency.rb +40 -0
  148. data/lib/facebook_ads/ad_objects/currency_amount.rb +40 -0
  149. data/lib/facebook_ads/ad_objects/custom_audience.rb +70 -59
  150. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +49 -45
  151. data/lib/facebook_ads/ad_objects/custom_audience_sharing_status.rb +38 -0
  152. data/lib/facebook_ads/ad_objects/custom_audienceshared_account_info.rb +41 -0
  153. data/lib/facebook_ads/ad_objects/custom_conversion.rb +11 -35
  154. data/lib/facebook_ads/ad_objects/custom_user_settings.rb +38 -0
  155. data/lib/facebook_ads/ad_objects/da_check.rb +49 -0
  156. data/lib/facebook_ads/ad_objects/delivery_window.rb +287 -0
  157. data/lib/facebook_ads/ad_objects/destination.rb +71 -0
  158. data/lib/facebook_ads/ad_objects/{offline_terms_of_service.rb → destination_catalog_settings.rb} +2 -3
  159. data/lib/facebook_ads/ad_objects/{products_quality_issue.rb → dynamic_post_child_attachment.rb} +6 -6
  160. data/lib/facebook_ads/ad_objects/{lead_gen_conditional_questions_group.rb → dynamic_price_config_by_date.rb} +4 -3
  161. data/lib/facebook_ads/ad_objects/entity_at_text_range.rb +49 -0
  162. data/lib/facebook_ads/ad_objects/event.rb +88 -98
  163. data/lib/facebook_ads/ad_objects/event_source_group.rb +1 -10
  164. data/lib/facebook_ads/ad_objects/experience.rb +40 -0
  165. data/lib/facebook_ads/ad_objects/extended_credit.rb +14 -7
  166. data/lib/facebook_ads/ad_objects/extended_credit_allocation_config.rb +4 -5
  167. data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +3 -0
  168. data/lib/facebook_ads/ad_objects/external_event_source.rb +1 -1
  169. data/lib/facebook_ads/ad_objects/fame_export_config.rb +40 -0
  170. data/lib/facebook_ads/ad_objects/flight.rb +72 -0
  171. data/lib/facebook_ads/ad_objects/{partner_integration_linked.rb → fundraiser_person_to_charity.rb} +43 -10
  172. data/lib/facebook_ads/ad_objects/{page_insights_async_export_run.rb → game_item.rb} +13 -8
  173. data/lib/facebook_ads/ad_objects/group.rb +594 -0
  174. data/lib/facebook_ads/ad_objects/home_listing.rb +98 -0
  175. data/lib/facebook_ads/ad_objects/hotel.rb +80 -0
  176. data/lib/facebook_ads/ad_objects/hotel_room.rb +6 -1
  177. data/lib/facebook_ads/ad_objects/{shadow_ig_comment.rb → ig_comment.rb} +7 -5
  178. data/lib/facebook_ads/ad_objects/{shadow_ig_media.rb → ig_media.rb} +22 -4
  179. data/lib/facebook_ads/ad_objects/{shadow_ig_user.rb → ig_user.rb} +71 -8
  180. data/lib/facebook_ads/ad_objects/image_copyright.rb +302 -0
  181. data/lib/facebook_ads/ad_objects/insights_result.rb +12 -12
  182. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +17 -9
  183. data/lib/facebook_ads/ad_objects/instagram_user.rb +58 -0
  184. data/lib/facebook_ads/ad_objects/instant_article.rb +8 -3
  185. data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +6 -7
  186. data/lib/facebook_ads/ad_objects/instant_articles_stats.rb +41 -0
  187. data/lib/facebook_ads/ad_objects/jobs_job.rb +79 -0
  188. data/lib/facebook_ads/ad_objects/{screen_name.rb → key_value.rb} +2 -3
  189. data/lib/facebook_ads/ad_objects/lead.rb +3 -1
  190. data/lib/facebook_ads/ad_objects/lead_gen_appointment_booking_info.rb +39 -0
  191. data/lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group_choices.rb +39 -0
  192. data/lib/facebook_ads/ad_objects/{lead_gen_qualifier.rb → lead_gen_conditional_questions_group_questions.rb} +4 -5
  193. data/lib/facebook_ads/ad_objects/lead_gen_draft_question.rb +2 -2
  194. data/lib/facebook_ads/ad_objects/lead_gen_post_submission_check_result.rb +39 -0
  195. data/lib/facebook_ads/ad_objects/lead_gen_question.rb +3 -2
  196. data/lib/facebook_ads/ad_objects/leadgen_form.rb +23 -34
  197. data/lib/facebook_ads/ad_objects/life_event.rb +2 -10
  198. data/lib/facebook_ads/ad_objects/link.rb +68 -0
  199. data/lib/facebook_ads/ad_objects/live_video.rb +98 -31
  200. data/lib/facebook_ads/ad_objects/live_video_ad_break_config.rb +46 -0
  201. data/lib/facebook_ads/ad_objects/live_video_error.rb +39 -0
  202. data/lib/facebook_ads/ad_objects/live_video_input_stream.rb +42 -0
  203. data/lib/facebook_ads/ad_objects/live_video_recommended_encoder_settings.rb +39 -0
  204. data/lib/facebook_ads/ad_objects/live_video_targeting.rb +40 -0
  205. data/lib/facebook_ads/ad_objects/local_service_business.rb +103 -0
  206. data/lib/facebook_ads/ad_objects/lookalike_spec.rb +5 -0
  207. data/lib/facebook_ads/ad_objects/managed_partner_business.rb +43 -0
  208. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +4 -4
  209. data/lib/facebook_ads/ad_objects/messaging_feature_status.rb +37 -0
  210. data/lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb +41 -0
  211. data/lib/facebook_ads/ad_objects/messenger_profile.rb +2 -12
  212. data/lib/facebook_ads/ad_objects/music_video_copyright.rb +48 -0
  213. data/lib/facebook_ads/ad_objects/{ad_account_contextual_targeting.rb → null_node.rb} +1 -1
  214. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +43 -46
  215. data/lib/facebook_ads/ad_objects/offline_conversion_data_set_permissions.rb +40 -0
  216. data/lib/facebook_ads/ad_objects/{direct_deal.rb → offline_conversion_data_set_upload.rb} +35 -30
  217. data/lib/facebook_ads/ad_objects/offline_conversion_data_set_usage.rb +37 -0
  218. data/lib/facebook_ads/ad_objects/{oracle_transaction.rb → omega_customer_trx.rb} +15 -2
  219. data/lib/facebook_ads/ad_objects/page.rb +683 -325
  220. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +50 -20
  221. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +2 -0
  222. data/lib/facebook_ads/ad_objects/page_commerce_eligibility.rb +38 -0
  223. data/lib/facebook_ads/ad_objects/page_post.rb +83 -60
  224. data/lib/facebook_ads/ad_objects/{page_label.rb → page_post_experiment.rb} +12 -12
  225. data/lib/facebook_ads/ad_objects/page_saved_filter.rb +0 -101
  226. data/lib/facebook_ads/ad_objects/page_thread_owner.rb +37 -0
  227. data/lib/facebook_ads/ad_objects/page_user_message_thread_label.rb +44 -0
  228. data/lib/facebook_ads/ad_objects/partner_study.rb +52 -0
  229. data/lib/facebook_ads/ad_objects/payment_engine_payment.rb +74 -0
  230. data/lib/facebook_ads/ad_objects/payment_pricepoints.rb +37 -0
  231. data/lib/facebook_ads/ad_objects/payment_subscription.rb +58 -0
  232. data/lib/facebook_ads/ad_objects/permission.rb +44 -0
  233. data/lib/facebook_ads/ad_objects/{page_admin_note.rb → persona.rb} +3 -4
  234. data/lib/facebook_ads/ad_objects/photo.rb +60 -29
  235. data/lib/facebook_ads/ad_objects/{business_advertisable_applications_result.rb → place.rb} +3 -3
  236. data/lib/facebook_ads/ad_objects/place_topic.rb +0 -7
  237. data/lib/facebook_ads/ad_objects/platform_image_source.rb +39 -0
  238. data/lib/facebook_ads/ad_objects/playable_content.rb +42 -0
  239. data/lib/facebook_ads/ad_objects/post.rb +229 -0
  240. data/lib/facebook_ads/ad_objects/privacy.rb +42 -0
  241. data/lib/facebook_ads/ad_objects/{ad_study_ads_asset_user_permissions.rb → private_lift_study_instance.rb} +15 -12
  242. data/lib/facebook_ads/ad_objects/product_catalog.rb +276 -62
  243. data/lib/facebook_ads/ad_objects/{partner_category.rb → product_catalog_category.rb} +12 -13
  244. data/lib/facebook_ads/ad_objects/product_catalog_data_source.rb +46 -0
  245. data/lib/facebook_ads/ad_objects/product_catalog_diagnostic_group.rb +106 -0
  246. data/lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb +0 -10
  247. data/lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb +0 -10
  248. data/lib/facebook_ads/ad_objects/product_event_stat.rb +5 -4
  249. data/lib/facebook_ads/ad_objects/product_feed.rb +122 -11
  250. data/lib/facebook_ads/ad_objects/product_feed_missing_feed_item_replacement.rb +39 -0
  251. data/lib/facebook_ads/ad_objects/product_feed_rule.rb +44 -0
  252. data/lib/facebook_ads/ad_objects/product_feed_rule_suggestion.rb +39 -0
  253. data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +7 -8
  254. data/lib/facebook_ads/ad_objects/product_feed_upload.rb +10 -2
  255. data/lib/facebook_ads/ad_objects/product_feed_upload_error.rb +11 -1
  256. data/lib/facebook_ads/ad_objects/product_feed_upload_error_report.rb +38 -0
  257. data/lib/facebook_ads/ad_objects/product_feed_upload_error_sample.rb +37 -0
  258. data/lib/facebook_ads/ad_objects/product_group.rb +17 -6
  259. data/lib/facebook_ads/ad_objects/{owned_domain.rb → product_image.rb} +2 -2
  260. data/lib/facebook_ads/ad_objects/product_item.rb +604 -16
  261. data/lib/facebook_ads/ad_objects/{product_da_event_samples_batch.rb → product_item_ar_data.rb} +22 -17
  262. data/lib/facebook_ads/ad_objects/product_item_error.rb +40 -0
  263. data/lib/facebook_ads/ad_objects/product_item_importer_address.rb +42 -0
  264. data/lib/facebook_ads/ad_objects/product_set.rb +51 -1
  265. data/lib/facebook_ads/ad_objects/product_set_metadata.rb +40 -0
  266. data/lib/facebook_ads/ad_objects/profile.rb +19 -3
  267. data/lib/facebook_ads/ad_objects/profile_picture_source.rb +6 -4
  268. data/lib/facebook_ads/ad_objects/publisher_block_list.rb +54 -0
  269. data/lib/facebook_ads/ad_objects/{domain.rb → raw_custom_audience.rb} +2 -2
  270. data/lib/facebook_ads/ad_objects/reach_frequency_activity.rb +42 -0
  271. data/lib/facebook_ads/ad_objects/reach_frequency_ad_format.rb +38 -0
  272. data/lib/facebook_ads/ad_objects/reach_frequency_curve_lower_confidence_range.rb +42 -0
  273. data/lib/facebook_ads/ad_objects/reach_frequency_curve_upper_confidence_range.rb +42 -0
  274. data/lib/facebook_ads/ad_objects/reach_frequency_day_part.rb +39 -0
  275. data/lib/facebook_ads/ad_objects/reach_frequency_estimates_curve.rb +44 -0
  276. data/lib/facebook_ads/ad_objects/reach_frequency_estimates_placement_breakdown.rb +49 -0
  277. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +89 -21
  278. data/lib/facebook_ads/ad_objects/reach_frequency_spec.rb +1 -0
  279. data/lib/facebook_ads/ad_objects/{open_graph_rating.rb → recommendation.rb} +2 -1
  280. data/lib/facebook_ads/ad_objects/rich_media_element.rb +39 -0
  281. data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +15 -1
  282. data/lib/facebook_ads/ad_objects/saved_audience.rb +50 -0
  283. data/lib/facebook_ads/ad_objects/saved_message_response.rb +2 -11
  284. data/lib/facebook_ads/ad_objects/security_settings.rb +36 -0
  285. data/lib/facebook_ads/ad_objects/server_side/action_source.rb +48 -0
  286. data/lib/facebook_ads/ad_objects/server_side/batch_processor.rb +73 -0
  287. data/lib/facebook_ads/ad_objects/server_side/content.rb +209 -0
  288. data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +395 -0
  289. data/lib/facebook_ads/ad_objects/server_side/delivery_category.rb +33 -0
  290. data/lib/facebook_ads/ad_objects/server_side/event.rb +324 -0
  291. data/lib/facebook_ads/ad_objects/server_side/event_request.rb +296 -0
  292. data/lib/facebook_ads/ad_objects/server_side/event_request_async.rb +43 -0
  293. data/lib/facebook_ads/ad_objects/server_side/event_response.rb +106 -0
  294. data/lib/facebook_ads/ad_objects/server_side/http_method.rb +28 -0
  295. data/lib/facebook_ads/ad_objects/server_side/http_service_interface.rb +33 -0
  296. data/lib/facebook_ads/ad_objects/server_side/http_util.rb +31 -0
  297. data/lib/facebook_ads/ad_objects/server_side/user_data.rb +724 -0
  298. data/lib/facebook_ads/ad_objects/server_side/util.rb +323 -0
  299. data/lib/facebook_ads/ad_objects/shadow_ig_media_product_tags.rb +47 -0
  300. data/lib/facebook_ads/ad_objects/shop.rb +37 -0
  301. data/lib/facebook_ads/ad_objects/split_test_winner.rb +39 -0
  302. data/lib/facebook_ads/ad_objects/store_catalog_settings.rb +34 -0
  303. data/lib/facebook_ads/ad_objects/system_user.rb +34 -4
  304. data/lib/facebook_ads/ad_objects/tab.rb +1 -1
  305. data/lib/facebook_ads/ad_objects/targeting.rb +12 -12
  306. data/lib/facebook_ads/ad_objects/targeting_geo_location.rb +9 -1
  307. data/lib/facebook_ads/ad_objects/targeting_geo_location_geo_entities.rb +41 -0
  308. data/lib/facebook_ads/ad_objects/targeting_geo_location_location_cluster.rb +37 -0
  309. data/lib/facebook_ads/ad_objects/targeting_geo_location_location_expansion.rb +37 -0
  310. data/lib/facebook_ads/ad_objects/targeting_prospecting_audience.rb +37 -0
  311. data/lib/facebook_ads/ad_objects/targeting_relaxation.rb +37 -0
  312. data/lib/facebook_ads/ad_objects/text_with_entities.rb +37 -0
  313. data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb +38 -0
  314. data/lib/facebook_ads/ad_objects/tracking_and_conversion_with_defaults.rb +40 -0
  315. data/lib/facebook_ads/ad_objects/unified_thread.rb +12 -0
  316. data/lib/facebook_ads/ad_objects/url.rb +6 -2
  317. data/lib/facebook_ads/ad_objects/user.rb +482 -70
  318. data/lib/facebook_ads/ad_objects/user_cover_photo.rb +39 -0
  319. data/lib/facebook_ads/ad_objects/user_device.rb +38 -0
  320. data/lib/facebook_ads/ad_objects/user_id_for_app.rb +37 -0
  321. data/lib/facebook_ads/ad_objects/{publisher_space.rb → user_id_for_page.rb} +2 -2
  322. data/lib/facebook_ads/ad_objects/user_payment_mobile_pricepoints.rb +40 -0
  323. data/lib/facebook_ads/ad_objects/{page_videos_you_can_use.rb → value_based_eligible_source.rb} +2 -2
  324. data/lib/facebook_ads/ad_objects/vehicle.rb +189 -0
  325. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +91 -0
  326. data/lib/facebook_ads/ad_objects/video_copyright.rb +10 -4
  327. data/lib/facebook_ads/ad_objects/video_copyright_condition_group.rb +39 -0
  328. data/lib/facebook_ads/ad_objects/video_copyright_geo_gate.rb +38 -0
  329. data/lib/facebook_ads/ad_objects/video_copyright_rule.rb +2 -1
  330. data/lib/facebook_ads/ad_objects/video_copyright_segment.rb +39 -0
  331. data/lib/facebook_ads/ad_objects/video_list.rb +1 -6
  332. data/lib/facebook_ads/ad_objects/video_poll.rb +58 -0
  333. data/lib/facebook_ads/ad_objects/video_upload_limits.rb +38 -0
  334. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +135 -0
  335. data/lib/facebook_ads/ad_objects/{lead_gen_legal_content.rb → whats_app_business_profile.rb} +3 -4
  336. data/lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb +38 -0
  337. data/lib/facebook_ads/ad_objects/work_user_frontline.rb +38 -0
  338. data/lib/facebook_ads/api_response.rb +4 -0
  339. data/lib/facebook_ads/config.rb +1 -1
  340. data/lib/facebook_ads/crash_logger.rb +133 -0
  341. data/lib/facebook_ads/edge.rb +2 -1
  342. data/lib/facebook_ads/errors.rb +7 -2
  343. data/lib/facebook_ads/session.rb +6 -2
  344. data/lib/facebook_ads/version.rb +2 -2
  345. data/lib/facebook_ads.rb +11 -1
  346. data/lib/facebookbusiness.rb +18 -0
  347. metadata +357 -106
  348. data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +0 -225
  349. data/lib/facebook_ads/ad_objects/ad_account_roas.rb +0 -97
  350. data/lib/facebook_ads/ad_objects/ad_keyword_stats.rb +0 -55
  351. data/lib/facebook_ads/ad_objects/business_activity_log_event.rb +0 -55
  352. data/lib/facebook_ads/ad_objects/lead_gen_data_draft.rb +0 -95
  353. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +0 -47
  354. data/lib/facebook_ads/ad_objects/measurement_report.rb +0 -47
  355. data/lib/facebook_ads/ad_objects/native_offer.rb +0 -113
@@ -0,0 +1,323 @@
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.
18
+
19
+ require 'digest'
20
+ require 'countries'
21
+ require 'money'
22
+ require 'time'
23
+
24
+ module FacebookAds
25
+ module ServerSide
26
+ class Util
27
+ PHONE_NUMBER_IGNORE_CHAR_SET = /[\-\s\(\)]+/
28
+ PHONE_NUMBER_DROP_PREFIX_ZEROS = /^\+?0{0,2}/
29
+ US_PHONE_NUMBER_REGEX = /^1\(?\d{3}\)?\d{7}$/
30
+ INTL_PHONE_NUMBER_REGEX = /^\d{1,4}\(?\d{2,3}\)?\d{4,}$/
31
+
32
+ # RFC 2822 for email format
33
+ EMAIL_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
34
+
35
+ # Normalizes the input array of strings given the field_type
36
+ # @param [Array<String>] input string array that needs to be normalized
37
+ # @param [String] field_type Type/Key for the value provided
38
+ # @return [Array<String>] Normalized values for the input and field_type.
39
+ def self.normalize_array(input_array, field_type)
40
+ return nil unless input_array.is_a?(Enumerable)
41
+ return nil if input_array.empty?
42
+ return nil unless input_array.all?{|value| value.is_a?(String)}
43
+
44
+ input_array
45
+ .map{|value| self.normalize(value, field_type)}
46
+ .to_set
47
+ .to_a
48
+ end
49
+
50
+ # Normalizes the input string given the field_type
51
+ # @param [String] input Input string that needs to be normalized
52
+ # @param [String] field_type Type/Key for the value provided
53
+ # @return [String] Normalized value for the input and field_type.
54
+ def self.normalize(input, field_type)
55
+
56
+ if input.nil? or field_type.nil?
57
+ return nil;
58
+ end
59
+
60
+ input = input.strip.downcase
61
+
62
+ # If the data is already hashed, we by-pass input normalization
63
+ if is_already_hashed?(input) == true
64
+ return input
65
+ end
66
+
67
+ normalized_input = input;
68
+
69
+ case field_type
70
+ when 'action_source'
71
+ return normalize_action_source input
72
+ when 'country'
73
+ normalized_input = normalize_country input
74
+ when 'ct'
75
+ normalized_input = normalize_city input
76
+ when 'currency'
77
+ return normalize_currency input
78
+ when 'delivery_category'
79
+ return normalize_delivery_category input
80
+ when 'em'
81
+ normalized_input = normalize_email input
82
+ when 'ge'
83
+ normalized_input = normalize_gender input
84
+ when 'ph'
85
+ normalized_input = normalize_phone input
86
+ when 'st'
87
+ normalized_input = normalize_state input
88
+ when 'zp'
89
+ normalized_input = normalize_zip input
90
+ when 'f5first'
91
+ normalized_input = normalize_f5 input
92
+ when 'f5last'
93
+ normalized_input = normalize_f5 input
94
+ when 'fi'
95
+ normalized_input = normalize_fi input
96
+ when 'dobd'
97
+ normalized_input = normalize_dobd input
98
+ when 'dobm'
99
+ normalized_input = normalize_dobm input
100
+ when 'doby'
101
+ normalized_input = normalize_doby input
102
+ end
103
+
104
+ normalized_input = sha256Hash normalized_input
105
+
106
+ return normalized_input
107
+ end
108
+
109
+ # @return [String] SHA 256 hash of input string
110
+ def self.sha256Hash(input)
111
+ unless input.nil?
112
+ Digest::SHA256.hexdigest input
113
+ end
114
+ end
115
+
116
+ # Boolean method which checks if a input is already hashed with MD5 or SHA256
117
+ # @param [String] input Input string that is to be validated
118
+ # @return [TrueClass|FalseClass] representing whether the value is hashed
119
+ def self.is_already_hashed?(input)
120
+
121
+ # We support Md5 and SHA256, and highly recommend users to use SHA256 for hashing PII keys.
122
+ md5_match = /^[a-f0-9]{32}$/.match(input)
123
+ sha256_match = /^[a-f0-9]{64}$/.match(input)
124
+
125
+ if md5_match != nil or sha256_match != nil
126
+ return true
127
+ end
128
+
129
+ return false
130
+ end
131
+
132
+ # Normalizes the given country code and returns acceptable hashed country ISO code
133
+ def self.normalize_country(country)
134
+
135
+ # Replace unwanted characters and retain only alpha characters bounded for ISO code.
136
+ country = country.gsub(/[^a-z]/,'')
137
+ iso_country = ISO3166::Country.search(country)
138
+ if iso_country == nil
139
+ raise ArgumentError, "Invalid format for country:'" + country + "'.Please follow ISO 2-letter ISO 3166-1 standard for representing country. eg: us"
140
+ end
141
+
142
+ return country
143
+ end
144
+
145
+ # Normalizes the given city and returns acceptable hashed city value
146
+ def self.normalize_city(city)
147
+
148
+ # Remove commonly occuring characters from city name.
149
+ city = city.gsub(/[0-9.\s\-()]/,'')
150
+
151
+ return city
152
+ end
153
+
154
+ # Normalizes the given currency code and returns acceptable hashed currency ISO code
155
+ def self.normalize_currency(currency)
156
+
157
+ # Retain only alpha characters bounded for ISO code.
158
+ currency = currency.gsub(/[^a-z]/,'')
159
+
160
+ iso_currency = Money::Currency.find(currency)
161
+ if iso_currency == nil
162
+ raise ArgumentError, "Invalid format for currency:'" + currency + "'.Please follow ISO 3-letter ISO 4217 standard for representing currency. Eg: usd"
163
+ end
164
+
165
+ return currency;
166
+ end
167
+
168
+ # Normalizes the given email and returns acceptable hashed email value
169
+ def self.normalize_email(email)
170
+
171
+ if EMAIL_REGEX.match(email) == nil
172
+ raise ArgumentError, "Invalid email format for the passed email: '#{email}'. Please check the passed email format."
173
+ end
174
+
175
+ return email
176
+ end
177
+
178
+ # Normalizes the given gender and returns acceptable hashed gender value
179
+ def self.normalize_gender(gender)
180
+
181
+ # Replace extra characters with space, to bound under alpha characters set.
182
+ gender = gender.gsub(/[^a-z]/,'')
183
+
184
+ case gender
185
+ when 'female' , 'f'
186
+ gender = 'f'
187
+ when 'male' , 'm'
188
+ gender = 'm'
189
+ else
190
+ return nil
191
+ end
192
+
193
+ return gender
194
+ end
195
+
196
+ # Normalizes the given phone and returns acceptable hashed phone value
197
+ def self.normalize_phone(phone)
198
+
199
+ # Drop the spaces, hyphen and parenthesis from the Phone Number
200
+ normalized_phone = phone.gsub(PHONE_NUMBER_IGNORE_CHAR_SET, '')
201
+
202
+ if(is_international_number?(normalized_phone))
203
+ normalized_phone = normalized_phone.gsub(PHONE_NUMBER_DROP_PREFIX_ZEROS, '')
204
+ end
205
+
206
+ if normalized_phone.length < 7 || normalized_phone.length > 15
207
+ return nil;
208
+ end
209
+
210
+ return normalized_phone
211
+ end
212
+
213
+ # Normalizes the given state and returns acceptable hashed state value
214
+ def self.normalize_state(state)
215
+ state = state.gsub(/[0-9.\s\-()]/,'')
216
+
217
+ return state
218
+ end
219
+
220
+ # Normalizes the given zip and returns acceptable hashed zip code value
221
+ def self.normalize_zip(zip)
222
+
223
+ # Remove spaces from the Postal code
224
+ zip = zip.gsub(/[\s]/,'')
225
+
226
+ # If the zip code '-', we retain just the first part alone.
227
+ zip = zip.split('-')[0]
228
+
229
+ if zip.length < 2
230
+ return nil
231
+ end
232
+
233
+ return zip
234
+ end
235
+
236
+ # Boolean method which checks if a given number is represented in international format
237
+ # @param [String] phone_number that has to be tested.
238
+ # @return [TrueClass | FalseClass] boolean value representing if a number is international
239
+ def self.is_international_number?(phone_number)
240
+
241
+ # Drop upto 2 leading 0s from the number
242
+ phone_number = phone_number.gsub(PHONE_NUMBER_DROP_PREFIX_ZEROS, '')
243
+
244
+ if phone_number.start_with?('0')
245
+ return false;
246
+ end
247
+
248
+ if phone_number.start_with?('1') && US_PHONE_NUMBER_REGEX.match(phone_number) != nil
249
+ return false;
250
+ end
251
+
252
+ if INTL_PHONE_NUMBER_REGEX.match(phone_number) != nil
253
+ return true;
254
+ end
255
+
256
+ return false;
257
+ end
258
+
259
+ def self.normalize_f5(input)
260
+ input[0, 5]
261
+ end
262
+
263
+ def self.normalize_fi(fi)
264
+ fi[0, 1]
265
+ end
266
+
267
+ def self.normalize_dobd(dobd)
268
+ if dobd.length == 1
269
+ dobd = '0' + dobd
270
+ end
271
+
272
+ dobd_int = dobd.to_i
273
+ if dobd.length > 2 or dobd_int < 1 or dobd_int > 31
274
+ raise ArgumentError.new("Invalid dobd format: '#{dobd}'. Please pass in a valid date of birth day in 'DD' format.")
275
+ end
276
+
277
+ return dobd
278
+ end
279
+
280
+ def self.normalize_dobm(dobm)
281
+ if dobm.length == 1
282
+ dobm = '0' + dobm
283
+ end
284
+
285
+ dobm_int = dobm.to_i
286
+ if dobm.length > 2 or dobm_int < 1 or dobm_int > 12
287
+ raise ArgumentError.new("Invalid dobm format: '#{dobm}'. Please pass in a valid date of birth month in 'MM' format.")
288
+ end
289
+
290
+ return dobm
291
+ end
292
+
293
+ def self.normalize_doby(doby)
294
+ unless doby.match("^[0-9]{4}$")
295
+ raise ArgumentError.new("Invalid doby format: '#{doby}'. Please pass in a valid birth year in 'YYYY' format.")
296
+ end
297
+ doby
298
+ end
299
+
300
+ # Normalizes the input delivery category and returns valid value (or throw exception if invalid).
301
+ def self.normalize_delivery_category(delivery_category)
302
+
303
+ unless FacebookAds::ServerSide::DeliveryCategory.include?(delivery_category)
304
+ raise ArgumentError.new("Invalid delivery_category passed: " + delivery_category + ". Please use one of the defined values #{FacebookAds::ServerSide::DeliveryCategory.to_a.join(',')}" )
305
+ end
306
+
307
+ delivery_category;
308
+ end
309
+
310
+ # Normalizes the input action_source and returns valid value (or throw exception if invalid).
311
+ def self.normalize_action_source(action_source)
312
+ unless FacebookAds::ServerSide::ActionSource.include?(action_source)
313
+ values = FacebookAds::ServerSide::ActionSource.to_a.join(',')
314
+ raise ArgumentError.new(
315
+ "Invalid action_source passed: #{action_source}. Please use one of the defined values: #{values}"
316
+ )
317
+ end
318
+
319
+ action_source
320
+ end
321
+ end
322
+ end
323
+ end
@@ -0,0 +1,47 @@
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.
18
+
19
+ # FB:AUTOGEN
20
+
21
+ module FacebookAds
22
+ # This class is auto-generated.
23
+
24
+ # For any issues or feature requests related to this class, please let us know
25
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
26
+ # pull request for this class.
27
+
28
+ class ShadowIgMediaProductTags < AdObject
29
+
30
+ field :image_url, 'string'
31
+ field :is_checkout, 'bool'
32
+ field :merchant_id, 'int'
33
+ field :name, 'string'
34
+ field :price_string, 'string'
35
+ field :product_id, 'int'
36
+ field :review_status, 'string'
37
+ field :stripped_price_string, 'string'
38
+ field :stripped_sale_price_string, 'string'
39
+ field :x, 'double'
40
+ field :y, 'double'
41
+ has_no_id
42
+ has_no_get
43
+ has_no_post
44
+ has_no_delete
45
+
46
+ end
47
+ end
@@ -0,0 +1,37 @@
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.
18
+
19
+ # FB:AUTOGEN
20
+
21
+ module FacebookAds
22
+ # This class is auto-generated.
23
+
24
+ # For any issues or feature requests related to this class, please let us know
25
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
26
+ # pull request for this class.
27
+
28
+ class Shop < AdObject
29
+
30
+ field :fb_sales_channel, 'object'
31
+ field :id, 'string'
32
+ field :ig_sales_channel, 'object'
33
+ has_no_post
34
+ has_no_delete
35
+
36
+ end
37
+ end
@@ -0,0 +1,39 @@
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.
18
+
19
+ # FB:AUTOGEN
20
+
21
+ module FacebookAds
22
+ # This class is auto-generated.
23
+
24
+ # For any issues or feature requests related to this class, please let us know
25
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
26
+ # pull request for this class.
27
+
28
+ class SplitTestWinner < AdObject
29
+
30
+ field :ad_object_level, 'string'
31
+ field :confidences, 'hash'
32
+ field :winner_ad_object_id, 'string'
33
+ has_no_id
34
+ has_no_get
35
+ has_no_post
36
+ has_no_delete
37
+
38
+ end
39
+ end
@@ -0,0 +1,34 @@
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.
18
+
19
+ # FB:AUTOGEN
20
+
21
+ module FacebookAds
22
+ # This class is auto-generated.
23
+
24
+ # For any issues or feature requests related to this class, please let us know
25
+ # on github and we'll fix in our codegen framework. We'll not be able to accept
26
+ # pull request for this class.
27
+
28
+ class StoreCatalogSettings < AdObject
29
+
30
+ field :id, 'string'
31
+ field :page, 'Page'
32
+
33
+ end
34
+ end
@@ -27,22 +27,52 @@ module FacebookAds
27
27
 
28
28
  class SystemUser < AdObject
29
29
  ROLE = [
30
- "FINANCE_EDITOR",
31
- "FINANCE_ANALYST",
32
- "ADS_RIGHTS_REVIEWER",
33
30
  "ADMIN",
31
+ "ADS_RIGHTS_REVIEWER",
32
+ "DEFAULT",
33
+ "DEVELOPER",
34
34
  "EMPLOYEE",
35
- "FB_EMPLOYEE_SALES_REP",
35
+ "FINANCE_ANALYST",
36
+ "FINANCE_EDIT",
37
+ "FINANCE_EDITOR",
38
+ "FINANCE_VIEW",
39
+ "MANAGE",
40
+ "PARTNER_CENTER_ADMIN",
41
+ "PARTNER_CENTER_ANALYST",
42
+ "PARTNER_CENTER_EDUCATION",
43
+ "PARTNER_CENTER_MARKETING",
44
+ "PARTNER_CENTER_OPERATIONS",
36
45
  ]
37
46
 
38
47
 
39
48
  field :created_by, 'User'
40
49
  field :created_time, 'datetime'
50
+ field :finance_permission, 'string'
41
51
  field :id, 'string'
52
+ field :ip_permission, 'string'
42
53
  field :name, 'string'
43
54
  field :role, { enum: -> { ROLE }}
44
55
  field :system_user_id, 'int'
56
+ has_no_post
45
57
  has_no_delete
46
58
 
59
+ has_edge :assigned_ad_accounts do |edge|
60
+ edge.get 'AdAccount'
61
+ end
62
+
63
+ has_edge :assigned_business_asset_groups do |edge|
64
+ edge.get 'BusinessAssetGroup' do |api|
65
+ api.has_param :contained_asset_id, 'string'
66
+ end
67
+ end
68
+
69
+ has_edge :assigned_pages do |edge|
70
+ edge.get 'Page'
71
+ end
72
+
73
+ has_edge :assigned_product_catalogs do |edge|
74
+ edge.get 'ProductCatalog'
75
+ end
76
+
47
77
  end
48
78
  end
@@ -27,7 +27,7 @@ module FacebookAds
27
27
 
28
28
  class Tab < AdObject
29
29
 
30
- field :application, 'object'
30
+ field :application, 'Application'
31
31
  field :custom_image_url, 'string'
32
32
  field :custom_name, 'string'
33
33
  field :id, 'string'
@@ -27,15 +27,13 @@ module FacebookAds
27
27
 
28
28
  class Targeting < AdObject
29
29
  DEVICE_PLATFORMS = [
30
- "mobile",
31
30
  "desktop",
32
- "connected_tv",
31
+ "mobile",
33
32
  ]
34
33
 
35
34
  EFFECTIVE_DEVICE_PLATFORMS = [
36
- "mobile",
37
35
  "desktop",
38
- "connected_tv",
36
+ "mobile",
39
37
  ]
40
38
 
41
39
 
@@ -46,14 +44,16 @@ module FacebookAds
46
44
  field :app_install_state, 'string'
47
45
  field :audience_network_positions, { list: 'string' }
48
46
  field :behaviors, { list: 'IdName' }
47
+ field :brand_safety_content_filter_levels, { list: 'string' }
48
+ field :catalog_based_targeting, 'CatalogBasedTargeting'
49
49
  field :cities, { list: 'IdName' }
50
50
  field :college_years, { list: 'int' }
51
- field :connections, { list: 'IdName' }
51
+ field :connections, { list: 'ConnectionsTargeting' }
52
52
  field :contextual_targeting_categories, { list: 'IdName' }
53
53
  field :countries, { list: 'string' }
54
54
  field :country, { list: 'string' }
55
55
  field :country_groups, { list: 'string' }
56
- field :custom_audiences, { list: 'object' }
56
+ field :custom_audiences, { list: 'RawCustomAudience' }
57
57
  field :device_platforms, { list: { enum: -> { DEVICE_PLATFORMS }} }
58
58
  field :direct_install_devices, 'bool'
59
59
  field :dynamic_audience_ids, { list: 'string' }
@@ -69,8 +69,9 @@ module FacebookAds
69
69
  field :engagement_specs, { list: 'TargetingDynamicRule' }
70
70
  field :ethnic_affinity, { list: 'IdName' }
71
71
  field :exclude_reached_since, { list: 'string' }
72
- field :excluded_connections, { list: 'IdName' }
73
- field :excluded_custom_audiences, { list: 'IdName' }
72
+ field :excluded_brand_safety_content_types, { list: 'string' }
73
+ field :excluded_connections, { list: 'ConnectionsTargeting' }
74
+ field :excluded_custom_audiences, { list: 'RawCustomAudience' }
74
75
  field :excluded_dynamic_audience_ids, { list: 'string' }
75
76
  field :excluded_engagement_specs, { list: 'TargetingDynamicRule' }
76
77
  field :excluded_geo_locations, 'TargetingGeoLocation'
@@ -84,7 +85,7 @@ module FacebookAds
84
85
  field :family_statuses, { list: 'IdName' }
85
86
  field :fb_deal_id, 'string'
86
87
  field :flexible_spec, { list: 'FlexibleTargeting' }
87
- field :friends_of_connections, { list: 'IdName' }
88
+ field :friends_of_connections, { list: 'ConnectionsTargeting' }
88
89
  field :genders, { list: 'int' }
89
90
  field :generation, { list: 'IdName' }
90
91
  field :geo_locations, 'TargetingGeoLocation'
@@ -95,7 +96,7 @@ module FacebookAds
95
96
  field :income, { list: 'IdName' }
96
97
  field :industries, { list: 'IdName' }
97
98
  field :instagram_positions, { list: 'string' }
98
- field :instream_video_sponsorship_placements, { list: 'string' }
99
+ field :instream_video_skippable_excluded, 'bool'
99
100
  field :interested_in, { list: 'int' }
100
101
  field :interests, { list: 'IdName' }
101
102
  field :is_whatsapp_destination_ad, 'bool'
@@ -110,12 +111,11 @@ module FacebookAds
110
111
  field :political_views, { list: 'int' }
111
112
  field :politics, { list: 'IdName' }
112
113
  field :product_audience_specs, { list: 'TargetingProductAudienceSpec' }
114
+ field :prospecting_audience, 'TargetingProspectingAudience'
113
115
  field :publisher_platforms, { list: 'string' }
114
- field :publisher_visibility_categories, { list: 'string' }
115
116
  field :radius, 'string'
116
117
  field :regions, { list: 'IdName' }
117
118
  field :relationship_statuses, { list: 'int' }
118
- field :rtb_flag, 'bool'
119
119
  field :site_category, { list: 'string' }
120
120
  field :targeting_optimization, 'string'
121
121
  field :user_adclusters, { list: 'IdName' }
@@ -33,11 +33,19 @@ module FacebookAds
33
33
  field :custom_locations, { list: 'TargetingGeoLocationCustomLocation' }
34
34
  field :electoral_districts, { list: 'TargetingGeoLocationElectoralDistrict' }
35
35
  field :geo_markets, { list: 'TargetingGeoLocationMarket' }
36
- field :location_set_ids, { list: 'string' }
36
+ field :large_geo_areas, { list: 'TargetingGeoLocationGeoEntities' }
37
+ field :location_cluster_ids, { list: 'TargetingGeoLocationLocationCluster' }
38
+ field :location_expansion, 'TargetingGeoLocationLocationExpansion'
37
39
  field :location_types, { list: 'string' }
40
+ field :medium_geo_areas, { list: 'TargetingGeoLocationGeoEntities' }
41
+ field :metro_areas, { list: 'TargetingGeoLocationGeoEntities' }
42
+ field :neighborhoods, { list: 'TargetingGeoLocationGeoEntities' }
38
43
  field :places, { list: 'TargetingGeoLocationPlace' }
39
44
  field :political_districts, { list: 'TargetingGeoLocationPoliticalDistrict' }
40
45
  field :regions, { list: 'TargetingGeoLocationRegion' }
46
+ field :small_geo_areas, { list: 'TargetingGeoLocationGeoEntities' }
47
+ field :subcities, { list: 'TargetingGeoLocationGeoEntities' }
48
+ field :subneighborhoods, { list: 'TargetingGeoLocationGeoEntities' }
41
49
  field :zips, { list: 'TargetingGeoLocationZip' }
42
50
  has_no_id
43
51
  has_no_get