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
@@ -27,69 +27,60 @@ module FacebookAds
|
|
27
27
|
|
28
28
|
class Campaign < AdObject
|
29
29
|
BID_STRATEGY = [
|
30
|
+
"COST_CAP",
|
30
31
|
"LOWEST_COST_WITHOUT_CAP",
|
31
32
|
"LOWEST_COST_WITH_BID_CAP",
|
32
|
-
"TARGET_COST",
|
33
33
|
]
|
34
34
|
|
35
35
|
CONFIGURED_STATUS = [
|
36
36
|
"ACTIVE",
|
37
|
-
"PAUSED",
|
38
|
-
"DELETED",
|
39
37
|
"ARCHIVED",
|
38
|
+
"DELETED",
|
39
|
+
"PAUSED",
|
40
40
|
]
|
41
41
|
|
42
42
|
EFFECTIVE_STATUS = [
|
43
43
|
"ACTIVE",
|
44
|
-
"PAUSED",
|
45
|
-
"DELETED",
|
46
|
-
"PENDING_REVIEW",
|
47
|
-
"DISAPPROVED",
|
48
|
-
"PREAPPROVED",
|
49
|
-
"PENDING_BILLING_INFO",
|
50
|
-
"CAMPAIGN_PAUSED",
|
51
44
|
"ARCHIVED",
|
52
|
-
"
|
45
|
+
"DELETED",
|
46
|
+
"IN_PROCESS",
|
47
|
+
"PAUSED",
|
48
|
+
"WITH_ISSUES",
|
53
49
|
]
|
54
50
|
|
55
51
|
STATUS = [
|
56
52
|
"ACTIVE",
|
57
|
-
"PAUSED",
|
58
|
-
"DELETED",
|
59
53
|
"ARCHIVED",
|
54
|
+
"DELETED",
|
55
|
+
"PAUSED",
|
60
56
|
]
|
61
57
|
|
62
58
|
DATE_PRESET = [
|
63
|
-
"
|
64
|
-
"yesterday",
|
65
|
-
"this_month",
|
66
|
-
"last_month",
|
67
|
-
"this_quarter",
|
68
|
-
"lifetime",
|
69
|
-
"last_3d",
|
70
|
-
"last_7d",
|
59
|
+
"data_maximum",
|
71
60
|
"last_14d",
|
72
61
|
"last_28d",
|
73
62
|
"last_30d",
|
63
|
+
"last_3d",
|
64
|
+
"last_7d",
|
74
65
|
"last_90d",
|
66
|
+
"last_month",
|
67
|
+
"last_quarter",
|
75
68
|
"last_week_mon_sun",
|
76
69
|
"last_week_sun_sat",
|
77
|
-
"last_quarter",
|
78
70
|
"last_year",
|
71
|
+
"maximum",
|
72
|
+
"this_month",
|
73
|
+
"this_quarter",
|
79
74
|
"this_week_mon_today",
|
80
75
|
"this_week_sun_today",
|
81
76
|
"this_year",
|
82
|
-
|
83
|
-
|
84
|
-
DELETE_STRATEGY = [
|
85
|
-
"DELETE_ANY",
|
86
|
-
"DELETE_OLDEST",
|
87
|
-
"DELETE_ARCHIVED_BEFORE",
|
77
|
+
"today",
|
78
|
+
"yesterday",
|
88
79
|
]
|
89
80
|
|
90
81
|
EXECUTION_OPTIONS = [
|
91
|
-
"validate_only",
|
92
82
|
"include_recommendations",
|
83
|
+
"validate_only",
|
93
84
|
]
|
94
85
|
|
95
86
|
OBJECTIVE = [
|
@@ -106,16 +97,302 @@ module FacebookAds
|
|
106
97
|
"POST_ENGAGEMENT",
|
107
98
|
"PRODUCT_CATALOG_SALES",
|
108
99
|
"REACH",
|
100
|
+
"STORE_VISITS",
|
109
101
|
"VIDEO_VIEWS",
|
110
102
|
]
|
111
103
|
|
104
|
+
SMART_PROMOTION_TYPE = [
|
105
|
+
"GUIDED_CREATION",
|
106
|
+
"SMART_APP_PROMOTION",
|
107
|
+
]
|
108
|
+
|
109
|
+
SPECIAL_AD_CATEGORIES = [
|
110
|
+
"CREDIT",
|
111
|
+
"EMPLOYMENT",
|
112
|
+
"HOUSING",
|
113
|
+
"ISSUES_ELECTIONS_POLITICS",
|
114
|
+
"NONE",
|
115
|
+
"ONLINE_GAMBLING_AND_GAMING",
|
116
|
+
]
|
117
|
+
|
118
|
+
SPECIAL_AD_CATEGORY_COUNTRY = [
|
119
|
+
"AD",
|
120
|
+
"AE",
|
121
|
+
"AF",
|
122
|
+
"AG",
|
123
|
+
"AI",
|
124
|
+
"AL",
|
125
|
+
"AM",
|
126
|
+
"AN",
|
127
|
+
"AO",
|
128
|
+
"AQ",
|
129
|
+
"AR",
|
130
|
+
"AS",
|
131
|
+
"AT",
|
132
|
+
"AU",
|
133
|
+
"AW",
|
134
|
+
"AX",
|
135
|
+
"AZ",
|
136
|
+
"BA",
|
137
|
+
"BB",
|
138
|
+
"BD",
|
139
|
+
"BE",
|
140
|
+
"BF",
|
141
|
+
"BG",
|
142
|
+
"BH",
|
143
|
+
"BI",
|
144
|
+
"BJ",
|
145
|
+
"BL",
|
146
|
+
"BM",
|
147
|
+
"BN",
|
148
|
+
"BO",
|
149
|
+
"BQ",
|
150
|
+
"BR",
|
151
|
+
"BS",
|
152
|
+
"BT",
|
153
|
+
"BV",
|
154
|
+
"BW",
|
155
|
+
"BY",
|
156
|
+
"BZ",
|
157
|
+
"CA",
|
158
|
+
"CC",
|
159
|
+
"CD",
|
160
|
+
"CF",
|
161
|
+
"CG",
|
162
|
+
"CH",
|
163
|
+
"CI",
|
164
|
+
"CK",
|
165
|
+
"CL",
|
166
|
+
"CM",
|
167
|
+
"CN",
|
168
|
+
"CO",
|
169
|
+
"CR",
|
170
|
+
"CU",
|
171
|
+
"CV",
|
172
|
+
"CW",
|
173
|
+
"CX",
|
174
|
+
"CY",
|
175
|
+
"CZ",
|
176
|
+
"DE",
|
177
|
+
"DJ",
|
178
|
+
"DK",
|
179
|
+
"DM",
|
180
|
+
"DO",
|
181
|
+
"DZ",
|
182
|
+
"EC",
|
183
|
+
"EE",
|
184
|
+
"EG",
|
185
|
+
"EH",
|
186
|
+
"ER",
|
187
|
+
"ES",
|
188
|
+
"ET",
|
189
|
+
"FI",
|
190
|
+
"FJ",
|
191
|
+
"FK",
|
192
|
+
"FM",
|
193
|
+
"FO",
|
194
|
+
"FR",
|
195
|
+
"GA",
|
196
|
+
"GB",
|
197
|
+
"GD",
|
198
|
+
"GE",
|
199
|
+
"GF",
|
200
|
+
"GG",
|
201
|
+
"GH",
|
202
|
+
"GI",
|
203
|
+
"GL",
|
204
|
+
"GM",
|
205
|
+
"GN",
|
206
|
+
"GP",
|
207
|
+
"GQ",
|
208
|
+
"GR",
|
209
|
+
"GS",
|
210
|
+
"GT",
|
211
|
+
"GU",
|
212
|
+
"GW",
|
213
|
+
"GY",
|
214
|
+
"HK",
|
215
|
+
"HM",
|
216
|
+
"HN",
|
217
|
+
"HR",
|
218
|
+
"HT",
|
219
|
+
"HU",
|
220
|
+
"ID",
|
221
|
+
"IE",
|
222
|
+
"IL",
|
223
|
+
"IM",
|
224
|
+
"IN",
|
225
|
+
"IO",
|
226
|
+
"IQ",
|
227
|
+
"IR",
|
228
|
+
"IS",
|
229
|
+
"IT",
|
230
|
+
"JE",
|
231
|
+
"JM",
|
232
|
+
"JO",
|
233
|
+
"JP",
|
234
|
+
"KE",
|
235
|
+
"KG",
|
236
|
+
"KH",
|
237
|
+
"KI",
|
238
|
+
"KM",
|
239
|
+
"KN",
|
240
|
+
"KP",
|
241
|
+
"KR",
|
242
|
+
"KW",
|
243
|
+
"KY",
|
244
|
+
"KZ",
|
245
|
+
"LA",
|
246
|
+
"LB",
|
247
|
+
"LC",
|
248
|
+
"LI",
|
249
|
+
"LK",
|
250
|
+
"LR",
|
251
|
+
"LS",
|
252
|
+
"LT",
|
253
|
+
"LU",
|
254
|
+
"LV",
|
255
|
+
"LY",
|
256
|
+
"MA",
|
257
|
+
"MC",
|
258
|
+
"MD",
|
259
|
+
"ME",
|
260
|
+
"MF",
|
261
|
+
"MG",
|
262
|
+
"MH",
|
263
|
+
"MK",
|
264
|
+
"ML",
|
265
|
+
"MM",
|
266
|
+
"MN",
|
267
|
+
"MO",
|
268
|
+
"MP",
|
269
|
+
"MQ",
|
270
|
+
"MR",
|
271
|
+
"MS",
|
272
|
+
"MT",
|
273
|
+
"MU",
|
274
|
+
"MV",
|
275
|
+
"MW",
|
276
|
+
"MX",
|
277
|
+
"MY",
|
278
|
+
"MZ",
|
279
|
+
"NA",
|
280
|
+
"NC",
|
281
|
+
"NE",
|
282
|
+
"NF",
|
283
|
+
"NG",
|
284
|
+
"NI",
|
285
|
+
"NL",
|
286
|
+
"NO",
|
287
|
+
"NP",
|
288
|
+
"NR",
|
289
|
+
"NU",
|
290
|
+
"NZ",
|
291
|
+
"OM",
|
292
|
+
"PA",
|
293
|
+
"PE",
|
294
|
+
"PF",
|
295
|
+
"PG",
|
296
|
+
"PH",
|
297
|
+
"PK",
|
298
|
+
"PL",
|
299
|
+
"PM",
|
300
|
+
"PN",
|
301
|
+
"PR",
|
302
|
+
"PS",
|
303
|
+
"PT",
|
304
|
+
"PW",
|
305
|
+
"PY",
|
306
|
+
"QA",
|
307
|
+
"RE",
|
308
|
+
"RO",
|
309
|
+
"RS",
|
310
|
+
"RU",
|
311
|
+
"RW",
|
312
|
+
"SA",
|
313
|
+
"SB",
|
314
|
+
"SC",
|
315
|
+
"SD",
|
316
|
+
"SE",
|
317
|
+
"SG",
|
318
|
+
"SH",
|
319
|
+
"SI",
|
320
|
+
"SJ",
|
321
|
+
"SK",
|
322
|
+
"SL",
|
323
|
+
"SM",
|
324
|
+
"SN",
|
325
|
+
"SO",
|
326
|
+
"SR",
|
327
|
+
"SS",
|
328
|
+
"ST",
|
329
|
+
"SV",
|
330
|
+
"SX",
|
331
|
+
"SY",
|
332
|
+
"SZ",
|
333
|
+
"TC",
|
334
|
+
"TD",
|
335
|
+
"TF",
|
336
|
+
"TG",
|
337
|
+
"TH",
|
338
|
+
"TJ",
|
339
|
+
"TK",
|
340
|
+
"TL",
|
341
|
+
"TM",
|
342
|
+
"TN",
|
343
|
+
"TO",
|
344
|
+
"TR",
|
345
|
+
"TT",
|
346
|
+
"TV",
|
347
|
+
"TW",
|
348
|
+
"TZ",
|
349
|
+
"UA",
|
350
|
+
"UG",
|
351
|
+
"UM",
|
352
|
+
"US",
|
353
|
+
"UY",
|
354
|
+
"UZ",
|
355
|
+
"VA",
|
356
|
+
"VC",
|
357
|
+
"VE",
|
358
|
+
"VG",
|
359
|
+
"VI",
|
360
|
+
"VN",
|
361
|
+
"VU",
|
362
|
+
"WF",
|
363
|
+
"WS",
|
364
|
+
"XK",
|
365
|
+
"YE",
|
366
|
+
"YT",
|
367
|
+
"ZA",
|
368
|
+
"ZM",
|
369
|
+
"ZW",
|
370
|
+
]
|
371
|
+
|
112
372
|
OPERATOR = [
|
113
373
|
"ALL",
|
114
374
|
"ANY",
|
115
375
|
]
|
116
376
|
|
377
|
+
SPECIAL_AD_CATEGORY = [
|
378
|
+
"CREDIT",
|
379
|
+
"EMPLOYMENT",
|
380
|
+
"HOUSING",
|
381
|
+
"ISSUES_ELECTIONS_POLITICS",
|
382
|
+
"NONE",
|
383
|
+
"ONLINE_GAMBLING_AND_GAMING",
|
384
|
+
]
|
385
|
+
|
386
|
+
STATUS_OPTION = [
|
387
|
+
"ACTIVE",
|
388
|
+
"INHERITED_FROM_SOURCE",
|
389
|
+
"PAUSED",
|
390
|
+
]
|
391
|
+
|
117
392
|
|
118
393
|
field :account_id, 'string'
|
394
|
+
field :ad_strategy_group_id, 'string'
|
395
|
+
field :ad_strategy_id, 'string'
|
119
396
|
field :adlabels, { list: 'AdLabel' }
|
120
397
|
field :bid_strategy, { enum: -> { BID_STRATEGY }}
|
121
398
|
field :boosted_object_id, 'string'
|
@@ -130,30 +407,40 @@ module FacebookAds
|
|
130
407
|
field :daily_budget, 'string'
|
131
408
|
field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
|
132
409
|
field :id, 'string'
|
410
|
+
field :is_skadnetwork_attribution, 'bool'
|
411
|
+
field :issues_info, { list: 'AdCampaignIssuesInfo' }
|
412
|
+
field :last_budget_toggling_time, 'datetime'
|
133
413
|
field :lifetime_budget, 'string'
|
134
414
|
field :name, 'string'
|
135
415
|
field :objective, 'string'
|
416
|
+
field :pacing_type, { list: 'string' }
|
417
|
+
field :promoted_object, 'AdPromotedObject'
|
136
418
|
field :recommendations, { list: 'AdRecommendation' }
|
419
|
+
field :smart_promotion_type, 'string'
|
137
420
|
field :source_campaign, 'Campaign'
|
138
421
|
field :source_campaign_id, 'string'
|
422
|
+
field :special_ad_categories, { list: 'string' }
|
423
|
+
field :special_ad_category, 'string'
|
424
|
+
field :special_ad_category_country, { list: 'string' }
|
139
425
|
field :spend_cap, 'string'
|
140
426
|
field :start_time, 'datetime'
|
141
427
|
field :status, { enum: -> { STATUS }}
|
142
428
|
field :stop_time, 'datetime'
|
429
|
+
field :topline_id, 'string'
|
143
430
|
field :updated_time, 'datetime'
|
144
431
|
field :adbatch, { list: 'object' }
|
145
432
|
field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
|
146
433
|
field :iterative_split_test_configs, { list: 'object' }
|
147
|
-
field :
|
434
|
+
field :upstream_events, 'hash'
|
435
|
+
|
436
|
+
has_edge :ad_studies do |edge|
|
437
|
+
edge.get 'AdStudy'
|
438
|
+
end
|
148
439
|
|
149
440
|
has_edge :adlabels do |edge|
|
150
|
-
edge.
|
441
|
+
edge.post 'Campaign' do |api|
|
151
442
|
api.has_param :adlabels, { list: 'object' }
|
152
|
-
api.has_param :execution_options, { list: { enum: -> {
|
153
|
-
end
|
154
|
-
edge.post 'AdLabel' do |api|
|
155
|
-
api.has_param :adlabels, { list: 'object' }
|
156
|
-
api.has_param :execution_options, { list: { enum: -> { AdLabel::EXECUTION_OPTIONS }} }
|
443
|
+
api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
|
157
444
|
end
|
158
445
|
end
|
159
446
|
|
@@ -165,7 +452,6 @@ module FacebookAds
|
|
165
452
|
|
166
453
|
has_edge :ads do |edge|
|
167
454
|
edge.get 'Ad' do |api|
|
168
|
-
api.has_param :ad_draft_id, 'string'
|
169
455
|
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
170
456
|
api.has_param :effective_status, { list: 'string' }
|
171
457
|
api.has_param :time_range, 'object'
|
@@ -175,7 +461,6 @@ module FacebookAds
|
|
175
461
|
|
176
462
|
has_edge :adsets do |edge|
|
177
463
|
edge.get 'AdSet' do |api|
|
178
|
-
api.has_param :ad_draft_id, 'string'
|
179
464
|
api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
|
180
465
|
api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
|
181
466
|
api.has_param :is_completed, 'bool'
|
@@ -183,6 +468,17 @@ module FacebookAds
|
|
183
468
|
end
|
184
469
|
end
|
185
470
|
|
471
|
+
has_edge :content_delivery_report do |edge|
|
472
|
+
edge.get 'ContentDeliveryReport' do |api|
|
473
|
+
api.has_param :end_date, 'datetime'
|
474
|
+
api.has_param :page_id, 'int'
|
475
|
+
api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
|
476
|
+
api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
|
477
|
+
api.has_param :start_date, 'datetime'
|
478
|
+
api.has_param :summary, 'bool'
|
479
|
+
end
|
480
|
+
end
|
481
|
+
|
186
482
|
has_edge :copies do |edge|
|
187
483
|
edge.get 'Campaign' do |api|
|
188
484
|
api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
|
@@ -190,6 +486,13 @@ module FacebookAds
|
|
190
486
|
api.has_param :is_completed, 'bool'
|
191
487
|
api.has_param :time_range, 'object'
|
192
488
|
end
|
489
|
+
edge.post 'Campaign' do |api|
|
490
|
+
api.has_param :deep_copy, 'bool'
|
491
|
+
api.has_param :end_time, 'datetime'
|
492
|
+
api.has_param :rename_options, 'object'
|
493
|
+
api.has_param :start_time, 'datetime'
|
494
|
+
api.has_param :status_option, { enum: -> { Campaign::STATUS_OPTION }}
|
495
|
+
end
|
193
496
|
end
|
194
497
|
|
195
498
|
has_edge :insights do |edge|
|
@@ -203,17 +506,18 @@ module FacebookAds
|
|
203
506
|
api.has_param :export_columns, { list: 'string' }
|
204
507
|
api.has_param :export_format, 'string'
|
205
508
|
api.has_param :export_name, 'string'
|
206
|
-
api.has_param :fields, { list:
|
509
|
+
api.has_param :fields, { list: 'string' }
|
207
510
|
api.has_param :filtering, { list: 'object' }
|
208
511
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
209
512
|
api.has_param :product_id_limit, 'int'
|
210
513
|
api.has_param :sort, { list: 'string' }
|
211
|
-
api.has_param :summary, { list:
|
514
|
+
api.has_param :summary, { list: 'string' }
|
212
515
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
213
516
|
api.has_param :time_increment, 'string'
|
214
517
|
api.has_param :time_range, 'object'
|
215
518
|
api.has_param :time_ranges, { list: 'object' }
|
216
519
|
api.has_param :use_account_attribution_setting, 'bool'
|
520
|
+
api.has_param :use_unified_attribution_setting, 'bool'
|
217
521
|
end
|
218
522
|
edge.post 'AdReportRun' do |api|
|
219
523
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
@@ -225,17 +529,18 @@ module FacebookAds
|
|
225
529
|
api.has_param :export_columns, { list: 'string' }
|
226
530
|
api.has_param :export_format, 'string'
|
227
531
|
api.has_param :export_name, 'string'
|
228
|
-
api.has_param :fields, { list:
|
532
|
+
api.has_param :fields, { list: 'string' }
|
229
533
|
api.has_param :filtering, { list: 'object' }
|
230
534
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
231
535
|
api.has_param :product_id_limit, 'int'
|
232
536
|
api.has_param :sort, { list: 'string' }
|
233
|
-
api.has_param :summary, { list:
|
537
|
+
api.has_param :summary, { list: 'string' }
|
234
538
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
235
539
|
api.has_param :time_increment, 'string'
|
236
540
|
api.has_param :time_range, 'object'
|
237
541
|
api.has_param :time_ranges, { list: 'object' }
|
238
542
|
api.has_param :use_account_attribution_setting, 'bool'
|
543
|
+
api.has_param :use_unified_attribution_setting, 'bool'
|
239
544
|
end
|
240
545
|
end
|
241
546
|
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
4
|
+
# copy, modify, and distribute this software in source code or binary form for use
|
5
|
+
# in connection with the web services and APIs provided by Facebook.
|
6
|
+
#
|
7
|
+
# As with any software that integrates with the Facebook platform, your use of
|
8
|
+
# this software is subject to the Facebook Platform Policy
|
9
|
+
# [http://developers.facebook.com/policy/]. This copyright notice shall be
|
10
|
+
# included in all copies or substantial portions of the software.
|
11
|
+
#
|
12
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
14
|
+
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
15
|
+
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
16
|
+
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
17
|
+
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
18
|
+
|
19
|
+
# FB:AUTOGEN
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
# This class is auto-generated.
|
23
|
+
|
24
|
+
# For any issues or feature requests related to this class, please let us know
|
25
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
|
+
# pull request for this class.
|
27
|
+
|
28
|
+
class CampaignGroupBrandConfiguration < AdObject
|
29
|
+
|
30
|
+
field :brand_product_name, 'string'
|
31
|
+
field :locale, 'string'
|
32
|
+
field :vertical, 'string'
|
33
|
+
has_no_id
|
34
|
+
has_no_get
|
35
|
+
has_no_post
|
36
|
+
has_no_delete
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,36 @@
|
|
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 CampaignGroupCollaborativeAdsPartnerInfo < AdObject
|
29
|
+
|
30
|
+
has_no_id
|
31
|
+
has_no_get
|
32
|
+
has_no_post
|
33
|
+
has_no_delete
|
34
|
+
|
35
|
+
end
|
36
|
+
end
|
@@ -29,21 +29,34 @@ module FacebookAds
|
|
29
29
|
|
30
30
|
field :background_color, 'string'
|
31
31
|
field :body_elements, { list: 'object' }
|
32
|
+
field :business_id, 'string'
|
32
33
|
field :canvas_link, 'string'
|
34
|
+
field :collection_hero_image, 'Photo'
|
35
|
+
field :collection_hero_video, 'AdVideo'
|
36
|
+
field :collection_thumbnails, { list: 'CanvasCollectionThumbnail' }
|
37
|
+
field :element_payload, 'string'
|
38
|
+
field :elements, { list: 'RichMediaElement' }
|
39
|
+
field :fb_body_elements, { list: 'object' }
|
33
40
|
field :id, 'string'
|
34
41
|
field :is_hidden, 'bool'
|
35
42
|
field :is_published, 'bool'
|
36
43
|
field :last_editor, 'User'
|
44
|
+
field :linked_documents, { list: 'Canvas' }
|
37
45
|
field :name, 'string'
|
38
46
|
field :owner, 'Page'
|
47
|
+
field :property_list, { list: 'string' }
|
48
|
+
field :source_template, 'CanvasTemplate'
|
49
|
+
field :store_url, 'string'
|
50
|
+
field :style_list, { list: 'string' }
|
51
|
+
field :tags, { list: 'string' }
|
52
|
+
field :ui_property_list, { list: 'string' }
|
53
|
+
field :unused_body_elements, { list: 'object' }
|
39
54
|
field :update_time, 'int'
|
55
|
+
field :use_retailer_item_ids, 'bool'
|
56
|
+
has_no_delete
|
40
57
|
|
41
|
-
has_edge :
|
42
|
-
edge.
|
43
|
-
end
|
44
|
-
|
45
|
-
has_edge :preview_notifications do |edge|
|
46
|
-
edge.post do |api|
|
58
|
+
has_edge :previews do |edge|
|
59
|
+
edge.get 'TextWithEntities' do |api|
|
47
60
|
api.has_param :user_ids, { list: 'int' }
|
48
61
|
end
|
49
62
|
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 CanvasAdSettings < AdObject
|
29
|
+
|
30
|
+
field :is_canvas_collection_eligible, 'bool'
|
31
|
+
field :lead_form_created_time, 'int'
|
32
|
+
field :lead_form_name, 'string'
|
33
|
+
field :lead_gen_form_id, 'string'
|
34
|
+
field :leads_count, 'int'
|
35
|
+
field :product_set_id, 'string'
|
36
|
+
field :use_retailer_item_ids, 'bool'
|
37
|
+
has_no_id
|
38
|
+
has_no_get
|
39
|
+
has_no_post
|
40
|
+
has_no_delete
|
41
|
+
|
42
|
+
end
|
43
|
+
end
|