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,13 +27,16 @@ module FacebookAds
|
|
27
27
|
|
28
28
|
class AdsInsights < AdObject
|
29
29
|
ACTION_ATTRIBUTION_WINDOWS = [
|
30
|
+
"1d_click",
|
30
31
|
"1d_view",
|
31
|
-
"
|
32
|
+
"28d_click",
|
32
33
|
"28d_view",
|
33
|
-
"1d_click",
|
34
34
|
"7d_click",
|
35
|
-
"
|
35
|
+
"7d_view",
|
36
|
+
"dda",
|
36
37
|
"default",
|
38
|
+
"skan_click",
|
39
|
+
"skan_view",
|
37
40
|
]
|
38
41
|
|
39
42
|
ACTION_BREAKDOWNS = [
|
@@ -42,7 +45,6 @@ module FacebookAds
|
|
42
45
|
"action_carousel_card_name",
|
43
46
|
"action_destination",
|
44
47
|
"action_device",
|
45
|
-
"action_link_click_destination",
|
46
48
|
"action_reaction",
|
47
49
|
"action_target_id",
|
48
50
|
"action_type",
|
@@ -51,62 +53,66 @@ module FacebookAds
|
|
51
53
|
]
|
52
54
|
|
53
55
|
ACTION_REPORT_TIME = [
|
54
|
-
"impression",
|
55
56
|
"conversion",
|
57
|
+
"impression",
|
58
|
+
"mixed",
|
56
59
|
]
|
57
60
|
|
58
61
|
BREAKDOWNS = [
|
62
|
+
"ad_format_asset",
|
59
63
|
"age",
|
64
|
+
"app_id",
|
65
|
+
"body_asset",
|
66
|
+
"call_to_action_asset",
|
60
67
|
"country",
|
68
|
+
"description_asset",
|
69
|
+
"device_platform",
|
61
70
|
"dma",
|
62
|
-
"gender",
|
63
71
|
"frequency_value",
|
72
|
+
"gender",
|
64
73
|
"hourly_stats_aggregated_by_advertiser_time_zone",
|
65
74
|
"hourly_stats_aggregated_by_audience_time_zone",
|
75
|
+
"image_asset",
|
66
76
|
"impression_device",
|
77
|
+
"link_url_asset",
|
67
78
|
"place_page_id",
|
68
|
-
"publisher_platform",
|
69
79
|
"platform_position",
|
70
|
-
"device_platform",
|
71
80
|
"product_id",
|
81
|
+
"publisher_platform",
|
72
82
|
"region",
|
73
|
-
"
|
74
|
-
"body_asset",
|
75
|
-
"call_to_action_asset",
|
76
|
-
"description_asset",
|
77
|
-
"image_asset",
|
78
|
-
"link_url_asset",
|
83
|
+
"skan_conversion_id",
|
79
84
|
"title_asset",
|
80
85
|
"video_asset",
|
81
86
|
]
|
82
87
|
|
83
88
|
DATE_PRESET = [
|
84
|
-
"
|
85
|
-
"yesterday",
|
86
|
-
"this_month",
|
87
|
-
"last_month",
|
88
|
-
"this_quarter",
|
89
|
-
"lifetime",
|
90
|
-
"last_3d",
|
91
|
-
"last_7d",
|
89
|
+
"data_maximum",
|
92
90
|
"last_14d",
|
93
91
|
"last_28d",
|
94
92
|
"last_30d",
|
93
|
+
"last_3d",
|
94
|
+
"last_7d",
|
95
95
|
"last_90d",
|
96
|
+
"last_month",
|
97
|
+
"last_quarter",
|
96
98
|
"last_week_mon_sun",
|
97
99
|
"last_week_sun_sat",
|
98
|
-
"last_quarter",
|
99
100
|
"last_year",
|
101
|
+
"maximum",
|
102
|
+
"this_month",
|
103
|
+
"this_quarter",
|
100
104
|
"this_week_mon_today",
|
101
105
|
"this_week_sun_today",
|
102
106
|
"this_year",
|
107
|
+
"today",
|
108
|
+
"yesterday",
|
103
109
|
]
|
104
110
|
|
105
111
|
LEVEL = [
|
112
|
+
"account",
|
106
113
|
"ad",
|
107
114
|
"adset",
|
108
115
|
"campaign",
|
109
|
-
"account",
|
110
116
|
]
|
111
117
|
|
112
118
|
SUMMARY_ACTION_BREAKDOWNS = [
|
@@ -115,7 +121,6 @@ module FacebookAds
|
|
115
121
|
"action_carousel_card_name",
|
116
122
|
"action_destination",
|
117
123
|
"action_device",
|
118
|
-
"action_link_click_destination",
|
119
124
|
"action_reaction",
|
120
125
|
"action_target_id",
|
121
126
|
"action_type",
|
@@ -123,91 +128,137 @@ module FacebookAds
|
|
123
128
|
"action_video_type",
|
124
129
|
]
|
125
130
|
|
126
|
-
SUMMARY = [
|
127
|
-
"id",
|
128
|
-
"account_id",
|
129
|
-
"async_percent_completion",
|
130
|
-
"async_status",
|
131
|
-
"date_start",
|
132
|
-
"date_stop",
|
133
|
-
"emails",
|
134
|
-
"friendly_name",
|
135
|
-
"is_bookmarked",
|
136
|
-
"is_running",
|
137
|
-
"schedule_id",
|
138
|
-
"time_completed",
|
139
|
-
"time_ref",
|
140
|
-
]
|
141
|
-
|
142
131
|
|
143
132
|
field :account_currency, 'string'
|
144
133
|
field :account_id, 'string'
|
145
134
|
field :account_name, 'string'
|
146
135
|
field :action_values, { list: 'AdsActionStats' }
|
147
136
|
field :actions, { list: 'AdsActionStats' }
|
137
|
+
field :ad_bid_value, 'string'
|
138
|
+
field :ad_click_actions, { list: 'AdsActionStats' }
|
148
139
|
field :ad_id, 'string'
|
140
|
+
field :ad_impression_actions, { list: 'AdsActionStats' }
|
149
141
|
field :ad_name, 'string'
|
142
|
+
field :adset_bid_value, 'string'
|
143
|
+
field :adset_end, 'string'
|
150
144
|
field :adset_id, 'string'
|
151
145
|
field :adset_name, 'string'
|
146
|
+
field :adset_start, 'string'
|
147
|
+
field :age_targeting, 'string'
|
148
|
+
field :attribution_setting, 'string'
|
149
|
+
field :auction_bid, 'string'
|
150
|
+
field :auction_competitiveness, 'string'
|
151
|
+
field :auction_max_competitor_bid, 'string'
|
152
152
|
field :buying_type, 'string'
|
153
153
|
field :campaign_id, 'string'
|
154
154
|
field :campaign_name, 'string'
|
155
155
|
field :canvas_avg_view_percent, 'string'
|
156
156
|
field :canvas_avg_view_time, 'string'
|
157
|
+
field :catalog_segment_actions, { list: 'AdsActionStats' }
|
158
|
+
field :catalog_segment_value, { list: 'AdsActionStats' }
|
159
|
+
field :catalog_segment_value_mobile_purchase_roas, { list: 'AdsActionStats' }
|
160
|
+
field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
|
161
|
+
field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
|
157
162
|
field :clicks, 'string'
|
158
|
-
field :
|
163
|
+
field :conversion_rate_ranking, 'string'
|
164
|
+
field :conversion_values, { list: 'AdsActionStats' }
|
165
|
+
field :conversions, { list: 'AdsActionStats' }
|
166
|
+
field :converted_product_quantity, { list: 'AdsActionStats' }
|
167
|
+
field :converted_product_value, { list: 'AdsActionStats' }
|
168
|
+
field :cost_per_15_sec_video_view, { list: 'AdsActionStats' }
|
169
|
+
field :cost_per_2_sec_continuous_video_view, { list: 'AdsActionStats' }
|
159
170
|
field :cost_per_action_type, { list: 'AdsActionStats' }
|
171
|
+
field :cost_per_ad_click, { list: 'AdsActionStats' }
|
172
|
+
field :cost_per_conversion, { list: 'AdsActionStats' }
|
173
|
+
field :cost_per_dda_countby_convs, 'string'
|
160
174
|
field :cost_per_estimated_ad_recallers, 'string'
|
161
175
|
field :cost_per_inline_link_click, 'string'
|
162
176
|
field :cost_per_inline_post_engagement, 'string'
|
177
|
+
field :cost_per_one_thousand_ad_impression, { list: 'AdsActionStats' }
|
163
178
|
field :cost_per_outbound_click, { list: 'AdsActionStats' }
|
179
|
+
field :cost_per_thruplay, { list: 'AdsActionStats' }
|
164
180
|
field :cost_per_unique_action_type, { list: 'AdsActionStats' }
|
165
181
|
field :cost_per_unique_click, 'string'
|
182
|
+
field :cost_per_unique_conversion, { list: 'AdsActionStats' }
|
166
183
|
field :cost_per_unique_inline_link_click, 'string'
|
167
184
|
field :cost_per_unique_outbound_click, { list: 'AdsActionStats' }
|
168
185
|
field :cpc, 'string'
|
169
186
|
field :cpm, 'string'
|
170
187
|
field :cpp, 'string'
|
188
|
+
field :created_time, 'string'
|
171
189
|
field :ctr, 'string'
|
172
190
|
field :date_start, 'string'
|
173
191
|
field :date_stop, 'string'
|
192
|
+
field :dda_countby_convs, 'string'
|
193
|
+
field :dda_results, { list: 'object' }
|
194
|
+
field :engagement_rate_ranking, 'string'
|
174
195
|
field :estimated_ad_recall_rate, 'string'
|
196
|
+
field :estimated_ad_recall_rate_lower_bound, 'string'
|
197
|
+
field :estimated_ad_recall_rate_upper_bound, 'string'
|
175
198
|
field :estimated_ad_recallers, 'string'
|
199
|
+
field :estimated_ad_recallers_lower_bound, 'string'
|
200
|
+
field :estimated_ad_recallers_upper_bound, 'string'
|
176
201
|
field :frequency, 'string'
|
202
|
+
field :full_view_impressions, 'string'
|
203
|
+
field :full_view_reach, 'string'
|
204
|
+
field :gender_targeting, 'string'
|
177
205
|
field :impressions, 'string'
|
178
206
|
field :inline_link_click_ctr, 'string'
|
179
207
|
field :inline_link_clicks, 'string'
|
180
208
|
field :inline_post_engagement, 'string'
|
209
|
+
field :instant_experience_clicks_to_open, 'string'
|
210
|
+
field :instant_experience_clicks_to_start, 'string'
|
211
|
+
field :instant_experience_outbound_clicks, { list: 'AdsActionStats' }
|
212
|
+
field :interactive_component_tap, { list: 'AdsActionStats' }
|
213
|
+
field :labels, 'string'
|
214
|
+
field :location, 'string'
|
181
215
|
field :mobile_app_purchase_roas, { list: 'AdsActionStats' }
|
182
216
|
field :objective, 'string'
|
217
|
+
field :optimization_goal, 'string'
|
183
218
|
field :outbound_clicks, { list: 'AdsActionStats' }
|
184
219
|
field :outbound_clicks_ctr, { list: 'AdsActionStats' }
|
185
220
|
field :place_page_name, 'string'
|
221
|
+
field :purchase_roas, { list: 'AdsActionStats' }
|
222
|
+
field :qualifying_question_qualify_answer_rate, 'string'
|
223
|
+
field :quality_ranking, 'string'
|
224
|
+
field :quality_score_ectr, 'string'
|
225
|
+
field :quality_score_ecvr, 'string'
|
226
|
+
field :quality_score_organic, 'string'
|
186
227
|
field :reach, 'string'
|
187
|
-
field :relevance_score, 'AdgroupRelevanceScore'
|
188
|
-
field :social_impressions, 'string'
|
189
228
|
field :social_spend, 'string'
|
190
229
|
field :spend, 'string'
|
191
|
-
field :
|
230
|
+
field :total_postbacks, 'string'
|
192
231
|
field :unique_actions, { list: 'AdsActionStats' }
|
193
232
|
field :unique_clicks, 'string'
|
233
|
+
field :unique_conversions, { list: 'AdsActionStats' }
|
194
234
|
field :unique_ctr, 'string'
|
195
235
|
field :unique_inline_link_click_ctr, 'string'
|
196
236
|
field :unique_inline_link_clicks, 'string'
|
197
237
|
field :unique_link_clicks_ctr, 'string'
|
198
238
|
field :unique_outbound_clicks, { list: 'AdsActionStats' }
|
199
239
|
field :unique_outbound_clicks_ctr, { list: 'AdsActionStats' }
|
200
|
-
field :
|
240
|
+
field :unique_video_continuous_2_sec_watched_actions, { list: 'AdsActionStats' }
|
241
|
+
field :unique_video_view_15_sec, { list: 'AdsActionStats' }
|
242
|
+
field :updated_time, 'string'
|
243
|
+
field :video_15_sec_watched_actions, { list: 'AdsActionStats' }
|
201
244
|
field :video_30_sec_watched_actions, { list: 'AdsActionStats' }
|
202
|
-
field :video_avg_percent_watched_actions, { list: 'AdsActionStats' }
|
203
245
|
field :video_avg_time_watched_actions, { list: 'AdsActionStats' }
|
246
|
+
field :video_continuous_2_sec_watched_actions, { list: 'AdsActionStats' }
|
204
247
|
field :video_p100_watched_actions, { list: 'AdsActionStats' }
|
205
248
|
field :video_p25_watched_actions, { list: 'AdsActionStats' }
|
206
249
|
field :video_p50_watched_actions, { list: 'AdsActionStats' }
|
207
250
|
field :video_p75_watched_actions, { list: 'AdsActionStats' }
|
208
251
|
field :video_p95_watched_actions, { list: 'AdsActionStats' }
|
252
|
+
field :video_play_actions, { list: 'AdsActionStats' }
|
253
|
+
field :video_play_curve_actions, { list: 'object' }
|
254
|
+
field :video_play_retention_0_to_15s_actions, { list: 'object' }
|
255
|
+
field :video_play_retention_20_to_60s_actions, { list: 'object' }
|
256
|
+
field :video_play_retention_graph_actions, { list: 'object' }
|
257
|
+
field :video_thruplay_watched_actions, { list: 'AdsActionStats' }
|
258
|
+
field :video_time_watched_actions, { list: 'AdsActionStats' }
|
209
259
|
field :website_ctr, { list: 'AdsActionStats' }
|
210
260
|
field :website_purchase_roas, { list: 'AdsActionStats' }
|
261
|
+
field :wish_bid, 'string'
|
211
262
|
has_no_id
|
212
263
|
has_no_get
|
213
264
|
has_no_post
|
@@ -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 AdsOptimalDeliveryGrowthOpportunity < AdObject
|
29
|
+
|
30
|
+
field :child_metadata, 'hash'
|
31
|
+
field :metadata, 'object'
|
32
|
+
field :optimization_type, 'string'
|
33
|
+
has_no_id
|
34
|
+
has_no_get
|
35
|
+
has_no_post
|
36
|
+
has_no_delete
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
@@ -26,25 +26,99 @@ module FacebookAds
|
|
26
26
|
# pull request for this class.
|
27
27
|
|
28
28
|
class AdsPixel < AdObject
|
29
|
+
SORT_BY = [
|
30
|
+
"LAST_FIRED_TIME",
|
31
|
+
"NAME",
|
32
|
+
]
|
29
33
|
|
34
|
+
AUTOMATIC_MATCHING_FIELDS = [
|
35
|
+
"country",
|
36
|
+
"ct",
|
37
|
+
"db",
|
38
|
+
"em",
|
39
|
+
"external_id",
|
40
|
+
"fn",
|
41
|
+
"ge",
|
42
|
+
"ln",
|
43
|
+
"ph",
|
44
|
+
"st",
|
45
|
+
"zp",
|
46
|
+
]
|
47
|
+
|
48
|
+
DATA_USE_SETTING = [
|
49
|
+
"ADVERTISING_AND_ANALYTICS",
|
50
|
+
"ANALYTICS_ONLY",
|
51
|
+
"EMPTY",
|
52
|
+
]
|
53
|
+
|
54
|
+
FIRST_PARTY_COOKIE_STATUS = [
|
55
|
+
"EMPTY",
|
56
|
+
"FIRST_PARTY_COOKIE_DISABLED",
|
57
|
+
"FIRST_PARTY_COOKIE_ENABLED",
|
58
|
+
]
|
59
|
+
|
60
|
+
TASKS = [
|
61
|
+
"AA_ANALYZE",
|
62
|
+
"ADVERTISE",
|
63
|
+
"ANALYZE",
|
64
|
+
"EDIT",
|
65
|
+
"UPLOAD",
|
66
|
+
]
|
67
|
+
|
68
|
+
|
69
|
+
field :automatic_matching_fields, { list: 'string' }
|
30
70
|
field :can_proxy, 'bool'
|
31
71
|
field :code, 'string'
|
32
72
|
field :creation_time, 'datetime'
|
33
73
|
field :creator, 'User'
|
74
|
+
field :data_use_setting, 'string'
|
75
|
+
field :enable_automatic_matching, 'bool'
|
76
|
+
field :first_party_cookie_status, 'string'
|
34
77
|
field :id, 'string'
|
35
78
|
field :is_created_by_business, 'bool'
|
79
|
+
field :is_crm, 'bool'
|
80
|
+
field :is_unavailable, 'bool'
|
36
81
|
field :last_fired_time, 'datetime'
|
37
82
|
field :name, 'string'
|
38
83
|
field :owner_ad_account, 'AdAccount'
|
39
84
|
field :owner_business, 'Business'
|
40
85
|
has_no_delete
|
41
86
|
|
42
|
-
has_edge :
|
43
|
-
edge.get '
|
44
|
-
api.has_param :
|
87
|
+
has_edge :assigned_users do |edge|
|
88
|
+
edge.get 'AssignedUser' do |api|
|
89
|
+
api.has_param :business, 'string'
|
90
|
+
end
|
91
|
+
edge.post 'AdsPixel' do |api|
|
92
|
+
api.has_param :tasks, { list: { enum: -> { AdsPixel::TASKS }} }
|
93
|
+
api.has_param :user, 'int'
|
45
94
|
end
|
46
95
|
end
|
47
96
|
|
97
|
+
has_edge :da_checks do |edge|
|
98
|
+
edge.get 'DaCheck' do |api|
|
99
|
+
api.has_param :checks, { list: 'string' }
|
100
|
+
api.has_param :connection_method, { enum: -> { DaCheck::CONNECTION_METHOD }}
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
has_edge :events do |edge|
|
105
|
+
edge.post 'AdsPixel' do |api|
|
106
|
+
api.has_param :data, { list: 'string' }
|
107
|
+
api.has_param :namespace_id, 'string'
|
108
|
+
api.has_param :partner_agent, 'string'
|
109
|
+
api.has_param :platforms, { list: 'hash' }
|
110
|
+
api.has_param :test_event_code, 'string'
|
111
|
+
api.has_param :trace, 'int'
|
112
|
+
api.has_param :upload_id, 'string'
|
113
|
+
api.has_param :upload_source, 'string'
|
114
|
+
api.has_param :upload_tag, 'string'
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
has_edge :shadowtraffichelper do |edge|
|
119
|
+
edge.post
|
120
|
+
end
|
121
|
+
|
48
122
|
has_edge :shared_accounts do |edge|
|
49
123
|
edge.delete do |api|
|
50
124
|
api.has_param :account_id, 'string'
|
@@ -53,7 +127,7 @@ module FacebookAds
|
|
53
127
|
edge.get 'AdAccount' do |api|
|
54
128
|
api.has_param :business, 'string'
|
55
129
|
end
|
56
|
-
edge.post do |api|
|
130
|
+
edge.post 'AdsPixel' do |api|
|
57
131
|
api.has_param :account_id, 'string'
|
58
132
|
api.has_param :business, 'string'
|
59
133
|
end
|
@@ -66,11 +140,16 @@ module FacebookAds
|
|
66
140
|
has_edge :stats do |edge|
|
67
141
|
edge.get 'AdsPixelStatsResult' do |api|
|
68
142
|
api.has_param :aggregation, { enum: -> { AdsPixelStatsResult::AGGREGATION }}
|
69
|
-
api.has_param :end_time, '
|
143
|
+
api.has_param :end_time, 'datetime'
|
70
144
|
api.has_param :event, 'string'
|
71
|
-
api.has_param :
|
145
|
+
api.has_param :event_source, 'string'
|
146
|
+
api.has_param :start_time, 'datetime'
|
72
147
|
end
|
73
148
|
end
|
74
149
|
|
150
|
+
has_edge :telemetry do |edge|
|
151
|
+
edge.post
|
152
|
+
end
|
153
|
+
|
75
154
|
end
|
76
155
|
end
|
@@ -32,14 +32,21 @@ module FacebookAds
|
|
32
32
|
"device_os",
|
33
33
|
"device_type",
|
34
34
|
"event",
|
35
|
+
"event_detection_method",
|
36
|
+
"event_processing_results",
|
37
|
+
"event_source",
|
38
|
+
"event_total_counts",
|
39
|
+
"event_value_count",
|
40
|
+
"had_pii",
|
35
41
|
"host",
|
42
|
+
"match_keys",
|
36
43
|
"pixel_fire",
|
37
44
|
"url",
|
38
|
-
"
|
45
|
+
"url_by_rule",
|
39
46
|
]
|
40
47
|
|
41
48
|
|
42
|
-
field :aggregation,
|
49
|
+
field :aggregation, 'string'
|
43
50
|
field :data, { list: 'AdsPixelStats' }
|
44
51
|
field :start_time, 'datetime'
|
45
52
|
has_no_id
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
4
|
+
# copy, modify, and distribute this software in source code or binary form for use
|
5
|
+
# in connection with the web services and APIs provided by Facebook.
|
6
|
+
#
|
7
|
+
# As with any software that integrates with the Facebook platform, your use of
|
8
|
+
# this software is subject to the Facebook Platform Policy
|
9
|
+
# [http://developers.facebook.com/policy/]. This copyright notice shall be
|
10
|
+
# included in all copies or substantial portions of the software.
|
11
|
+
#
|
12
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
14
|
+
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
15
|
+
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
16
|
+
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
17
|
+
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
18
|
+
|
19
|
+
# FB:AUTOGEN
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
# This class is auto-generated.
|
23
|
+
|
24
|
+
# For any issues or feature requests related to this class, please let us know
|
25
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
|
+
# pull request for this class.
|
27
|
+
|
28
|
+
class AgeRange < AdObject
|
29
|
+
|
30
|
+
field :max, 'int'
|
31
|
+
field :min, 'int'
|
32
|
+
has_no_id
|
33
|
+
has_no_get
|
34
|
+
has_no_post
|
35
|
+
has_no_delete
|
36
|
+
|
37
|
+
end
|
38
|
+
end
|
@@ -45,7 +45,7 @@ module FacebookAds
|
|
45
45
|
field :modified_major, 'datetime'
|
46
46
|
field :name, 'string'
|
47
47
|
field :photo_count, 'int'
|
48
|
-
field :place, '
|
48
|
+
field :place, 'Place'
|
49
49
|
field :privacy, 'string'
|
50
50
|
field :type, 'string'
|
51
51
|
field :updated_time, 'datetime'
|
@@ -53,11 +53,49 @@ module FacebookAds
|
|
53
53
|
has_no_post
|
54
54
|
has_no_delete
|
55
55
|
|
56
|
+
has_edge :comments do |edge|
|
57
|
+
edge.get 'Comment' do |api|
|
58
|
+
api.has_param :filter, { enum: -> { Comment::FILTER }}
|
59
|
+
api.has_param :live_filter, { enum: -> { Comment::LIVE_FILTER }}
|
60
|
+
api.has_param :order, { enum: -> { Comment::ORDER }}
|
61
|
+
api.has_param :since, 'datetime'
|
62
|
+
end
|
63
|
+
edge.post 'Comment' do |api|
|
64
|
+
api.has_param :attachment_id, 'string'
|
65
|
+
api.has_param :attachment_share_url, 'string'
|
66
|
+
api.has_param :attachment_url, 'string'
|
67
|
+
api.has_param :comment_privacy_value, { enum: -> { Comment::COMMENT_PRIVACY_VALUE }}
|
68
|
+
api.has_param :facepile_mentioned_ids, { list: 'string' }
|
69
|
+
api.has_param :feedback_source, 'string'
|
70
|
+
api.has_param :is_offline, 'bool'
|
71
|
+
api.has_param :message, 'string'
|
72
|
+
api.has_param :nectar_module, 'string'
|
73
|
+
api.has_param :object_id, 'string'
|
74
|
+
api.has_param :parent_comment_id, 'object'
|
75
|
+
api.has_param :text, 'string'
|
76
|
+
api.has_param :tracking, 'string'
|
77
|
+
end
|
78
|
+
end
|
79
|
+
|
80
|
+
has_edge :likes do |edge|
|
81
|
+
edge.get 'Profile'
|
82
|
+
edge.post 'Album' do |api|
|
83
|
+
api.has_param :feedback_source, 'string'
|
84
|
+
api.has_param :nectar_module, 'string'
|
85
|
+
api.has_param :notify, 'bool'
|
86
|
+
api.has_param :tracking, 'string'
|
87
|
+
end
|
88
|
+
end
|
89
|
+
|
56
90
|
has_edge :photos do |edge|
|
91
|
+
edge.get 'Photo'
|
57
92
|
edge.post 'Photo' do |api|
|
58
93
|
api.has_param :aid, 'string'
|
59
94
|
api.has_param :allow_spherical_photo, 'bool'
|
95
|
+
api.has_param :alt_text_custom, 'string'
|
96
|
+
api.has_param :android_key_hash, 'string'
|
60
97
|
api.has_param :application_id, 'string'
|
98
|
+
api.has_param :attempt, 'int'
|
61
99
|
api.has_param :audience_exp, 'bool'
|
62
100
|
api.has_param :backdated_time, 'datetime'
|
63
101
|
api.has_param :backdated_time_granularity, { enum: -> { Photo::BACKDATED_TIME_GRANULARITY }}
|
@@ -65,10 +103,12 @@ module FacebookAds
|
|
65
103
|
api.has_param :composer_session_id, 'string'
|
66
104
|
api.has_param :direct_share_status, 'int'
|
67
105
|
api.has_param :feed_targeting, 'object'
|
106
|
+
api.has_param :filter_type, 'int'
|
68
107
|
api.has_param :full_res_is_coming_later, 'bool'
|
69
108
|
api.has_param :initial_view_heading_override_degrees, 'int'
|
70
109
|
api.has_param :initial_view_pitch_override_degrees, 'int'
|
71
110
|
api.has_param :initial_view_vertical_fov_override_degrees, 'int'
|
111
|
+
api.has_param :ios_bundle_id, 'string'
|
72
112
|
api.has_param :is_explicit_location, 'bool'
|
73
113
|
api.has_param :is_explicit_place, 'bool'
|
74
114
|
api.has_param :manual_privacy, 'bool'
|
@@ -83,8 +123,9 @@ module FacebookAds
|
|
83
123
|
api.has_param :og_set_profile_badge, 'bool'
|
84
124
|
api.has_param :og_suggestion_mechanism, 'string'
|
85
125
|
api.has_param :place, 'object'
|
86
|
-
api.has_param :privacy, '
|
126
|
+
api.has_param :privacy, 'string'
|
87
127
|
api.has_param :profile_id, 'int'
|
128
|
+
api.has_param :proxied_app_id, 'string'
|
88
129
|
api.has_param :published, 'bool'
|
89
130
|
api.has_param :qn, 'string'
|
90
131
|
api.has_param :scheduled_publish_time, 'int'
|
@@ -94,7 +135,19 @@ module FacebookAds
|
|
94
135
|
api.has_param :tags, { list: 'object' }
|
95
136
|
api.has_param :target_id, 'int'
|
96
137
|
api.has_param :targeting, 'object'
|
138
|
+
api.has_param :time_since_original_post, 'int'
|
139
|
+
api.has_param :uid, 'int'
|
140
|
+
api.has_param :unpublished_content_type, { enum: -> { Photo::UNPUBLISHED_CONTENT_TYPE }}
|
97
141
|
api.has_param :url, 'string'
|
142
|
+
api.has_param :user_selected_tags, 'bool'
|
143
|
+
api.has_param :vault_image_id, 'string'
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
has_edge :picture do |edge|
|
148
|
+
edge.get 'ProfilePictureSource' do |api|
|
149
|
+
api.has_param :redirect, 'bool'
|
150
|
+
api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
|
98
151
|
end
|
99
152
|
end
|
100
153
|
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
4
|
+
# copy, modify, and distribute this software in source code or binary form for use
|
5
|
+
# in connection with the web services and APIs provided by Facebook.
|
6
|
+
#
|
7
|
+
# As with any software that integrates with the Facebook platform, your use of
|
8
|
+
# this software is subject to the Facebook Platform Policy
|
9
|
+
# [http://developers.facebook.com/policy/]. This copyright notice shall be
|
10
|
+
# included in all copies or substantial portions of the software.
|
11
|
+
#
|
12
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
14
|
+
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
15
|
+
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
16
|
+
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
17
|
+
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
18
|
+
|
19
|
+
# FB:AUTOGEN
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
# This class is auto-generated.
|
23
|
+
|
24
|
+
# For any issues or feature requests related to this class, please let us know
|
25
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
|
+
# pull request for this class.
|
27
|
+
|
28
|
+
class AppRequest < AdObject
|
29
|
+
|
30
|
+
field :action_type, 'string'
|
31
|
+
field :application, 'Application'
|
32
|
+
field :created_time, 'datetime'
|
33
|
+
field :data, 'string'
|
34
|
+
field :from, 'object'
|
35
|
+
field :id, 'string'
|
36
|
+
field :message, 'string'
|
37
|
+
field :object, 'object'
|
38
|
+
field :to, 'object'
|
39
|
+
has_no_post
|
40
|
+
|
41
|
+
end
|
42
|
+
end
|