facebook-nodejs-business-sdk
Version:
SDK for the Facebook Ads API in Javascript and Node.js
355 lines (352 loc) • 15.8 kB
JavaScript
/**
* Copyright (c) 2017-present, Facebook, Inc.
* 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';
/**
* AdsInsights
* @extends AbstractCrudObject
* @see {@link https://developers.facebook.com/docs/marketing-api/}
*/
export default class AdsInsights extends AbstractCrudObject {
static get Fields () {
return Object.freeze({
account_currency: 'account_currency',
account_id: 'account_id',
account_name: 'account_name',
action_values: 'action_values',
actions: 'actions',
actions_per_impression: 'actions_per_impression',
actions_results: 'actions_results',
activity_recency: 'activity_recency',
ad_bid_type: 'ad_bid_type',
ad_bid_value: 'ad_bid_value',
ad_click_actions: 'ad_click_actions',
ad_delivery: 'ad_delivery',
ad_format_asset: 'ad_format_asset',
ad_id: 'ad_id',
ad_impression_actions: 'ad_impression_actions',
ad_name: 'ad_name',
adset_bid_type: 'adset_bid_type',
adset_bid_value: 'adset_bid_value',
adset_budget_type: 'adset_budget_type',
adset_budget_value: 'adset_budget_value',
adset_delivery: 'adset_delivery',
adset_end: 'adset_end',
adset_id: 'adset_id',
adset_name: 'adset_name',
adset_start: 'adset_start',
age: 'age',
age_targeting: 'age_targeting',
amount_in_catalog_currency: 'amount_in_catalog_currency',
app_store_clicks: 'app_store_clicks',
attention_events_per_impression: 'attention_events_per_impression',
attention_events_unq_per_reach: 'attention_events_unq_per_reach',
auction_bid: 'auction_bid',
auction_competitiveness: 'auction_competitiveness',
auction_max_competitor_bid: 'auction_max_competitor_bid',
body_asset: 'body_asset',
buying_type: 'buying_type',
call_to_action_asset: 'call_to_action_asset',
call_to_action_clicks: 'call_to_action_clicks',
campaign_delivery: 'campaign_delivery',
campaign_end: 'campaign_end',
campaign_id: 'campaign_id',
campaign_name: 'campaign_name',
campaign_start: 'campaign_start',
cancel_subscription_actions: 'cancel_subscription_actions',
canvas_avg_view_percent: 'canvas_avg_view_percent',
canvas_avg_view_time: 'canvas_avg_view_time',
card_views: 'card_views',
catalog_segment_actions: 'catalog_segment_actions',
catalog_segment_value_in_catalog_currency: 'catalog_segment_value_in_catalog_currency',
catalog_segment_value_mobile_purchase_roas: 'catalog_segment_value_mobile_purchase_roas',
catalog_segment_value_website_purchase_roas: 'catalog_segment_value_website_purchase_roas',
clicks: 'clicks',
conditional_time_spent_ms_over_10s_actions: 'conditional_time_spent_ms_over_10s_actions',
conditional_time_spent_ms_over_15s_actions: 'conditional_time_spent_ms_over_15s_actions',
conditional_time_spent_ms_over_2s_actions: 'conditional_time_spent_ms_over_2s_actions',
conditional_time_spent_ms_over_3s_actions: 'conditional_time_spent_ms_over_3s_actions',
conditional_time_spent_ms_over_6s_actions: 'conditional_time_spent_ms_over_6s_actions',
contact_actions: 'contact_actions',
contact_value: 'contact_value',
conversion_rate_ranking: 'conversion_rate_ranking',
conversion_values: 'conversion_values',
conversions: 'conversions',
cost_per_15_sec_video_view: 'cost_per_15_sec_video_view',
cost_per_2_sec_continuous_video_view: 'cost_per_2_sec_continuous_video_view',
cost_per_action_result: 'cost_per_action_result',
cost_per_action_type: 'cost_per_action_type',
cost_per_ad_click: 'cost_per_ad_click',
cost_per_completed_video_view: 'cost_per_completed_video_view',
cost_per_contact: 'cost_per_contact',
cost_per_conversion: 'cost_per_conversion',
cost_per_customize_product: 'cost_per_customize_product',
cost_per_dda_countby_convs: 'cost_per_dda_countby_convs',
cost_per_donate: 'cost_per_donate',
cost_per_dwell: 'cost_per_dwell',
cost_per_dwell_3_sec: 'cost_per_dwell_3_sec',
cost_per_dwell_5_sec: 'cost_per_dwell_5_sec',
cost_per_dwell_7_sec: 'cost_per_dwell_7_sec',
cost_per_estimated_ad_recallers: 'cost_per_estimated_ad_recallers',
cost_per_find_location: 'cost_per_find_location',
cost_per_inline_link_click: 'cost_per_inline_link_click',
cost_per_inline_post_engagement: 'cost_per_inline_post_engagement',
cost_per_one_thousand_ad_impression: 'cost_per_one_thousand_ad_impression',
cost_per_outbound_click: 'cost_per_outbound_click',
cost_per_schedule: 'cost_per_schedule',
cost_per_start_trial: 'cost_per_start_trial',
cost_per_submit_application: 'cost_per_submit_application',
cost_per_subscribe: 'cost_per_subscribe',
cost_per_thruplay: 'cost_per_thruplay',
cost_per_total_action: 'cost_per_total_action',
cost_per_unique_action_type: 'cost_per_unique_action_type',
cost_per_unique_click: 'cost_per_unique_click',
cost_per_unique_conversion: 'cost_per_unique_conversion',
cost_per_unique_inline_link_click: 'cost_per_unique_inline_link_click',
cost_per_unique_outbound_click: 'cost_per_unique_outbound_click',
country: 'country',
cpc: 'cpc',
cpm: 'cpm',
cpp: 'cpp',
created_time: 'created_time',
creative_fingerprint: 'creative_fingerprint',
ctr: 'ctr',
customize_product_actions: 'customize_product_actions',
customize_product_value: 'customize_product_value',
date_start: 'date_start',
date_stop: 'date_stop',
dda_countby_convs: 'dda_countby_convs',
deduping_1st_source_ratio: 'deduping_1st_source_ratio',
deduping_2nd_source_ratio: 'deduping_2nd_source_ratio',
deduping_3rd_source_ratio: 'deduping_3rd_source_ratio',
deduping_ratio: 'deduping_ratio',
deeplink_clicks: 'deeplink_clicks',
description_asset: 'description_asset',
device_platform: 'device_platform',
dma: 'dma',
donate_actions: 'donate_actions',
donate_value: 'donate_value',
dwell_3_sec: 'dwell_3_sec',
dwell_5_sec: 'dwell_5_sec',
dwell_7_sec: 'dwell_7_sec',
dwell_rate: 'dwell_rate',
earned_impression: 'earned_impression',
engagement_rate_ranking: 'engagement_rate_ranking',
estimated_ad_recall_rate: 'estimated_ad_recall_rate',
estimated_ad_recall_rate_lower_bound: 'estimated_ad_recall_rate_lower_bound',
estimated_ad_recall_rate_upper_bound: 'estimated_ad_recall_rate_upper_bound',
estimated_ad_recallers: 'estimated_ad_recallers',
estimated_ad_recallers_lower_bound: 'estimated_ad_recallers_lower_bound',
estimated_ad_recallers_upper_bound: 'estimated_ad_recallers_upper_bound',
find_location_actions: 'find_location_actions',
find_location_value: 'find_location_value',
frequency: 'frequency',
frequency_value: 'frequency_value',
full_view_impressions: 'full_view_impressions',
full_view_reach: 'full_view_reach',
gender: 'gender',
gender_targeting: 'gender_targeting',
hourly_stats_aggregated_by_advertiser_time_zone: 'hourly_stats_aggregated_by_advertiser_time_zone',
hourly_stats_aggregated_by_audience_time_zone: 'hourly_stats_aggregated_by_audience_time_zone',
image_asset: 'image_asset',
impression_device: 'impression_device',
impressions: 'impressions',
impressions_auto_refresh: 'impressions_auto_refresh',
impressions_gross: 'impressions_gross',
inline_link_click_ctr: 'inline_link_click_ctr',
inline_link_clicks: 'inline_link_clicks',
inline_post_engagement: 'inline_post_engagement',
instant_experience_clicks_to_open: 'instant_experience_clicks_to_open',
instant_experience_clicks_to_start: 'instant_experience_clicks_to_start',
instant_experience_outbound_clicks: 'instant_experience_outbound_clicks',
interactive_component_tap: 'interactive_component_tap',
labels: 'labels',
link_url_asset: 'link_url_asset',
location: 'location',
media_asset: 'media_asset',
mobile_app_purchase_roas: 'mobile_app_purchase_roas',
newsfeed_avg_position: 'newsfeed_avg_position',
newsfeed_clicks: 'newsfeed_clicks',
newsfeed_impressions: 'newsfeed_impressions',
objective: 'objective',
optimization_goal: 'optimization_goal',
outbound_clicks: 'outbound_clicks',
outbound_clicks_ctr: 'outbound_clicks_ctr',
performance_indicator: 'performance_indicator',
place_page_id: 'place_page_id',
place_page_name: 'place_page_name',
placement: 'placement',
platform_position: 'platform_position',
product_id: 'product_id',
publisher_platform: 'publisher_platform',
purchase_roas: 'purchase_roas',
quality_ranking: 'quality_ranking',
quality_score_ectr: 'quality_score_ectr',
quality_score_ecvr: 'quality_score_ecvr',
quality_score_organic: 'quality_score_organic',
reach: 'reach',
recurring_subscription_payment_actions: 'recurring_subscription_payment_actions',
region: 'region',
rule_asset: 'rule_asset',
schedule_actions: 'schedule_actions',
schedule_value: 'schedule_value',
social_spend: 'social_spend',
spend: 'spend',
start_trial_actions: 'start_trial_actions',
start_trial_value: 'start_trial_value',
submit_application_actions: 'submit_application_actions',
submit_application_value: 'submit_application_value',
subscribe_actions: 'subscribe_actions',
subscribe_value: 'subscribe_value',
thumb_stops: 'thumb_stops',
title_asset: 'title_asset',
today_spend: 'today_spend',
total_action_value: 'total_action_value',
total_actions: 'total_actions',
total_unique_actions: 'total_unique_actions',
unique_actions: 'unique_actions',
unique_clicks: 'unique_clicks',
unique_conversions: 'unique_conversions',
unique_ctr: 'unique_ctr',
unique_impressions: 'unique_impressions',
unique_inline_link_click_ctr: 'unique_inline_link_click_ctr',
unique_inline_link_clicks: 'unique_inline_link_clicks',
unique_link_clicks_ctr: 'unique_link_clicks_ctr',
unique_outbound_clicks: 'unique_outbound_clicks',
unique_outbound_clicks_ctr: 'unique_outbound_clicks_ctr',
unique_video_continuous_2_sec_watched_actions: 'unique_video_continuous_2_sec_watched_actions',
unique_video_view_15_sec: 'unique_video_view_15_sec',
updated_time: 'updated_time',
video_15_sec_watched_actions: 'video_15_sec_watched_actions',
video_30_sec_watched_actions: 'video_30_sec_watched_actions',
video_asset: 'video_asset',
video_avg_time_watched_actions: 'video_avg_time_watched_actions',
video_complete_watched_actions: 'video_complete_watched_actions',
video_completed_view_or_15s_passed_actions: 'video_completed_view_or_15s_passed_actions',
video_continuous_2_sec_watched_actions: 'video_continuous_2_sec_watched_actions',
video_p100_watched_actions: 'video_p100_watched_actions',
video_p25_watched_actions: 'video_p25_watched_actions',
video_p50_watched_actions: 'video_p50_watched_actions',
video_p75_watched_actions: 'video_p75_watched_actions',
video_p95_watched_actions: 'video_p95_watched_actions',
video_play_actions: 'video_play_actions',
video_play_curve_actions: 'video_play_curve_actions',
video_play_retention_0_to_15s_actions: 'video_play_retention_0_to_15s_actions',
video_play_retention_20_to_60s_actions: 'video_play_retention_20_to_60s_actions',
video_play_retention_graph_actions: 'video_play_retention_graph_actions',
video_thruplay_watched_actions: 'video_thruplay_watched_actions',
video_time_watched_actions: 'video_time_watched_actions',
website_clicks: 'website_clicks',
website_ctr: 'website_ctr',
website_purchase_roas: 'website_purchase_roas',
wish_bid: 'wish_bid',
});
}
static get ActionAttributionWindows (): Object {
return Object.freeze({
value_1d_click: '1d_click',
value_1d_view: '1d_view',
value_28d_click: '28d_click',
value_28d_view: '28d_view',
value_7d_click: '7d_click',
value_7d_view: '7d_view',
default: 'default',
});
}
static get ActionBreakdowns (): Object {
return Object.freeze({
action_canvas_component_name: 'action_canvas_component_name',
action_carousel_card_id: 'action_carousel_card_id',
action_carousel_card_name: 'action_carousel_card_name',
action_destination: 'action_destination',
action_device: 'action_device',
action_reaction: 'action_reaction',
action_target_id: 'action_target_id',
action_type: 'action_type',
action_video_sound: 'action_video_sound',
action_video_type: 'action_video_type',
});
}
static get ActionReportTime (): Object {
return Object.freeze({
conversion: 'conversion',
impression: 'impression',
});
}
static get Breakdowns (): Object {
return Object.freeze({
ad_format_asset: 'ad_format_asset',
age: 'age',
body_asset: 'body_asset',
call_to_action_asset: 'call_to_action_asset',
country: 'country',
description_asset: 'description_asset',
device_platform: 'device_platform',
dma: 'dma',
frequency_value: 'frequency_value',
gender: 'gender',
hourly_stats_aggregated_by_advertiser_time_zone: 'hourly_stats_aggregated_by_advertiser_time_zone',
hourly_stats_aggregated_by_audience_time_zone: 'hourly_stats_aggregated_by_audience_time_zone',
image_asset: 'image_asset',
impression_device: 'impression_device',
link_url_asset: 'link_url_asset',
place_page_id: 'place_page_id',
platform_position: 'platform_position',
product_id: 'product_id',
publisher_platform: 'publisher_platform',
region: 'region',
title_asset: 'title_asset',
video_asset: 'video_asset',
});
}
static get DatePreset (): Object {
return Object.freeze({
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',
lifetime: 'lifetime',
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 Level (): Object {
return Object.freeze({
account: 'account',
ad: 'ad',
adset: 'adset',
campaign: 'campaign',
});
}
static get SummaryActionBreakdowns (): Object {
return Object.freeze({
action_canvas_component_name: 'action_canvas_component_name',
action_carousel_card_id: 'action_carousel_card_id',
action_carousel_card_name: 'action_carousel_card_name',
action_destination: 'action_destination',
action_device: 'action_device',
action_reaction: 'action_reaction',
action_target_id: 'action_target_id',
action_type: 'action_type',
action_video_sound: 'action_video_sound',
action_video_type: 'action_video_type',
});
}
}