facebookbusiness 0.3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (297) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE.txt +17 -0
  3. data/README.md +256 -0
  4. data/lib/facebook_ads.rb +72 -0
  5. data/lib/facebook_ads/ad_object.rb +177 -0
  6. data/lib/facebook_ads/ad_objects/ad.rb +243 -0
  7. data/lib/facebook_ads/ad_objects/ad_account.rb +771 -0
  8. data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +59 -0
  9. data/lib/facebook_ads/ad_objects/ad_account_contextual_targeting.rb +36 -0
  10. data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +217 -0
  11. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +65 -0
  12. data/lib/facebook_ads/ad_objects/ad_account_roas.rb +97 -0
  13. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +151 -0
  14. data/lib/facebook_ads/ad_objects/ad_account_user.rb +40 -0
  15. data/lib/facebook_ads/ad_objects/ad_activity.rb +125 -0
  16. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +98 -0
  17. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_asset_label.rb +37 -0
  18. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_body.rb +39 -0
  19. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_caption.rb +39 -0
  20. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_description.rb +39 -0
  21. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_group_rule.rb +43 -0
  22. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_image.rb +41 -0
  23. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_link_url.rb +42 -0
  24. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_title.rb +39 -0
  25. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_video.rb +42 -0
  26. data/lib/facebook_ads/ad_objects/ad_async_request.rb +67 -0
  27. data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +68 -0
  28. data/lib/facebook_ads/ad_objects/ad_async_request_set_notification_result.rb +38 -0
  29. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +65 -0
  30. data/lib/facebook_ads/ad_objects/ad_campaign_frequency_control_specs.rb +39 -0
  31. data/lib/facebook_ads/ad_objects/ad_creative.rb +178 -0
  32. data/lib/facebook_ads/ad_objects/ad_creative_collection_thumbnail_info.rb +39 -0
  33. data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +79 -0
  34. data/lib/facebook_ads/ad_objects/ad_creative_link_data_app_link_spec.rb +40 -0
  35. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +87 -0
  36. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +46 -0
  37. data/lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb +47 -0
  38. data/lib/facebook_ads/ad_objects/ad_creative_link_data_custom_overlay_spec.rb +100 -0
  39. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +101 -0
  40. data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +43 -0
  41. data/lib/facebook_ads/ad_objects/ad_creative_photo_data.rb +43 -0
  42. data/lib/facebook_ads/ad_objects/ad_creative_place_data.rb +42 -0
  43. data/lib/facebook_ads/ad_objects/ad_creative_post_click_configuration.rb +38 -0
  44. data/lib/facebook_ads/ad_objects/ad_creative_text_data.rb +37 -0
  45. data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb +53 -0
  46. data/lib/facebook_ads/ad_objects/ad_image.rb +57 -0
  47. data/lib/facebook_ads/ad_objects/ad_keyword_stats.rb +55 -0
  48. data/lib/facebook_ads/ad_objects/ad_label.rb +57 -0
  49. data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_result.rb +41 -0
  50. data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +38 -0
  51. data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +44 -0
  52. data/lib/facebook_ads/ad_objects/ad_preview.rb +62 -0
  53. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +64 -0
  54. data/lib/facebook_ads/ad_objects/ad_recommendation.rb +55 -0
  55. data/lib/facebook_ads/ad_objects/ad_recommendation_data.rb +37 -0
  56. data/lib/facebook_ads/ad_objects/ad_report_run.rb +71 -0
  57. data/lib/facebook_ads/ad_objects/ad_rule.rb +56 -0
  58. data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb +44 -0
  59. data/lib/facebook_ads/ad_objects/ad_rule_execution_options.rb +44 -0
  60. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +49 -0
  61. data/lib/facebook_ads/ad_objects/ad_rule_filters.rb +55 -0
  62. data/lib/facebook_ads/ad_objects/ad_rule_history.rb +58 -0
  63. data/lib/facebook_ads/ad_objects/ad_rule_history_result.rb +45 -0
  64. data/lib/facebook_ads/ad_objects/ad_rule_history_result_action.rb +40 -0
  65. data/lib/facebook_ads/ad_objects/ad_rule_schedule.rb +39 -0
  66. data/lib/facebook_ads/ad_objects/ad_rule_schedule_spec.rb +38 -0
  67. data/lib/facebook_ads/ad_objects/ad_rule_trigger.rb +63 -0
  68. data/lib/facebook_ads/ad_objects/ad_set.rb +300 -0
  69. data/lib/facebook_ads/ad_objects/ad_study.rb +104 -0
  70. data/lib/facebook_ads/ad_objects/ad_study_ads_asset_user_permissions.rb +46 -0
  71. data/lib/facebook_ads/ad_objects/ad_study_cell.rb +59 -0
  72. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +58 -0
  73. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +50 -0
  74. data/lib/facebook_ads/ad_objects/adgroup_relevance_score.rb +40 -0
  75. data/lib/facebook_ads/ad_objects/adgroup_review_feedback.rb +38 -0
  76. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +55 -0
  77. data/lib/facebook_ads/ad_objects/ads_data_partner.rb +37 -0
  78. data/lib/facebook_ads/ad_objects/ads_image_crops.rb +43 -0
  79. data/lib/facebook_ads/ad_objects/ads_insights.rb +224 -0
  80. data/lib/facebook_ads/ad_objects/ads_pixel.rb +76 -0
  81. data/lib/facebook_ads/ad_objects/ads_pixel_stats.rb +40 -0
  82. data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb +51 -0
  83. data/lib/facebook_ads/ad_objects/agency_client_declaration.rb +48 -0
  84. data/lib/facebook_ads/ad_objects/album.rb +102 -0
  85. data/lib/facebook_ads/ad_objects/android_app_link.rb +40 -0
  86. data/lib/facebook_ads/ad_objects/app_links.rb +43 -0
  87. data/lib/facebook_ads/ad_objects/assigned_user.rb +38 -0
  88. data/lib/facebook_ads/ad_objects/attribution_spec.rb +38 -0
  89. data/lib/facebook_ads/ad_objects/audience_permission.rb +39 -0
  90. data/lib/facebook_ads/ad_objects/audio_copyright.rb +46 -0
  91. data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +46 -0
  92. data/lib/facebook_ads/ad_objects/business.rb +523 -0
  93. data/lib/facebook_ads/ad_objects/business_activity_log_event.rb +55 -0
  94. data/lib/facebook_ads/ad_objects/business_ad_account_request.rb +37 -0
  95. data/lib/facebook_ads/ad_objects/business_advertisable_applications_result.rb +38 -0
  96. data/lib/facebook_ads/ad_objects/business_application_request.rb +37 -0
  97. data/lib/facebook_ads/ad_objects/business_matched_search_applications_edge_data.rb +58 -0
  98. data/lib/facebook_ads/ad_objects/business_page_request.rb +37 -0
  99. data/lib/facebook_ads/ad_objects/business_project.rb +45 -0
  100. data/lib/facebook_ads/ad_objects/business_role_request.rb +61 -0
  101. data/lib/facebook_ads/ad_objects/business_user.rb +52 -0
  102. data/lib/facebook_ads/ad_objects/campaign.rb +233 -0
  103. data/lib/facebook_ads/ad_objects/canvas.rb +52 -0
  104. data/lib/facebook_ads/ad_objects/canvas_body_element.rb +37 -0
  105. data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +40 -0
  106. data/lib/facebook_ads/ad_objects/conversion_action_query.rb +62 -0
  107. data/lib/facebook_ads/ad_objects/copyright_attribution_insights.rb +41 -0
  108. data/lib/facebook_ads/ad_objects/cover_photo.rb +40 -0
  109. data/lib/facebook_ads/ad_objects/custom_audience.rb +174 -0
  110. data/lib/facebook_ads/ad_objects/custom_audience_ad_account.rb +36 -0
  111. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +104 -0
  112. data/lib/facebook_ads/ad_objects/custom_audience_permission.rb +41 -0
  113. data/lib/facebook_ads/ad_objects/custom_audience_prefill_state.rb +39 -0
  114. data/lib/facebook_ads/ad_objects/custom_audience_session.rb +44 -0
  115. data/lib/facebook_ads/ad_objects/custom_audience_status.rb +38 -0
  116. data/lib/facebook_ads/ad_objects/custom_audiences_tos.rb +38 -0
  117. data/lib/facebook_ads/ad_objects/custom_conversion.rb +109 -0
  118. data/lib/facebook_ads/ad_objects/custom_conversion_stats_result.rb +50 -0
  119. data/lib/facebook_ads/ad_objects/day_part.rb +40 -0
  120. data/lib/facebook_ads/ad_objects/delivery_check.rb +40 -0
  121. data/lib/facebook_ads/ad_objects/delivery_check_extra_info.rb +39 -0
  122. data/lib/facebook_ads/ad_objects/direct_deal.rb +66 -0
  123. data/lib/facebook_ads/ad_objects/direct_debit.rb +45 -0
  124. data/lib/facebook_ads/ad_objects/domain.rb +37 -0
  125. data/lib/facebook_ads/ad_objects/engagement.rb +43 -0
  126. data/lib/facebook_ads/ad_objects/ent_with_sponsor.rb +39 -0
  127. data/lib/facebook_ads/ad_objects/event.rb +190 -0
  128. data/lib/facebook_ads/ad_objects/event_source_group.rb +53 -0
  129. data/lib/facebook_ads/ad_objects/extended_credit.rb +70 -0
  130. data/lib/facebook_ads/ad_objects/extended_credit_allocation_config.rb +61 -0
  131. data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +43 -0
  132. data/lib/facebook_ads/ad_objects/external_event_source.rb +38 -0
  133. data/lib/facebook_ads/ad_objects/flexible_targeting.rb +64 -0
  134. data/lib/facebook_ads/ad_objects/funding_source_details.rb +39 -0
  135. data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +40 -0
  136. data/lib/facebook_ads/ad_objects/helpers/custom_audience_helpers.rb +170 -0
  137. data/lib/facebook_ads/ad_objects/hotel_room.rb +43 -0
  138. data/lib/facebook_ads/ad_objects/id_name.rb +37 -0
  139. data/lib/facebook_ads/ad_objects/insights_result.rb +73 -0
  140. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +67 -0
  141. data/lib/facebook_ads/ad_objects/instagram_insights_value.rb +38 -0
  142. data/lib/facebook_ads/ad_objects/instant_article.rb +47 -0
  143. data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +61 -0
  144. data/lib/facebook_ads/ad_objects/ios_app_link.rb +39 -0
  145. data/lib/facebook_ads/ad_objects/lead.rb +47 -0
  146. data/lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group.rb +37 -0
  147. data/lib/facebook_ads/ad_objects/lead_gen_data_draft.rb +94 -0
  148. data/lib/facebook_ads/ad_objects/lead_gen_draft_question.rb +44 -0
  149. data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +47 -0
  150. data/lib/facebook_ads/ad_objects/lead_gen_legal_content.rb +43 -0
  151. data/lib/facebook_ads/ad_objects/lead_gen_qualifier.rb +40 -0
  152. data/lib/facebook_ads/ad_objects/lead_gen_question.rb +43 -0
  153. data/lib/facebook_ads/ad_objects/lead_gen_question_option.rb +38 -0
  154. data/lib/facebook_ads/ad_objects/leadgen_form.rb +118 -0
  155. data/lib/facebook_ads/ad_objects/legacy_business_ad_account_request.rb +38 -0
  156. data/lib/facebook_ads/ad_objects/life_event.rb +54 -0
  157. data/lib/facebook_ads/ad_objects/live_video.rb +100 -0
  158. data/lib/facebook_ads/ad_objects/location.rb +49 -0
  159. data/lib/facebook_ads/ad_objects/lookalike_spec.rb +43 -0
  160. data/lib/facebook_ads/ad_objects/mailing_address.rb +42 -0
  161. data/lib/facebook_ads/ad_objects/measurement_report.rb +47 -0
  162. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +47 -0
  163. data/lib/facebook_ads/ad_objects/messaging_feature_review.rb +38 -0
  164. data/lib/facebook_ads/ad_objects/messenger_profile.rb +55 -0
  165. data/lib/facebook_ads/ad_objects/minimum_budget.rb +41 -0
  166. data/lib/facebook_ads/ad_objects/native_offer.rb +113 -0
  167. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +137 -0
  168. data/lib/facebook_ads/ad_objects/offline_terms_of_service.rb +37 -0
  169. data/lib/facebook_ads/ad_objects/offsite_pixel.rb +57 -0
  170. data/lib/facebook_ads/ad_objects/open_graph_context.rb +35 -0
  171. data/lib/facebook_ads/ad_objects/open_graph_rating.rb +43 -0
  172. data/lib/facebook_ads/ad_objects/oracle_transaction.rb +51 -0
  173. data/lib/facebook_ads/ad_objects/outcome_prediction_point.rb +40 -0
  174. data/lib/facebook_ads/ad_objects/owned_domain.rb +37 -0
  175. data/lib/facebook_ads/ad_objects/page.rb +1231 -0
  176. data/lib/facebook_ads/ad_objects/page_admin_note.rb +37 -0
  177. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +104 -0
  178. data/lib/facebook_ads/ad_objects/page_category.rb +39 -0
  179. data/lib/facebook_ads/ad_objects/page_change_proposal.rb +39 -0
  180. data/lib/facebook_ads/ad_objects/page_insights_async_export_run.rb +43 -0
  181. data/lib/facebook_ads/ad_objects/page_label.rb +47 -0
  182. data/lib/facebook_ads/ad_objects/page_parking.rb +39 -0
  183. data/lib/facebook_ads/ad_objects/page_payment_options.rb +41 -0
  184. data/lib/facebook_ads/ad_objects/page_post.rb +159 -0
  185. data/lib/facebook_ads/ad_objects/page_restaurant_services.rb +46 -0
  186. data/lib/facebook_ads/ad_objects/page_restaurant_specialties.rb +41 -0
  187. data/lib/facebook_ads/ad_objects/page_saved_filter.rb +134 -0
  188. data/lib/facebook_ads/ad_objects/page_settings.rb +38 -0
  189. data/lib/facebook_ads/ad_objects/page_start_info.rb +38 -0
  190. data/lib/facebook_ads/ad_objects/page_upcoming_change.rb +39 -0
  191. data/lib/facebook_ads/ad_objects/page_videos_you_can_use.rb +38 -0
  192. data/lib/facebook_ads/ad_objects/partner_category.rb +51 -0
  193. data/lib/facebook_ads/ad_objects/partner_integration_linked.rb +42 -0
  194. data/lib/facebook_ads/ad_objects/persona.rb +37 -0
  195. data/lib/facebook_ads/ad_objects/photo.rb +102 -0
  196. data/lib/facebook_ads/ad_objects/place_topic.rb +49 -0
  197. data/lib/facebook_ads/ad_objects/product_catalog.rb +335 -0
  198. data/lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb +50 -0
  199. data/lib/facebook_ads/ad_objects/product_catalog_image_settings.rb +38 -0
  200. data/lib/facebook_ads/ad_objects/product_catalog_image_settings_operation.rb +37 -0
  201. data/lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb +50 -0
  202. data/lib/facebook_ads/ad_objects/product_catalog_product_sets_batch.rb +40 -0
  203. data/lib/facebook_ads/ad_objects/product_da_event_samples_batch.rb +54 -0
  204. data/lib/facebook_ads/ad_objects/product_event_stat.rb +74 -0
  205. data/lib/facebook_ads/ad_objects/product_feed.rb +126 -0
  206. data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +62 -0
  207. data/lib/facebook_ads/ad_objects/product_feed_upload.rb +57 -0
  208. data/lib/facebook_ads/ad_objects/product_feed_upload_error.rb +49 -0
  209. data/lib/facebook_ads/ad_objects/product_group.rb +98 -0
  210. data/lib/facebook_ads/ad_objects/product_item.rb +155 -0
  211. data/lib/facebook_ads/ad_objects/product_item_commerce_insights.rb +39 -0
  212. data/lib/facebook_ads/ad_objects/product_set.rb +52 -0
  213. data/lib/facebook_ads/ad_objects/product_variant.rb +39 -0
  214. data/lib/facebook_ads/ad_objects/products_quality_issue.rb +42 -0
  215. data/lib/facebook_ads/ad_objects/profile.rb +62 -0
  216. data/lib/facebook_ads/ad_objects/profile_picture_source.rb +53 -0
  217. data/lib/facebook_ads/ad_objects/publisher_space.rb +37 -0
  218. data/lib/facebook_ads/ad_objects/reach_estimate.rb +39 -0
  219. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +101 -0
  220. data/lib/facebook_ads/ad_objects/reach_frequency_spec.rb +43 -0
  221. data/lib/facebook_ads/ad_objects/rev_share_policy.rb +38 -0
  222. data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +44 -0
  223. data/lib/facebook_ads/ad_objects/saved_message_response.rb +49 -0
  224. data/lib/facebook_ads/ad_objects/screen_name.rb +39 -0
  225. data/lib/facebook_ads/ad_objects/shadow_ig_comment.rb +47 -0
  226. data/lib/facebook_ads/ad_objects/shadow_ig_media.rb +61 -0
  227. data/lib/facebook_ads/ad_objects/shadow_ig_user.rb +74 -0
  228. data/lib/facebook_ads/ad_objects/system_user.rb +48 -0
  229. data/lib/facebook_ads/ad_objects/tab.rb +45 -0
  230. data/lib/facebook_ads/ad_objects/targeting.rb +134 -0
  231. data/lib/facebook_ads/ad_objects/targeting_dynamic_rule.rb +44 -0
  232. data/lib/facebook_ads/ad_objects/targeting_geo_location.rb +47 -0
  233. data/lib/facebook_ads/ad_objects/targeting_geo_location_city.rb +43 -0
  234. data/lib/facebook_ads/ad_objects/targeting_geo_location_custom_location.rb +50 -0
  235. data/lib/facebook_ads/ad_objects/targeting_geo_location_electoral_district.rb +40 -0
  236. data/lib/facebook_ads/ad_objects/targeting_geo_location_market.rb +40 -0
  237. data/lib/facebook_ads/ad_objects/targeting_geo_location_place.rb +45 -0
  238. data/lib/facebook_ads/ad_objects/targeting_geo_location_political_district.rb +40 -0
  239. data/lib/facebook_ads/ad_objects/targeting_geo_location_region.rb +39 -0
  240. data/lib/facebook_ads/ad_objects/targeting_geo_location_zip.rb +41 -0
  241. data/lib/facebook_ads/ad_objects/targeting_product_audience_spec.rb +39 -0
  242. data/lib/facebook_ads/ad_objects/targeting_product_audience_sub_spec.rb +38 -0
  243. data/lib/facebook_ads/ad_objects/targeting_sentence_line.rb +38 -0
  244. data/lib/facebook_ads/ad_objects/transaction.rb +51 -0
  245. data/lib/facebook_ads/ad_objects/transaction_currency_amount.rb +39 -0
  246. data/lib/facebook_ads/ad_objects/unified_thread.rb +49 -0
  247. data/lib/facebook_ads/ad_objects/url.rb +41 -0
  248. data/lib/facebook_ads/ad_objects/user.rb +268 -0
  249. data/lib/facebook_ads/ad_objects/user_lead_gen_disclaimer_response.rb +38 -0
  250. data/lib/facebook_ads/ad_objects/user_lead_gen_field_data.rb +38 -0
  251. data/lib/facebook_ads/ad_objects/video_copyright.rb +58 -0
  252. data/lib/facebook_ads/ad_objects/video_copyright_rule.rb +46 -0
  253. data/lib/facebook_ads/ad_objects/video_list.rb +52 -0
  254. data/lib/facebook_ads/ad_objects/video_thumbnail.rb +42 -0
  255. data/lib/facebook_ads/ad_objects/voip_info.rb +43 -0
  256. data/lib/facebook_ads/ad_objects/web_app_link.rb +38 -0
  257. data/lib/facebook_ads/ad_objects/windows_app_link.rb +40 -0
  258. data/lib/facebook_ads/ad_objects/windows_phone_app_link.rb +39 -0
  259. data/lib/facebook_ads/api_request.rb +123 -0
  260. data/lib/facebook_ads/api_response.rb +47 -0
  261. data/lib/facebook_ads/batch_api/batch.rb +86 -0
  262. data/lib/facebook_ads/batch_api/batch_proxy.rb +67 -0
  263. data/lib/facebook_ads/config.rb +43 -0
  264. data/lib/facebook_ads/edge.rb +184 -0
  265. data/lib/facebook_ads/errors.rb +55 -0
  266. data/lib/facebook_ads/field_types.rb +65 -0
  267. data/lib/facebook_ads/field_types/ad_object.rb +37 -0
  268. data/lib/facebook_ads/field_types/base.rb +33 -0
  269. data/lib/facebook_ads/field_types/boolean.rb +25 -0
  270. data/lib/facebook_ads/field_types/datetime.rb +47 -0
  271. data/lib/facebook_ads/field_types/double.rb +29 -0
  272. data/lib/facebook_ads/field_types/enum.rb +31 -0
  273. data/lib/facebook_ads/field_types/integer.rb +33 -0
  274. data/lib/facebook_ads/field_types/list.rb +57 -0
  275. data/lib/facebook_ads/field_types/object.rb +45 -0
  276. data/lib/facebook_ads/field_types/string_type.rb +39 -0
  277. data/lib/facebook_ads/field_types/upload_file.rb +121 -0
  278. data/lib/facebook_ads/fields.rb +66 -0
  279. data/lib/facebook_ads/helpers/edge_helpers.rb +57 -0
  280. data/lib/facebook_ads/helpers/node_helpers.rb +80 -0
  281. data/lib/facebook_ads/helpers/shortcuts.rb +34 -0
  282. data/lib/facebook_ads/param_set.rb +74 -0
  283. data/lib/facebook_ads/ruby2patch.rb +27 -0
  284. data/lib/facebook_ads/session.rb +99 -0
  285. data/lib/facebook_ads/test.rb +23 -0
  286. data/lib/facebook_ads/test/base.rb +98 -0
  287. data/lib/facebook_ads/test/config.rb +55 -0
  288. data/lib/facebook_ads/test/errors.rb +23 -0
  289. data/lib/facebook_ads/test/exit_codes.rb +29 -0
  290. data/lib/facebook_ads/test/exit_hook.rb +35 -0
  291. data/lib/facebook_ads/test/fixtures.rb +107 -0
  292. data/lib/facebook_ads/utils/utils.rb +29 -0
  293. data/lib/facebook_ads/version.rb +24 -0
  294. data/lib/facebook_ads/videos/video_io.rb +25 -0
  295. data/lib/facebook_ads/videos/video_request.rb +42 -0
  296. data/lib/facebookbusiness.rb +1 -0
  297. metadata +508 -0
@@ -0,0 +1,38 @@
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 LegacyBusinessAdAccountRequest < AdObject
29
+
30
+ field :ad_account, 'AdAccount'
31
+ field :id, 'string'
32
+ field :permitted_roles, { list: 'string' }
33
+ has_no_get
34
+ has_no_post
35
+ has_no_delete
36
+
37
+ end
38
+ end
@@ -0,0 +1,54 @@
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 LifeEvent < AdObject
29
+
30
+ field :created_time, 'datetime'
31
+ field :description, 'string'
32
+ field :end_time, 'datetime'
33
+ field :from, 'Page'
34
+ field :id, 'string'
35
+ field :is_hidden, 'bool'
36
+ field :start_time, 'datetime'
37
+ field :title, 'string'
38
+ field :updated_time, 'datetime'
39
+ has_no_post
40
+ has_no_delete
41
+
42
+ has_edge :comments do |edge|
43
+ edge.post do |api|
44
+ api.has_param :attachment_id, 'string'
45
+ api.has_param :attachment_share_url, 'string'
46
+ api.has_param :attachment_url, 'string'
47
+ api.has_param :is_offline, 'bool'
48
+ api.has_param :message, 'string'
49
+ api.has_param :text, 'string'
50
+ end
51
+ end
52
+
53
+ end
54
+ end
@@ -0,0 +1,100 @@
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 LiveVideo < AdObject
29
+ LIVE_COMMENT_MODERATION_SETTING = [
30
+ "FOLLOWER",
31
+ "SLOW",
32
+ "DISCUSSION",
33
+ ]
34
+
35
+ STATUS = [
36
+ "UNPUBLISHED",
37
+ "LIVE_NOW",
38
+ "SCHEDULED_UNPUBLISHED",
39
+ "SCHEDULED_LIVE",
40
+ "SCHEDULED_CANCELED",
41
+ ]
42
+
43
+ STREAM_TYPE = [
44
+ "REGULAR",
45
+ "AMBIENT",
46
+ ]
47
+
48
+ BROADCAST_STATUS = [
49
+ "UNPUBLISHED",
50
+ "LIVE",
51
+ "LIVE_STOPPED",
52
+ "PROCESSING",
53
+ "VOD",
54
+ "SCHEDULED_UNPUBLISHED",
55
+ "SCHEDULED_LIVE",
56
+ "SCHEDULED_EXPIRED",
57
+ "SCHEDULED_CANCELED",
58
+ ]
59
+
60
+ PROJECTION = [
61
+ "EQUIRECTANGULAR",
62
+ "CUBEMAP",
63
+ "SINGLE_FISH_EYE",
64
+ ]
65
+
66
+ SPATIAL_AUDIO_FORMAT = [
67
+ "ambiX_4",
68
+ ]
69
+
70
+ TYPE = [
71
+ "tagged",
72
+ "uploaded",
73
+ ]
74
+
75
+
76
+ field :ad_break_config, 'object'
77
+ field :ad_break_failure_reason, 'string'
78
+ field :broadcast_start_time, 'datetime'
79
+ field :copyright, 'VideoCopyright'
80
+ field :creation_time, 'datetime'
81
+ field :dash_preview_url, 'string'
82
+ field :description, 'string'
83
+ field :embed_html, 'string'
84
+ field :from, 'object'
85
+ field :id, 'string'
86
+ field :is_manual_mode, 'bool'
87
+ field :is_reference_only, 'bool'
88
+ field :live_encoders, { list: 'object' }
89
+ field :live_views, 'int'
90
+ field :permalink_url, 'string'
91
+ field :planned_start_time, 'datetime'
92
+ field :seconds_left, 'int'
93
+ field :secure_stream_url, 'string'
94
+ field :status, 'string'
95
+ field :stream_url, 'string'
96
+ field :title, 'string'
97
+ field :video, 'object'
98
+
99
+ end
100
+ end
@@ -0,0 +1,49 @@
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 Location < AdObject
29
+
30
+ field :city, 'string'
31
+ field :city_id, 'int'
32
+ field :country, 'string'
33
+ field :country_code, 'string'
34
+ field :latitude, 'double'
35
+ field :located_in, 'string'
36
+ field :longitude, 'double'
37
+ field :name, 'string'
38
+ field :region, 'string'
39
+ field :region_id, 'int'
40
+ field :state, 'string'
41
+ field :street, 'string'
42
+ field :zip, 'string'
43
+ has_no_id
44
+ has_no_get
45
+ has_no_post
46
+ has_no_delete
47
+
48
+ end
49
+ end
@@ -0,0 +1,43 @@
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 LookalikeSpec < AdObject
29
+
30
+ field :country, 'string'
31
+ field :is_financial_service, 'bool'
32
+ field :origin, { list: 'object' }
33
+ field :ratio, 'double'
34
+ field :starting_ratio, 'double'
35
+ field :target_countries, { list: 'string' }
36
+ field :type, 'string'
37
+ has_no_id
38
+ has_no_get
39
+ has_no_post
40
+ has_no_delete
41
+
42
+ end
43
+ end
@@ -0,0 +1,42 @@
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 MailingAddress < AdObject
29
+
30
+ field :city, 'string'
31
+ field :city_page, 'Page'
32
+ field :country, 'string'
33
+ field :id, 'string'
34
+ field :postal_code, 'string'
35
+ field :region, 'string'
36
+ field :street1, 'string'
37
+ field :street2, 'string'
38
+ has_no_post
39
+ has_no_delete
40
+
41
+ end
42
+ 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 MeasurementReport < AdObject
29
+ REPORT_TYPE = [
30
+ "multi_channel_report",
31
+ "video_metrics_report",
32
+ "fruit_rollup_report",
33
+ "third_party_mta_report",
34
+ "partner_lift_study_report",
35
+ "mmm_report",
36
+ ]
37
+
38
+
39
+ field :download_urls, { list: 'string' }
40
+ field :id, 'string'
41
+ field :metadata, 'hash'
42
+ field :report_type, 'string'
43
+ field :status, 'string'
44
+ field :upload_urls, { list: 'string' }
45
+
46
+ end
47
+ 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 MediaFingerprint < AdObject
29
+ FINGERPRINT_CONTENT_TYPE = [
30
+ "SONGTRACK",
31
+ "EPISODE",
32
+ "OTHER",
33
+ "MOVIE",
34
+ "AM_SONGTRACK",
35
+ ]
36
+
37
+
38
+ field :duration_in_sec, 'double'
39
+ field :fingerprint_content_type, 'string'
40
+ field :fingerprint_type, 'string'
41
+ field :id, 'string'
42
+ field :metadata, 'object'
43
+ field :title, 'string'
44
+ field :universal_content_id, 'string'
45
+
46
+ end
47
+ end
@@ -0,0 +1,38 @@
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 MessagingFeatureReview < AdObject
29
+
30
+ field :feature, 'string'
31
+ field :status, 'string'
32
+ has_no_id
33
+ has_no_get
34
+ has_no_post
35
+ has_no_delete
36
+
37
+ end
38
+ end