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,53 @@
|
|
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 EventSourceGroup < AdObject
|
29
|
+
|
30
|
+
field :business, 'Business'
|
31
|
+
field :event_sources, { list: 'ExternalEventSource' }
|
32
|
+
field :id, 'string'
|
33
|
+
field :name, 'string'
|
34
|
+
has_no_delete
|
35
|
+
|
36
|
+
has_edge :shared_accounts do |edge|
|
37
|
+
edge.post 'EventSourceGroup' do |api|
|
38
|
+
api.has_param :accounts, { list: 'string' }
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
has_edge :userpermissions do |edge|
|
43
|
+
edge.delete do |api|
|
44
|
+
api.has_param :user, 'int'
|
45
|
+
end
|
46
|
+
edge.post do |api|
|
47
|
+
api.has_param :role, { enum: %w{ANALYST LIMITED_ANALYST }}
|
48
|
+
api.has_param :user, 'int'
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,70 @@
|
|
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 ExtendedCredit < AdObject
|
29
|
+
|
30
|
+
field :allocated_amount, 'object'
|
31
|
+
field :balance, 'object'
|
32
|
+
field :credit_available, 'object'
|
33
|
+
field :credit_type, 'string'
|
34
|
+
field :id, 'string'
|
35
|
+
field :last_payment_time, 'datetime'
|
36
|
+
field :legal_entity_name, 'string'
|
37
|
+
field :liable_biz_name, 'string'
|
38
|
+
field :max_balance, 'object'
|
39
|
+
field :online_max_balance, 'object'
|
40
|
+
field :owner_business, 'Business'
|
41
|
+
field :owner_business_name, 'string'
|
42
|
+
field :partition_from, 'string'
|
43
|
+
field :receiving_credit_allocation_config, 'ExtendedCreditAllocationConfig'
|
44
|
+
field :send_bill_to_biz_name, 'string'
|
45
|
+
has_no_post
|
46
|
+
has_no_delete
|
47
|
+
|
48
|
+
has_edge :extended_credit_invoice_groups do |edge|
|
49
|
+
edge.get 'ExtendedCreditInvoiceGroup'
|
50
|
+
edge.post 'ExtendedCredit' do |api|
|
51
|
+
api.has_param :email, 'string'
|
52
|
+
api.has_param :name, 'string'
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
has_edge :owning_credit_allocation_configs do |edge|
|
57
|
+
edge.get 'ExtendedCreditAllocationConfig' do |api|
|
58
|
+
api.has_param :receiving_business_id, 'string'
|
59
|
+
end
|
60
|
+
edge.post 'ExtendedCreditAllocationConfig' do |api|
|
61
|
+
api.has_param :amount, 'object'
|
62
|
+
api.has_param :liability_type, { enum: -> { ExtendedCreditAllocationConfig::LIABILITY_TYPE }}
|
63
|
+
api.has_param :partition_type, { enum: -> { ExtendedCreditAllocationConfig::PARTITION_TYPE }}
|
64
|
+
api.has_param :receiving_business_id, 'string'
|
65
|
+
api.has_param :send_bill_to, { enum: -> { ExtendedCreditAllocationConfig::SEND_BILL_TO }}
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
end
|
70
|
+
end
|
@@ -0,0 +1,61 @@
|
|
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 ExtendedCreditAllocationConfig < AdObject
|
29
|
+
LIABILITY_TYPE = [
|
30
|
+
"",
|
31
|
+
"Normal",
|
32
|
+
"Sequential",
|
33
|
+
"MSA",
|
34
|
+
]
|
35
|
+
|
36
|
+
PARTITION_TYPE = [
|
37
|
+
"FIXED",
|
38
|
+
"AUTH",
|
39
|
+
]
|
40
|
+
|
41
|
+
SEND_BILL_TO = [
|
42
|
+
"",
|
43
|
+
"Agency",
|
44
|
+
"Advertiser",
|
45
|
+
]
|
46
|
+
|
47
|
+
|
48
|
+
field :currency_amount, 'object'
|
49
|
+
field :id, 'string'
|
50
|
+
field :liability_type, 'string'
|
51
|
+
field :owning_business, 'Business'
|
52
|
+
field :owning_credential, 'ExtendedCredit'
|
53
|
+
field :partition_type, 'string'
|
54
|
+
field :receiving_business, 'Business'
|
55
|
+
field :receiving_credential, 'ExtendedCredit'
|
56
|
+
field :request_status, 'string'
|
57
|
+
field :send_bill_to, 'string'
|
58
|
+
has_no_post
|
59
|
+
|
60
|
+
end
|
61
|
+
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 ExtendedCreditInvoiceGroup < AdObject
|
29
|
+
|
30
|
+
field :email, 'object'
|
31
|
+
field :emails, { list: 'string' }
|
32
|
+
field :id, 'string'
|
33
|
+
field :name, 'string'
|
34
|
+
|
35
|
+
has_edge :ad_accounts do |edge|
|
36
|
+
edge.delete do |api|
|
37
|
+
api.has_param :ad_account_id, 'string'
|
38
|
+
end
|
39
|
+
edge.get 'AdAccount'
|
40
|
+
end
|
41
|
+
|
42
|
+
end
|
43
|
+
end
|
@@ -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 ExternalEventSource < AdObject
|
29
|
+
|
30
|
+
field :id, 'string'
|
31
|
+
field :name, 'string'
|
32
|
+
field :source_type, 'string'
|
33
|
+
field :external_event_sources, { list: 'string' }
|
34
|
+
has_no_post
|
35
|
+
has_no_delete
|
36
|
+
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,64 @@
|
|
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 FlexibleTargeting < AdObject
|
29
|
+
|
30
|
+
field :behaviors, { list: 'IdName' }
|
31
|
+
field :college_years, { list: 'int' }
|
32
|
+
field :connections, { list: 'IdName' }
|
33
|
+
field :custom_audiences, { list: 'IdName' }
|
34
|
+
field :education_majors, { list: 'IdName' }
|
35
|
+
field :education_schools, { list: 'IdName' }
|
36
|
+
field :education_statuses, { list: 'int' }
|
37
|
+
field :ethnic_affinity, { list: 'IdName' }
|
38
|
+
field :family_statuses, { list: 'IdName' }
|
39
|
+
field :friends_of_connections, { list: 'IdName' }
|
40
|
+
field :generation, { list: 'IdName' }
|
41
|
+
field :home_ownership, { list: 'IdName' }
|
42
|
+
field :home_type, { list: 'IdName' }
|
43
|
+
field :home_value, { list: 'IdName' }
|
44
|
+
field :household_composition, { list: 'IdName' }
|
45
|
+
field :income, { list: 'IdName' }
|
46
|
+
field :industries, { list: 'IdName' }
|
47
|
+
field :interested_in, { list: 'int' }
|
48
|
+
field :interests, { list: 'IdName' }
|
49
|
+
field :life_events, { list: 'IdName' }
|
50
|
+
field :moms, { list: 'IdName' }
|
51
|
+
field :net_worth, { list: 'IdName' }
|
52
|
+
field :office_type, { list: 'IdName' }
|
53
|
+
field :politics, { list: 'IdName' }
|
54
|
+
field :relationship_statuses, { list: 'int' }
|
55
|
+
field :user_adclusters, { list: 'IdName' }
|
56
|
+
field :work_employers, { list: 'IdName' }
|
57
|
+
field :work_positions, { list: 'IdName' }
|
58
|
+
has_no_id
|
59
|
+
has_no_get
|
60
|
+
has_no_post
|
61
|
+
has_no_delete
|
62
|
+
|
63
|
+
end
|
64
|
+
end
|
@@ -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 FundingSourceDetails < AdObject
|
29
|
+
|
30
|
+
field :coupon, 'FundingSourceDetailsCoupon'
|
31
|
+
field :display_string, 'string'
|
32
|
+
field :id, 'string'
|
33
|
+
field :type, 'int'
|
34
|
+
has_no_get
|
35
|
+
has_no_post
|
36
|
+
has_no_delete
|
37
|
+
|
38
|
+
end
|
39
|
+
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 FundingSourceDetailsCoupon < AdObject
|
29
|
+
|
30
|
+
field :amount, 'int'
|
31
|
+
field :currency, 'string'
|
32
|
+
field :display_amount, 'string'
|
33
|
+
field :expiration, 'datetime'
|
34
|
+
has_no_id
|
35
|
+
has_no_get
|
36
|
+
has_no_post
|
37
|
+
has_no_delete
|
38
|
+
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,170 @@
|
|
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
|
+
require 'digest'
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
module CustomAudienceHelpers
|
23
|
+
SCHEMAS = %w{
|
24
|
+
UID
|
25
|
+
EMAIL_SHA256
|
26
|
+
PHONE_SHA256
|
27
|
+
MOBILE_ADVERTISER_ID
|
28
|
+
}
|
29
|
+
|
30
|
+
MULTIKEY_SCHEMAS = %w{
|
31
|
+
EXTERN_ID
|
32
|
+
EMAIL
|
33
|
+
PHONE
|
34
|
+
GEN
|
35
|
+
DOBY
|
36
|
+
DOBM
|
37
|
+
DOBD
|
38
|
+
LN
|
39
|
+
FN
|
40
|
+
FI
|
41
|
+
CT
|
42
|
+
ST
|
43
|
+
ZIP
|
44
|
+
MADID
|
45
|
+
COUNTRY
|
46
|
+
}
|
47
|
+
|
48
|
+
SCHEMAS_WITHOUT_HASH = %w{
|
49
|
+
EXTERN_ID
|
50
|
+
MOBILE_ADVERTISER_ID
|
51
|
+
}
|
52
|
+
|
53
|
+
def add_user(data, schema, options = {})
|
54
|
+
self.users.create(prepare_params(data, schema, options))
|
55
|
+
end
|
56
|
+
|
57
|
+
def remove_user(data, schema, options = {})
|
58
|
+
self.users.destroy(prepare_params(data, schema, options))
|
59
|
+
end
|
60
|
+
|
61
|
+
def prepare_params(data,
|
62
|
+
schema,
|
63
|
+
app_ids: nil,
|
64
|
+
page_ids: nil,
|
65
|
+
pre_hashed: false,
|
66
|
+
namespace: nil,
|
67
|
+
session: nil,
|
68
|
+
data_source: nil)
|
69
|
+
|
70
|
+
unless schema.is_a?(Array) || schema.split(',').length > 1
|
71
|
+
# single key
|
72
|
+
schema = schema.upcase
|
73
|
+
unless is_valid_single_key?(schema) || is_combinational_key?(schema)
|
74
|
+
raise InvalidParameterError, "#{schema} is not a valid schema"
|
75
|
+
end
|
76
|
+
|
77
|
+
data = pre_hashed ? data : data.map { |entry| generate_hash(entry, schema)}
|
78
|
+
is_raw = !is_combinational_key?(schema)
|
79
|
+
else
|
80
|
+
# multi key
|
81
|
+
schema = schema.split(',') unless schema.is_a?(Array)
|
82
|
+
|
83
|
+
data = data.map do |row|
|
84
|
+
raise 'Schema size and data size mismatch' if row.length != schema.length
|
85
|
+
|
86
|
+
row.each_with_index.map do |val, idx|
|
87
|
+
pre_hashed ? val : generate_hash(val, schema[idx])
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
is_raw = !(schema.map { |s| is_combinational_key?(s) }.any?)
|
92
|
+
end
|
93
|
+
|
94
|
+
{
|
95
|
+
payload: {
|
96
|
+
schema: schema,
|
97
|
+
data: data,
|
98
|
+
is_raw: is_raw,
|
99
|
+
app_ids: app_ids,
|
100
|
+
page_ids: page_ids,
|
101
|
+
data_source: data_source,
|
102
|
+
}.compact,
|
103
|
+
namespace: namespace,
|
104
|
+
session: session,
|
105
|
+
}.compact
|
106
|
+
end
|
107
|
+
|
108
|
+
private
|
109
|
+
def is_valid_single_key?(schema)
|
110
|
+
SCHEMAS.include?(schema)
|
111
|
+
end
|
112
|
+
|
113
|
+
def is_raw_schema?(schemas)
|
114
|
+
(schemas - MULTIKEY_SCHEMAS).empty?
|
115
|
+
end
|
116
|
+
|
117
|
+
def generate_hash(data, schema)
|
118
|
+
SCHEMAS_WITHOUT_HASH.include?(schema) ? normalize(data, schema) : hash_sha256(normalize(data, schema))
|
119
|
+
end
|
120
|
+
|
121
|
+
def is_combinational_key?(schema)
|
122
|
+
schema_parts = schema.split('_').map(&:upcase)
|
123
|
+
return false if schema == 'EXTERN_ID' || schema_parts.count <= 1
|
124
|
+
# EXTERN_ID will be safe here since it's can be used as combination key
|
125
|
+
|
126
|
+
(schema_parts - MULTIKEY_SCHEMAS).empty?
|
127
|
+
end
|
128
|
+
|
129
|
+
def normalize(data, schema)
|
130
|
+
schema = schema.gsub(/_SHA256$/,'') # remove hash suffix
|
131
|
+
# Data normalization
|
132
|
+
# Refer to https://developers.facebook.com/docs/marketing-api/audiences-api for rules
|
133
|
+
|
134
|
+
case schema
|
135
|
+
when 'EMAIL'
|
136
|
+
data.to_s.strip.downcase
|
137
|
+
when 'PHONE'
|
138
|
+
data.to_s.gsub(/[^0-9]/,'')
|
139
|
+
when 'GEN'
|
140
|
+
# Match the first F or M character
|
141
|
+
data.to_s[/[mfMF]/] || (raise InvalidParameterError, "Invalid value: #{data} for Gender")
|
142
|
+
when 'DOBY'
|
143
|
+
data.to_s.strip.gsub(/[^0-9]/,'')
|
144
|
+
when 'DOBM','DOBD'
|
145
|
+
data.to_s.strip.gsub(/[^0-9]/,'').rjust(2,'0')
|
146
|
+
when 'LN', 'FN'
|
147
|
+
data.to_s.strip.gsub(/[^[:alpha:]]/,'').downcase # using [:alpha] here to include also Unicode
|
148
|
+
when 'FI'
|
149
|
+
data.to_s.strip[0].downcase
|
150
|
+
when 'ST', 'CT'
|
151
|
+
data.to_s.strip.downcase.gsub(/[^a-z]+/,'')
|
152
|
+
when 'ZIP'
|
153
|
+
data.to_s.split('-').first.strip.gsub(/[:blank:]+/,'').downcase
|
154
|
+
when 'MADID'
|
155
|
+
data.to_s.downcase
|
156
|
+
when 'COUNTRY'
|
157
|
+
if data.strip.length != 2
|
158
|
+
raise InvalidParameterError, "Only 2-letter country codes is accepted for COUNTRY"
|
159
|
+
end
|
160
|
+
data.strip.downcase
|
161
|
+
else # UID, EXTERN_ID, MOBILE_ADVERTISER_ID
|
162
|
+
data
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
def hash_sha256(data)
|
167
|
+
Digest::SHA256.hexdigest(data)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
end
|