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,243 @@
|
|
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 Ad < AdObject
|
29
|
+
BID_TYPE = [
|
30
|
+
"CPC",
|
31
|
+
"CPM",
|
32
|
+
"MULTI_PREMIUM",
|
33
|
+
"ABSOLUTE_OCPM",
|
34
|
+
"CPA",
|
35
|
+
]
|
36
|
+
|
37
|
+
CONFIGURED_STATUS = [
|
38
|
+
"ACTIVE",
|
39
|
+
"PAUSED",
|
40
|
+
"DELETED",
|
41
|
+
"ARCHIVED",
|
42
|
+
]
|
43
|
+
|
44
|
+
EFFECTIVE_STATUS = [
|
45
|
+
"ACTIVE",
|
46
|
+
"PAUSED",
|
47
|
+
"DELETED",
|
48
|
+
"PENDING_REVIEW",
|
49
|
+
"DISAPPROVED",
|
50
|
+
"PREAPPROVED",
|
51
|
+
"PENDING_BILLING_INFO",
|
52
|
+
"CAMPAIGN_PAUSED",
|
53
|
+
"ARCHIVED",
|
54
|
+
"ADSET_PAUSED",
|
55
|
+
]
|
56
|
+
|
57
|
+
STATUS = [
|
58
|
+
"ACTIVE",
|
59
|
+
"PAUSED",
|
60
|
+
"DELETED",
|
61
|
+
"ARCHIVED",
|
62
|
+
]
|
63
|
+
|
64
|
+
DATE_PRESET = [
|
65
|
+
"today",
|
66
|
+
"yesterday",
|
67
|
+
"this_month",
|
68
|
+
"last_month",
|
69
|
+
"this_quarter",
|
70
|
+
"lifetime",
|
71
|
+
"last_3d",
|
72
|
+
"last_7d",
|
73
|
+
"last_14d",
|
74
|
+
"last_28d",
|
75
|
+
"last_30d",
|
76
|
+
"last_90d",
|
77
|
+
"last_week_mon_sun",
|
78
|
+
"last_week_sun_sat",
|
79
|
+
"last_quarter",
|
80
|
+
"last_year",
|
81
|
+
"this_week_mon_today",
|
82
|
+
"this_week_sun_today",
|
83
|
+
"this_year",
|
84
|
+
]
|
85
|
+
|
86
|
+
EXECUTION_OPTIONS = [
|
87
|
+
"validate_only",
|
88
|
+
"synchronous_ad_review",
|
89
|
+
"include_recommendations",
|
90
|
+
]
|
91
|
+
|
92
|
+
OPERATOR = [
|
93
|
+
"ALL",
|
94
|
+
"ANY",
|
95
|
+
]
|
96
|
+
|
97
|
+
STATUS_OPTION = [
|
98
|
+
"ACTIVE",
|
99
|
+
"PAUSED",
|
100
|
+
"INHERITED_FROM_SOURCE",
|
101
|
+
]
|
102
|
+
|
103
|
+
|
104
|
+
field :account_id, 'string'
|
105
|
+
field :ad_review_feedback, 'AdgroupReviewFeedback'
|
106
|
+
field :adlabels, { list: 'AdLabel' }
|
107
|
+
field :adset, 'AdSet'
|
108
|
+
field :adset_id, 'string'
|
109
|
+
field :bid_amount, 'int'
|
110
|
+
field :bid_info, 'map<string, unsigned int>'
|
111
|
+
field :bid_type, { enum: -> { BID_TYPE }}
|
112
|
+
field :campaign, 'Campaign'
|
113
|
+
field :campaign_id, 'string'
|
114
|
+
field :configured_status, { enum: -> { CONFIGURED_STATUS }}
|
115
|
+
field :conversion_specs, { list: 'ConversionActionQuery' }
|
116
|
+
field :created_time, 'datetime'
|
117
|
+
field :creative, 'AdCreative'
|
118
|
+
field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
|
119
|
+
field :id, 'string'
|
120
|
+
field :last_updated_by_app_id, 'string'
|
121
|
+
field :name, 'string'
|
122
|
+
field :recommendations, { list: 'AdRecommendation' }
|
123
|
+
field :source_ad, 'Ad'
|
124
|
+
field :source_ad_id, 'string'
|
125
|
+
field :status, { enum: -> { STATUS }}
|
126
|
+
field :tracking_specs, { list: 'ConversionActionQuery' }
|
127
|
+
field :updated_time, 'datetime'
|
128
|
+
field :adset_spec, 'AdSet'
|
129
|
+
field :date_format, 'string'
|
130
|
+
field :display_sequence, 'int'
|
131
|
+
field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
|
132
|
+
|
133
|
+
has_edge :adcreatives do |edge|
|
134
|
+
edge.get 'AdCreative'
|
135
|
+
end
|
136
|
+
|
137
|
+
has_edge :adlabels do |edge|
|
138
|
+
edge.delete do |api|
|
139
|
+
api.has_param :adlabels, { list: 'object' }
|
140
|
+
api.has_param :execution_options, { list: { enum: -> { AdLabel::EXECUTION_OPTIONS }} }
|
141
|
+
end
|
142
|
+
edge.post 'AdLabel' do |api|
|
143
|
+
api.has_param :adlabels, { list: 'object' }
|
144
|
+
api.has_param :execution_options, { list: { enum: -> { AdLabel::EXECUTION_OPTIONS }} }
|
145
|
+
end
|
146
|
+
end
|
147
|
+
|
148
|
+
has_edge :adrules_governed do |edge|
|
149
|
+
edge.get 'AdRule' do |api|
|
150
|
+
api.has_param :pass_evaluation, 'bool'
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
has_edge :copies do |edge|
|
155
|
+
edge.post 'Ad' do |api|
|
156
|
+
api.has_param :adset_id, 'string'
|
157
|
+
api.has_param :rename_options, 'object'
|
158
|
+
api.has_param :status_option, { enum: -> { Ad::STATUS_OPTION }}
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
has_edge :insights do |edge|
|
163
|
+
edge.get 'AdsInsights' do |api|
|
164
|
+
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
165
|
+
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
166
|
+
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
167
|
+
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
168
|
+
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
169
|
+
api.has_param :default_summary, 'bool'
|
170
|
+
api.has_param :export_columns, { list: 'string' }
|
171
|
+
api.has_param :export_format, 'string'
|
172
|
+
api.has_param :export_name, 'string'
|
173
|
+
api.has_param :fields, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
174
|
+
api.has_param :filtering, { list: 'object' }
|
175
|
+
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
176
|
+
api.has_param :product_id_limit, 'int'
|
177
|
+
api.has_param :sort, { list: 'string' }
|
178
|
+
api.has_param :summary, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
179
|
+
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
180
|
+
api.has_param :time_increment, 'string'
|
181
|
+
api.has_param :time_range, 'object'
|
182
|
+
api.has_param :time_ranges, { list: 'object' }
|
183
|
+
api.has_param :use_account_attribution_setting, 'bool'
|
184
|
+
end
|
185
|
+
edge.post 'AdReportRun' do |api|
|
186
|
+
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
187
|
+
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
188
|
+
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
189
|
+
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
190
|
+
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
191
|
+
api.has_param :default_summary, 'bool'
|
192
|
+
api.has_param :export_columns, { list: 'string' }
|
193
|
+
api.has_param :export_format, 'string'
|
194
|
+
api.has_param :export_name, 'string'
|
195
|
+
api.has_param :fields, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
196
|
+
api.has_param :filtering, { list: 'object' }
|
197
|
+
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
198
|
+
api.has_param :product_id_limit, 'int'
|
199
|
+
api.has_param :sort, { list: 'string' }
|
200
|
+
api.has_param :summary, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
201
|
+
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
202
|
+
api.has_param :time_increment, 'string'
|
203
|
+
api.has_param :time_range, 'object'
|
204
|
+
api.has_param :time_ranges, { list: 'object' }
|
205
|
+
api.has_param :use_account_attribution_setting, 'bool'
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
has_edge :keywordstats do |edge|
|
210
|
+
edge.get 'AdKeywordStats' do |api|
|
211
|
+
api.has_param :date, 'datetime'
|
212
|
+
end
|
213
|
+
end
|
214
|
+
|
215
|
+
has_edge :leads do |edge|
|
216
|
+
edge.get 'Lead'
|
217
|
+
edge.post do |api|
|
218
|
+
api.has_param :end_time, 'datetime'
|
219
|
+
api.has_param :session_id, 'string'
|
220
|
+
api.has_param :start_time, 'datetime'
|
221
|
+
end
|
222
|
+
end
|
223
|
+
|
224
|
+
has_edge :previews do |edge|
|
225
|
+
edge.get 'AdPreview' do |api|
|
226
|
+
api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
|
227
|
+
api.has_param :dynamic_creative_spec, 'object'
|
228
|
+
api.has_param :end_date, 'datetime'
|
229
|
+
api.has_param :height, 'int'
|
230
|
+
api.has_param :place_page_id, 'int'
|
231
|
+
api.has_param :post, 'object'
|
232
|
+
api.has_param :product_item_ids, { list: 'string' }
|
233
|
+
api.has_param :start_date, 'datetime'
|
234
|
+
api.has_param :width, 'int'
|
235
|
+
end
|
236
|
+
end
|
237
|
+
|
238
|
+
has_edge :targetingsentencelines do |edge|
|
239
|
+
edge.get 'TargetingSentenceLine'
|
240
|
+
end
|
241
|
+
|
242
|
+
end
|
243
|
+
end
|
@@ -0,0 +1,771 @@
|
|
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 AdAccount < AdObject
|
29
|
+
ROLE = [
|
30
|
+
"ADMIN",
|
31
|
+
"GENERAL_USER",
|
32
|
+
"REPORTS_ONLY",
|
33
|
+
"INSTAGRAM_ADVERTISER",
|
34
|
+
"INSTAGRAM_MANAGER",
|
35
|
+
"CREATIVE",
|
36
|
+
"FB_EMPLOYEE_DSO_ADVERTISER",
|
37
|
+
]
|
38
|
+
|
39
|
+
PERMITTED_ROLES = [
|
40
|
+
"ADMIN",
|
41
|
+
"GENERAL_USER",
|
42
|
+
"REPORTS_ONLY",
|
43
|
+
"INSTAGRAM_ADVERTISER",
|
44
|
+
"INSTAGRAM_MANAGER",
|
45
|
+
"CREATIVE",
|
46
|
+
"FB_EMPLOYEE_DSO_ADVERTISER",
|
47
|
+
]
|
48
|
+
|
49
|
+
|
50
|
+
field :account_id, 'string'
|
51
|
+
field :account_status, 'int'
|
52
|
+
field :age, 'double'
|
53
|
+
field :agency_client_declaration, 'AgencyClientDeclaration'
|
54
|
+
field :amount_spent, 'string'
|
55
|
+
field :attribution_spec, { list: 'AttributionSpec' }
|
56
|
+
field :balance, 'string'
|
57
|
+
field :business, 'Business'
|
58
|
+
field :business_city, 'string'
|
59
|
+
field :business_country_code, 'string'
|
60
|
+
field :business_name, 'string'
|
61
|
+
field :business_state, 'string'
|
62
|
+
field :business_street, 'string'
|
63
|
+
field :business_street2, 'string'
|
64
|
+
field :business_zip, 'string'
|
65
|
+
field :can_create_brand_lift_study, 'bool'
|
66
|
+
field :capabilities, { list: 'string' }
|
67
|
+
field :created_time, 'datetime'
|
68
|
+
field :currency, 'string'
|
69
|
+
field :disable_reason, 'int'
|
70
|
+
field :end_advertiser, 'string'
|
71
|
+
field :end_advertiser_name, 'string'
|
72
|
+
field :extended_credit_invoice_group, 'ExtendedCreditInvoiceGroup'
|
73
|
+
field :failed_delivery_checks, { list: 'DeliveryCheck' }
|
74
|
+
field :funding_source, 'string'
|
75
|
+
field :funding_source_details, 'FundingSourceDetails'
|
76
|
+
field :has_migrated_permissions, 'bool'
|
77
|
+
field :id, 'string'
|
78
|
+
field :io_number, 'string'
|
79
|
+
field :is_attribution_spec_system_default, 'bool'
|
80
|
+
field :is_direct_deals_enabled, 'bool'
|
81
|
+
field :is_notifications_enabled, 'bool'
|
82
|
+
field :is_personal, 'int'
|
83
|
+
field :is_prepay_account, 'bool'
|
84
|
+
field :is_tax_id_required, 'bool'
|
85
|
+
field :line_numbers, { list: 'int' }
|
86
|
+
field :media_agency, 'string'
|
87
|
+
field :min_campaign_group_spend_cap, 'string'
|
88
|
+
field :min_daily_budget, 'int'
|
89
|
+
field :name, 'string'
|
90
|
+
field :offsite_pixels_tos_accepted, 'bool'
|
91
|
+
field :owner, 'string'
|
92
|
+
field :partner, 'string'
|
93
|
+
field :rf_spec, 'ReachFrequencySpec'
|
94
|
+
field :show_checkout_experience, 'bool'
|
95
|
+
field :spend_cap, 'string'
|
96
|
+
field :tax_id, 'string'
|
97
|
+
field :tax_id_status, 'int'
|
98
|
+
field :tax_id_type, 'string'
|
99
|
+
field :timezone_id, 'int'
|
100
|
+
field :timezone_name, 'string'
|
101
|
+
field :timezone_offset_hours_utc, 'double'
|
102
|
+
field :tos_accepted, 'hash'
|
103
|
+
field :user_role, 'string'
|
104
|
+
has_no_delete
|
105
|
+
|
106
|
+
has_edge :activities do |edge|
|
107
|
+
edge.get 'AdActivity' do |api|
|
108
|
+
api.has_param :add_children, 'bool'
|
109
|
+
api.has_param :business_id, 'string'
|
110
|
+
api.has_param :category, { enum: -> { AdActivity::CATEGORY }}
|
111
|
+
api.has_param :extra_oids, { list: 'string' }
|
112
|
+
api.has_param :oid, 'string'
|
113
|
+
api.has_param :since, 'datetime'
|
114
|
+
api.has_param :uid, 'int'
|
115
|
+
api.has_param :until, 'datetime'
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
has_edge :ad_place_page_sets do |edge|
|
120
|
+
edge.get 'AdPlacePageSet'
|
121
|
+
edge.post 'AdPlacePageSet' do |api|
|
122
|
+
api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
|
123
|
+
api.has_param :name, 'string'
|
124
|
+
api.has_param :parent_page, 'string'
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
has_edge :adasset_feeds do |edge|
|
129
|
+
edge.get
|
130
|
+
end
|
131
|
+
|
132
|
+
has_edge :adcreatives do |edge|
|
133
|
+
edge.get 'AdCreative'
|
134
|
+
edge.post 'AdCreative' do |api|
|
135
|
+
api.has_param :adlabels, { list: 'object' }
|
136
|
+
api.has_param :applink_treatment, { enum: -> { AdCreative::APPLINK_TREATMENT }}
|
137
|
+
api.has_param :body, 'string'
|
138
|
+
api.has_param :branded_content_sponsor_page_id, 'string'
|
139
|
+
api.has_param :dynamic_ad_voice, { enum: -> { AdCreative::DYNAMIC_AD_VOICE }}
|
140
|
+
api.has_param :image_crops, 'hash'
|
141
|
+
api.has_param :image_file, 'string'
|
142
|
+
api.has_param :image_hash, 'string'
|
143
|
+
api.has_param :image_url, 'string'
|
144
|
+
api.has_param :instagram_actor_id, 'string'
|
145
|
+
api.has_param :instagram_permalink_url, 'string'
|
146
|
+
api.has_param :link_og_id, 'string'
|
147
|
+
api.has_param :link_url, 'string'
|
148
|
+
api.has_param :name, 'string'
|
149
|
+
api.has_param :object_id, 'int'
|
150
|
+
api.has_param :object_story_id, 'string'
|
151
|
+
api.has_param :object_story_spec, 'AdCreativeObjectStorySpec'
|
152
|
+
api.has_param :object_type, 'string'
|
153
|
+
api.has_param :platform_customizations, 'object'
|
154
|
+
api.has_param :product_set_id, 'string'
|
155
|
+
api.has_param :recommender_settings, 'hash'
|
156
|
+
api.has_param :template_url, 'string'
|
157
|
+
api.has_param :template_url_spec, 'object'
|
158
|
+
api.has_param :thumbnail_url, 'string'
|
159
|
+
api.has_param :title, 'string'
|
160
|
+
api.has_param :url_tags, 'string'
|
161
|
+
api.has_param :use_page_actor_override, 'bool'
|
162
|
+
end
|
163
|
+
end
|
164
|
+
|
165
|
+
has_edge :adcreativesbylabels do |edge|
|
166
|
+
edge.get 'AdCreative' do |api|
|
167
|
+
api.has_param :ad_label_ids, { list: 'string' }
|
168
|
+
api.has_param :operator, { enum: -> { AdCreative::OPERATOR }}
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
has_edge :adimages do |edge|
|
173
|
+
edge.delete do |api|
|
174
|
+
api.has_param :hash, 'string'
|
175
|
+
end
|
176
|
+
edge.get 'AdImage' do |api|
|
177
|
+
api.has_param :biz_tag_id, 'int'
|
178
|
+
api.has_param :business_id, 'string'
|
179
|
+
api.has_param :hashes, { list: 'string' }
|
180
|
+
api.has_param :minheight, 'int'
|
181
|
+
api.has_param :minwidth, 'int'
|
182
|
+
api.has_param :name, 'string'
|
183
|
+
end
|
184
|
+
edge.post list: 'AdImage' do |api|
|
185
|
+
api.has_param :bytes, 'object'
|
186
|
+
api.has_param :copy_from, 'object'
|
187
|
+
api.accepts_files!
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
has_edge :adlabels do |edge|
|
192
|
+
edge.get 'AdLabel'
|
193
|
+
edge.post 'AdLabel' do |api|
|
194
|
+
api.has_param :name, 'string'
|
195
|
+
end
|
196
|
+
end
|
197
|
+
|
198
|
+
has_edge :adlanguage_assets do |edge|
|
199
|
+
edge.post do |api|
|
200
|
+
api.has_param :bodies, { list: 'object' }
|
201
|
+
api.has_param :call_to_action_type, { enum: %w{OPEN_LINK LIKE_PAGE SHOP_NOW PLAY_GAME INSTALL_APP USE_APP CALL CALL_ME INSTALL_MOBILE_APP USE_MOBILE_APP MOBILE_DOWNLOAD BOOK_TRAVEL LISTEN_MUSIC WATCH_VIDEO LEARN_MORE SIGN_UP DOWNLOAD WATCH_MORE NO_BUTTON VISIT_PAGES_FEED APPLY_NOW BUY_NOW GET_OFFER GET_OFFER_VIEW BUY_TICKETS UPDATE_APP GET_DIRECTIONS BUY MESSAGE_PAGE DONATE SUBSCRIBE SAY_THANKS SELL_NOW SHARE DONATE_NOW GET_QUOTE CONTACT_US ORDER_NOW ADD_TO_CART VIDEO_ANNOTATION MOMENTS RECORD_NOW GET_SHOWTIMES LISTEN_NOW EVENT_RSVP WHATSAPP_MESSAGE }}
|
202
|
+
api.has_param :default_language, 'string'
|
203
|
+
api.has_param :descriptions, { list: 'object' }
|
204
|
+
api.has_param :image, 'object'
|
205
|
+
api.has_param :link_urls, { list: 'object' }
|
206
|
+
api.has_param :titles, { list: 'object' }
|
207
|
+
api.has_param :video, 'object'
|
208
|
+
end
|
209
|
+
end
|
210
|
+
|
211
|
+
has_edge :adreportruns do |edge|
|
212
|
+
edge.get 'AdReportRun'
|
213
|
+
end
|
214
|
+
|
215
|
+
has_edge :adreportschedules do |edge|
|
216
|
+
edge.get
|
217
|
+
end
|
218
|
+
|
219
|
+
has_edge :adrules_history do |edge|
|
220
|
+
edge.get 'AdAccountAdRulesHistory' do |api|
|
221
|
+
api.has_param :action, { enum: -> { AdAccountAdRulesHistory::ACTION }}
|
222
|
+
api.has_param :hide_no_changes, 'bool'
|
223
|
+
api.has_param :object_id, 'string'
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
has_edge :adrules_library do |edge|
|
228
|
+
edge.post 'AdRule' do |api|
|
229
|
+
api.has_param :account_id, 'string'
|
230
|
+
api.has_param :evaluation_spec, 'object'
|
231
|
+
api.has_param :execution_spec, 'object'
|
232
|
+
api.has_param :name, 'string'
|
233
|
+
api.has_param :schedule_spec, 'object'
|
234
|
+
api.has_param :status, { enum: -> { AdRule::STATUS }}
|
235
|
+
end
|
236
|
+
end
|
237
|
+
|
238
|
+
has_edge :ads do |edge|
|
239
|
+
edge.get 'Ad' do |api|
|
240
|
+
api.has_param :ad_draft_id, 'string'
|
241
|
+
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
242
|
+
api.has_param :effective_status, { list: 'string' }
|
243
|
+
api.has_param :time_range, 'object'
|
244
|
+
api.has_param :updated_since, 'int'
|
245
|
+
end
|
246
|
+
edge.post 'Ad' do |api|
|
247
|
+
api.has_param :adlabels, { list: 'object' }
|
248
|
+
api.has_param :adset_id, 'int'
|
249
|
+
api.has_param :adset_spec, 'AdSet'
|
250
|
+
api.has_param :bid_amount, 'int'
|
251
|
+
api.has_param :creative, 'AdCreative'
|
252
|
+
api.has_param :date_format, 'string'
|
253
|
+
api.has_param :display_sequence, 'int'
|
254
|
+
api.has_param :execution_options, { list: { enum: -> { Ad::EXECUTION_OPTIONS }} }
|
255
|
+
api.has_param :name, 'string'
|
256
|
+
api.has_param :status, { enum: -> { Ad::STATUS }}
|
257
|
+
api.has_param :tracking_specs, 'object'
|
258
|
+
api.accepts_files!
|
259
|
+
end
|
260
|
+
end
|
261
|
+
|
262
|
+
has_edge :adsbylabels do |edge|
|
263
|
+
edge.get 'Ad' do |api|
|
264
|
+
api.has_param :ad_label_ids, { list: 'string' }
|
265
|
+
api.has_param :operator, { enum: -> { Ad::OPERATOR }}
|
266
|
+
end
|
267
|
+
end
|
268
|
+
|
269
|
+
has_edge :adsets do |edge|
|
270
|
+
edge.get 'AdSet' do |api|
|
271
|
+
api.has_param :ad_draft_id, 'string'
|
272
|
+
api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
|
273
|
+
api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
|
274
|
+
api.has_param :is_completed, 'bool'
|
275
|
+
api.has_param :time_range, 'object'
|
276
|
+
end
|
277
|
+
edge.post 'AdSet' do |api|
|
278
|
+
api.has_param :adlabels, { list: 'object' }
|
279
|
+
api.has_param :adset_schedule, { list: 'object' }
|
280
|
+
api.has_param :attribution_spec, { list: 'hash' }
|
281
|
+
api.has_param :bid_amount, 'int'
|
282
|
+
api.has_param :bid_strategy, { enum: -> { AdSet::BID_STRATEGY }}
|
283
|
+
api.has_param :billing_event, { enum: -> { AdSet::BILLING_EVENT }}
|
284
|
+
api.has_param :campaign_id, 'string'
|
285
|
+
api.has_param :campaign_spec, 'object'
|
286
|
+
api.has_param :creative_sequence, { list: 'string' }
|
287
|
+
api.has_param :daily_budget, 'int'
|
288
|
+
api.has_param :daily_imps, 'int'
|
289
|
+
api.has_param :destination_type, { enum: -> { AdSet::DESTINATION_TYPE }}
|
290
|
+
api.has_param :end_time, 'datetime'
|
291
|
+
api.has_param :execution_options, { list: { enum: -> { AdSet::EXECUTION_OPTIONS }} }
|
292
|
+
api.has_param :frequency_control_specs, { list: 'object' }
|
293
|
+
api.has_param :lifetime_budget, 'int'
|
294
|
+
api.has_param :lifetime_imps, 'int'
|
295
|
+
api.has_param :name, 'string'
|
296
|
+
api.has_param :optimization_goal, { enum: -> { AdSet::OPTIMIZATION_GOAL }}
|
297
|
+
api.has_param :pacing_type, { list: 'string' }
|
298
|
+
api.has_param :promoted_object, 'object'
|
299
|
+
api.has_param :rf_prediction_id, 'string'
|
300
|
+
api.has_param :start_time, 'datetime'
|
301
|
+
api.has_param :status, { enum: -> { AdSet::STATUS }}
|
302
|
+
api.has_param :targeting, 'Targeting'
|
303
|
+
api.has_param :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
|
304
|
+
api.has_param :time_based_ad_rotation_intervals, { list: 'int' }
|
305
|
+
end
|
306
|
+
end
|
307
|
+
|
308
|
+
has_edge :adsetsbylabels do |edge|
|
309
|
+
edge.get 'AdSet' do |api|
|
310
|
+
api.has_param :ad_label_ids, { list: 'string' }
|
311
|
+
api.has_param :operator, { enum: -> { AdSet::OPERATOR }}
|
312
|
+
end
|
313
|
+
end
|
314
|
+
|
315
|
+
has_edge :adspixels do |edge|
|
316
|
+
edge.get 'AdsPixel'
|
317
|
+
edge.post 'AdsPixel' do |api|
|
318
|
+
api.has_param :name, 'string'
|
319
|
+
end
|
320
|
+
end
|
321
|
+
|
322
|
+
has_edge :advertisable_applications do |edge|
|
323
|
+
edge.get do |api|
|
324
|
+
api.has_param :app_id, 'string'
|
325
|
+
api.has_param :business_id, 'string'
|
326
|
+
end
|
327
|
+
end
|
328
|
+
|
329
|
+
has_edge :advideos do |edge|
|
330
|
+
edge.get do |api|
|
331
|
+
api.has_param :max_aspect_ratio, 'double'
|
332
|
+
api.has_param :maxheight, 'int'
|
333
|
+
api.has_param :maxlength, 'int'
|
334
|
+
api.has_param :maxwidth, 'int'
|
335
|
+
api.has_param :min_aspect_ratio, 'double'
|
336
|
+
api.has_param :minheight, 'int'
|
337
|
+
api.has_param :minlength, 'int'
|
338
|
+
api.has_param :minwidth, 'int'
|
339
|
+
api.has_param :title, 'string'
|
340
|
+
end
|
341
|
+
edge.post do |api|
|
342
|
+
api.has_param :composer_session_id, 'string'
|
343
|
+
api.has_param :description, 'string'
|
344
|
+
api.has_param :end_offset, 'int'
|
345
|
+
api.has_param :file_size, 'int'
|
346
|
+
api.has_param :file_url, 'string'
|
347
|
+
api.has_param :fisheye_video_cropped, 'bool'
|
348
|
+
api.has_param :front_z_rotation, 'double'
|
349
|
+
api.has_param :is_explicit_share, 'bool'
|
350
|
+
api.has_param :manual_privacy, 'bool'
|
351
|
+
api.has_param :name, 'string'
|
352
|
+
api.has_param :og_action_type_id, 'string'
|
353
|
+
api.has_param :og_icon_id, 'string'
|
354
|
+
api.has_param :og_object_id, 'string'
|
355
|
+
api.has_param :og_phrase, 'string'
|
356
|
+
api.has_param :og_suggestion_mechanism, 'string'
|
357
|
+
api.has_param :original_fov, 'int'
|
358
|
+
api.has_param :original_projection_type, { enum: %w{equirectangular cubemap equiangular_cubemap half_equirectangular }}
|
359
|
+
api.has_param :referenced_sticker_id, 'string'
|
360
|
+
api.has_param :slideshow_spec, 'hash'
|
361
|
+
api.has_param :start_offset, 'int'
|
362
|
+
api.has_param :time_since_original_post, 'int'
|
363
|
+
api.has_param :title, 'string'
|
364
|
+
api.has_param :unpublished_content_type, { enum: %w{SCHEDULED DRAFT ADS_POST INLINE_CREATED PUBLISHED }}
|
365
|
+
api.has_param :upload_phase, { enum: %w{start transfer finish cancel }}
|
366
|
+
api.has_param :upload_session_id, 'string'
|
367
|
+
api.has_param :video_file_chunk, 'string'
|
368
|
+
api.accepts_files!
|
369
|
+
end
|
370
|
+
end
|
371
|
+
|
372
|
+
has_edge :agencies do |edge|
|
373
|
+
edge.delete do |api|
|
374
|
+
api.has_param :business, 'string'
|
375
|
+
end
|
376
|
+
edge.post do |api|
|
377
|
+
api.has_param :business, 'string'
|
378
|
+
api.has_param :permitted_roles, { list: { enum: %w{ADMIN GENERAL_USER REPORTS_ONLY INSTAGRAM_ADVERTISER INSTAGRAM_MANAGER CREATIVE FB_EMPLOYEE_DSO_ADVERTISER }} }
|
379
|
+
end
|
380
|
+
end
|
381
|
+
|
382
|
+
has_edge :applications do |edge|
|
383
|
+
edge.get
|
384
|
+
end
|
385
|
+
|
386
|
+
has_edge :assigned_users do |edge|
|
387
|
+
edge.delete do |api|
|
388
|
+
api.has_param :user, 'int'
|
389
|
+
end
|
390
|
+
edge.get 'AssignedUser' do |api|
|
391
|
+
api.has_param :business, 'string'
|
392
|
+
end
|
393
|
+
edge.post 'AdAccount' do |api|
|
394
|
+
api.has_param :role, { enum: -> { AdAccount::ROLE }}
|
395
|
+
api.has_param :user, 'int'
|
396
|
+
end
|
397
|
+
end
|
398
|
+
|
399
|
+
has_edge :async_batch_requests do |edge|
|
400
|
+
edge.post 'Campaign' do |api|
|
401
|
+
api.has_param :adbatch, { list: 'object' }
|
402
|
+
api.has_param :name, 'string'
|
403
|
+
end
|
404
|
+
end
|
405
|
+
|
406
|
+
has_edge :asyncadrequestsets do |edge|
|
407
|
+
edge.get 'AdAsyncRequestSet' do |api|
|
408
|
+
api.has_param :is_completed, 'bool'
|
409
|
+
end
|
410
|
+
edge.post 'AdAsyncRequestSet' do |api|
|
411
|
+
api.has_param :ad_specs, { list: 'hash' }
|
412
|
+
api.has_param :name, 'string'
|
413
|
+
api.has_param :notification_mode, { enum: %w{OFF ON_COMPLETE }}
|
414
|
+
api.has_param :notification_uri, 'string'
|
415
|
+
end
|
416
|
+
end
|
417
|
+
|
418
|
+
has_edge :audiencereplace do |edge|
|
419
|
+
edge.post do |api|
|
420
|
+
api.has_param :payload, 'object'
|
421
|
+
api.has_param :session, 'object'
|
422
|
+
end
|
423
|
+
end
|
424
|
+
|
425
|
+
has_edge :broadtargetingcategories do |edge|
|
426
|
+
edge.get 'BroadTargetingCategories' do |api|
|
427
|
+
api.has_param :custom_categories_only, 'bool'
|
428
|
+
end
|
429
|
+
end
|
430
|
+
|
431
|
+
has_edge :campaigns do |edge|
|
432
|
+
edge.delete do |api|
|
433
|
+
api.has_param :before_date, 'datetime'
|
434
|
+
api.has_param :delete_strategy, { enum: -> { Campaign::DELETE_STRATEGY }}
|
435
|
+
api.has_param :object_count, 'int'
|
436
|
+
end
|
437
|
+
edge.get 'Campaign' do |api|
|
438
|
+
api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
|
439
|
+
api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
|
440
|
+
api.has_param :is_completed, 'bool'
|
441
|
+
end
|
442
|
+
edge.post 'Campaign' do |api|
|
443
|
+
api.has_param :adlabels, { list: 'object' }
|
444
|
+
api.has_param :budget_rebalance_flag, 'bool'
|
445
|
+
api.has_param :buying_type, 'string'
|
446
|
+
api.has_param :execution_options, { list: { enum: -> { Campaign::EXECUTION_OPTIONS }} }
|
447
|
+
api.has_param :iterative_split_test_configs, { list: 'object' }
|
448
|
+
api.has_param :name, 'string'
|
449
|
+
api.has_param :objective, { enum: -> { Campaign::OBJECTIVE }}
|
450
|
+
api.has_param :promoted_object, 'object'
|
451
|
+
api.has_param :spend_cap, 'int'
|
452
|
+
api.has_param :status, { enum: -> { Campaign::STATUS }}
|
453
|
+
end
|
454
|
+
end
|
455
|
+
|
456
|
+
has_edge :campaignsbylabels do |edge|
|
457
|
+
edge.get 'Campaign' do |api|
|
458
|
+
api.has_param :ad_label_ids, { list: 'string' }
|
459
|
+
api.has_param :operator, { enum: -> { Campaign::OPERATOR }}
|
460
|
+
end
|
461
|
+
end
|
462
|
+
|
463
|
+
has_edge :customaudiences do |edge|
|
464
|
+
edge.get 'CustomAudience' do |api|
|
465
|
+
api.has_param :business_id, 'string'
|
466
|
+
api.has_param :fields, { list: { enum: -> { CustomAudience::FIELDS }} }
|
467
|
+
api.has_param :filtering, { list: 'object' }
|
468
|
+
api.has_param :pixel_id, 'string'
|
469
|
+
end
|
470
|
+
edge.post 'CustomAudience' do |api|
|
471
|
+
api.has_param :allowed_domains, { list: 'string' }
|
472
|
+
api.has_param :claim_objective, { enum: -> { CustomAudience::CLAIM_OBJECTIVE }}
|
473
|
+
api.has_param :content_type, { enum: -> { CustomAudience::CONTENT_TYPE }}
|
474
|
+
api.has_param :dataset_id, 'string'
|
475
|
+
api.has_param :description, 'string'
|
476
|
+
api.has_param :event_source_group, 'string'
|
477
|
+
api.has_param :is_value_based, 'bool'
|
478
|
+
api.has_param :list_of_accounts, { list: 'int' }
|
479
|
+
api.has_param :lookalike_spec, 'string'
|
480
|
+
api.has_param :name, 'string'
|
481
|
+
api.has_param :opt_out_link, 'string'
|
482
|
+
api.has_param :origin_audience_id, 'string'
|
483
|
+
api.has_param :pixel_id, 'string'
|
484
|
+
api.has_param :prefill, 'bool'
|
485
|
+
api.has_param :product_set_id, 'string'
|
486
|
+
api.has_param :retention_days, 'int'
|
487
|
+
api.has_param :rule, 'string'
|
488
|
+
api.has_param :rule_aggregation, 'string'
|
489
|
+
api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
|
490
|
+
end
|
491
|
+
end
|
492
|
+
|
493
|
+
has_edge :customaudiencestos do |edge|
|
494
|
+
edge.get 'CustomAudiencesTos'
|
495
|
+
end
|
496
|
+
|
497
|
+
has_edge :customconversions do |edge|
|
498
|
+
edge.post 'CustomConversion' do |api|
|
499
|
+
api.has_param :advanced_rule, 'string'
|
500
|
+
api.has_param :custom_event_type, { enum: -> { CustomConversion::CUSTOM_EVENT_TYPE }}
|
501
|
+
api.has_param :default_conversion_value, 'double'
|
502
|
+
api.has_param :description, 'string'
|
503
|
+
api.has_param :event_source_id, 'string'
|
504
|
+
api.has_param :name, 'string'
|
505
|
+
api.has_param :rule, 'string'
|
506
|
+
end
|
507
|
+
end
|
508
|
+
|
509
|
+
has_edge :delivery_estimate do |edge|
|
510
|
+
edge.get 'AdAccountDeliveryEstimate' do |api|
|
511
|
+
api.has_param :optimization_goal, { enum: -> { AdAccountDeliveryEstimate::OPTIMIZATION_GOAL }}
|
512
|
+
api.has_param :promoted_object, 'object'
|
513
|
+
api.has_param :targeting_spec, 'Targeting'
|
514
|
+
end
|
515
|
+
end
|
516
|
+
|
517
|
+
has_edge :generatepreviews do |edge|
|
518
|
+
edge.get 'AdPreview' do |api|
|
519
|
+
api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
|
520
|
+
api.has_param :creative, 'AdCreative'
|
521
|
+
api.has_param :dynamic_creative_spec, 'object'
|
522
|
+
api.has_param :end_date, 'datetime'
|
523
|
+
api.has_param :height, 'int'
|
524
|
+
api.has_param :place_page_id, 'int'
|
525
|
+
api.has_param :post, 'object'
|
526
|
+
api.has_param :product_item_ids, { list: 'string' }
|
527
|
+
api.has_param :start_date, 'datetime'
|
528
|
+
api.has_param :width, 'int'
|
529
|
+
end
|
530
|
+
end
|
531
|
+
|
532
|
+
has_edge :insights do |edge|
|
533
|
+
edge.get 'AdsInsights' do |api|
|
534
|
+
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
535
|
+
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
536
|
+
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
537
|
+
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
538
|
+
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
539
|
+
api.has_param :default_summary, 'bool'
|
540
|
+
api.has_param :export_columns, { list: 'string' }
|
541
|
+
api.has_param :export_format, 'string'
|
542
|
+
api.has_param :export_name, 'string'
|
543
|
+
api.has_param :fields, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
544
|
+
api.has_param :filtering, { list: 'object' }
|
545
|
+
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
546
|
+
api.has_param :product_id_limit, 'int'
|
547
|
+
api.has_param :sort, { list: 'string' }
|
548
|
+
api.has_param :summary, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
549
|
+
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
550
|
+
api.has_param :time_increment, 'string'
|
551
|
+
api.has_param :time_range, 'object'
|
552
|
+
api.has_param :time_ranges, { list: 'object' }
|
553
|
+
api.has_param :use_account_attribution_setting, 'bool'
|
554
|
+
end
|
555
|
+
edge.post 'AdReportRun' do |api|
|
556
|
+
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
557
|
+
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
558
|
+
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
559
|
+
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
560
|
+
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
561
|
+
api.has_param :default_summary, 'bool'
|
562
|
+
api.has_param :export_columns, { list: 'string' }
|
563
|
+
api.has_param :export_format, 'string'
|
564
|
+
api.has_param :export_name, 'string'
|
565
|
+
api.has_param :fields, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
566
|
+
api.has_param :filtering, { list: 'object' }
|
567
|
+
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
568
|
+
api.has_param :product_id_limit, 'int'
|
569
|
+
api.has_param :sort, { list: 'string' }
|
570
|
+
api.has_param :summary, { list: { enum: -> { AdsInsights::SUMMARY }} }
|
571
|
+
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
572
|
+
api.has_param :time_increment, 'string'
|
573
|
+
api.has_param :time_range, 'object'
|
574
|
+
api.has_param :time_ranges, { list: 'object' }
|
575
|
+
api.has_param :use_account_attribution_setting, 'bool'
|
576
|
+
end
|
577
|
+
end
|
578
|
+
|
579
|
+
has_edge :instagram_accounts do |edge|
|
580
|
+
edge.get
|
581
|
+
end
|
582
|
+
|
583
|
+
has_edge :leadgen_forms do |edge|
|
584
|
+
edge.get 'LeadgenForm' do |api|
|
585
|
+
api.has_param :query, 'string'
|
586
|
+
end
|
587
|
+
end
|
588
|
+
|
589
|
+
has_edge :minimum_budgets do |edge|
|
590
|
+
edge.get 'MinimumBudget' do |api|
|
591
|
+
api.has_param :bid_amount, 'int'
|
592
|
+
end
|
593
|
+
end
|
594
|
+
|
595
|
+
has_edge :offline_conversion_data_sets do |edge|
|
596
|
+
edge.get 'OfflineConversionDataSet'
|
597
|
+
end
|
598
|
+
|
599
|
+
has_edge :offsitepixels do |edge|
|
600
|
+
edge.get 'OffsitePixel'
|
601
|
+
edge.post 'OffsitePixel' do |api|
|
602
|
+
api.has_param :name, 'string'
|
603
|
+
api.has_param :tag, { enum: -> { OffsitePixel::TAG }}
|
604
|
+
end
|
605
|
+
end
|
606
|
+
|
607
|
+
has_edge :partnercategories do |edge|
|
608
|
+
edge.get 'PartnerCategory' do |api|
|
609
|
+
api.has_param :hide_pc, 'bool'
|
610
|
+
api.has_param :is_exclusion, 'bool'
|
611
|
+
api.has_param :private_or_public, { enum: -> { PartnerCategory::PRIVATE_OR_PUBLIC }}
|
612
|
+
api.has_param :targeting_type, 'string'
|
613
|
+
end
|
614
|
+
end
|
615
|
+
|
616
|
+
has_edge :partners do |edge|
|
617
|
+
edge.get 'AdsDataPartner'
|
618
|
+
end
|
619
|
+
|
620
|
+
has_edge :pending_users do |edge|
|
621
|
+
edge.delete do |api|
|
622
|
+
api.has_param :request_id, 'int'
|
623
|
+
end
|
624
|
+
edge.post 'AdAccount' do |api|
|
625
|
+
api.has_param :request_id, 'int'
|
626
|
+
api.has_param :role, { enum: -> { AdAccount::ROLE }}
|
627
|
+
end
|
628
|
+
end
|
629
|
+
|
630
|
+
has_edge :product_audiences do |edge|
|
631
|
+
edge.post 'CustomAudience' do |api|
|
632
|
+
api.has_param :associated_audience_id, 'int'
|
633
|
+
api.has_param :creation_params, 'hash'
|
634
|
+
api.has_param :description, 'string'
|
635
|
+
api.has_param :exclusions, { list: 'object' }
|
636
|
+
api.has_param :inclusions, { list: 'object' }
|
637
|
+
api.has_param :name, 'string'
|
638
|
+
api.has_param :opt_out_link, 'string'
|
639
|
+
api.has_param :parent_audience_id, 'int'
|
640
|
+
api.has_param :product_set_id, 'string'
|
641
|
+
api.has_param :subtype, { enum: -> { CustomAudience::SUBTYPE }}
|
642
|
+
api.has_param :tags, { list: 'string' }
|
643
|
+
end
|
644
|
+
end
|
645
|
+
|
646
|
+
has_edge :publisher_block_lists do |edge|
|
647
|
+
edge.get
|
648
|
+
edge.post do |api|
|
649
|
+
api.has_param :block_list_id, 'object'
|
650
|
+
api.has_param :draft_id, 'object'
|
651
|
+
api.has_param :name, 'string'
|
652
|
+
end
|
653
|
+
end
|
654
|
+
|
655
|
+
has_edge :reachestimate do |edge|
|
656
|
+
edge.get 'ReachEstimate' do |api|
|
657
|
+
api.has_param :object_store_url, 'string'
|
658
|
+
api.has_param :targeting_spec, 'Targeting'
|
659
|
+
end
|
660
|
+
end
|
661
|
+
|
662
|
+
has_edge :reachfrequencypredictions do |edge|
|
663
|
+
edge.get 'ReachFrequencyPrediction'
|
664
|
+
edge.post 'ReachFrequencyPrediction' do |api|
|
665
|
+
api.has_param :budget, 'int'
|
666
|
+
api.has_param :campaign_group_id, 'string'
|
667
|
+
api.has_param :day_parting_schedule, { list: 'object' }
|
668
|
+
api.has_param :destination_id, 'int'
|
669
|
+
api.has_param :destination_ids, { list: 'string' }
|
670
|
+
api.has_param :end_time, 'int'
|
671
|
+
api.has_param :frequency_cap, 'int'
|
672
|
+
api.has_param :instream_packages, { list: { enum: -> { ReachFrequencyPrediction::INSTREAM_PACKAGES }} }
|
673
|
+
api.has_param :interval_frequency_cap_reset_period, 'int'
|
674
|
+
api.has_param :num_curve_points, 'int'
|
675
|
+
api.has_param :objective, 'string'
|
676
|
+
api.has_param :prediction_mode, 'int'
|
677
|
+
api.has_param :reach, 'int'
|
678
|
+
api.has_param :rf_prediction_id_to_share, 'string'
|
679
|
+
api.has_param :start_time, 'int'
|
680
|
+
api.has_param :stop_time, 'int'
|
681
|
+
api.has_param :story_event_type, 'int'
|
682
|
+
api.has_param :target_spec, 'Targeting'
|
683
|
+
end
|
684
|
+
end
|
685
|
+
|
686
|
+
has_edge :roas do |edge|
|
687
|
+
edge.get 'AdAccountRoas' do |api|
|
688
|
+
api.has_param :fields, { list: { enum: -> { AdAccountRoas::FIELDS }} }
|
689
|
+
api.has_param :filtering, { list: 'object' }
|
690
|
+
api.has_param :time_increment, 'string'
|
691
|
+
api.has_param :time_range, 'object'
|
692
|
+
end
|
693
|
+
end
|
694
|
+
|
695
|
+
has_edge :sponsored_message_ads do |edge|
|
696
|
+
edge.post do |api|
|
697
|
+
api.has_param :bid_amount, 'int'
|
698
|
+
api.has_param :daily_budget, 'int'
|
699
|
+
api.has_param :message_creative_id, 'string'
|
700
|
+
api.has_param :targeting, 'Targeting'
|
701
|
+
end
|
702
|
+
end
|
703
|
+
|
704
|
+
has_edge :targetingbrowse do |edge|
|
705
|
+
edge.get 'AdAccountTargetingUnified' do |api|
|
706
|
+
api.has_param :include_nodes, 'bool'
|
707
|
+
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
708
|
+
end
|
709
|
+
end
|
710
|
+
|
711
|
+
has_edge :targetingsearch do |edge|
|
712
|
+
edge.get 'AdAccountTargetingUnified' do |api|
|
713
|
+
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
714
|
+
api.has_param :q, 'string'
|
715
|
+
end
|
716
|
+
end
|
717
|
+
|
718
|
+
has_edge :targetingsentencelines do |edge|
|
719
|
+
edge.get 'TargetingSentenceLine' do |api|
|
720
|
+
api.has_param :discard_ages, 'bool'
|
721
|
+
api.has_param :discard_placements, 'bool'
|
722
|
+
api.has_param :targeting_spec, 'Targeting'
|
723
|
+
end
|
724
|
+
end
|
725
|
+
|
726
|
+
has_edge :targetingsuggestions do |edge|
|
727
|
+
edge.get 'AdAccountTargetingUnified' do |api|
|
728
|
+
api.has_param :limit_type, { enum: -> { AdAccountTargetingUnified::LIMIT_TYPE }}
|
729
|
+
api.has_param :targeting_list, { list: 'object' }
|
730
|
+
end
|
731
|
+
end
|
732
|
+
|
733
|
+
has_edge :targetingvalidation do |edge|
|
734
|
+
edge.get 'AdAccountTargetingUnified' do |api|
|
735
|
+
api.has_param :id_list, { list: 'int' }
|
736
|
+
api.has_param :is_exclusion, 'bool'
|
737
|
+
api.has_param :name_list, { list: 'string' }
|
738
|
+
api.has_param :targeting_list, { list: 'object' }
|
739
|
+
end
|
740
|
+
end
|
741
|
+
|
742
|
+
has_edge :tracking do |edge|
|
743
|
+
edge.delete do |api|
|
744
|
+
api.has_param :tracking_specs, 'object'
|
745
|
+
end
|
746
|
+
edge.post do |api|
|
747
|
+
api.has_param :tracking_specs, 'object'
|
748
|
+
end
|
749
|
+
end
|
750
|
+
|
751
|
+
has_edge :user_match do |edge|
|
752
|
+
edge.delete do |api|
|
753
|
+
api.has_param :bidirectional, 'bool'
|
754
|
+
api.has_param :namespace, 'string'
|
755
|
+
api.has_param :payload, 'object'
|
756
|
+
end
|
757
|
+
edge.post do |api|
|
758
|
+
api.has_param :action, 'string'
|
759
|
+
api.has_param :bidirectional, 'bool'
|
760
|
+
api.has_param :namespace, 'string'
|
761
|
+
api.has_param :payload, 'object'
|
762
|
+
api.has_param :retention, 'string'
|
763
|
+
end
|
764
|
+
end
|
765
|
+
|
766
|
+
has_edge :users do |edge|
|
767
|
+
edge.get 'AdAccountUser'
|
768
|
+
end
|
769
|
+
|
770
|
+
end
|
771
|
+
end
|