@types/facebook-nodejs-business-sdk

import { AbstractCrudObject } from "./../abstract-crud-object"; import AbstractObject from "./../abstract-object"; import Cursor from "./../cursor"; import HighDemandPeriod from "./high-demand-period"; import AdReportRun from "./ad-report-run"; /** * AdSet * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class AdSet extends AbstractCrudObject { static get Fields(): Readonly<{ account_id: "account_id"; adlabels: "adlabels"; adset_schedule: "adset_schedule"; asset_feed_id: "asset_feed_id"; attribution_spec: "attribution_spec"; bid_adjustments: "bid_adjustments"; bid_amount: "bid_amount"; bid_constraints: "bid_constraints"; bid_info: "bid_info"; bid_strategy: "bid_strategy"; billing_event: "billing_event"; brand_safety_config: "brand_safety_config"; budget_remaining: "budget_remaining"; campaign: "campaign"; campaign_active_time: "campaign_active_time"; campaign_attribution: "campaign_attribution"; campaign_id: "campaign_id"; configured_status: "configured_status"; created_time: "created_time"; creative_sequence: "creative_sequence"; daily_budget: "daily_budget"; daily_min_spend_target: "daily_min_spend_target"; daily_spend_cap: "daily_spend_cap"; destination_type: "destination_type"; dsa_beneficiary: "dsa_beneficiary"; dsa_payor: "dsa_payor"; effective_status: "effective_status"; end_time: "end_time"; existing_customer_budget_percentage: "existing_customer_budget_percentage"; frequency_control_specs: "frequency_control_specs"; full_funnel_exploration_mode: "full_funnel_exploration_mode"; id: "id"; instagram_user_id: "instagram_user_id"; is_ba_skip_delayed_eligible: "is_ba_skip_delayed_eligible"; is_budget_schedule_enabled: "is_budget_schedule_enabled"; is_dynamic_creative: "is_dynamic_creative"; issues_info: "issues_info"; learning_stage_info: "learning_stage_info"; lifetime_budget: "lifetime_budget"; lifetime_imps: "lifetime_imps"; lifetime_min_spend_target: "lifetime_min_spend_target"; lifetime_spend_cap: "lifetime_spend_cap"; max_budget_spend_percentage: "max_budget_spend_percentage"; min_budget_spend_percentage: "min_budget_spend_percentage"; multi_optimization_goal_weight: "multi_optimization_goal_weight"; name: "name"; optimization_goal: "optimization_goal"; optimization_sub_event: "optimization_sub_event"; pacing_type: "pacing_type"; promoted_object: "promoted_object"; recommendations: "recommendations"; recurring_budget_semantics: "recurring_budget_semantics"; regional_regulated_categories: "regional_regulated_categories"; regional_regulation_identities: "regional_regulation_identities"; review_feedback: "review_feedback"; rf_prediction_id: "rf_prediction_id"; source_adset: "source_adset"; source_adset_id: "source_adset_id"; start_time: "start_time"; status: "status"; targeting: "targeting"; targeting_optimization_types: "targeting_optimization_types"; time_based_ad_rotation_id_blocks: "time_based_ad_rotation_id_blocks"; time_based_ad_rotation_intervals: "time_based_ad_rotation_intervals"; updated_time: "updated_time"; use_new_app_click: "use_new_app_click"; }>; static get BidStrategy(): Readonly<{ cost_cap: "COST_CAP"; lowest_cost_without_cap: "LOWEST_COST_WITHOUT_CAP"; lowest_cost_with_bid_cap: "LOWEST_COST_WITH_BID_CAP"; lowest_cost_with_min_roas: "LOWEST_COST_WITH_MIN_ROAS"; }>; static get BillingEvent(): Readonly<{ app_installs: "APP_INSTALLS"; clicks: "CLICKS"; impressions: "IMPRESSIONS"; link_clicks: "LINK_CLICKS"; listing_interaction: "LISTING_INTERACTION"; none: "NONE"; offer_claims: "OFFER_CLAIMS"; page_likes: "PAGE_LIKES"; post_engagement: "POST_ENGAGEMENT"; purchase: "PURCHASE"; thruplay: "THRUPLAY"; }>; static get ConfiguredStatus(): Readonly<{ active: "ACTIVE"; archived: "ARCHIVED"; deleted: "DELETED"; paused: "PAUSED"; }>; static get EffectiveStatus(): Readonly<{ active: "ACTIVE"; archived: "ARCHIVED"; campaign_paused: "CAMPAIGN_PAUSED"; deleted: "DELETED"; in_process: "IN_PROCESS"; paused: "PAUSED"; with_issues: "WITH_ISSUES"; }>; static get OptimizationGoal(): Readonly<{ advertiser_siloed_value: "ADVERTISER_SILOED_VALUE"; ad_recall_lift: "AD_RECALL_LIFT"; app_installs: "APP_INSTALLS"; app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; conversations: "CONVERSATIONS"; derived_events: "DERIVED_EVENTS"; engaged_users: "ENGAGED_USERS"; event_responses: "EVENT_RESPONSES"; impressions: "IMPRESSIONS"; in_app_value: "IN_APP_VALUE"; landing_page_views: "LANDING_PAGE_VIEWS"; lead_generation: "LEAD_GENERATION"; link_clicks: "LINK_CLICKS"; meaningful_call_attempt: "MEANINGFUL_CALL_ATTEMPT"; messaging_appointment_conversion: "MESSAGING_APPOINTMENT_CONVERSION"; messaging_purchase_conversion: "MESSAGING_PURCHASE_CONVERSION"; none: "NONE"; offsite_conversions: "OFFSITE_CONVERSIONS"; page_likes: "PAGE_LIKES"; post_engagement: "POST_ENGAGEMENT"; profile_and_page_engagement: "PROFILE_AND_PAGE_ENGAGEMENT"; profile_visit: "PROFILE_VISIT"; quality_call: "QUALITY_CALL"; quality_lead: "QUALITY_LEAD"; reach: "REACH"; reminders_set: "REMINDERS_SET"; subscribers: "SUBSCRIBERS"; thruplay: "THRUPLAY"; value: "VALUE"; visit_instagram_profile: "VISIT_INSTAGRAM_PROFILE"; }>; static get Status(): Readonly<{ active: "ACTIVE"; archived: "ARCHIVED"; deleted: "DELETED"; paused: "PAUSED"; }>; static get DatePreset(): Readonly<{ data_maximum: "DATA_MAXIMUM"; last_14d: "LAST_14D"; last_28d: "LAST_28D"; last_30d: "LAST_30D"; last_3d: "LAST_3D"; last_7d: "LAST_7D"; last_90d: "LAST_90D"; last_month: "LAST_MONTH"; last_quarter: "LAST_QUARTER"; last_week_mon_sun: "LAST_WEEK_MON_SUN"; last_week_sun_sat: "LAST_WEEK_SUN_SAT"; last_year: "LAST_YEAR"; maximum: "MAXIMUM"; this_month: "THIS_MONTH"; this_quarter: "THIS_QUARTER"; this_week_mon_today: "THIS_WEEK_MON_TODAY"; this_week_sun_today: "THIS_WEEK_SUN_TODAY"; this_year: "THIS_YEAR"; today: "TODAY"; yesterday: "YESTERDAY"; }>; static get DestinationType(): Readonly<{ app: "APP"; applinks_automatic: "APPLINKS_AUTOMATIC"; facebook: "FACEBOOK"; facebook_page: "FACEBOOK_PAGE"; instagram_direct: "INSTAGRAM_DIRECT"; instagram_profile: "INSTAGRAM_PROFILE"; instagram_profile_and_facebook_page: "INSTAGRAM_PROFILE_AND_FACEBOOK_PAGE"; messaging_instagram_direct_messenger: "MESSAGING_INSTAGRAM_DIRECT_MESSENGER"; messaging_instagram_direct_messenger_whatsapp: "MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP"; messaging_instagram_direct_whatsapp: "MESSAGING_INSTAGRAM_DIRECT_WHATSAPP"; messaging_messenger_whatsapp: "MESSAGING_MESSENGER_WHATSAPP"; messenger: "MESSENGER"; on_ad: "ON_AD"; on_event: "ON_EVENT"; on_page: "ON_PAGE"; on_post: "ON_POST"; on_video: "ON_VIDEO"; shop_automatic: "SHOP_AUTOMATIC"; website: "WEBSITE"; whatsapp: "WHATSAPP"; }>; static get ExecutionOptions(): Readonly<{ include_recommendations: "include_recommendations"; validate_only: "validate_only"; }>; static get FullFunnelExplorationMode(): Readonly<{ extended_exploration: "EXTENDED_EXPLORATION"; limited_exploration: "LIMITED_EXPLORATION"; none_exploration: "NONE_EXPLORATION"; }>; static get MultiOptimizationGoalWeight(): Readonly<{ balanced: "BALANCED"; prefer_event: "PREFER_EVENT"; prefer_install: "PREFER_INSTALL"; undefined: "UNDEFINED"; }>; static get OptimizationSubEvent(): Readonly<{ none: "NONE"; travel_intent: "TRAVEL_INTENT"; travel_intent_bucket_01: "TRAVEL_INTENT_BUCKET_01"; travel_intent_bucket_02: "TRAVEL_INTENT_BUCKET_02"; travel_intent_bucket_03: "TRAVEL_INTENT_BUCKET_03"; travel_intent_bucket_04: "TRAVEL_INTENT_BUCKET_04"; travel_intent_bucket_05: "TRAVEL_INTENT_BUCKET_05"; travel_intent_no_destination_intent: "TRAVEL_INTENT_NO_DESTINATION_INTENT"; trip_consideration: "TRIP_CONSIDERATION"; video_sound_on: "VIDEO_SOUND_ON"; }>; static get RegionalRegulatedCategories(): Readonly<{ value_0: "0"; value_1: "1"; value_2: "2"; value_3: "3"; value_4: "4"; value_5: "5"; }>; static get TuneForCategory(): Readonly<{ credit: "CREDIT"; employment: "EMPLOYMENT"; financial_products_services: "FINANCIAL_PRODUCTS_SERVICES"; housing: "HOUSING"; issues_elections_politics: "ISSUES_ELECTIONS_POLITICS"; none: "NONE"; online_gambling_and_gaming: "ONLINE_GAMBLING_AND_GAMING"; }>; static get Operator(): Readonly<{ all: "ALL"; any: "ANY"; }>; static get StatusOption(): Readonly<{ active: "ACTIVE"; inherited_from_source: "INHERITED_FROM_SOURCE"; paused: "PAUSED"; }>; getActivities(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getAdStudies(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getAdCreatives(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; deleteAdLabels(params?: Record<string, any>): Promise<any>; createAdLabel(fields: string[], params?: Record<string, any>, pathOverride?: string | null): Promise<AdSet>; getAdRulesGoverned(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getAds(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getAsyncAdRequests(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; createBudgetSchedule(fields: string[], params?: Record<string, any>, pathOverride?: string | null): Promise<HighDemandPeriod>; getCopies(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; createCopy(fields: string[], params?: Record<string, any>, pathOverride?: string | null): Promise<AdSet>; getDeliveryEstimate(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getInsights(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getInsightsAsync(fields: string[], params?: Record<string, any>, pathOverride?: string | null): Promise<AdReportRun>; getMessageDeliveryEstimate(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; getTargetingSentenceLines(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>; delete(fields: string[], params?: Record<string, any>): Promise<AbstractObject>; get(fields: string[], params?: Record<string, any>): Promise<AdSet>; update(fields: string[], params?: Record<string, any>): Promise<AdSet>; }