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,594 @@
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 Group < AdObject
29
+ JOIN_SETTING = [
30
+ "ADMIN_ONLY",
31
+ "ANYONE",
32
+ "NONE",
33
+ ]
34
+
35
+ POST_PERMISSIONS = [
36
+ "0",
37
+ "1",
38
+ "2",
39
+ ]
40
+
41
+ PURPOSE = [
42
+ "BOOKS",
43
+ "CASUAL",
44
+ "CLOSE_FRIENDS",
45
+ "CLUB",
46
+ "COUPLE",
47
+ "COWORKERS",
48
+ "CUSTOM",
49
+ "DEALS",
50
+ "EPHEMERAL",
51
+ "EVENT_PLANNING",
52
+ "FAMILY",
53
+ "FANDOM_RADAR",
54
+ "FANTASY_LEAGUE",
55
+ "FITNESS",
56
+ "FOR_SALE",
57
+ "FOR_WORK",
58
+ "FRATERNITY",
59
+ "GAME",
60
+ "HEALTH_SUPPORT",
61
+ "HIGH_SCHOOL_FORUM",
62
+ "JOBS",
63
+ "LEARNING",
64
+ "MENTORSHIP",
65
+ "MUSIC_CASA_BUNDLE",
66
+ "NEIGHBORS",
67
+ "NONE",
68
+ "OCULUS",
69
+ "PARENTING",
70
+ "PARENTS",
71
+ "PROJECT",
72
+ "REAL_WORLD",
73
+ "REAL_WORLD_AT_WORK",
74
+ "RESTYLE",
75
+ "SCHOOL_CLASS",
76
+ "SORORITY",
77
+ "SPORTS",
78
+ "SPORTS_ACTIVITY",
79
+ "STREAMER",
80
+ "STUDY_GROUP",
81
+ "SUPPORT",
82
+ "TEAMMATES",
83
+ "THEME",
84
+ "TOGETHER_VR",
85
+ "TRAVEL_PLANNING",
86
+ "WORK_ANNOUNCEMENT",
87
+ "WORK_DEMO_GROUP",
88
+ "WORK_DISCUSSION",
89
+ "WORK_EPHEMERAL",
90
+ "WORK_FEEDBACK",
91
+ "WORK_FOR_SALE",
92
+ "WORK_GARDEN",
93
+ "WORK_GUEST_GROUP",
94
+ "WORK_INTEGRITY",
95
+ "WORK_LEARNING",
96
+ "WORK_MENTORSHIP",
97
+ "WORK_MULTI_COMPANY",
98
+ "WORK_RECRUITING",
99
+ "WORK_RESUME_REVIEW",
100
+ "WORK_SOCIAL",
101
+ "WORK_STAGES",
102
+ "WORK_TEAM",
103
+ "WORK_TEAMWORK",
104
+ "WORK_VC_CALL",
105
+ ]
106
+
107
+ GROUP_TYPE = [
108
+ "BOOKS",
109
+ "CASUAL",
110
+ "CLOSE_FRIENDS",
111
+ "CLUB",
112
+ "COUPLE",
113
+ "COWORKERS",
114
+ "CUSTOM",
115
+ "DEALS",
116
+ "EPHEMERAL",
117
+ "EVENT_PLANNING",
118
+ "FAMILY",
119
+ "FANDOM_RADAR",
120
+ "FANTASY_LEAGUE",
121
+ "FITNESS",
122
+ "FOR_SALE",
123
+ "FOR_WORK",
124
+ "FRATERNITY",
125
+ "GAME",
126
+ "HEALTH_SUPPORT",
127
+ "HIGH_SCHOOL_FORUM",
128
+ "JOBS",
129
+ "LEARNING",
130
+ "MENTORSHIP",
131
+ "MUSIC_CASA_BUNDLE",
132
+ "NEIGHBORS",
133
+ "NONE",
134
+ "OCULUS",
135
+ "PARENTING",
136
+ "PARENTS",
137
+ "PROJECT",
138
+ "REAL_WORLD",
139
+ "REAL_WORLD_AT_WORK",
140
+ "RESTYLE",
141
+ "SCHOOL_CLASS",
142
+ "SORORITY",
143
+ "SPORTS",
144
+ "SPORTS_ACTIVITY",
145
+ "STREAMER",
146
+ "STUDY_GROUP",
147
+ "SUPPORT",
148
+ "TEAMMATES",
149
+ "THEME",
150
+ "TOGETHER_VR",
151
+ "TRAVEL_PLANNING",
152
+ "WORK_ANNOUNCEMENT",
153
+ "WORK_DEMO_GROUP",
154
+ "WORK_DISCUSSION",
155
+ "WORK_EPHEMERAL",
156
+ "WORK_FEEDBACK",
157
+ "WORK_FOR_SALE",
158
+ "WORK_GARDEN",
159
+ "WORK_GUEST_GROUP",
160
+ "WORK_INTEGRITY",
161
+ "WORK_LEARNING",
162
+ "WORK_MENTORSHIP",
163
+ "WORK_MULTI_COMPANY",
164
+ "WORK_RECRUITING",
165
+ "WORK_RESUME_REVIEW",
166
+ "WORK_SOCIAL",
167
+ "WORK_STAGES",
168
+ "WORK_TEAM",
169
+ "WORK_TEAMWORK",
170
+ "WORK_VC_CALL",
171
+ ]
172
+
173
+
174
+ field :archived, 'bool'
175
+ field :cover, 'CoverPhoto'
176
+ field :created_time, 'datetime'
177
+ field :description, 'string'
178
+ field :email, 'string'
179
+ field :icon, 'string'
180
+ field :id, 'string'
181
+ field :install, 'object'
182
+ field :link, 'string'
183
+ field :member_count, 'int'
184
+ field :member_request_count, 'int'
185
+ field :name, 'string'
186
+ field :parent, 'object'
187
+ field :permissions, { list: 'string' }
188
+ field :privacy, 'string'
189
+ field :purpose, 'string'
190
+ field :subdomain, 'string'
191
+ field :updated_time, 'datetime'
192
+ field :venue, 'Location'
193
+ has_no_delete
194
+
195
+ has_edge :admins do |edge|
196
+ edge.delete do |api|
197
+ api.has_param :uid, 'int'
198
+ end
199
+ edge.post 'Group' do |api|
200
+ api.has_param :uid, 'int'
201
+ end
202
+ end
203
+
204
+ has_edge :albums do |edge|
205
+ edge.get 'Album'
206
+ edge.post 'Album' do |api|
207
+ api.has_param :contributors, { list: 'int' }
208
+ api.has_param :description, 'string'
209
+ api.has_param :is_default, 'bool'
210
+ api.has_param :location, 'string'
211
+ api.has_param :make_shared_album, 'bool'
212
+ api.has_param :message, 'string'
213
+ api.has_param :name, 'string'
214
+ api.has_param :place, 'object'
215
+ api.has_param :privacy, 'string'
216
+ api.has_param :tags, { list: 'int' }
217
+ api.has_param :visible, 'string'
218
+ end
219
+ end
220
+
221
+ has_edge :attachment_surfaces do |edge|
222
+ edge.get
223
+ edge.post do |api|
224
+ api.has_param :title, 'hash'
225
+ end
226
+ end
227
+
228
+ has_edge :docs do |edge|
229
+ edge.get
230
+ end
231
+
232
+ has_edge :events do |edge|
233
+ edge.get 'Event'
234
+ end
235
+
236
+ has_edge :featured_cards do |edge|
237
+ edge.get
238
+ edge.post do |api|
239
+ api.has_param :body, 'hash'
240
+ api.has_param :description, 'hash'
241
+ api.has_param :title, 'hash'
242
+ end
243
+ end
244
+
245
+ has_edge :feed do |edge|
246
+ edge.get 'Post' do |api|
247
+ api.has_param :include_hidden, 'bool'
248
+ api.has_param :q, 'string'
249
+ api.has_param :show_expired, 'bool'
250
+ api.has_param :since, 'datetime'
251
+ api.has_param :until, 'datetime'
252
+ api.has_param :with, 'string'
253
+ end
254
+ edge.post 'Post' do |api|
255
+ api.has_param :actions, 'object'
256
+ api.has_param :adaptive_type, 'string'
257
+ api.has_param :album_id, 'string'
258
+ api.has_param :android_key_hash, 'string'
259
+ api.has_param :animated_effect_id, 'int'
260
+ api.has_param :application_id, 'string'
261
+ api.has_param :asked_fun_fact_prompt_id, 'int'
262
+ api.has_param :asset3d_id, 'int'
263
+ api.has_param :associated_id, 'string'
264
+ api.has_param :attach_place_suggestion, 'bool'
265
+ api.has_param :attached_media, { list: 'object' }
266
+ api.has_param :audience_exp, 'bool'
267
+ api.has_param :backdated_time, 'datetime'
268
+ api.has_param :backdated_time_granularity, { enum: -> { Post::BACKDATED_TIME_GRANULARITY }}
269
+ api.has_param :call_to_action, 'object'
270
+ api.has_param :caption, 'string'
271
+ api.has_param :checkin_entry_point, { enum: -> { Post::CHECKIN_ENTRY_POINT }}
272
+ api.has_param :child_attachments, { list: 'object' }
273
+ api.has_param :client_mutation_id, 'string'
274
+ api.has_param :composer_entry_picker, 'string'
275
+ api.has_param :composer_entry_point, 'string'
276
+ api.has_param :composer_entry_time, 'int'
277
+ api.has_param :composer_session_events_log, 'string'
278
+ api.has_param :composer_session_id, 'string'
279
+ api.has_param :composer_source_surface, 'string'
280
+ api.has_param :composer_type, 'string'
281
+ api.has_param :connection_class, 'string'
282
+ api.has_param :content_attachment, 'string'
283
+ api.has_param :coordinates, 'object'
284
+ api.has_param :cta_link, 'string'
285
+ api.has_param :cta_type, 'string'
286
+ api.has_param :description, 'string'
287
+ api.has_param :direct_share_status, 'int'
288
+ api.has_param :expanded_height, 'int'
289
+ api.has_param :expanded_width, 'int'
290
+ api.has_param :feed_targeting, 'object'
291
+ api.has_param :formatting, { enum: -> { Post::FORMATTING }}
292
+ api.has_param :fun_fact_prompt_id, 'int'
293
+ api.has_param :fun_fact_toastee_id, 'int'
294
+ api.has_param :has_nickname, 'bool'
295
+ api.has_param :height, 'int'
296
+ api.has_param :holiday_card, 'string'
297
+ api.has_param :home_checkin_city_id, 'object'
298
+ api.has_param :image_crops, 'hash'
299
+ api.has_param :implicit_with_tags, { list: 'int' }
300
+ api.has_param :instant_game_entry_point_data, 'string'
301
+ api.has_param :ios_bundle_id, 'string'
302
+ api.has_param :is_backout_draft, 'bool'
303
+ api.has_param :is_boost_intended, 'bool'
304
+ api.has_param :is_explicit_location, 'bool'
305
+ api.has_param :is_explicit_share, 'bool'
306
+ api.has_param :is_group_linking_post, 'bool'
307
+ api.has_param :is_photo_container, 'bool'
308
+ api.has_param :link, 'string'
309
+ api.has_param :location_source_id, 'string'
310
+ api.has_param :manual_privacy, 'bool'
311
+ api.has_param :message, 'string'
312
+ api.has_param :multi_share_end_card, 'bool'
313
+ api.has_param :multi_share_optimized, 'bool'
314
+ api.has_param :name, 'string'
315
+ api.has_param :nectar_module, 'string'
316
+ api.has_param :object_attachment, 'string'
317
+ api.has_param :offer_like_post_id, 'int'
318
+ api.has_param :og_action_type_id, 'string'
319
+ api.has_param :og_hide_object_attachment, 'bool'
320
+ api.has_param :og_icon_id, 'string'
321
+ api.has_param :og_object_id, 'string'
322
+ api.has_param :og_phrase, 'string'
323
+ api.has_param :og_set_profile_badge, 'bool'
324
+ api.has_param :og_suggestion_mechanism, 'string'
325
+ api.has_param :page_recommendation, 'string'
326
+ api.has_param :picture, 'string'
327
+ api.has_param :place, 'object'
328
+ api.has_param :place_attachment_setting, { enum: -> { Post::PLACE_ATTACHMENT_SETTING }}
329
+ api.has_param :place_list, 'string'
330
+ api.has_param :place_list_data, { list: 'string' }
331
+ api.has_param :post_surfaces_blacklist, { list: { enum: -> { Post::POST_SURFACES_BLACKLIST }} }
332
+ api.has_param :posting_to_redspace, { enum: -> { Post::POSTING_TO_REDSPACE }}
333
+ api.has_param :privacy, 'string'
334
+ api.has_param :prompt_id, 'string'
335
+ api.has_param :prompt_tracking_string, 'string'
336
+ api.has_param :properties, 'object'
337
+ api.has_param :proxied_app_id, 'string'
338
+ api.has_param :publish_event_id, 'int'
339
+ api.has_param :published, 'bool'
340
+ api.has_param :quote, 'string'
341
+ api.has_param :react_mode_metadata, 'string'
342
+ api.has_param :ref, { list: 'string' }
343
+ api.has_param :referenceable_image_ids, { list: 'string' }
344
+ api.has_param :referral_id, 'string'
345
+ api.has_param :scheduled_publish_time, 'datetime'
346
+ api.has_param :source, 'string'
347
+ api.has_param :sponsor_id, 'string'
348
+ api.has_param :sponsor_relationship, 'int'
349
+ api.has_param :suggested_place_id, 'object'
350
+ api.has_param :tags, { list: 'int' }
351
+ api.has_param :target_surface, { enum: -> { Post::TARGET_SURFACE }}
352
+ api.has_param :targeting, 'object'
353
+ api.has_param :text_format_metadata, 'string'
354
+ api.has_param :text_format_preset_id, 'string'
355
+ api.has_param :text_only_place, 'string'
356
+ api.has_param :throwback_camera_roll_media, 'string'
357
+ api.has_param :thumbnail, 'file'
358
+ api.has_param :time_since_original_post, 'int'
359
+ api.has_param :title, 'string'
360
+ api.has_param :tracking_info, 'string'
361
+ api.has_param :unpublished_content_type, { enum: -> { Post::UNPUBLISHED_CONTENT_TYPE }}
362
+ api.has_param :user_selected_tags, 'bool'
363
+ api.has_param :video_start_time_ms, 'int'
364
+ api.has_param :viewer_coordinates, 'object'
365
+ api.has_param :width, 'int'
366
+ end
367
+ end
368
+
369
+ has_edge :files do |edge|
370
+ edge.get
371
+ end
372
+
373
+ has_edge :groups do |edge|
374
+ edge.get 'Group'
375
+ edge.post 'Group' do |api|
376
+ api.has_param :admin, 'int'
377
+ api.has_param :description, 'string'
378
+ api.has_param :group_icon_id, 'object'
379
+ api.has_param :group_type, { enum: -> { Group::GROUP_TYPE }}
380
+ api.has_param :join_setting, { enum: -> { Group::JOIN_SETTING }}
381
+ api.has_param :name, 'string'
382
+ api.has_param :parent_id, 'object'
383
+ api.has_param :post_permissions, { enum: -> { Group::POST_PERMISSIONS }}
384
+ api.has_param :post_requires_admin_approval, 'bool'
385
+ api.has_param :privacy, 'string'
386
+ api.has_param :ref, 'string'
387
+ end
388
+ end
389
+
390
+ has_edge :live_videos do |edge|
391
+ edge.get 'LiveVideo' do |api|
392
+ api.has_param :broadcast_status, { list: { enum: -> { LiveVideo::BROADCAST_STATUS }} }
393
+ api.has_param :source, { enum: -> { LiveVideo::SOURCE }}
394
+ end
395
+ edge.post 'LiveVideo' do |api|
396
+ api.has_param :content_tags, { list: 'string' }
397
+ api.has_param :description, 'string'
398
+ api.has_param :enable_backup_ingest, 'bool'
399
+ api.has_param :encoding_settings, 'string'
400
+ api.has_param :event_params, 'object'
401
+ api.has_param :fisheye_video_cropped, 'bool'
402
+ api.has_param :front_z_rotation, 'double'
403
+ api.has_param :is_audio_only, 'bool'
404
+ api.has_param :is_spherical, 'bool'
405
+ api.has_param :original_fov, 'int'
406
+ api.has_param :planned_start_time, 'int'
407
+ api.has_param :privacy, 'string'
408
+ api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
409
+ api.has_param :published, 'bool'
410
+ api.has_param :schedule_custom_profile_image, 'file'
411
+ api.has_param :spatial_audio_format, { enum: -> { LiveVideo::SPATIAL_AUDIO_FORMAT }}
412
+ api.has_param :status, { enum: -> { LiveVideo::STATUS }}
413
+ api.has_param :stereoscopic_mode, { enum: -> { LiveVideo::STEREOSCOPIC_MODE }}
414
+ api.has_param :stop_on_delete_stream, 'bool'
415
+ api.has_param :stream_type, { enum: -> { LiveVideo::STREAM_TYPE }}
416
+ api.has_param :title, 'string'
417
+ end
418
+ end
419
+
420
+ has_edge :members do |edge|
421
+ edge.delete do |api|
422
+ api.has_param :email, 'string'
423
+ api.has_param :member, 'int'
424
+ end
425
+ edge.post 'Group' do |api|
426
+ api.has_param :email, 'string'
427
+ api.has_param :from, 'int'
428
+ api.has_param :member, 'int'
429
+ api.has_param :rate, 'int'
430
+ api.has_param :source, 'string'
431
+ end
432
+ end
433
+
434
+ has_edge :opted_in_members do |edge|
435
+ edge.get 'User'
436
+ end
437
+
438
+ has_edge :photos do |edge|
439
+ edge.post 'Photo' do |api|
440
+ api.has_param :aid, 'string'
441
+ api.has_param :allow_spherical_photo, 'bool'
442
+ api.has_param :alt_text_custom, 'string'
443
+ api.has_param :android_key_hash, 'string'
444
+ api.has_param :application_id, 'string'
445
+ api.has_param :attempt, 'int'
446
+ api.has_param :audience_exp, 'bool'
447
+ api.has_param :backdated_time, 'datetime'
448
+ api.has_param :backdated_time_granularity, { enum: -> { Photo::BACKDATED_TIME_GRANULARITY }}
449
+ api.has_param :caption, 'string'
450
+ api.has_param :composer_session_id, 'string'
451
+ api.has_param :direct_share_status, 'int'
452
+ api.has_param :feed_targeting, 'object'
453
+ api.has_param :filter_type, 'int'
454
+ api.has_param :full_res_is_coming_later, 'bool'
455
+ api.has_param :initial_view_heading_override_degrees, 'int'
456
+ api.has_param :initial_view_pitch_override_degrees, 'int'
457
+ api.has_param :initial_view_vertical_fov_override_degrees, 'int'
458
+ api.has_param :ios_bundle_id, 'string'
459
+ api.has_param :is_explicit_location, 'bool'
460
+ api.has_param :is_explicit_place, 'bool'
461
+ api.has_param :manual_privacy, 'bool'
462
+ api.has_param :message, 'string'
463
+ api.has_param :name, 'string'
464
+ api.has_param :no_story, 'bool'
465
+ api.has_param :offline_id, 'int'
466
+ api.has_param :og_action_type_id, 'string'
467
+ api.has_param :og_icon_id, 'string'
468
+ api.has_param :og_object_id, 'string'
469
+ api.has_param :og_phrase, 'string'
470
+ api.has_param :og_set_profile_badge, 'bool'
471
+ api.has_param :og_suggestion_mechanism, 'string'
472
+ api.has_param :place, 'object'
473
+ api.has_param :privacy, 'string'
474
+ api.has_param :profile_id, 'int'
475
+ api.has_param :proxied_app_id, 'string'
476
+ api.has_param :published, 'bool'
477
+ api.has_param :qn, 'string'
478
+ api.has_param :scheduled_publish_time, 'int'
479
+ api.has_param :spherical_metadata, 'hash'
480
+ api.has_param :sponsor_id, 'string'
481
+ api.has_param :sponsor_relationship, 'int'
482
+ api.has_param :tags, { list: 'object' }
483
+ api.has_param :target_id, 'int'
484
+ api.has_param :targeting, 'object'
485
+ api.has_param :time_since_original_post, 'int'
486
+ api.has_param :uid, 'int'
487
+ api.has_param :unpublished_content_type, { enum: -> { Photo::UNPUBLISHED_CONTENT_TYPE }}
488
+ api.has_param :url, 'string'
489
+ api.has_param :user_selected_tags, 'bool'
490
+ api.has_param :vault_image_id, 'string'
491
+ end
492
+ end
493
+
494
+ has_edge :picture do |edge|
495
+ edge.get 'ProfilePictureSource' do |api|
496
+ api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
497
+ api.has_param :height, 'int'
498
+ api.has_param :redirect, 'bool'
499
+ api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
500
+ api.has_param :width, 'int'
501
+ end
502
+ end
503
+
504
+ has_edge :shift_settings do |edge|
505
+ edge.post do |api|
506
+ api.has_param :external_id, 'string'
507
+ api.has_param :shift_feature_setting, { enum: %w{ALL_FEATURES_OFF ALL_FEATURES_ON SHIFT_COVER_ONLY_ON SHIFT_VIEWER_ONLY_ON }}
508
+ end
509
+ end
510
+
511
+ has_edge :videos do |edge|
512
+ edge.get 'AdVideo' do |api|
513
+ api.has_param :type, { enum: -> { AdVideo::TYPE }}
514
+ end
515
+ edge.post 'AdVideo' do |api|
516
+ api.has_param :adaptive_type, 'string'
517
+ api.has_param :animated_effect_id, 'int'
518
+ api.has_param :application_id, 'string'
519
+ api.has_param :asked_fun_fact_prompt_id, 'int'
520
+ api.has_param :audio_story_wave_animation_handle, 'string'
521
+ api.has_param :composer_entry_picker, 'string'
522
+ api.has_param :composer_entry_point, 'string'
523
+ api.has_param :composer_entry_time, 'int'
524
+ api.has_param :composer_session_events_log, 'string'
525
+ api.has_param :composer_session_id, 'string'
526
+ api.has_param :composer_source_surface, 'string'
527
+ api.has_param :composer_type, 'string'
528
+ api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
529
+ api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
530
+ api.has_param :creative_tools, 'string'
531
+ api.has_param :description, 'string'
532
+ api.has_param :embeddable, 'bool'
533
+ api.has_param :end_offset, 'int'
534
+ api.has_param :fbuploader_video_file_chunk, 'string'
535
+ api.has_param :file_size, 'int'
536
+ api.has_param :file_url, 'string'
537
+ api.has_param :fisheye_video_cropped, 'bool'
538
+ api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
539
+ api.has_param :fov, 'int'
540
+ api.has_param :front_z_rotation, 'double'
541
+ api.has_param :fun_fact_prompt_id, 'int'
542
+ api.has_param :fun_fact_toastee_id, 'int'
543
+ api.has_param :guide, { list: { list: 'int' } }
544
+ api.has_param :guide_enabled, 'bool'
545
+ api.has_param :has_nickname, 'bool'
546
+ api.has_param :holiday_card, 'string'
547
+ api.has_param :initial_heading, 'int'
548
+ api.has_param :initial_pitch, 'int'
549
+ api.has_param :instant_game_entry_point_data, 'string'
550
+ api.has_param :is_boost_intended, 'bool'
551
+ api.has_param :is_explicit_share, 'bool'
552
+ api.has_param :is_group_linking_post, 'bool'
553
+ api.has_param :is_voice_clip, 'bool'
554
+ api.has_param :location_source_id, 'string'
555
+ api.has_param :manual_privacy, 'bool'
556
+ api.has_param :offer_like_post_id, 'int'
557
+ api.has_param :og_action_type_id, 'string'
558
+ api.has_param :og_icon_id, 'string'
559
+ api.has_param :og_object_id, 'string'
560
+ api.has_param :og_phrase, 'string'
561
+ api.has_param :og_suggestion_mechanism, 'string'
562
+ api.has_param :original_fov, 'int'
563
+ api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
564
+ api.has_param :publish_event_id, 'int'
565
+ api.has_param :published, 'bool'
566
+ api.has_param :react_mode_metadata, 'string'
567
+ api.has_param :referenced_sticker_id, 'string'
568
+ api.has_param :replace_video_id, 'string'
569
+ api.has_param :scheduled_publish_time, 'int'
570
+ api.has_param :slideshow_spec, 'hash'
571
+ api.has_param :source, 'string'
572
+ api.has_param :source_instagram_media_id, 'string'
573
+ api.has_param :spherical, 'bool'
574
+ api.has_param :start_offset, 'int'
575
+ api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
576
+ api.has_param :text_format_metadata, 'string'
577
+ api.has_param :throwback_camera_roll_media, 'string'
578
+ api.has_param :thumb, 'file'
579
+ api.has_param :time_since_original_post, 'int'
580
+ api.has_param :title, 'string'
581
+ api.has_param :transcode_setting_properties, 'string'
582
+ api.has_param :unpublished_content_type, { enum: -> { AdVideo::UNPUBLISHED_CONTENT_TYPE }}
583
+ api.has_param :upload_phase, { enum: -> { AdVideo::UPLOAD_PHASE }}
584
+ api.has_param :upload_session_id, 'string'
585
+ api.has_param :upload_setting_properties, 'string'
586
+ api.has_param :video_file_chunk, 'string'
587
+ api.has_param :video_id_original, 'string'
588
+ api.has_param :video_start_time_ms, 'int'
589
+ api.has_param :waterfall_id, 'string'
590
+ end
591
+ end
592
+
593
+ end
594
+ end
@@ -0,0 +1,98 @@
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 HomeListing < AdObject
29
+ IMAGE_FETCH_STATUS = [
30
+ "DIRECT_UPLOAD",
31
+ "FETCHED",
32
+ "FETCH_FAILED",
33
+ "NO_STATUS",
34
+ "OUTDATED",
35
+ "PARTIAL_FETCH",
36
+ ]
37
+
38
+
39
+ field :ac_type, 'string'
40
+ field :additional_fees_description, 'string'
41
+ field :address, 'object'
42
+ field :agent_company, 'string'
43
+ field :agent_email, 'string'
44
+ field :agent_fb_page_id, 'Page'
45
+ field :agent_name, 'string'
46
+ field :agent_phone, 'string'
47
+ field :applinks, 'CatalogItemAppLinks'
48
+ field :area_size, 'int'
49
+ field :area_unit, 'string'
50
+ field :availability, 'string'
51
+ field :category_specific_fields, 'CatalogSubVerticalList'
52
+ field :co_2_emission_rating_eu, 'object'
53
+ field :currency, 'string'
54
+ field :days_on_market, 'int'
55
+ field :description, 'string'
56
+ field :energy_rating_eu, 'object'
57
+ field :furnish_type, 'string'
58
+ field :group_id, 'string'
59
+ field :heating_type, 'string'
60
+ field :home_listing_id, 'string'
61
+ field :id, 'string'
62
+ field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
63
+ field :images, { list: 'string' }
64
+ field :laundry_type, 'string'
65
+ field :listing_type, 'string'
66
+ field :max_currency, 'string'
67
+ field :max_price, 'string'
68
+ field :min_currency, 'string'
69
+ field :min_price, 'string'
70
+ field :name, 'string'
71
+ field :num_baths, 'double'
72
+ field :num_beds, 'double'
73
+ field :num_rooms, 'double'
74
+ field :num_units, 'int'
75
+ field :parking_type, 'string'
76
+ field :partner_verification, 'string'
77
+ field :pet_policy, 'string'
78
+ field :price, 'string'
79
+ field :property_type, 'string'
80
+ field :sanitized_images, { list: 'string' }
81
+ field :unit_price, 'object'
82
+ field :url, 'string'
83
+ field :year_built, 'int'
84
+
85
+ has_edge :augmented_realities_metadata do |edge|
86
+ edge.get
87
+ end
88
+
89
+ has_edge :channels_to_integrity_status do |edge|
90
+ edge.get 'CatalogItemChannelsToIntegrityStatus'
91
+ end
92
+
93
+ has_edge :videos_metadata do |edge|
94
+ edge.get
95
+ end
96
+
97
+ end
98
+ end