facebook-nodejs-business-sdk
Version:
SDK for the Facebook Marketing API in Javascript and Node.js
164 lines (160 loc) • 8.18 kB
JavaScript
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under the license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
*/
import {AbstractCrudObject} from './../abstract-crud-object';
/**
* AdAccountAdVolume
* @extends AbstractCrudObject
* @see {@link https://developers.facebook.com/docs/marketing-api/}
*/
export default class AdAccountAdVolume extends AbstractCrudObject {
static get Fields (): Object {
return Object.freeze({
actor_id: 'actor_id',
actor_name: 'actor_name',
ad_limit_scope_business: 'ad_limit_scope_business',
ad_limit_scope_business_manager_id: 'ad_limit_scope_business_manager_id',
ad_limit_set_by_page_admin: 'ad_limit_set_by_page_admin',
ads_running_or_in_review_count: 'ads_running_or_in_review_count',
ads_running_or_in_review_count_subject_to_limit_set_by_page: 'ads_running_or_in_review_count_subject_to_limit_set_by_page',
current_account_ads_running_or_in_review_count: 'current_account_ads_running_or_in_review_count',
future_limit_activation_date: 'future_limit_activation_date',
future_limit_on_ads_running_or_in_review: 'future_limit_on_ads_running_or_in_review',
limit_on_ads_running_or_in_review: 'limit_on_ads_running_or_in_review',
recommendations: 'recommendations',
});
}
static get RecommendationType (): Object {
return Object.freeze({
ab_test: 'AB_TEST',
account_spend_limit: 'ACCOUNT_SPEND_LIMIT',
aco_toggle: 'ACO_TOGGLE',
ads_reporting: 'ADS_REPORTING',
advanced_campaign_budget: 'ADVANCED_CAMPAIGN_BUDGET',
advantage_app_campaign: 'ADVANTAGE_APP_CAMPAIGN',
advantage_custom_audience: 'ADVANTAGE_CUSTOM_AUDIENCE',
advantage_custom_audience_upsell: 'ADVANTAGE_CUSTOM_AUDIENCE_UPSELL',
advantage_detailed_targeting: 'ADVANTAGE_DETAILED_TARGETING',
advantage_lookalike_audience: 'ADVANTAGE_LOOKALIKE_AUDIENCE',
advantage_plus_audience: 'ADVANTAGE_PLUS_AUDIENCE',
advantage_plus_audience_friction: 'ADVANTAGE_PLUS_AUDIENCE_FRICTION',
advantage_plus_audience_toggle: 'ADVANTAGE_PLUS_AUDIENCE_TOGGLE',
advantage_plus_creative: 'ADVANTAGE_PLUS_CREATIVE',
advantage_plus_creative_catalog: 'ADVANTAGE_PLUS_CREATIVE_CATALOG',
advantage_plus_placements_friction: 'ADVANTAGE_PLUS_PLACEMENTS_FRICTION',
advantage_shopping_campaign: 'ADVANTAGE_SHOPPING_CAMPAIGN',
advantage_shopping_campaign_fragmentation: 'ADVANTAGE_SHOPPING_CAMPAIGN_FRAGMENTATION',
ad_objective: 'AD_OBJECTIVE',
aem_v2_ineligible: 'AEM_V2_INELIGIBLE',
aggregated_bid_limited: 'AGGREGATED_BID_LIMITED',
aggregated_budget_limited: 'AGGREGATED_BUDGET_LIMITED',
aggregated_cost_limited: 'AGGREGATED_COST_LIMITED',
app_aem_v2_installation_promotion: 'APP_AEM_V2_INSTALLATION_PROMOTION',
asc_budget_optimization: 'ASC_BUDGET_OPTIMIZATION',
asc_budget_optimization_pfr: 'ASC_BUDGET_OPTIMIZATION_PFR',
asc_creation_package: 'ASC_CREATION_PACKAGE',
aspect_ratio: 'ASPECT_RATIO',
atleast_6_placements: 'ATLEAST_6_PLACEMENTS',
auction_overlap: 'AUCTION_OVERLAP',
auction_overlap_consolidation: 'AUCTION_OVERLAP_CONSOLIDATION',
audience_expansion: 'AUDIENCE_EXPANSION',
audience_expansion_retargeting: 'AUDIENCE_EXPANSION_RETARGETING',
audience_learning_limited: 'AUDIENCE_LEARNING_LIMITED',
autoflow_opt_in: 'AUTOFLOW_OPT_IN',
autoflow_opt_in_fallback_duplication_flow: 'AUTOFLOW_OPT_IN_FALLBACK_DUPLICATION_FLOW',
automatic_placements: 'AUTOMATIC_PLACEMENTS',
auto_bid: 'AUTO_BID',
blended_ads: 'BLENDED_ADS',
broad_targeting: 'BROAD_TARGETING',
capi: 'CAPI',
capi_performance_match_key: 'CAPI_PERFORMANCE_MATCH_KEY',
capi_performance_match_key_v2: 'CAPI_PERFORMANCE_MATCH_KEY_V2',
cash_rewards_opt_in: 'CASH_REWARDS_OPT_IN',
connect_facebook_page_to_instagram: 'CONNECT_FACEBOOK_PAGE_TO_INSTAGRAM',
connect_facebook_page_to_whatsapp: 'CONNECT_FACEBOOK_PAGE_TO_WHATSAPP',
conversion_lead_ads: 'CONVERSION_LEAD_ADS',
cost_goal: 'COST_GOAL',
cost_goal_budget_limited: 'COST_GOAL_BUDGET_LIMITED',
cost_goal_cpa_limited: 'COST_GOAL_CPA_LIMITED',
cost_per_result: 'COST_PER_RESULT',
creation_package_upgrade_to_asc: 'CREATION_PACKAGE_UPGRADE_TO_ASC',
creation_package_upgrade_to_tla: 'CREATION_PACKAGE_UPGRADE_TO_TLA',
creation_package_upgrade_to_tmc: 'CREATION_PACKAGE_UPGRADE_TO_TMC',
creative_badge: 'CREATIVE_BADGE',
creative_diversity: 'CREATIVE_DIVERSITY',
creative_fatigue: 'CREATIVE_FATIGUE',
creative_fatigue_hourly: 'CREATIVE_FATIGUE_HOURLY',
creative_limited: 'CREATIVE_LIMITED',
creative_limited_hourly: 'CREATIVE_LIMITED_HOURLY',
creator_ads_pa_conversion: 'CREATOR_ADS_PA_CONVERSION',
cta: 'CTA',
ctx_budget_optimization: 'CTX_BUDGET_OPTIMIZATION',
ctx_guidance: 'CTX_GUIDANCE',
da_advantage_plus_creative_info_labels: 'DA_ADVANTAGE_PLUS_CREATIVE_INFO_LABELS',
dead_link: 'DEAD_LINK',
dynamic_advantage_campaign_budget: 'DYNAMIC_ADVANTAGE_CAMPAIGN_BUDGET',
ecosystem_bid_reduce_l1_cardinality: 'ECOSYSTEM_BID_REDUCE_L1_CARDINALITY',
evc_app_duplication_upgrade: 'EVC_APP_DUPLICATION_UPGRADE',
evc_web_duplication_upgrade: 'EVC_WEB_DUPLICATION_UPGRADE',
fragmentation: 'FRAGMENTATION',
ges_test: 'GES_TEST',
guidance_center_code_gen: 'GUIDANCE_CENTER_CODE_GEN',
high_cost: 'HIGH_COST',
historical_benchmark: 'HISTORICAL_BENCHMARK',
ig_multi_ads: 'IG_MULTI_ADS',
lead_ads_guidance: 'LEAD_ADS_GUIDANCE',
learning_limited: 'LEARNING_LIMITED',
learning_pause_friction: 'LEARNING_PAUSE_FRICTION',
learning_phase_budget_edits: 'LEARNING_PHASE_BUDGET_EDITS',
low_outcome: 'LOW_OUTCOME',
merlin_guidance: 'MERLIN_GUIDANCE',
mixed_pa_combine_adsets: 'MIXED_PA_COMBINE_ADSETS',
mmt_carousel_to_video: 'MMT_CAROUSEL_TO_VIDEO',
mobile_first_video: 'MOBILE_FIRST_VIDEO',
mr_aemv2sub_kconsolidation: 'MR_AEMV2SUB_KCONSOLIDATION',
multi_text: 'MULTI_TEXT',
music: 'MUSIC',
not_applicable: 'NOT_APPLICABLE',
optimal_bau: 'OPTIMAL_BAU',
payment_method: 'PAYMENT_METHOD',
performant_creative_reels_opt_in: 'PERFORMANT_CREATIVE_REELS_OPT_IN',
pfr_l1_inline_mmt: 'PFR_L1_INLINE_MMT',
predictive_creative_limited: 'PREDICTIVE_CREATIVE_LIMITED',
predictive_creative_limited_hourly: 'PREDICTIVE_CREATIVE_LIMITED_HOURLY',
rapid_learning_limited: 'RAPID_LEARNING_LIMITED',
rapid_learning_phase: 'RAPID_LEARNING_PHASE',
reels_duplication_upsell: 'REELS_DUPLICATION_UPSELL',
revert: 'REVERT',
scale_good_campaign: 'SCALE_GOOD_CAMPAIGN',
semantic_based_audience_expansion: 'SEMANTIC_BASED_AUDIENCE_EXPANSION',
setup_pixel: 'SETUP_PIXEL',
shops_ads: 'SHOPS_ADS',
signals_growth_capi: 'SIGNALS_GROWTH_CAPI',
signals_growth_capi_table: 'SIGNALS_GROWTH_CAPI_TABLE',
signals_growth_capi_v2: 'SIGNALS_GROWTH_CAPI_V2',
six_plus_manual_placements: 'SIX_PLUS_MANUAL_PLACEMENTS',
spend_limit: 'SPEND_LIMIT',
syd_test_mode: 'SYD_TEST_MODE',
tailored_lead_ad_campaign: 'TAILORED_LEAD_AD_CAMPAIGN',
tailored_messages_campaign: 'TAILORED_MESSAGES_CAMPAIGN',
top_adsets_with_ads_under_cap: 'TOP_ADSETS_WITH_ADS_UNDER_CAP',
top_campaigns_with_ads_under_cap: 'TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP',
two_p_guidance_card_aaa: 'TWO_P_GUIDANCE_CARD_AAA',
two_p_guidance_card_auto_placement: 'TWO_P_GUIDANCE_CARD_AUTO_PLACEMENT',
two_p_guidance_card_cbo_off: 'TWO_P_GUIDANCE_CARD_CBO_OFF',
two_p_guidance_card_ctm_preflight: 'TWO_P_GUIDANCE_CARD_CTM_PREFLIGHT',
uncrop_image: 'UNCROP_IMAGE',
uneconomical_ads_throttling: 'UNECONOMICAL_ADS_THROTTLING',
unused_budget: 'UNUSED_BUDGET',
video_length: 'VIDEO_LENGTH',
zero_conversion: 'ZERO_CONVERSION',
zero_impression: 'ZERO_IMPRESSION',
});
}
}