@types/facebook-nodejs-business-sdk
Version:
TypeScript definitions for facebook-nodejs-business-sdk
228 lines (227 loc) • 9.27 kB
TypeScript
import { AbstractCrudObject } from "./../abstract-crud-object";
import AbstractObject from "./../abstract-object";
import Cursor from "./../cursor";
/**
* AdCreative
* @see {@link https://developers.facebook.com/docs/marketing-api/}
*/
export default class AdCreative extends AbstractCrudObject {
static get Fields(): Readonly<{
account_id: "account_id";
actor_id: "actor_id";
ad_disclaimer_spec: "ad_disclaimer_spec";
adlabels: "adlabels";
applink_treatment: "applink_treatment";
asset_feed_spec: "asset_feed_spec";
authorization_category: "authorization_category";
auto_update: "auto_update";
body: "body";
branded_content: "branded_content";
branded_content_sponsor_page_id: "branded_content_sponsor_page_id";
bundle_folder_id: "bundle_folder_id";
call_to_action: "call_to_action";
call_to_action_type: "call_to_action_type";
categorization_criteria: "categorization_criteria";
category_media_source: "category_media_source";
collaborative_ads_lsb_image_bank_id: "collaborative_ads_lsb_image_bank_id";
contextual_multi_ads: "contextual_multi_ads";
creative_sourcing_spec: "creative_sourcing_spec";
degrees_of_freedom_spec: "degrees_of_freedom_spec";
destination_set_id: "destination_set_id";
dynamic_ad_voice: "dynamic_ad_voice";
effective_authorization_category: "effective_authorization_category";
effective_instagram_media_id: "effective_instagram_media_id";
effective_object_story_id: "effective_object_story_id";
enable_direct_install: "enable_direct_install";
enable_launch_instant_app: "enable_launch_instant_app";
facebook_branded_content: "facebook_branded_content";
id: "id";
image_crops: "image_crops";
image_hash: "image_hash";
image_url: "image_url";
instagram_branded_content: "instagram_branded_content";
instagram_permalink_url: "instagram_permalink_url";
instagram_user_id: "instagram_user_id";
interactive_components_spec: "interactive_components_spec";
link_deep_link_url: "link_deep_link_url";
link_destination_display_url: "link_destination_display_url";
link_og_id: "link_og_id";
link_url: "link_url";
messenger_sponsored_message: "messenger_sponsored_message";
name: "name";
object_id: "object_id";
object_store_url: "object_store_url";
object_story_id: "object_story_id";
object_story_spec: "object_story_spec";
object_type: "object_type";
object_url: "object_url";
omnichannel_link_spec: "omnichannel_link_spec";
page_welcome_message: "page_welcome_message";
photo_album_source_object_story_id: "photo_album_source_object_story_id";
place_page_set_id: "place_page_set_id";
platform_customizations: "platform_customizations";
playable_asset_id: "playable_asset_id";
portrait_customizations: "portrait_customizations";
product_data: "product_data";
product_set_id: "product_set_id";
recommender_settings: "recommender_settings";
regional_regulation_disclaimer_spec: "regional_regulation_disclaimer_spec";
source_instagram_media_id: "source_instagram_media_id";
status: "status";
template_url: "template_url";
template_url_spec: "template_url_spec";
thumbnail_id: "thumbnail_id";
thumbnail_url: "thumbnail_url";
title: "title";
url_tags: "url_tags";
use_page_actor_override: "use_page_actor_override";
video_id: "video_id";
}>;
static get CallToActionType(): Readonly<{
add_to_cart: "ADD_TO_CART";
apply_now: "APPLY_NOW";
ask_about_services: "ASK_ABOUT_SERVICES";
ask_for_more_info: "ASK_FOR_MORE_INFO";
audio_call: "AUDIO_CALL";
book_a_consultation: "BOOK_A_CONSULTATION";
book_now: "BOOK_NOW";
book_travel: "BOOK_TRAVEL";
buy: "BUY";
buy_now: "BUY_NOW";
buy_tickets: "BUY_TICKETS";
buy_via_message: "BUY_VIA_MESSAGE";
call: "CALL";
call_me: "CALL_ME";
call_now: "CALL_NOW";
chat_with_us: "CHAT_WITH_US";
confirm: "CONFIRM";
contact: "CONTACT";
contact_us: "CONTACT_US";
donate: "DONATE";
donate_now: "DONATE_NOW";
download: "DOWNLOAD";
event_rsvp: "EVENT_RSVP";
find_a_group: "FIND_A_GROUP";
find_your_groups: "FIND_YOUR_GROUPS";
follow_news_storyline: "FOLLOW_NEWS_STORYLINE";
follow_page: "FOLLOW_PAGE";
follow_user: "FOLLOW_USER";
get_a_quote: "GET_A_QUOTE";
get_directions: "GET_DIRECTIONS";
get_in_touch: "GET_IN_TOUCH";
get_offer: "GET_OFFER";
get_offer_view: "GET_OFFER_VIEW";
get_promotions: "GET_PROMOTIONS";
get_quote: "GET_QUOTE";
get_showtimes: "GET_SHOWTIMES";
get_started: "GET_STARTED";
inquire_now: "INQUIRE_NOW";
install_app: "INSTALL_APP";
install_mobile_app: "INSTALL_MOBILE_APP";
join_channel: "JOIN_CHANNEL";
learn_more: "LEARN_MORE";
like_page: "LIKE_PAGE";
listen_music: "LISTEN_MUSIC";
listen_now: "LISTEN_NOW";
make_an_appointment: "MAKE_AN_APPOINTMENT";
message_page: "MESSAGE_PAGE";
mobile_download: "MOBILE_DOWNLOAD";
no_button: "NO_BUTTON";
open_instant_app: "OPEN_INSTANT_APP";
open_link: "OPEN_LINK";
order_now: "ORDER_NOW";
pay_to_access: "PAY_TO_ACCESS";
play_game: "PLAY_GAME";
play_game_on_facebook: "PLAY_GAME_ON_FACEBOOK";
purchase_gift_cards: "PURCHASE_GIFT_CARDS";
raise_money: "RAISE_MONEY";
record_now: "RECORD_NOW";
refer_friends: "REFER_FRIENDS";
request_time: "REQUEST_TIME";
say_thanks: "SAY_THANKS";
see_more: "SEE_MORE";
sell_now: "SELL_NOW";
send_a_gift: "SEND_A_GIFT";
send_gift_money: "SEND_GIFT_MONEY";
send_updates: "SEND_UPDATES";
share: "SHARE";
shop_now: "SHOP_NOW";
sign_up: "SIGN_UP";
sotto_subscribe: "SOTTO_SUBSCRIBE";
start_order: "START_ORDER";
subscribe: "SUBSCRIBE";
swipe_up_product: "SWIPE_UP_PRODUCT";
swipe_up_shop: "SWIPE_UP_SHOP";
update_app: "UPDATE_APP";
use_app: "USE_APP";
use_mobile_app: "USE_MOBILE_APP";
video_annotation: "VIDEO_ANNOTATION";
video_call: "VIDEO_CALL";
view_cart: "VIEW_CART";
view_channel: "VIEW_CHANNEL";
view_product: "VIEW_PRODUCT";
visit_pages_feed: "VISIT_PAGES_FEED";
watch_live_video: "WATCH_LIVE_VIDEO";
watch_more: "WATCH_MORE";
watch_video: "WATCH_VIDEO";
whatsapp_message: "WHATSAPP_MESSAGE";
woodhenge_support: "WOODHENGE_SUPPORT";
}>;
static get ObjectType(): Readonly<{
application: "APPLICATION";
domain: "DOMAIN";
event: "EVENT";
invalid: "INVALID";
offer: "OFFER";
page: "PAGE";
photo: "PHOTO";
post_deleted: "POST_DELETED";
privacy_check_fail: "PRIVACY_CHECK_FAIL";
share: "SHARE";
status: "STATUS";
store_item: "STORE_ITEM";
video: "VIDEO";
}>;
static get Status(): Readonly<{
active: "ACTIVE";
deleted: "DELETED";
in_process: "IN_PROCESS";
with_issues: "WITH_ISSUES";
}>;
static get ApplinkTreatment(): Readonly<{
automatic: "automatic";
deeplink_with_appstore_fallback: "deeplink_with_appstore_fallback";
deeplink_with_web_fallback: "deeplink_with_web_fallback";
web_only: "web_only";
}>;
static get AuthorizationCategory(): Readonly<{
none: "NONE";
political: "POLITICAL";
political_with_digitally_created_media: "POLITICAL_WITH_DIGITALLY_CREATED_MEDIA";
}>;
static get CategorizationCriteria(): Readonly<{
brand: "brand";
category: "category";
product_type: "product_type";
}>;
static get CategoryMediaSource(): Readonly<{
category: "CATEGORY";
mixed: "MIXED";
products_collage: "PRODUCTS_COLLAGE";
products_slideshow: "PRODUCTS_SLIDESHOW";
}>;
static get DynamicAdVoice(): Readonly<{
dynamic: "DYNAMIC";
story_owner: "STORY_OWNER";
}>;
static get Operator(): Readonly<{
all: "ALL";
any: "ANY";
}>;
createAdLabel(fields: string[], params?: Record<string, any>, pathOverride?: string | null): Promise<AdCreative>;
getCreativeInsights(fields: string[], params?: Record<string, any>, fetchFirstPage?: boolean): Cursor | Promise<Cursor>;
getPreviews(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<AdCreative>;
update(fields: string[], params?: Record<string, any>): Promise<AdCreative>;
}