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.
- checksums.yaml +4 -4
- data/README.md +6 -0
- data/lib/facebook_ads/ad_objects/ad.rb +58 -46
- data/lib/facebook_ads/ad_objects/ad_account.rb +462 -117
- data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +5 -0
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +71 -0
- data/lib/facebook_ads/ad_objects/ad_account_default_destination.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb +80 -0
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +15 -12
- data/lib/facebook_ads/ad_objects/ad_account_ios_fourteen_campaign_limits.rb +39 -0
- data/lib/facebook_ads/ad_objects/{business_matched_search_applications_edge_data.rb → ad_account_matched_search_applications_edge_data.rb} +20 -8
- data/lib/facebook_ads/ad_objects/ad_account_max_bid.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_account_promotable_objects.rb +39 -0
- data/lib/facebook_ads/ad_objects/{reach_estimate.rb → ad_account_reach_estimate.rb} +3 -3
- data/lib/facebook_ads/ad_objects/ad_account_recommended_camapaign_budget.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_account_subscribed_apps.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +201 -82
- data/lib/facebook_ads/ad_objects/ad_account_tracking_data.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +65 -46
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +61 -36
- data/lib/facebook_ads/ad_objects/ad_async_request.rb +9 -18
- data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -9
- data/lib/facebook_ads/ad_objects/ad_bid_adjustments.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +184 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_bid_constraint.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +15 -12
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_stats_unsupported_reasons.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_issues_info.rb +41 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_learning_stage_info.rb +40 -0
- data/lib/facebook_ads/ad_objects/{audience_permission.rb → ad_campaign_optimization_event.rb} +4 -4
- data/lib/facebook_ads/ad_objects/ad_campaign_paced_bid_info.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +126 -53
- data/lib/facebook_ads/ad_objects/ad_creative_ad_disclaimer.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_creative_insights.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_creative_interactive_components_spec.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +7 -5
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +57 -36
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +1 -0
- data/lib/facebook_ads/ad_objects/{ad_creative_link_data_custom_overlay_spec.rb → ad_creative_link_data_image_layer_spec.rb} +52 -51
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +24 -19
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_sponsorship_info_spec.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_template_video_spec.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_creative_omnichannel_link_spec.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_creative_photo_data.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_creative_photo_data_media_elements.rb +40 -0
- data/lib/facebook_ads/ad_objects/ad_creative_platform_customization.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_creative_recommender_settings.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_creative_static_fallback_spec.rb +42 -0
- data/lib/facebook_ads/ad_objects/ad_creative_template_url_spec.rb +43 -0
- data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_customization_rule_spec.rb +46 -0
- data/lib/facebook_ads/ad_objects/ad_dynamic_creative.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_entity_target_spend.rb +41 -0
- data/lib/facebook_ads/ad_objects/ad_image.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_keywords.rb +40 -0
- data/lib/facebook_ads/ad_objects/ad_label.rb +0 -4
- data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +66 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +63 -0
- data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +9 -1
- data/lib/facebook_ads/ad_objects/ad_place_page_set_metadata.rb +40 -0
- data/lib/facebook_ads/ad_objects/ad_placement.rb +43 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +43 -13
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +29 -10
- data/lib/facebook_ads/ad_objects/ad_recommendation.rb +2 -2
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +3 -2
- data/lib/facebook_ads/ad_objects/ad_rule.rb +38 -2
- data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb +1 -2
- data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +13 -5
- data/lib/facebook_ads/ad_objects/ad_rule_filters.rb +9 -9
- data/lib/facebook_ads/ad_objects/ad_rule_history_result.rb +2 -2
- data/lib/facebook_ads/ad_objects/ad_rule_trigger.rb +11 -11
- data/lib/facebook_ads/ad_objects/ad_set.rb +135 -47
- data/lib/facebook_ads/ad_objects/ad_study.rb +10 -41
- data/lib/facebook_ads/ad_objects/ad_study_cell.rb +16 -5
- data/lib/facebook_ads/ad_objects/ad_study_objective.rb +29 -14
- data/lib/facebook_ads/ad_objects/ad_study_objective_id.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_study_objective_offsite_datasets.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +477 -0
- data/lib/facebook_ads/ad_objects/adgroup_issues_info.rb +41 -0
- data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +22 -0
- data/lib/facebook_ads/ad_objects/ads_action_stats.rb +12 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +98 -47
- data/lib/facebook_ads/ad_objects/ads_optimal_delivery_growth_opportunity.rb +39 -0
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +85 -6
- data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb +9 -2
- data/lib/facebook_ads/ad_objects/age_range.rb +38 -0
- data/lib/facebook_ads/ad_objects/album.rb +55 -2
- data/lib/facebook_ads/ad_objects/app_request.rb +42 -0
- data/lib/facebook_ads/ad_objects/app_request_former_recipient.rb +37 -0
- data/lib/facebook_ads/ad_objects/application.rb +614 -0
- data/lib/facebook_ads/ad_objects/{adgroup_relevance_score.rb → ar_effects_batch_status.rb} +3 -4
- data/lib/facebook_ads/ad_objects/assigned_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/async_request.rb +52 -0
- data/lib/facebook_ads/ad_objects/async_session.rb +49 -0
- data/lib/facebook_ads/ad_objects/{custom_audience_permission.rb → audience_permission_for_actions.rb} +1 -1
- data/lib/facebook_ads/ad_objects/audio_copyright.rb +5 -0
- data/lib/facebook_ads/ad_objects/automotive_model.rb +84 -0
- data/lib/facebook_ads/ad_objects/brand_safety_block_list_usage.rb +41 -0
- data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +2 -1
- data/lib/facebook_ads/ad_objects/business.rb +338 -188
- data/lib/facebook_ads/ad_objects/business_application_request.rb +1 -1
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +182 -0
- data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +48 -0
- data/lib/facebook_ads/ad_objects/{business_project.rb → business_image.rb} +8 -9
- data/lib/facebook_ads/ad_objects/business_managed_partner_eligibility.rb +39 -0
- data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +48 -0
- data/lib/facebook_ads/ad_objects/business_role_request.rb +14 -11
- data/lib/facebook_ads/ad_objects/business_user.rb +31 -4
- data/lib/facebook_ads/ad_objects/campaign.rb +347 -42
- data/lib/facebook_ads/ad_objects/campaign_group_brand_configuration.rb +39 -0
- data/lib/facebook_ads/ad_objects/campaign_group_collaborative_ads_partner_info.rb +36 -0
- data/lib/facebook_ads/ad_objects/canvas.rb +19 -6
- data/lib/facebook_ads/ad_objects/canvas_ad_settings.rb +43 -0
- data/lib/facebook_ads/ad_objects/canvas_collection_thumbnail.rb +39 -0
- data/lib/facebook_ads/ad_objects/canvas_template.rb +48 -0
- data/lib/facebook_ads/ad_objects/catalog_based_targeting.rb +37 -0
- data/lib/facebook_ads/ad_objects/{app_links.rb → catalog_item_app_links.rb} +3 -2
- data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb +40 -0
- data/lib/facebook_ads/ad_objects/catalog_item_channels_to_integrity_status.rb +38 -0
- data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +90 -0
- data/lib/facebook_ads/ad_objects/chat_plugin.rb +48 -0
- data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +9 -0
- data/lib/facebook_ads/ad_objects/{legacy_business_ad_account_request.rb → child_event.rb} +4 -3
- data/lib/facebook_ads/ad_objects/cloud_game.rb +43 -0
- data/lib/facebook_ads/ad_objects/collaborative_ads_partner_info_list_item.rb +36 -0
- data/lib/facebook_ads/ad_objects/collaborative_ads_share_settings.rb +39 -0
- data/lib/facebook_ads/ad_objects/comment.rb +128 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +142 -0
- data/lib/facebook_ads/ad_objects/{copyright_attribution_insights.rb → commerce_merchant_settings_setup_status.rb} +7 -6
- data/lib/facebook_ads/ad_objects/commerce_order.rb +170 -0
- data/lib/facebook_ads/ad_objects/commerce_order_transaction_detail.rb +52 -0
- data/lib/facebook_ads/ad_objects/commerce_payout.rb +41 -0
- data/lib/facebook_ads/ad_objects/commerce_settings.rb +38 -0
- data/lib/facebook_ads/ad_objects/{ads_data_partner.rb → connections_targeting.rb} +2 -2
- data/lib/facebook_ads/ad_objects/content_delivery_report.rb +93 -0
- data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → contextual_bundling_spec.rb} +1 -3
- data/lib/facebook_ads/ad_objects/copyright_audio_asset.rb +39 -0
- data/lib/facebook_ads/ad_objects/copyright_reference_container.rb +47 -0
- data/lib/facebook_ads/ad_objects/cpas_advertiser_partnership_recommendation.rb +43 -0
- data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +43 -0
- data/lib/facebook_ads/ad_objects/cpas_collaboration_request.rb +50 -0
- data/lib/facebook_ads/ad_objects/cpas_merchant_config.rb +41 -0
- data/lib/facebook_ads/ad_objects/creative_history.rb +38 -0
- data/lib/facebook_ads/ad_objects/credit_card.rb +55 -0
- data/lib/facebook_ads/ad_objects/credit_partition_action_options.rb +39 -0
- data/lib/facebook_ads/ad_objects/currency.rb +40 -0
- data/lib/facebook_ads/ad_objects/currency_amount.rb +40 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +70 -59
- data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +49 -45
- data/lib/facebook_ads/ad_objects/custom_audience_sharing_status.rb +38 -0
- data/lib/facebook_ads/ad_objects/custom_audienceshared_account_info.rb +41 -0
- data/lib/facebook_ads/ad_objects/custom_conversion.rb +11 -35
- data/lib/facebook_ads/ad_objects/custom_user_settings.rb +38 -0
- data/lib/facebook_ads/ad_objects/da_check.rb +49 -0
- data/lib/facebook_ads/ad_objects/delivery_window.rb +287 -0
- data/lib/facebook_ads/ad_objects/destination.rb +71 -0
- data/lib/facebook_ads/ad_objects/{offline_terms_of_service.rb → destination_catalog_settings.rb} +2 -3
- data/lib/facebook_ads/ad_objects/{products_quality_issue.rb → dynamic_post_child_attachment.rb} +6 -6
- data/lib/facebook_ads/ad_objects/{lead_gen_conditional_questions_group.rb → dynamic_price_config_by_date.rb} +4 -3
- data/lib/facebook_ads/ad_objects/entity_at_text_range.rb +49 -0
- data/lib/facebook_ads/ad_objects/event.rb +88 -98
- data/lib/facebook_ads/ad_objects/event_source_group.rb +1 -10
- data/lib/facebook_ads/ad_objects/experience.rb +40 -0
- data/lib/facebook_ads/ad_objects/extended_credit.rb +14 -7
- data/lib/facebook_ads/ad_objects/extended_credit_allocation_config.rb +4 -5
- data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +3 -0
- data/lib/facebook_ads/ad_objects/external_event_source.rb +1 -1
- data/lib/facebook_ads/ad_objects/fame_export_config.rb +40 -0
- data/lib/facebook_ads/ad_objects/flight.rb +72 -0
- data/lib/facebook_ads/ad_objects/{partner_integration_linked.rb → fundraiser_person_to_charity.rb} +43 -10
- data/lib/facebook_ads/ad_objects/{page_insights_async_export_run.rb → game_item.rb} +13 -8
- data/lib/facebook_ads/ad_objects/group.rb +594 -0
- data/lib/facebook_ads/ad_objects/home_listing.rb +98 -0
- data/lib/facebook_ads/ad_objects/hotel.rb +80 -0
- data/lib/facebook_ads/ad_objects/hotel_room.rb +6 -1
- data/lib/facebook_ads/ad_objects/{shadow_ig_comment.rb → ig_comment.rb} +7 -5
- data/lib/facebook_ads/ad_objects/{shadow_ig_media.rb → ig_media.rb} +22 -4
- data/lib/facebook_ads/ad_objects/{shadow_ig_user.rb → ig_user.rb} +71 -8
- data/lib/facebook_ads/ad_objects/image_copyright.rb +302 -0
- data/lib/facebook_ads/ad_objects/insights_result.rb +12 -12
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +17 -9
- data/lib/facebook_ads/ad_objects/instagram_user.rb +58 -0
- data/lib/facebook_ads/ad_objects/instant_article.rb +8 -3
- data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +6 -7
- data/lib/facebook_ads/ad_objects/instant_articles_stats.rb +41 -0
- data/lib/facebook_ads/ad_objects/jobs_job.rb +79 -0
- data/lib/facebook_ads/ad_objects/{screen_name.rb → key_value.rb} +2 -3
- data/lib/facebook_ads/ad_objects/lead.rb +3 -1
- data/lib/facebook_ads/ad_objects/lead_gen_appointment_booking_info.rb +39 -0
- data/lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group_choices.rb +39 -0
- data/lib/facebook_ads/ad_objects/{lead_gen_qualifier.rb → lead_gen_conditional_questions_group_questions.rb} +4 -5
- data/lib/facebook_ads/ad_objects/lead_gen_draft_question.rb +2 -2
- data/lib/facebook_ads/ad_objects/lead_gen_post_submission_check_result.rb +39 -0
- data/lib/facebook_ads/ad_objects/lead_gen_question.rb +3 -2
- data/lib/facebook_ads/ad_objects/leadgen_form.rb +23 -34
- data/lib/facebook_ads/ad_objects/life_event.rb +2 -10
- data/lib/facebook_ads/ad_objects/link.rb +68 -0
- data/lib/facebook_ads/ad_objects/live_video.rb +98 -31
- data/lib/facebook_ads/ad_objects/live_video_ad_break_config.rb +46 -0
- data/lib/facebook_ads/ad_objects/live_video_error.rb +39 -0
- data/lib/facebook_ads/ad_objects/live_video_input_stream.rb +42 -0
- data/lib/facebook_ads/ad_objects/live_video_recommended_encoder_settings.rb +39 -0
- data/lib/facebook_ads/ad_objects/live_video_targeting.rb +40 -0
- data/lib/facebook_ads/ad_objects/local_service_business.rb +103 -0
- data/lib/facebook_ads/ad_objects/lookalike_spec.rb +5 -0
- data/lib/facebook_ads/ad_objects/managed_partner_business.rb +43 -0
- data/lib/facebook_ads/ad_objects/media_fingerprint.rb +4 -4
- data/lib/facebook_ads/ad_objects/messaging_feature_status.rb +37 -0
- data/lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb +41 -0
- data/lib/facebook_ads/ad_objects/messenger_profile.rb +2 -12
- data/lib/facebook_ads/ad_objects/music_video_copyright.rb +48 -0
- data/lib/facebook_ads/ad_objects/{ad_account_contextual_targeting.rb → null_node.rb} +1 -1
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +43 -46
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set_permissions.rb +40 -0
- data/lib/facebook_ads/ad_objects/{direct_deal.rb → offline_conversion_data_set_upload.rb} +35 -30
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set_usage.rb +37 -0
- data/lib/facebook_ads/ad_objects/{oracle_transaction.rb → omega_customer_trx.rb} +15 -2
- data/lib/facebook_ads/ad_objects/page.rb +683 -325
- data/lib/facebook_ads/ad_objects/page_call_to_action.rb +50 -20
- data/lib/facebook_ads/ad_objects/page_change_proposal.rb +2 -0
- data/lib/facebook_ads/ad_objects/page_commerce_eligibility.rb +38 -0
- data/lib/facebook_ads/ad_objects/page_post.rb +83 -60
- data/lib/facebook_ads/ad_objects/{page_label.rb → page_post_experiment.rb} +12 -12
- data/lib/facebook_ads/ad_objects/page_saved_filter.rb +0 -101
- data/lib/facebook_ads/ad_objects/page_thread_owner.rb +37 -0
- data/lib/facebook_ads/ad_objects/page_user_message_thread_label.rb +44 -0
- data/lib/facebook_ads/ad_objects/partner_study.rb +52 -0
- data/lib/facebook_ads/ad_objects/payment_engine_payment.rb +74 -0
- data/lib/facebook_ads/ad_objects/payment_pricepoints.rb +37 -0
- data/lib/facebook_ads/ad_objects/payment_subscription.rb +58 -0
- data/lib/facebook_ads/ad_objects/permission.rb +44 -0
- data/lib/facebook_ads/ad_objects/{page_admin_note.rb → persona.rb} +3 -4
- data/lib/facebook_ads/ad_objects/photo.rb +60 -29
- data/lib/facebook_ads/ad_objects/{business_advertisable_applications_result.rb → place.rb} +3 -3
- data/lib/facebook_ads/ad_objects/place_topic.rb +0 -7
- data/lib/facebook_ads/ad_objects/platform_image_source.rb +39 -0
- data/lib/facebook_ads/ad_objects/playable_content.rb +42 -0
- data/lib/facebook_ads/ad_objects/post.rb +229 -0
- data/lib/facebook_ads/ad_objects/privacy.rb +42 -0
- data/lib/facebook_ads/ad_objects/{ad_study_ads_asset_user_permissions.rb → private_lift_study_instance.rb} +15 -12
- data/lib/facebook_ads/ad_objects/product_catalog.rb +276 -62
- data/lib/facebook_ads/ad_objects/{partner_category.rb → product_catalog_category.rb} +12 -13
- data/lib/facebook_ads/ad_objects/product_catalog_data_source.rb +46 -0
- data/lib/facebook_ads/ad_objects/product_catalog_diagnostic_group.rb +106 -0
- data/lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb +0 -10
- data/lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb +0 -10
- data/lib/facebook_ads/ad_objects/product_event_stat.rb +5 -4
- data/lib/facebook_ads/ad_objects/product_feed.rb +122 -11
- data/lib/facebook_ads/ad_objects/product_feed_missing_feed_item_replacement.rb +39 -0
- data/lib/facebook_ads/ad_objects/product_feed_rule.rb +44 -0
- data/lib/facebook_ads/ad_objects/product_feed_rule_suggestion.rb +39 -0
- data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +7 -8
- data/lib/facebook_ads/ad_objects/product_feed_upload.rb +10 -2
- data/lib/facebook_ads/ad_objects/product_feed_upload_error.rb +11 -1
- data/lib/facebook_ads/ad_objects/product_feed_upload_error_report.rb +38 -0
- data/lib/facebook_ads/ad_objects/product_feed_upload_error_sample.rb +37 -0
- data/lib/facebook_ads/ad_objects/product_group.rb +17 -6
- data/lib/facebook_ads/ad_objects/{owned_domain.rb → product_image.rb} +2 -2
- data/lib/facebook_ads/ad_objects/product_item.rb +604 -16
- data/lib/facebook_ads/ad_objects/{product_da_event_samples_batch.rb → product_item_ar_data.rb} +22 -17
- data/lib/facebook_ads/ad_objects/product_item_error.rb +40 -0
- data/lib/facebook_ads/ad_objects/product_item_importer_address.rb +42 -0
- data/lib/facebook_ads/ad_objects/product_set.rb +51 -1
- data/lib/facebook_ads/ad_objects/product_set_metadata.rb +40 -0
- data/lib/facebook_ads/ad_objects/profile.rb +19 -3
- data/lib/facebook_ads/ad_objects/profile_picture_source.rb +6 -4
- data/lib/facebook_ads/ad_objects/publisher_block_list.rb +54 -0
- data/lib/facebook_ads/ad_objects/{domain.rb → raw_custom_audience.rb} +2 -2
- data/lib/facebook_ads/ad_objects/reach_frequency_activity.rb +42 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_ad_format.rb +38 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_curve_lower_confidence_range.rb +42 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_curve_upper_confidence_range.rb +42 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_day_part.rb +39 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_estimates_curve.rb +44 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_estimates_placement_breakdown.rb +49 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +89 -21
- data/lib/facebook_ads/ad_objects/reach_frequency_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/{open_graph_rating.rb → recommendation.rb} +2 -1
- data/lib/facebook_ads/ad_objects/rich_media_element.rb +39 -0
- data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +15 -1
- data/lib/facebook_ads/ad_objects/saved_audience.rb +50 -0
- data/lib/facebook_ads/ad_objects/saved_message_response.rb +2 -11
- data/lib/facebook_ads/ad_objects/security_settings.rb +36 -0
- data/lib/facebook_ads/ad_objects/server_side/action_source.rb +48 -0
- data/lib/facebook_ads/ad_objects/server_side/batch_processor.rb +73 -0
- data/lib/facebook_ads/ad_objects/server_side/content.rb +209 -0
- data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +395 -0
- data/lib/facebook_ads/ad_objects/server_side/delivery_category.rb +33 -0
- data/lib/facebook_ads/ad_objects/server_side/event.rb +324 -0
- data/lib/facebook_ads/ad_objects/server_side/event_request.rb +296 -0
- data/lib/facebook_ads/ad_objects/server_side/event_request_async.rb +43 -0
- data/lib/facebook_ads/ad_objects/server_side/event_response.rb +106 -0
- data/lib/facebook_ads/ad_objects/server_side/http_method.rb +28 -0
- data/lib/facebook_ads/ad_objects/server_side/http_service_interface.rb +33 -0
- data/lib/facebook_ads/ad_objects/server_side/http_util.rb +31 -0
- data/lib/facebook_ads/ad_objects/server_side/user_data.rb +724 -0
- data/lib/facebook_ads/ad_objects/server_side/util.rb +323 -0
- data/lib/facebook_ads/ad_objects/shadow_ig_media_product_tags.rb +47 -0
- data/lib/facebook_ads/ad_objects/shop.rb +37 -0
- data/lib/facebook_ads/ad_objects/split_test_winner.rb +39 -0
- data/lib/facebook_ads/ad_objects/store_catalog_settings.rb +34 -0
- data/lib/facebook_ads/ad_objects/system_user.rb +34 -4
- data/lib/facebook_ads/ad_objects/tab.rb +1 -1
- data/lib/facebook_ads/ad_objects/targeting.rb +12 -12
- data/lib/facebook_ads/ad_objects/targeting_geo_location.rb +9 -1
- data/lib/facebook_ads/ad_objects/targeting_geo_location_geo_entities.rb +41 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_location_cluster.rb +37 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_location_expansion.rb +37 -0
- data/lib/facebook_ads/ad_objects/targeting_prospecting_audience.rb +37 -0
- data/lib/facebook_ads/ad_objects/targeting_relaxation.rb +37 -0
- data/lib/facebook_ads/ad_objects/text_with_entities.rb +37 -0
- data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb +38 -0
- data/lib/facebook_ads/ad_objects/tracking_and_conversion_with_defaults.rb +40 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +12 -0
- data/lib/facebook_ads/ad_objects/url.rb +6 -2
- data/lib/facebook_ads/ad_objects/user.rb +482 -70
- data/lib/facebook_ads/ad_objects/user_cover_photo.rb +39 -0
- data/lib/facebook_ads/ad_objects/user_device.rb +38 -0
- data/lib/facebook_ads/ad_objects/user_id_for_app.rb +37 -0
- data/lib/facebook_ads/ad_objects/{publisher_space.rb → user_id_for_page.rb} +2 -2
- data/lib/facebook_ads/ad_objects/user_payment_mobile_pricepoints.rb +40 -0
- data/lib/facebook_ads/ad_objects/{page_videos_you_can_use.rb → value_based_eligible_source.rb} +2 -2
- data/lib/facebook_ads/ad_objects/vehicle.rb +189 -0
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +91 -0
- data/lib/facebook_ads/ad_objects/video_copyright.rb +10 -4
- data/lib/facebook_ads/ad_objects/video_copyright_condition_group.rb +39 -0
- data/lib/facebook_ads/ad_objects/video_copyright_geo_gate.rb +38 -0
- data/lib/facebook_ads/ad_objects/video_copyright_rule.rb +2 -1
- data/lib/facebook_ads/ad_objects/video_copyright_segment.rb +39 -0
- data/lib/facebook_ads/ad_objects/video_list.rb +1 -6
- data/lib/facebook_ads/ad_objects/video_poll.rb +58 -0
- data/lib/facebook_ads/ad_objects/video_upload_limits.rb +38 -0
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +135 -0
- data/lib/facebook_ads/ad_objects/{lead_gen_legal_content.rb → whats_app_business_profile.rb} +3 -4
- data/lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb +38 -0
- data/lib/facebook_ads/ad_objects/work_user_frontline.rb +38 -0
- data/lib/facebook_ads/api_response.rb +4 -0
- data/lib/facebook_ads/config.rb +1 -1
- data/lib/facebook_ads/crash_logger.rb +133 -0
- data/lib/facebook_ads/edge.rb +2 -1
- data/lib/facebook_ads/errors.rb +7 -2
- data/lib/facebook_ads/session.rb +6 -2
- data/lib/facebook_ads/version.rb +2 -2
- data/lib/facebook_ads.rb +11 -1
- data/lib/facebookbusiness.rb +18 -0
- metadata +357 -106
- data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +0 -225
- data/lib/facebook_ads/ad_objects/ad_account_roas.rb +0 -97
- data/lib/facebook_ads/ad_objects/ad_keyword_stats.rb +0 -55
- data/lib/facebook_ads/ad_objects/business_activity_log_event.rb +0 -55
- data/lib/facebook_ads/ad_objects/lead_gen_data_draft.rb +0 -95
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +0 -47
- data/lib/facebook_ads/ad_objects/measurement_report.rb +0 -47
- data/lib/facebook_ads/ad_objects/native_offer.rb +0 -113
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cfeeae322f41c46f8eede6ac5d68e8e18f78b03ab3bdb6b71beb94df2e7918e3
|
4
|
+
data.tar.gz: 98bba522d56d2cd44601fdd5a303cce5477c1e1e2e17b3d11784aebf133eb8df
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 988d0881bfe4de308bd6bd47fcfc787d6f78faab73964e10f62e24b12aefc1eeadef5724be44c2e44aab3b7e96c4c92205d3b6db3b22c83bf3f0e37b9d0aa63c
|
7
|
+
data.tar.gz: bf1748a3533538d22c34dbf34609b64eefcf553fefecf866da87e67ddb76df8c5f9ea27056bd4e5a91f0b2f63e80d138ee0feb526e5585772d469650b40c514a
|
data/README.md
CHANGED
@@ -252,5 +252,11 @@ FacebookAds.configure do |config|
|
|
252
252
|
end
|
253
253
|
```
|
254
254
|
|
255
|
+
## SDK Codegen
|
256
|
+
Our SDK is autogenerated from [SDK Codegen](https://github.com/facebook/facebook-business-sdk-codegen). If you want to learn more about how our SDK code is generated, please check this repository.
|
257
|
+
|
255
258
|
## Reporting Bugs/Feedback
|
256
259
|
Please raise any issue on GitHub.
|
260
|
+
|
261
|
+
## License
|
262
|
+
Facebook Business SDK for Ruby is licensed under the LICENSE file in the root directory of this source tree.
|
@@ -27,66 +27,69 @@ module FacebookAds
|
|
27
27
|
|
28
28
|
class Ad < AdObject
|
29
29
|
BID_TYPE = [
|
30
|
+
"ABSOLUTE_OCPM",
|
31
|
+
"CPA",
|
30
32
|
"CPC",
|
31
33
|
"CPM",
|
32
34
|
"MULTI_PREMIUM",
|
33
|
-
"ABSOLUTE_OCPM",
|
34
|
-
"CPA",
|
35
35
|
]
|
36
36
|
|
37
37
|
CONFIGURED_STATUS = [
|
38
38
|
"ACTIVE",
|
39
|
-
"PAUSED",
|
40
|
-
"DELETED",
|
41
39
|
"ARCHIVED",
|
40
|
+
"DELETED",
|
41
|
+
"PAUSED",
|
42
42
|
]
|
43
43
|
|
44
44
|
EFFECTIVE_STATUS = [
|
45
45
|
"ACTIVE",
|
46
|
-
"
|
46
|
+
"ADSET_PAUSED",
|
47
|
+
"ARCHIVED",
|
48
|
+
"CAMPAIGN_PAUSED",
|
47
49
|
"DELETED",
|
48
|
-
"PENDING_REVIEW",
|
49
50
|
"DISAPPROVED",
|
50
|
-
"
|
51
|
+
"IN_PROCESS",
|
52
|
+
"PAUSED",
|
51
53
|
"PENDING_BILLING_INFO",
|
52
|
-
"
|
53
|
-
"
|
54
|
-
"
|
54
|
+
"PENDING_REVIEW",
|
55
|
+
"PREAPPROVED",
|
56
|
+
"WITH_ISSUES",
|
55
57
|
]
|
56
58
|
|
57
59
|
STATUS = [
|
58
60
|
"ACTIVE",
|
59
|
-
"PAUSED",
|
60
|
-
"DELETED",
|
61
61
|
"ARCHIVED",
|
62
|
+
"DELETED",
|
63
|
+
"PAUSED",
|
62
64
|
]
|
63
65
|
|
64
66
|
DATE_PRESET = [
|
65
|
-
"
|
66
|
-
"yesterday",
|
67
|
-
"this_month",
|
68
|
-
"last_month",
|
69
|
-
"this_quarter",
|
70
|
-
"lifetime",
|
71
|
-
"last_3d",
|
72
|
-
"last_7d",
|
67
|
+
"data_maximum",
|
73
68
|
"last_14d",
|
74
69
|
"last_28d",
|
75
70
|
"last_30d",
|
71
|
+
"last_3d",
|
72
|
+
"last_7d",
|
76
73
|
"last_90d",
|
74
|
+
"last_month",
|
75
|
+
"last_quarter",
|
77
76
|
"last_week_mon_sun",
|
78
77
|
"last_week_sun_sat",
|
79
|
-
"last_quarter",
|
80
78
|
"last_year",
|
79
|
+
"maximum",
|
80
|
+
"this_month",
|
81
|
+
"this_quarter",
|
81
82
|
"this_week_mon_today",
|
82
83
|
"this_week_sun_today",
|
83
84
|
"this_year",
|
85
|
+
"today",
|
86
|
+
"yesterday",
|
84
87
|
]
|
85
88
|
|
86
89
|
EXECUTION_OPTIONS = [
|
87
|
-
"validate_only",
|
88
|
-
"synchronous_ad_review",
|
89
90
|
"include_recommendations",
|
91
|
+
"synchronous_ad_review",
|
92
|
+
"validate_only",
|
90
93
|
]
|
91
94
|
|
92
95
|
OPERATOR = [
|
@@ -96,8 +99,8 @@ module FacebookAds
|
|
96
99
|
|
97
100
|
STATUS_OPTION = [
|
98
101
|
"ACTIVE",
|
99
|
-
"PAUSED",
|
100
102
|
"INHERITED_FROM_SOURCE",
|
103
|
+
"PAUSED",
|
101
104
|
]
|
102
105
|
|
103
106
|
|
@@ -112,36 +115,44 @@ module FacebookAds
|
|
112
115
|
field :campaign, 'Campaign'
|
113
116
|
field :campaign_id, 'string'
|
114
117
|
field :configured_status, { enum: -> { CONFIGURED_STATUS }}
|
118
|
+
field :conversion_domain, 'string'
|
115
119
|
field :conversion_specs, { list: 'ConversionActionQuery' }
|
116
120
|
field :created_time, 'datetime'
|
117
121
|
field :creative, 'AdCreative'
|
122
|
+
field :demolink_hash, 'string'
|
123
|
+
field :display_sequence, 'int'
|
118
124
|
field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
|
125
|
+
field :engagement_audience, 'bool'
|
126
|
+
field :failed_delivery_checks, { list: 'DeliveryCheck' }
|
119
127
|
field :id, 'string'
|
128
|
+
field :issues_info, { list: 'AdgroupIssuesInfo' }
|
120
129
|
field :last_updated_by_app_id, 'string'
|
121
130
|
field :name, 'string'
|
131
|
+
field :preview_shareable_link, 'string'
|
132
|
+
field :priority, 'int'
|
122
133
|
field :recommendations, { list: 'AdRecommendation' }
|
123
134
|
field :source_ad, 'Ad'
|
124
135
|
field :source_ad_id, 'string'
|
125
136
|
field :status, { enum: -> { STATUS }}
|
137
|
+
field :targeting, 'Targeting'
|
138
|
+
field :tracking_and_conversion_with_defaults, 'TrackingAndConversionWithDefaults'
|
126
139
|
field :tracking_specs, { list: 'ConversionActionQuery' }
|
127
140
|
field :updated_time, 'datetime'
|
128
141
|
field :adset_spec, 'AdSet'
|
142
|
+
field :audience_id, 'string'
|
129
143
|
field :date_format, 'string'
|
130
|
-
field :
|
144
|
+
field :draft_adgroup_id, 'string'
|
131
145
|
field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
|
146
|
+
field :include_demolink_hashes, 'bool'
|
132
147
|
|
133
148
|
has_edge :adcreatives do |edge|
|
134
149
|
edge.get 'AdCreative'
|
135
150
|
end
|
136
151
|
|
137
152
|
has_edge :adlabels do |edge|
|
138
|
-
edge.
|
139
|
-
api.has_param :adlabels, { list: 'object' }
|
140
|
-
api.has_param :execution_options, { list: { enum: -> { AdLabel::EXECUTION_OPTIONS }} }
|
141
|
-
end
|
142
|
-
edge.post 'AdLabel' do |api|
|
153
|
+
edge.post 'Ad' do |api|
|
143
154
|
api.has_param :adlabels, { list: 'object' }
|
144
|
-
api.has_param :execution_options, { list: { enum: -> {
|
155
|
+
api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
|
145
156
|
end
|
146
157
|
end
|
147
158
|
|
@@ -152,6 +163,12 @@ module FacebookAds
|
|
152
163
|
end
|
153
164
|
|
154
165
|
has_edge :copies do |edge|
|
166
|
+
edge.get 'Ad' do |api|
|
167
|
+
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
168
|
+
api.has_param :effective_status, { list: 'string' }
|
169
|
+
api.has_param :time_range, 'object'
|
170
|
+
api.has_param :updated_since, 'int'
|
171
|
+
end
|
155
172
|
edge.post 'Ad' do |api|
|
156
173
|
api.has_param :adset_id, 'string'
|
157
174
|
api.has_param :rename_options, 'object'
|
@@ -170,17 +187,18 @@ module FacebookAds
|
|
170
187
|
api.has_param :export_columns, { list: 'string' }
|
171
188
|
api.has_param :export_format, 'string'
|
172
189
|
api.has_param :export_name, 'string'
|
173
|
-
api.has_param :fields, { list:
|
190
|
+
api.has_param :fields, { list: 'string' }
|
174
191
|
api.has_param :filtering, { list: 'object' }
|
175
192
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
176
193
|
api.has_param :product_id_limit, 'int'
|
177
194
|
api.has_param :sort, { list: 'string' }
|
178
|
-
api.has_param :summary, { list:
|
195
|
+
api.has_param :summary, { list: 'string' }
|
179
196
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
180
197
|
api.has_param :time_increment, 'string'
|
181
198
|
api.has_param :time_range, 'object'
|
182
199
|
api.has_param :time_ranges, { list: 'object' }
|
183
200
|
api.has_param :use_account_attribution_setting, 'bool'
|
201
|
+
api.has_param :use_unified_attribution_setting, 'bool'
|
184
202
|
end
|
185
203
|
edge.post 'AdReportRun' do |api|
|
186
204
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
@@ -192,44 +210,38 @@ module FacebookAds
|
|
192
210
|
api.has_param :export_columns, { list: 'string' }
|
193
211
|
api.has_param :export_format, 'string'
|
194
212
|
api.has_param :export_name, 'string'
|
195
|
-
api.has_param :fields, { list:
|
213
|
+
api.has_param :fields, { list: 'string' }
|
196
214
|
api.has_param :filtering, { list: 'object' }
|
197
215
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
198
216
|
api.has_param :product_id_limit, 'int'
|
199
217
|
api.has_param :sort, { list: 'string' }
|
200
|
-
api.has_param :summary, { list:
|
218
|
+
api.has_param :summary, { list: 'string' }
|
201
219
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
202
220
|
api.has_param :time_increment, 'string'
|
203
221
|
api.has_param :time_range, 'object'
|
204
222
|
api.has_param :time_ranges, { list: 'object' }
|
205
223
|
api.has_param :use_account_attribution_setting, 'bool'
|
206
|
-
|
207
|
-
end
|
208
|
-
|
209
|
-
has_edge :keywordstats do |edge|
|
210
|
-
edge.get 'AdKeywordStats' do |api|
|
211
|
-
api.has_param :date, 'datetime'
|
224
|
+
api.has_param :use_unified_attribution_setting, 'bool'
|
212
225
|
end
|
213
226
|
end
|
214
227
|
|
215
228
|
has_edge :leads do |edge|
|
216
229
|
edge.get 'Lead'
|
217
|
-
edge.post do |api|
|
218
|
-
api.has_param :end_time, 'datetime'
|
219
|
-
api.has_param :session_id, 'string'
|
220
|
-
api.has_param :start_time, 'datetime'
|
221
|
-
end
|
222
230
|
end
|
223
231
|
|
224
232
|
has_edge :previews do |edge|
|
225
233
|
edge.get 'AdPreview' do |api|
|
226
234
|
api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
|
235
|
+
api.has_param :dynamic_asset_label, 'string'
|
227
236
|
api.has_param :dynamic_creative_spec, 'object'
|
237
|
+
api.has_param :dynamic_customization, 'object'
|
228
238
|
api.has_param :end_date, 'datetime'
|
229
239
|
api.has_param :height, 'int'
|
240
|
+
api.has_param :locale, 'string'
|
230
241
|
api.has_param :place_page_id, 'int'
|
231
242
|
api.has_param :post, 'object'
|
232
243
|
api.has_param :product_item_ids, { list: 'string' }
|
244
|
+
api.has_param :render_type, { enum: -> { AdPreview::RENDER_TYPE }}
|
233
245
|
api.has_param :start_date, 'datetime'
|
234
246
|
api.has_param :width, 'int'
|
235
247
|
end
|