facebookbusiness 0.3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE.txt +17 -0
- data/README.md +256 -0
- data/lib/facebook_ads.rb +72 -0
- data/lib/facebook_ads/ad_object.rb +177 -0
- data/lib/facebook_ads/ad_objects/ad.rb +243 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +771 -0
- data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +59 -0
- data/lib/facebook_ads/ad_objects/ad_account_contextual_targeting.rb +36 -0
- data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +217 -0
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +65 -0
- data/lib/facebook_ads/ad_objects/ad_account_roas.rb +97 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +151 -0
- data/lib/facebook_ads/ad_objects/ad_account_user.rb +40 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +125 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +98 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_asset_label.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_body.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_caption.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_description.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_group_rule.rb +43 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_image.rb +41 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_link_url.rb +42 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_title.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec_video.rb +42 -0
- data/lib/facebook_ads/ad_objects/ad_async_request.rb +67 -0
- data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +68 -0
- data/lib/facebook_ads/ad_objects/ad_async_request_set_notification_result.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +65 -0
- data/lib/facebook_ads/ad_objects/ad_campaign_frequency_control_specs.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +178 -0
- data/lib/facebook_ads/ad_objects/ad_creative_collection_thumbnail_info.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +79 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_app_link_spec.rb +40 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +87 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb +46 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb +47 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_custom_overlay_spec.rb +100 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +101 -0
- data/lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb +43 -0
- data/lib/facebook_ads/ad_objects/ad_creative_photo_data.rb +43 -0
- data/lib/facebook_ads/ad_objects/ad_creative_place_data.rb +42 -0
- data/lib/facebook_ads/ad_objects/ad_creative_post_click_configuration.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_creative_text_data.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_creative_video_data.rb +53 -0
- data/lib/facebook_ads/ad_objects/ad_image.rb +57 -0
- data/lib/facebook_ads/ad_objects/ad_keyword_stats.rb +55 -0
- data/lib/facebook_ads/ad_objects/ad_label.rb +57 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_result.rb +41 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +44 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +62 -0
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +64 -0
- data/lib/facebook_ads/ad_objects/ad_recommendation.rb +55 -0
- data/lib/facebook_ads/ad_objects/ad_recommendation_data.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +71 -0
- data/lib/facebook_ads/ad_objects/ad_rule.rb +56 -0
- data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb +44 -0
- data/lib/facebook_ads/ad_objects/ad_rule_execution_options.rb +44 -0
- data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +49 -0
- data/lib/facebook_ads/ad_objects/ad_rule_filters.rb +55 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history.rb +58 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history_result.rb +45 -0
- data/lib/facebook_ads/ad_objects/ad_rule_history_result_action.rb +40 -0
- data/lib/facebook_ads/ad_objects/ad_rule_schedule.rb +39 -0
- data/lib/facebook_ads/ad_objects/ad_rule_schedule_spec.rb +38 -0
- data/lib/facebook_ads/ad_objects/ad_rule_trigger.rb +63 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +300 -0
- data/lib/facebook_ads/ad_objects/ad_study.rb +104 -0
- data/lib/facebook_ads/ad_objects/ad_study_ads_asset_user_permissions.rb +46 -0
- data/lib/facebook_ads/ad_objects/ad_study_cell.rb +59 -0
- data/lib/facebook_ads/ad_objects/ad_study_objective.rb +58 -0
- data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +50 -0
- data/lib/facebook_ads/ad_objects/adgroup_relevance_score.rb +40 -0
- data/lib/facebook_ads/ad_objects/adgroup_review_feedback.rb +38 -0
- data/lib/facebook_ads/ad_objects/ads_action_stats.rb +55 -0
- data/lib/facebook_ads/ad_objects/ads_data_partner.rb +37 -0
- data/lib/facebook_ads/ad_objects/ads_image_crops.rb +43 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +224 -0
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +76 -0
- data/lib/facebook_ads/ad_objects/ads_pixel_stats.rb +40 -0
- data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb +51 -0
- data/lib/facebook_ads/ad_objects/agency_client_declaration.rb +48 -0
- data/lib/facebook_ads/ad_objects/album.rb +102 -0
- data/lib/facebook_ads/ad_objects/android_app_link.rb +40 -0
- data/lib/facebook_ads/ad_objects/app_links.rb +43 -0
- data/lib/facebook_ads/ad_objects/assigned_user.rb +38 -0
- data/lib/facebook_ads/ad_objects/attribution_spec.rb +38 -0
- data/lib/facebook_ads/ad_objects/audience_permission.rb +39 -0
- data/lib/facebook_ads/ad_objects/audio_copyright.rb +46 -0
- data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +46 -0
- data/lib/facebook_ads/ad_objects/business.rb +523 -0
- data/lib/facebook_ads/ad_objects/business_activity_log_event.rb +55 -0
- data/lib/facebook_ads/ad_objects/business_ad_account_request.rb +37 -0
- data/lib/facebook_ads/ad_objects/business_advertisable_applications_result.rb +38 -0
- data/lib/facebook_ads/ad_objects/business_application_request.rb +37 -0
- data/lib/facebook_ads/ad_objects/business_matched_search_applications_edge_data.rb +58 -0
- data/lib/facebook_ads/ad_objects/business_page_request.rb +37 -0
- data/lib/facebook_ads/ad_objects/business_project.rb +45 -0
- data/lib/facebook_ads/ad_objects/business_role_request.rb +61 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +52 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +233 -0
- data/lib/facebook_ads/ad_objects/canvas.rb +52 -0
- data/lib/facebook_ads/ad_objects/canvas_body_element.rb +37 -0
- data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +40 -0
- data/lib/facebook_ads/ad_objects/conversion_action_query.rb +62 -0
- data/lib/facebook_ads/ad_objects/copyright_attribution_insights.rb +41 -0
- data/lib/facebook_ads/ad_objects/cover_photo.rb +40 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +174 -0
- data/lib/facebook_ads/ad_objects/custom_audience_ad_account.rb +36 -0
- data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +104 -0
- data/lib/facebook_ads/ad_objects/custom_audience_permission.rb +41 -0
- data/lib/facebook_ads/ad_objects/custom_audience_prefill_state.rb +39 -0
- data/lib/facebook_ads/ad_objects/custom_audience_session.rb +44 -0
- data/lib/facebook_ads/ad_objects/custom_audience_status.rb +38 -0
- data/lib/facebook_ads/ad_objects/custom_audiences_tos.rb +38 -0
- data/lib/facebook_ads/ad_objects/custom_conversion.rb +109 -0
- data/lib/facebook_ads/ad_objects/custom_conversion_stats_result.rb +50 -0
- data/lib/facebook_ads/ad_objects/day_part.rb +40 -0
- data/lib/facebook_ads/ad_objects/delivery_check.rb +40 -0
- data/lib/facebook_ads/ad_objects/delivery_check_extra_info.rb +39 -0
- data/lib/facebook_ads/ad_objects/direct_deal.rb +66 -0
- data/lib/facebook_ads/ad_objects/direct_debit.rb +45 -0
- data/lib/facebook_ads/ad_objects/domain.rb +37 -0
- data/lib/facebook_ads/ad_objects/engagement.rb +43 -0
- data/lib/facebook_ads/ad_objects/ent_with_sponsor.rb +39 -0
- data/lib/facebook_ads/ad_objects/event.rb +190 -0
- data/lib/facebook_ads/ad_objects/event_source_group.rb +53 -0
- data/lib/facebook_ads/ad_objects/extended_credit.rb +70 -0
- data/lib/facebook_ads/ad_objects/extended_credit_allocation_config.rb +61 -0
- data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +43 -0
- data/lib/facebook_ads/ad_objects/external_event_source.rb +38 -0
- data/lib/facebook_ads/ad_objects/flexible_targeting.rb +64 -0
- data/lib/facebook_ads/ad_objects/funding_source_details.rb +39 -0
- data/lib/facebook_ads/ad_objects/funding_source_details_coupon.rb +40 -0
- data/lib/facebook_ads/ad_objects/helpers/custom_audience_helpers.rb +170 -0
- data/lib/facebook_ads/ad_objects/hotel_room.rb +43 -0
- data/lib/facebook_ads/ad_objects/id_name.rb +37 -0
- data/lib/facebook_ads/ad_objects/insights_result.rb +73 -0
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +67 -0
- data/lib/facebook_ads/ad_objects/instagram_insights_value.rb +38 -0
- data/lib/facebook_ads/ad_objects/instant_article.rb +47 -0
- data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +61 -0
- data/lib/facebook_ads/ad_objects/ios_app_link.rb +39 -0
- data/lib/facebook_ads/ad_objects/lead.rb +47 -0
- data/lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group.rb +37 -0
- data/lib/facebook_ads/ad_objects/lead_gen_data_draft.rb +94 -0
- data/lib/facebook_ads/ad_objects/lead_gen_draft_question.rb +44 -0
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +47 -0
- data/lib/facebook_ads/ad_objects/lead_gen_legal_content.rb +43 -0
- data/lib/facebook_ads/ad_objects/lead_gen_qualifier.rb +40 -0
- data/lib/facebook_ads/ad_objects/lead_gen_question.rb +43 -0
- data/lib/facebook_ads/ad_objects/lead_gen_question_option.rb +38 -0
- data/lib/facebook_ads/ad_objects/leadgen_form.rb +118 -0
- data/lib/facebook_ads/ad_objects/legacy_business_ad_account_request.rb +38 -0
- data/lib/facebook_ads/ad_objects/life_event.rb +54 -0
- data/lib/facebook_ads/ad_objects/live_video.rb +100 -0
- data/lib/facebook_ads/ad_objects/location.rb +49 -0
- data/lib/facebook_ads/ad_objects/lookalike_spec.rb +43 -0
- data/lib/facebook_ads/ad_objects/mailing_address.rb +42 -0
- data/lib/facebook_ads/ad_objects/measurement_report.rb +47 -0
- data/lib/facebook_ads/ad_objects/media_fingerprint.rb +47 -0
- data/lib/facebook_ads/ad_objects/messaging_feature_review.rb +38 -0
- data/lib/facebook_ads/ad_objects/messenger_profile.rb +55 -0
- data/lib/facebook_ads/ad_objects/minimum_budget.rb +41 -0
- data/lib/facebook_ads/ad_objects/native_offer.rb +113 -0
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +137 -0
- data/lib/facebook_ads/ad_objects/offline_terms_of_service.rb +37 -0
- data/lib/facebook_ads/ad_objects/offsite_pixel.rb +57 -0
- data/lib/facebook_ads/ad_objects/open_graph_context.rb +35 -0
- data/lib/facebook_ads/ad_objects/open_graph_rating.rb +43 -0
- data/lib/facebook_ads/ad_objects/oracle_transaction.rb +51 -0
- data/lib/facebook_ads/ad_objects/outcome_prediction_point.rb +40 -0
- data/lib/facebook_ads/ad_objects/owned_domain.rb +37 -0
- data/lib/facebook_ads/ad_objects/page.rb +1231 -0
- data/lib/facebook_ads/ad_objects/page_admin_note.rb +37 -0
- data/lib/facebook_ads/ad_objects/page_call_to_action.rb +104 -0
- data/lib/facebook_ads/ad_objects/page_category.rb +39 -0
- data/lib/facebook_ads/ad_objects/page_change_proposal.rb +39 -0
- data/lib/facebook_ads/ad_objects/page_insights_async_export_run.rb +43 -0
- data/lib/facebook_ads/ad_objects/page_label.rb +47 -0
- data/lib/facebook_ads/ad_objects/page_parking.rb +39 -0
- data/lib/facebook_ads/ad_objects/page_payment_options.rb +41 -0
- data/lib/facebook_ads/ad_objects/page_post.rb +159 -0
- data/lib/facebook_ads/ad_objects/page_restaurant_services.rb +46 -0
- data/lib/facebook_ads/ad_objects/page_restaurant_specialties.rb +41 -0
- data/lib/facebook_ads/ad_objects/page_saved_filter.rb +134 -0
- data/lib/facebook_ads/ad_objects/page_settings.rb +38 -0
- data/lib/facebook_ads/ad_objects/page_start_info.rb +38 -0
- data/lib/facebook_ads/ad_objects/page_upcoming_change.rb +39 -0
- data/lib/facebook_ads/ad_objects/page_videos_you_can_use.rb +38 -0
- data/lib/facebook_ads/ad_objects/partner_category.rb +51 -0
- data/lib/facebook_ads/ad_objects/partner_integration_linked.rb +42 -0
- data/lib/facebook_ads/ad_objects/persona.rb +37 -0
- data/lib/facebook_ads/ad_objects/photo.rb +102 -0
- data/lib/facebook_ads/ad_objects/place_topic.rb +49 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +335 -0
- data/lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb +50 -0
- data/lib/facebook_ads/ad_objects/product_catalog_image_settings.rb +38 -0
- data/lib/facebook_ads/ad_objects/product_catalog_image_settings_operation.rb +37 -0
- data/lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb +50 -0
- data/lib/facebook_ads/ad_objects/product_catalog_product_sets_batch.rb +40 -0
- data/lib/facebook_ads/ad_objects/product_da_event_samples_batch.rb +54 -0
- data/lib/facebook_ads/ad_objects/product_event_stat.rb +74 -0
- data/lib/facebook_ads/ad_objects/product_feed.rb +126 -0
- data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +62 -0
- data/lib/facebook_ads/ad_objects/product_feed_upload.rb +57 -0
- data/lib/facebook_ads/ad_objects/product_feed_upload_error.rb +49 -0
- data/lib/facebook_ads/ad_objects/product_group.rb +98 -0
- data/lib/facebook_ads/ad_objects/product_item.rb +155 -0
- data/lib/facebook_ads/ad_objects/product_item_commerce_insights.rb +39 -0
- data/lib/facebook_ads/ad_objects/product_set.rb +52 -0
- data/lib/facebook_ads/ad_objects/product_variant.rb +39 -0
- data/lib/facebook_ads/ad_objects/products_quality_issue.rb +42 -0
- data/lib/facebook_ads/ad_objects/profile.rb +62 -0
- data/lib/facebook_ads/ad_objects/profile_picture_source.rb +53 -0
- data/lib/facebook_ads/ad_objects/publisher_space.rb +37 -0
- data/lib/facebook_ads/ad_objects/reach_estimate.rb +39 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +101 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_spec.rb +43 -0
- data/lib/facebook_ads/ad_objects/rev_share_policy.rb +38 -0
- data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +44 -0
- data/lib/facebook_ads/ad_objects/saved_message_response.rb +49 -0
- data/lib/facebook_ads/ad_objects/screen_name.rb +39 -0
- data/lib/facebook_ads/ad_objects/shadow_ig_comment.rb +47 -0
- data/lib/facebook_ads/ad_objects/shadow_ig_media.rb +61 -0
- data/lib/facebook_ads/ad_objects/shadow_ig_user.rb +74 -0
- data/lib/facebook_ads/ad_objects/system_user.rb +48 -0
- data/lib/facebook_ads/ad_objects/tab.rb +45 -0
- data/lib/facebook_ads/ad_objects/targeting.rb +134 -0
- data/lib/facebook_ads/ad_objects/targeting_dynamic_rule.rb +44 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location.rb +47 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_city.rb +43 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_custom_location.rb +50 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_electoral_district.rb +40 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_market.rb +40 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_place.rb +45 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_political_district.rb +40 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_region.rb +39 -0
- data/lib/facebook_ads/ad_objects/targeting_geo_location_zip.rb +41 -0
- data/lib/facebook_ads/ad_objects/targeting_product_audience_spec.rb +39 -0
- data/lib/facebook_ads/ad_objects/targeting_product_audience_sub_spec.rb +38 -0
- data/lib/facebook_ads/ad_objects/targeting_sentence_line.rb +38 -0
- data/lib/facebook_ads/ad_objects/transaction.rb +51 -0
- data/lib/facebook_ads/ad_objects/transaction_currency_amount.rb +39 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +49 -0
- data/lib/facebook_ads/ad_objects/url.rb +41 -0
- data/lib/facebook_ads/ad_objects/user.rb +268 -0
- data/lib/facebook_ads/ad_objects/user_lead_gen_disclaimer_response.rb +38 -0
- data/lib/facebook_ads/ad_objects/user_lead_gen_field_data.rb +38 -0
- data/lib/facebook_ads/ad_objects/video_copyright.rb +58 -0
- data/lib/facebook_ads/ad_objects/video_copyright_rule.rb +46 -0
- data/lib/facebook_ads/ad_objects/video_list.rb +52 -0
- data/lib/facebook_ads/ad_objects/video_thumbnail.rb +42 -0
- data/lib/facebook_ads/ad_objects/voip_info.rb +43 -0
- data/lib/facebook_ads/ad_objects/web_app_link.rb +38 -0
- data/lib/facebook_ads/ad_objects/windows_app_link.rb +40 -0
- data/lib/facebook_ads/ad_objects/windows_phone_app_link.rb +39 -0
- data/lib/facebook_ads/api_request.rb +123 -0
- data/lib/facebook_ads/api_response.rb +47 -0
- data/lib/facebook_ads/batch_api/batch.rb +86 -0
- data/lib/facebook_ads/batch_api/batch_proxy.rb +67 -0
- data/lib/facebook_ads/config.rb +43 -0
- data/lib/facebook_ads/edge.rb +184 -0
- data/lib/facebook_ads/errors.rb +55 -0
- data/lib/facebook_ads/field_types.rb +65 -0
- data/lib/facebook_ads/field_types/ad_object.rb +37 -0
- data/lib/facebook_ads/field_types/base.rb +33 -0
- data/lib/facebook_ads/field_types/boolean.rb +25 -0
- data/lib/facebook_ads/field_types/datetime.rb +47 -0
- data/lib/facebook_ads/field_types/double.rb +29 -0
- data/lib/facebook_ads/field_types/enum.rb +31 -0
- data/lib/facebook_ads/field_types/integer.rb +33 -0
- data/lib/facebook_ads/field_types/list.rb +57 -0
- data/lib/facebook_ads/field_types/object.rb +45 -0
- data/lib/facebook_ads/field_types/string_type.rb +39 -0
- data/lib/facebook_ads/field_types/upload_file.rb +121 -0
- data/lib/facebook_ads/fields.rb +66 -0
- data/lib/facebook_ads/helpers/edge_helpers.rb +57 -0
- data/lib/facebook_ads/helpers/node_helpers.rb +80 -0
- data/lib/facebook_ads/helpers/shortcuts.rb +34 -0
- data/lib/facebook_ads/param_set.rb +74 -0
- data/lib/facebook_ads/ruby2patch.rb +27 -0
- data/lib/facebook_ads/session.rb +99 -0
- data/lib/facebook_ads/test.rb +23 -0
- data/lib/facebook_ads/test/base.rb +98 -0
- data/lib/facebook_ads/test/config.rb +55 -0
- data/lib/facebook_ads/test/errors.rb +23 -0
- data/lib/facebook_ads/test/exit_codes.rb +29 -0
- data/lib/facebook_ads/test/exit_hook.rb +35 -0
- data/lib/facebook_ads/test/fixtures.rb +107 -0
- data/lib/facebook_ads/utils/utils.rb +29 -0
- data/lib/facebook_ads/version.rb +24 -0
- data/lib/facebook_ads/videos/video_io.rb +25 -0
- data/lib/facebook_ads/videos/video_request.rb +42 -0
- data/lib/facebookbusiness.rb +1 -0
- metadata +508 -0
@@ -0,0 +1,151 @@
|
|
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 AdAccountTargetingUnified < AdObject
|
29
|
+
LIMIT_TYPE = [
|
30
|
+
"adgroup_id",
|
31
|
+
"genders",
|
32
|
+
"age_min",
|
33
|
+
"age_max",
|
34
|
+
"country_groups",
|
35
|
+
"countries",
|
36
|
+
"country",
|
37
|
+
"cities",
|
38
|
+
"radius",
|
39
|
+
"regions",
|
40
|
+
"zips",
|
41
|
+
"interests",
|
42
|
+
"keywords",
|
43
|
+
"education_schools",
|
44
|
+
"education_majors",
|
45
|
+
"work_positions",
|
46
|
+
"work_employers",
|
47
|
+
"relationship_statuses",
|
48
|
+
"interested_in",
|
49
|
+
"locales",
|
50
|
+
"user_adclusters",
|
51
|
+
"excluded_user_adclusters",
|
52
|
+
"conjunctive_user_adclusters",
|
53
|
+
"custom_audiences",
|
54
|
+
"excluded_custom_audiences",
|
55
|
+
"college_years",
|
56
|
+
"education_statuses",
|
57
|
+
"connections",
|
58
|
+
"excluded_connections",
|
59
|
+
"friends_of_connections",
|
60
|
+
"user_event",
|
61
|
+
"dynamic_audience_ids",
|
62
|
+
"excluded_dynamic_audience_ids",
|
63
|
+
"rtb_flag",
|
64
|
+
"site_category",
|
65
|
+
"geo_locations",
|
66
|
+
"excluded_geo_locations",
|
67
|
+
"timezones",
|
68
|
+
"place_page_set_ids",
|
69
|
+
"page_types",
|
70
|
+
"publisher_platforms",
|
71
|
+
"effective_publisher_platforms",
|
72
|
+
"facebook_positions",
|
73
|
+
"effective_facebook_positions",
|
74
|
+
"instagram_positions",
|
75
|
+
"effective_instagram_positions",
|
76
|
+
"messenger_positions",
|
77
|
+
"effective_messenger_positions",
|
78
|
+
"device_platforms",
|
79
|
+
"effective_device_platforms",
|
80
|
+
"audience_network_positions",
|
81
|
+
"effective_audience_network_positions",
|
82
|
+
"excluded_publisher_categories",
|
83
|
+
"excluded_publisher_list_ids",
|
84
|
+
"publisher_visibility_categories",
|
85
|
+
"user_device",
|
86
|
+
"mobile_device_model",
|
87
|
+
"excluded_user_device",
|
88
|
+
"excluded_mobile_device_model",
|
89
|
+
"user_os",
|
90
|
+
"wireless_carrier",
|
91
|
+
"family_statuses",
|
92
|
+
"industries",
|
93
|
+
"life_events",
|
94
|
+
"political_views",
|
95
|
+
"politics",
|
96
|
+
"behaviors",
|
97
|
+
"income",
|
98
|
+
"net_worth",
|
99
|
+
"home_type",
|
100
|
+
"home_ownership",
|
101
|
+
"home_value",
|
102
|
+
"ethnic_affinity",
|
103
|
+
"generation",
|
104
|
+
"household_composition",
|
105
|
+
"moms",
|
106
|
+
"office_type",
|
107
|
+
"targeting_optimization",
|
108
|
+
"direct_install_devices",
|
109
|
+
"engagement_specs",
|
110
|
+
"excluded_engagement_specs",
|
111
|
+
"product_audience_specs",
|
112
|
+
"excluded_product_audience_specs",
|
113
|
+
"exclusions",
|
114
|
+
"flexible_spec",
|
115
|
+
"exclude_reached_since",
|
116
|
+
"exclude_previous_days",
|
117
|
+
"app_install_state",
|
118
|
+
"fb_deal_id",
|
119
|
+
"interest_defaults_source",
|
120
|
+
"alternate_auto_targeting_option",
|
121
|
+
"contextual_targeting_categories",
|
122
|
+
"topic",
|
123
|
+
"format",
|
124
|
+
"trending",
|
125
|
+
"gatekeepers",
|
126
|
+
"follow_profiles",
|
127
|
+
"follow_profiles_negative",
|
128
|
+
"location_categories",
|
129
|
+
"user_page_threads",
|
130
|
+
"user_page_threads_excluded",
|
131
|
+
"is_whatsapp_destination_ad",
|
132
|
+
"marketplace_product_categories",
|
133
|
+
]
|
134
|
+
|
135
|
+
|
136
|
+
field :audience_size, 'int'
|
137
|
+
field :description, 'string'
|
138
|
+
field :id, 'string'
|
139
|
+
field :is_recommendation, 'bool'
|
140
|
+
field :name, 'string'
|
141
|
+
field :path, { list: 'string' }
|
142
|
+
field :recommendation_model, 'string'
|
143
|
+
field :search_interest_id, 'string'
|
144
|
+
field :type, 'string'
|
145
|
+
field :valid, 'bool'
|
146
|
+
has_no_get
|
147
|
+
has_no_post
|
148
|
+
has_no_delete
|
149
|
+
|
150
|
+
end
|
151
|
+
end
|
@@ -0,0 +1,40 @@
|
|
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 AdAccountUser < AdObject
|
29
|
+
|
30
|
+
field :id, 'string'
|
31
|
+
field :name, 'string'
|
32
|
+
field :permissions, { list: 'int' }
|
33
|
+
field :role, 'int'
|
34
|
+
field :roles, { list: 'string' }
|
35
|
+
has_no_get
|
36
|
+
has_no_post
|
37
|
+
has_no_delete
|
38
|
+
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,125 @@
|
|
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 AdActivity < AdObject
|
29
|
+
EVENT_TYPE = [
|
30
|
+
"ad_account_update_spend_limit",
|
31
|
+
"ad_account_reset_spend_limit",
|
32
|
+
"ad_account_remove_spend_limit",
|
33
|
+
"ad_account_set_business_information",
|
34
|
+
"ad_account_update_status",
|
35
|
+
"ad_account_add_user_to_role",
|
36
|
+
"ad_account_remove_user_from_role",
|
37
|
+
"add_images",
|
38
|
+
"edit_images",
|
39
|
+
"delete_images",
|
40
|
+
"ad_account_billing_charge",
|
41
|
+
"ad_account_billing_charge_failed",
|
42
|
+
"ad_account_billing_chargeback",
|
43
|
+
"ad_account_billing_chargeback_reversal",
|
44
|
+
"ad_account_billing_decline",
|
45
|
+
"ad_account_billing_refund",
|
46
|
+
"billing_event",
|
47
|
+
"add_funding_source",
|
48
|
+
"remove_funding_source",
|
49
|
+
"create_campaign_group",
|
50
|
+
"update_campaign_name",
|
51
|
+
"update_campaign_run_status",
|
52
|
+
"update_campaign_group_spend_cap",
|
53
|
+
"create_campaign_legacy",
|
54
|
+
"update_campaign_budget",
|
55
|
+
"update_campaign_duration",
|
56
|
+
"campaign_ended",
|
57
|
+
"create_ad_set",
|
58
|
+
"update_ad_set_bidding",
|
59
|
+
"update_ad_set_bid_strategy",
|
60
|
+
"update_ad_set_budget",
|
61
|
+
"update_ad_set_duration",
|
62
|
+
"update_ad_set_run_status",
|
63
|
+
"update_ad_set_name",
|
64
|
+
"update_ad_set_target_spec",
|
65
|
+
"update_ad_set_bid_adjustments",
|
66
|
+
"create_ad",
|
67
|
+
"ad_review_approved",
|
68
|
+
"ad_review_declined",
|
69
|
+
"update_ad_creative",
|
70
|
+
"edit_and_update_ad_creative",
|
71
|
+
"update_ad_bid_info",
|
72
|
+
"update_ad_bid_type",
|
73
|
+
"update_ad_run_status",
|
74
|
+
"update_ad_friendly_name",
|
75
|
+
"update_ad_targets_spec",
|
76
|
+
"update_adgroup_stop_delivery",
|
77
|
+
"first_delivery_event",
|
78
|
+
"create_audience",
|
79
|
+
"update_audience",
|
80
|
+
"delete_audience",
|
81
|
+
"share_audience",
|
82
|
+
"receive_audience",
|
83
|
+
"unshare_audience",
|
84
|
+
"remove_shared_audience",
|
85
|
+
"unknown",
|
86
|
+
"account_spending_limit_reached",
|
87
|
+
"campaign_spending_limit_reached",
|
88
|
+
"lifetime_budget_spent",
|
89
|
+
"funding_event_initiated",
|
90
|
+
"funding_event_successful",
|
91
|
+
"update_ad_labels",
|
92
|
+
]
|
93
|
+
|
94
|
+
CATEGORY = [
|
95
|
+
"ACCOUNT",
|
96
|
+
"AD",
|
97
|
+
"AD_SET",
|
98
|
+
"AUDIENCE",
|
99
|
+
"BID",
|
100
|
+
"BUDGET",
|
101
|
+
"CAMPAIGN",
|
102
|
+
"DATE",
|
103
|
+
"STATUS",
|
104
|
+
"TARGETING",
|
105
|
+
]
|
106
|
+
|
107
|
+
|
108
|
+
field :actor_id, 'string'
|
109
|
+
field :actor_name, 'string'
|
110
|
+
field :application_id, 'string'
|
111
|
+
field :application_name, 'string'
|
112
|
+
field :date_time_in_timezone, 'string'
|
113
|
+
field :event_time, 'datetime'
|
114
|
+
field :event_type, { enum: -> { EVENT_TYPE }}
|
115
|
+
field :extra_data, 'string'
|
116
|
+
field :object_id, 'string'
|
117
|
+
field :object_name, 'string'
|
118
|
+
field :translated_event_type, 'string'
|
119
|
+
has_no_id
|
120
|
+
has_no_get
|
121
|
+
has_no_post
|
122
|
+
has_no_delete
|
123
|
+
|
124
|
+
end
|
125
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
4
|
+
# copy, modify, and distribute this software in source code or binary form for use
|
5
|
+
# in connection with the web services and APIs provided by Facebook.
|
6
|
+
#
|
7
|
+
# As with any software that integrates with the Facebook platform, your use of
|
8
|
+
# this software is subject to the Facebook Platform Policy
|
9
|
+
# [http://developers.facebook.com/policy/]. This copyright notice shall be
|
10
|
+
# included in all copies or substantial portions of the software.
|
11
|
+
#
|
12
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
14
|
+
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
15
|
+
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
16
|
+
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
17
|
+
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
18
|
+
|
19
|
+
# FB:AUTOGEN
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
# This class is auto-generated.
|
23
|
+
|
24
|
+
# For any issues or feature requests related to this class, please let us know
|
25
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
|
+
# pull request for this class.
|
27
|
+
|
28
|
+
class AdAssetFeedSpec < AdObject
|
29
|
+
CALL_TO_ACTION_TYPES = [
|
30
|
+
"OPEN_LINK",
|
31
|
+
"LIKE_PAGE",
|
32
|
+
"SHOP_NOW",
|
33
|
+
"PLAY_GAME",
|
34
|
+
"INSTALL_APP",
|
35
|
+
"USE_APP",
|
36
|
+
"CALL",
|
37
|
+
"CALL_ME",
|
38
|
+
"INSTALL_MOBILE_APP",
|
39
|
+
"USE_MOBILE_APP",
|
40
|
+
"MOBILE_DOWNLOAD",
|
41
|
+
"BOOK_TRAVEL",
|
42
|
+
"LISTEN_MUSIC",
|
43
|
+
"WATCH_VIDEO",
|
44
|
+
"LEARN_MORE",
|
45
|
+
"SIGN_UP",
|
46
|
+
"DOWNLOAD",
|
47
|
+
"WATCH_MORE",
|
48
|
+
"NO_BUTTON",
|
49
|
+
"VISIT_PAGES_FEED",
|
50
|
+
"APPLY_NOW",
|
51
|
+
"BUY_NOW",
|
52
|
+
"GET_OFFER",
|
53
|
+
"GET_OFFER_VIEW",
|
54
|
+
"BUY_TICKETS",
|
55
|
+
"UPDATE_APP",
|
56
|
+
"GET_DIRECTIONS",
|
57
|
+
"BUY",
|
58
|
+
"MESSAGE_PAGE",
|
59
|
+
"DONATE",
|
60
|
+
"SUBSCRIBE",
|
61
|
+
"SAY_THANKS",
|
62
|
+
"SELL_NOW",
|
63
|
+
"SHARE",
|
64
|
+
"DONATE_NOW",
|
65
|
+
"GET_QUOTE",
|
66
|
+
"CONTACT_US",
|
67
|
+
"ORDER_NOW",
|
68
|
+
"ADD_TO_CART",
|
69
|
+
"VIDEO_ANNOTATION",
|
70
|
+
"MOMENTS",
|
71
|
+
"RECORD_NOW",
|
72
|
+
"GET_SHOWTIMES",
|
73
|
+
"LISTEN_NOW",
|
74
|
+
"EVENT_RSVP",
|
75
|
+
"WHATSAPP_MESSAGE",
|
76
|
+
]
|
77
|
+
|
78
|
+
|
79
|
+
field :ad_formats, { list: 'string' }
|
80
|
+
field :asset_customization_rules, { list: 'object' }
|
81
|
+
field :autotranslate, { list: 'string' }
|
82
|
+
field :bodies, { list: 'AdAssetFeedSpecBody' }
|
83
|
+
field :call_to_action_types, { list: { enum: -> { CALL_TO_ACTION_TYPES }} }
|
84
|
+
field :captions, { list: 'AdAssetFeedSpecCaption' }
|
85
|
+
field :descriptions, { list: 'AdAssetFeedSpecDescription' }
|
86
|
+
field :groups, { list: 'AdAssetFeedSpecGroupRule' }
|
87
|
+
field :images, { list: 'AdAssetFeedSpecImage' }
|
88
|
+
field :link_urls, { list: 'AdAssetFeedSpecLinkUrl' }
|
89
|
+
field :optimization_type, 'string'
|
90
|
+
field :titles, { list: 'AdAssetFeedSpecTitle' }
|
91
|
+
field :videos, { list: 'AdAssetFeedSpecVideo' }
|
92
|
+
has_no_id
|
93
|
+
has_no_get
|
94
|
+
has_no_post
|
95
|
+
has_no_delete
|
96
|
+
|
97
|
+
end
|
98
|
+
end
|
@@ -0,0 +1,37 @@
|
|
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 AdAssetFeedSpecAssetLabel < AdObject
|
29
|
+
|
30
|
+
field :id, 'string'
|
31
|
+
field :name, 'string'
|
32
|
+
has_no_get
|
33
|
+
has_no_post
|
34
|
+
has_no_delete
|
35
|
+
|
36
|
+
end
|
37
|
+
end
|