@tapline/client 0.2.13 → 0.2.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -2
- package/dist/cjs/client.d.ts +8 -0
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +32 -20
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/index.d.ts +8 -0
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +33 -21
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/airbnb/client.d.ts +6 -6
- package/dist/cjs/services/airbnb/client.d.ts.map +1 -1
- package/dist/cjs/services/airbnb/client.js +6 -6
- package/dist/cjs/services/airbnb/client.js.map +1 -1
- package/dist/cjs/services/birdeye/client.d.ts +10 -10
- package/dist/cjs/services/birdeye/client.d.ts.map +1 -1
- package/dist/cjs/services/birdeye/client.js +10 -10
- package/dist/cjs/services/birdeye/client.js.map +1 -1
- package/dist/cjs/services/brave_search/client.d.ts +1 -1
- package/dist/cjs/services/brave_search/client.d.ts.map +1 -1
- package/dist/cjs/services/brave_search/client.js +1 -1
- package/dist/cjs/services/brave_search/client.js.map +1 -1
- package/dist/cjs/services/brave_search/types.d.ts +1211 -1273
- package/dist/cjs/services/brave_search/types.d.ts.map +1 -1
- package/dist/cjs/services/facebook/client.d.ts +65 -0
- package/dist/cjs/services/facebook/client.d.ts.map +1 -0
- package/dist/cjs/services/facebook/client.js +151 -0
- package/dist/cjs/services/facebook/client.js.map +1 -0
- package/dist/cjs/services/facebook/index.d.ts +3 -0
- package/dist/cjs/services/facebook/index.d.ts.map +1 -0
- package/dist/cjs/services/facebook/index.js +22 -0
- package/dist/cjs/services/facebook/index.js.map +1 -0
- package/dist/cjs/services/facebook/types.d.ts +1021 -0
- package/dist/cjs/services/facebook/types.d.ts.map +1 -0
- package/dist/cjs/services/facebook/types.js +4 -0
- package/dist/cjs/services/facebook/types.js.map +1 -0
- package/dist/cjs/services/facebook_ad_library/client.d.ts +25 -0
- package/dist/cjs/services/facebook_ad_library/client.d.ts.map +1 -0
- package/dist/cjs/services/facebook_ad_library/client.js +53 -0
- package/dist/cjs/services/facebook_ad_library/client.js.map +1 -0
- package/dist/cjs/services/facebook_ad_library/index.d.ts +3 -0
- package/dist/cjs/services/facebook_ad_library/index.d.ts.map +1 -0
- package/dist/cjs/services/facebook_ad_library/index.js +22 -0
- package/dist/cjs/services/facebook_ad_library/index.js.map +1 -0
- package/dist/cjs/services/facebook_ad_library/types.d.ts +606 -0
- package/dist/cjs/services/facebook_ad_library/types.d.ts.map +1 -0
- package/dist/cjs/services/facebook_ad_library/types.js +4 -0
- package/dist/cjs/services/facebook_ad_library/types.js.map +1 -0
- package/dist/cjs/services/facebook_marketplace/client.d.ts +23 -0
- package/dist/cjs/services/facebook_marketplace/client.d.ts.map +1 -0
- package/dist/cjs/services/facebook_marketplace/client.js +47 -0
- package/dist/cjs/services/facebook_marketplace/client.js.map +1 -0
- package/dist/cjs/services/facebook_marketplace/index.d.ts +3 -0
- package/dist/cjs/services/facebook_marketplace/index.d.ts.map +1 -0
- package/dist/cjs/services/facebook_marketplace/index.js +22 -0
- package/dist/cjs/services/facebook_marketplace/index.js.map +1 -0
- package/dist/cjs/services/facebook_marketplace/types.d.ts +400 -0
- package/dist/cjs/services/facebook_marketplace/types.d.ts.map +1 -0
- package/dist/cjs/services/facebook_marketplace/types.js +4 -0
- package/dist/cjs/services/facebook_marketplace/types.js.map +1 -0
- package/dist/cjs/services/geckoterminal/client.d.ts +2 -2
- package/dist/cjs/services/geckoterminal/client.d.ts.map +1 -1
- package/dist/cjs/services/geckoterminal/client.js +2 -2
- package/dist/cjs/services/geckoterminal/client.js.map +1 -1
- package/dist/cjs/services/geckoterminal/types.d.ts +15 -4
- package/dist/cjs/services/geckoterminal/types.d.ts.map +1 -1
- package/dist/cjs/services/gmgn/client.d.ts +18 -18
- package/dist/cjs/services/gmgn/client.d.ts.map +1 -1
- package/dist/cjs/services/gmgn/client.js +18 -18
- package/dist/cjs/services/gmgn/client.js.map +1 -1
- package/dist/cjs/services/gmgn/types.d.ts +2 -2
- package/dist/cjs/services/gmgn/types.d.ts.map +1 -1
- package/dist/cjs/services/goplus/client.d.ts +3 -3
- package/dist/cjs/services/goplus/client.d.ts.map +1 -1
- package/dist/cjs/services/goplus/client.js +3 -3
- package/dist/cjs/services/goplus/client.js.map +1 -1
- package/dist/cjs/services/imovelweb/client.d.ts +6 -6
- package/dist/cjs/services/imovelweb/client.d.ts.map +1 -1
- package/dist/cjs/services/imovelweb/client.js +6 -6
- package/dist/cjs/services/imovelweb/client.js.map +1 -1
- package/dist/cjs/services/indeed/types.d.ts +233 -187
- package/dist/cjs/services/indeed/types.d.ts.map +1 -1
- package/dist/cjs/services/instagram/client.d.ts +12 -12
- package/dist/cjs/services/instagram/client.d.ts.map +1 -1
- package/dist/cjs/services/instagram/client.js +12 -12
- package/dist/cjs/services/instagram/client.js.map +1 -1
- package/dist/cjs/services/instagram/types.d.ts +399 -2284
- package/dist/cjs/services/instagram/types.d.ts.map +1 -1
- package/dist/cjs/services/linkedin/client.d.ts +7 -7
- package/dist/cjs/services/linkedin/client.d.ts.map +1 -1
- package/dist/cjs/services/linkedin/client.js +7 -7
- package/dist/cjs/services/linkedin/client.js.map +1 -1
- package/dist/cjs/services/pinterest/client.d.ts +4 -4
- package/dist/cjs/services/pinterest/client.d.ts.map +1 -1
- package/dist/cjs/services/pinterest/client.js +4 -4
- package/dist/cjs/services/pinterest/client.js.map +1 -1
- package/dist/cjs/services/pinterest/types.d.ts +740 -711
- package/dist/cjs/services/pinterest/types.d.ts.map +1 -1
- package/dist/cjs/services/pinterest_v2/client.d.ts +15 -0
- package/dist/cjs/services/pinterest_v2/client.d.ts.map +1 -0
- package/dist/cjs/services/pinterest_v2/client.js +28 -0
- package/dist/cjs/services/pinterest_v2/client.js.map +1 -0
- package/dist/cjs/services/pinterest_v2/index.d.ts +3 -0
- package/dist/cjs/services/pinterest_v2/index.d.ts.map +1 -0
- package/dist/cjs/services/pinterest_v2/index.js +22 -0
- package/dist/cjs/services/pinterest_v2/index.js.map +1 -0
- package/dist/cjs/services/pinterest_v2/types.d.ts +558 -0
- package/dist/cjs/services/pinterest_v2/types.d.ts.map +1 -0
- package/dist/cjs/services/pinterest_v2/types.js +4 -0
- package/dist/cjs/services/pinterest_v2/types.js.map +1 -0
- package/dist/cjs/services/ponsfamily/client.d.ts +8 -8
- package/dist/cjs/services/ponsfamily/client.d.ts.map +1 -1
- package/dist/cjs/services/ponsfamily/client.js +8 -8
- package/dist/cjs/services/ponsfamily/client.js.map +1 -1
- package/dist/cjs/services/ponsfamily/types.d.ts +83 -14
- package/dist/cjs/services/ponsfamily/types.d.ts.map +1 -1
- package/dist/cjs/services/pumpfun/client.d.ts +56 -56
- package/dist/cjs/services/pumpfun/client.d.ts.map +1 -1
- package/dist/cjs/services/pumpfun/client.js +56 -56
- package/dist/cjs/services/pumpfun/client.js.map +1 -1
- package/dist/cjs/services/pumpfun/types.d.ts +280 -101
- package/dist/cjs/services/pumpfun/types.d.ts.map +1 -1
- package/dist/cjs/services/twitter/client.d.ts +5 -5
- package/dist/cjs/services/twitter/client.d.ts.map +1 -1
- package/dist/cjs/services/twitter/client.js +5 -5
- package/dist/cjs/services/twitter/client.js.map +1 -1
- package/dist/cjs/services/twitter/types.d.ts +294 -403
- package/dist/cjs/services/twitter/types.d.ts.map +1 -1
- package/dist/cjs/services/youtube/client.d.ts +11 -11
- package/dist/cjs/services/youtube/client.d.ts.map +1 -1
- package/dist/cjs/services/youtube/client.js +11 -11
- package/dist/cjs/services/youtube/client.js.map +1 -1
- package/dist/cjs/services/youtube/types.d.ts +164 -158
- package/dist/cjs/services/youtube/types.d.ts.map +1 -1
- package/dist/cjs/services/zillow/client.d.ts +8 -6
- package/dist/cjs/services/zillow/client.d.ts.map +1 -1
- package/dist/cjs/services/zillow/client.js +10 -5
- package/dist/cjs/services/zillow/client.js.map +1 -1
- package/dist/cjs/services/zillow/types.d.ts +720 -886
- package/dist/cjs/services/zillow/types.d.ts.map +1 -1
- package/dist/client.d.ts +8 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +12 -0
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/dist/services/airbnb/client.d.ts +6 -6
- package/dist/services/airbnb/client.d.ts.map +1 -1
- package/dist/services/airbnb/client.js +6 -6
- package/dist/services/airbnb/client.js.map +1 -1
- package/dist/services/birdeye/client.d.ts +10 -10
- package/dist/services/birdeye/client.d.ts.map +1 -1
- package/dist/services/birdeye/client.js +10 -10
- package/dist/services/birdeye/client.js.map +1 -1
- package/dist/services/brave_search/client.d.ts +1 -1
- package/dist/services/brave_search/client.d.ts.map +1 -1
- package/dist/services/brave_search/client.js +1 -1
- package/dist/services/brave_search/client.js.map +1 -1
- package/dist/services/brave_search/types.d.ts +1211 -1273
- package/dist/services/brave_search/types.d.ts.map +1 -1
- package/dist/services/facebook/client.d.ts +65 -0
- package/dist/services/facebook/client.d.ts.map +1 -0
- package/dist/services/facebook/client.js +147 -0
- package/dist/services/facebook/client.js.map +1 -0
- package/dist/services/facebook/index.d.ts +3 -0
- package/dist/services/facebook/index.d.ts.map +1 -0
- package/dist/services/facebook/index.js +4 -0
- package/dist/services/facebook/index.js.map +1 -0
- package/dist/services/facebook/types.d.ts +1021 -0
- package/dist/services/facebook/types.d.ts.map +1 -0
- package/dist/services/facebook/types.js +3 -0
- package/dist/services/facebook/types.js.map +1 -0
- package/dist/services/facebook_ad_library/client.d.ts +25 -0
- package/dist/services/facebook_ad_library/client.d.ts.map +1 -0
- package/dist/services/facebook_ad_library/client.js +49 -0
- package/dist/services/facebook_ad_library/client.js.map +1 -0
- package/dist/services/facebook_ad_library/index.d.ts +3 -0
- package/dist/services/facebook_ad_library/index.d.ts.map +1 -0
- package/dist/services/facebook_ad_library/index.js +4 -0
- package/dist/services/facebook_ad_library/index.js.map +1 -0
- package/dist/services/facebook_ad_library/types.d.ts +606 -0
- package/dist/services/facebook_ad_library/types.d.ts.map +1 -0
- package/dist/services/facebook_ad_library/types.js +3 -0
- package/dist/services/facebook_ad_library/types.js.map +1 -0
- package/dist/services/facebook_marketplace/client.d.ts +23 -0
- package/dist/services/facebook_marketplace/client.d.ts.map +1 -0
- package/dist/services/facebook_marketplace/client.js +43 -0
- package/dist/services/facebook_marketplace/client.js.map +1 -0
- package/dist/services/facebook_marketplace/index.d.ts +3 -0
- package/dist/services/facebook_marketplace/index.d.ts.map +1 -0
- package/dist/services/facebook_marketplace/index.js +4 -0
- package/dist/services/facebook_marketplace/index.js.map +1 -0
- package/dist/services/facebook_marketplace/types.d.ts +400 -0
- package/dist/services/facebook_marketplace/types.d.ts.map +1 -0
- package/dist/services/facebook_marketplace/types.js +3 -0
- package/dist/services/facebook_marketplace/types.js.map +1 -0
- package/dist/services/geckoterminal/client.d.ts +2 -2
- package/dist/services/geckoterminal/client.d.ts.map +1 -1
- package/dist/services/geckoterminal/client.js +2 -2
- package/dist/services/geckoterminal/client.js.map +1 -1
- package/dist/services/geckoterminal/types.d.ts +15 -4
- package/dist/services/geckoterminal/types.d.ts.map +1 -1
- package/dist/services/gmgn/client.d.ts +18 -18
- package/dist/services/gmgn/client.d.ts.map +1 -1
- package/dist/services/gmgn/client.js +18 -18
- package/dist/services/gmgn/client.js.map +1 -1
- package/dist/services/gmgn/types.d.ts +2 -2
- package/dist/services/gmgn/types.d.ts.map +1 -1
- package/dist/services/goplus/client.d.ts +3 -3
- package/dist/services/goplus/client.d.ts.map +1 -1
- package/dist/services/goplus/client.js +3 -3
- package/dist/services/goplus/client.js.map +1 -1
- package/dist/services/imovelweb/client.d.ts +6 -6
- package/dist/services/imovelweb/client.d.ts.map +1 -1
- package/dist/services/imovelweb/client.js +6 -6
- package/dist/services/imovelweb/client.js.map +1 -1
- package/dist/services/indeed/types.d.ts +233 -187
- package/dist/services/indeed/types.d.ts.map +1 -1
- package/dist/services/instagram/client.d.ts +12 -12
- package/dist/services/instagram/client.d.ts.map +1 -1
- package/dist/services/instagram/client.js +12 -12
- package/dist/services/instagram/client.js.map +1 -1
- package/dist/services/instagram/types.d.ts +399 -2284
- package/dist/services/instagram/types.d.ts.map +1 -1
- package/dist/services/linkedin/client.d.ts +7 -7
- package/dist/services/linkedin/client.d.ts.map +1 -1
- package/dist/services/linkedin/client.js +7 -7
- package/dist/services/linkedin/client.js.map +1 -1
- package/dist/services/pinterest/client.d.ts +4 -4
- package/dist/services/pinterest/client.d.ts.map +1 -1
- package/dist/services/pinterest/client.js +4 -4
- package/dist/services/pinterest/client.js.map +1 -1
- package/dist/services/pinterest/types.d.ts +740 -711
- package/dist/services/pinterest/types.d.ts.map +1 -1
- package/dist/services/pinterest_v2/client.d.ts +15 -0
- package/dist/services/pinterest_v2/client.d.ts.map +1 -0
- package/dist/services/pinterest_v2/client.js +24 -0
- package/dist/services/pinterest_v2/client.js.map +1 -0
- package/dist/services/pinterest_v2/index.d.ts +3 -0
- package/dist/services/pinterest_v2/index.d.ts.map +1 -0
- package/dist/services/pinterest_v2/index.js +4 -0
- package/dist/services/pinterest_v2/index.js.map +1 -0
- package/dist/services/pinterest_v2/types.d.ts +558 -0
- package/dist/services/pinterest_v2/types.d.ts.map +1 -0
- package/dist/services/pinterest_v2/types.js +3 -0
- package/dist/services/pinterest_v2/types.js.map +1 -0
- package/dist/services/ponsfamily/client.d.ts +8 -8
- package/dist/services/ponsfamily/client.d.ts.map +1 -1
- package/dist/services/ponsfamily/client.js +8 -8
- package/dist/services/ponsfamily/client.js.map +1 -1
- package/dist/services/ponsfamily/types.d.ts +83 -14
- package/dist/services/ponsfamily/types.d.ts.map +1 -1
- package/dist/services/pumpfun/client.d.ts +56 -56
- package/dist/services/pumpfun/client.d.ts.map +1 -1
- package/dist/services/pumpfun/client.js +56 -56
- package/dist/services/pumpfun/client.js.map +1 -1
- package/dist/services/pumpfun/types.d.ts +280 -101
- package/dist/services/pumpfun/types.d.ts.map +1 -1
- package/dist/services/twitter/client.d.ts +5 -5
- package/dist/services/twitter/client.d.ts.map +1 -1
- package/dist/services/twitter/client.js +5 -5
- package/dist/services/twitter/client.js.map +1 -1
- package/dist/services/twitter/types.d.ts +294 -403
- package/dist/services/twitter/types.d.ts.map +1 -1
- package/dist/services/youtube/client.d.ts +11 -11
- package/dist/services/youtube/client.d.ts.map +1 -1
- package/dist/services/youtube/client.js +11 -11
- package/dist/services/youtube/client.js.map +1 -1
- package/dist/services/youtube/types.d.ts +164 -158
- package/dist/services/youtube/types.d.ts.map +1 -1
- package/dist/services/zillow/client.d.ts +8 -6
- package/dist/services/zillow/client.d.ts.map +1 -1
- package/dist/services/zillow/client.js +10 -5
- package/dist/services/zillow/client.js.map +1 -1
- package/dist/services/zillow/types.d.ts +720 -886
- package/dist/services/zillow/types.d.ts.map +1 -1
- package/package.json +6 -2
|
@@ -0,0 +1,606 @@
|
|
|
1
|
+
export type AdMatch = "any_words" | "exact_phrase";
|
|
2
|
+
export type AdMediaType = "all" | "image" | "video" | "meme" | "image_and_meme" | "none";
|
|
3
|
+
export type AdPlatform = "facebook" | "instagram" | "audience_network" | "messenger" | "threads";
|
|
4
|
+
export type AdSort = "relevance" | "time_active" | "relevancy_monthly_grouped";
|
|
5
|
+
export type AdStatus = "active" | "inactive" | "all";
|
|
6
|
+
export type AdType = "all" | "political_and_issue" | "housing" | "employment" | "credit" | "financial_products_and_services" | "uncategorized";
|
|
7
|
+
export type AudiencePeriod = "last_7_days" | "last_30_days" | "last_90_days";
|
|
8
|
+
export interface ErrorDetail {
|
|
9
|
+
type?: string | null;
|
|
10
|
+
loc?: (string | number)[] | null;
|
|
11
|
+
msg?: string | null;
|
|
12
|
+
input?: unknown | null;
|
|
13
|
+
ctx?: Record<string, unknown> | null;
|
|
14
|
+
}
|
|
15
|
+
export interface ErrorResponse {
|
|
16
|
+
code: PublicError;
|
|
17
|
+
message: string;
|
|
18
|
+
request_id: string;
|
|
19
|
+
domain?: string | null;
|
|
20
|
+
details?: ErrorDetail[] | null;
|
|
21
|
+
upgrade_url?: string | null;
|
|
22
|
+
}
|
|
23
|
+
export interface FacebookAd {
|
|
24
|
+
ad: FacebookAdCard;
|
|
25
|
+
service_status: FacebookServiceStatus;
|
|
26
|
+
}
|
|
27
|
+
export interface FacebookAdCard {
|
|
28
|
+
ad_archive_id: string | null;
|
|
29
|
+
ad_id: string | null;
|
|
30
|
+
text: FacebookAdText;
|
|
31
|
+
url: string | null;
|
|
32
|
+
page: FacebookPage;
|
|
33
|
+
regulation: FacebookAdRegulation;
|
|
34
|
+
collation: FacebookAdCollation;
|
|
35
|
+
categories: FacebookCode[];
|
|
36
|
+
disclaimer: FacebookAdDisclaimer;
|
|
37
|
+
creative: FacebookAdCreative;
|
|
38
|
+
performance: FacebookAdPerformance;
|
|
39
|
+
delivery: FacebookAdDelivery;
|
|
40
|
+
moderation: FacebookAdModeration;
|
|
41
|
+
}
|
|
42
|
+
export interface FacebookAdCarouselCard {
|
|
43
|
+
title: string | null;
|
|
44
|
+
body: string | null;
|
|
45
|
+
caption: string | null;
|
|
46
|
+
link_description: string | null;
|
|
47
|
+
link_url: string | null;
|
|
48
|
+
cta_type: FacebookCode;
|
|
49
|
+
image: FacebookAdImage | null;
|
|
50
|
+
video: FacebookAdVideo | null;
|
|
51
|
+
}
|
|
52
|
+
export interface FacebookAdCollation {
|
|
53
|
+
id: string | null;
|
|
54
|
+
count: number | null;
|
|
55
|
+
}
|
|
56
|
+
export interface FacebookAdCreative {
|
|
57
|
+
link_url: string | null;
|
|
58
|
+
extra_links: string[];
|
|
59
|
+
branded_content: FacebookPage | null;
|
|
60
|
+
display_format: FacebookCode;
|
|
61
|
+
cta_type: FacebookCode;
|
|
62
|
+
cards: FacebookAdCarouselCard[];
|
|
63
|
+
is_reshared: boolean | null;
|
|
64
|
+
root_reshared_post: unknown | null;
|
|
65
|
+
event: unknown | null;
|
|
66
|
+
images: FacebookAdImage[];
|
|
67
|
+
extra_images: FacebookAdImage[];
|
|
68
|
+
videos: FacebookAdVideo[];
|
|
69
|
+
extra_videos: FacebookAdVideo[];
|
|
70
|
+
}
|
|
71
|
+
export interface FacebookAdDelivery {
|
|
72
|
+
total_active_seconds: number | null;
|
|
73
|
+
is_active: boolean | null;
|
|
74
|
+
start_at: string | null;
|
|
75
|
+
end_at: string | null;
|
|
76
|
+
last_seen_at: string | null;
|
|
77
|
+
publisher_platforms: FacebookCode[];
|
|
78
|
+
targeted_or_reached_countries: string[];
|
|
79
|
+
}
|
|
80
|
+
export interface FacebookAdDisclaimer {
|
|
81
|
+
type: FacebookCode;
|
|
82
|
+
paid_for_by: string | null;
|
|
83
|
+
verification: FacebookAdDisclaimerVerification | null;
|
|
84
|
+
}
|
|
85
|
+
export interface FacebookAdDisclaimerVerification {
|
|
86
|
+
help_text: string | null;
|
|
87
|
+
help_url: string | null;
|
|
88
|
+
website: string | null;
|
|
89
|
+
method: string | null;
|
|
90
|
+
submitted_on: string | null;
|
|
91
|
+
phone: string | null;
|
|
92
|
+
email: string | null;
|
|
93
|
+
address: string | null;
|
|
94
|
+
page_admin_info: string | null;
|
|
95
|
+
free_form_info: string | null;
|
|
96
|
+
page_name_info: string | null;
|
|
97
|
+
fec_info: string | null;
|
|
98
|
+
}
|
|
99
|
+
export interface FacebookAdImage {
|
|
100
|
+
original_url: string | null;
|
|
101
|
+
resized_url: string | null;
|
|
102
|
+
watermarked_resized_url: string | null;
|
|
103
|
+
crops: unknown[];
|
|
104
|
+
}
|
|
105
|
+
export interface FacebookAdModeration {
|
|
106
|
+
report_count: number | null;
|
|
107
|
+
hide_data_status: FacebookCode;
|
|
108
|
+
gated_type: FacebookCode;
|
|
109
|
+
is_eligible_for_beneficiary_payer_disclosure: boolean | null;
|
|
110
|
+
contains_sensitive_content: boolean | null;
|
|
111
|
+
state_media_label: string | null;
|
|
112
|
+
contains_digital_created_media: boolean | null;
|
|
113
|
+
}
|
|
114
|
+
export interface FacebookAdParty {
|
|
115
|
+
name: string | null;
|
|
116
|
+
website: string | null;
|
|
117
|
+
location: string | null;
|
|
118
|
+
license_info: string | null;
|
|
119
|
+
license_info_list: string[];
|
|
120
|
+
}
|
|
121
|
+
export interface FacebookAdPerformance {
|
|
122
|
+
spend: FacebookMoneyRange | null;
|
|
123
|
+
impressions: FacebookCountRange | null;
|
|
124
|
+
reach: FacebookCountRange | null;
|
|
125
|
+
impressions_bucket: number | null;
|
|
126
|
+
}
|
|
127
|
+
export interface FacebookAdRegulation {
|
|
128
|
+
brazil_tax_id: string | null;
|
|
129
|
+
is_financial_services_ad: boolean | null;
|
|
130
|
+
has_limited_financial_delivery: boolean | null;
|
|
131
|
+
has_limited_taiwan_anti_scam_delivery: boolean | null;
|
|
132
|
+
country_iso_code: string | null;
|
|
133
|
+
eu_certificates: unknown[];
|
|
134
|
+
additional_info: unknown | null;
|
|
135
|
+
}
|
|
136
|
+
export interface FacebookAdReport {
|
|
137
|
+
locations: FacebookReportLocation[];
|
|
138
|
+
advertisers: FacebookReportAdvertisers;
|
|
139
|
+
downloads: FacebookReportDownload[];
|
|
140
|
+
lifetime: FacebookReportLifetime;
|
|
141
|
+
country: string;
|
|
142
|
+
date: string;
|
|
143
|
+
period: string;
|
|
144
|
+
supported_countries: string[];
|
|
145
|
+
service_status: FacebookServiceStatus;
|
|
146
|
+
}
|
|
147
|
+
export interface FacebookAdReportAdvertisersPage {
|
|
148
|
+
advertisers: FacebookReportAdvertiser[];
|
|
149
|
+
total_count: number | null;
|
|
150
|
+
country: string;
|
|
151
|
+
date: string;
|
|
152
|
+
period: string;
|
|
153
|
+
pagination: FacebookCursorPagination;
|
|
154
|
+
}
|
|
155
|
+
export interface FacebookAdSearchPage {
|
|
156
|
+
ads: FacebookAdCard[];
|
|
157
|
+
pagination: FacebookCursorPagination;
|
|
158
|
+
}
|
|
159
|
+
export interface FacebookAdText {
|
|
160
|
+
title: string | null;
|
|
161
|
+
body: string | null;
|
|
162
|
+
caption: string | null;
|
|
163
|
+
link_description: string | null;
|
|
164
|
+
extra_texts: string[];
|
|
165
|
+
}
|
|
166
|
+
export interface FacebookAdTransparency {
|
|
167
|
+
ad_archive_id: string;
|
|
168
|
+
status: FacebookAdTransparencyStatus;
|
|
169
|
+
payer_beneficiary: FacebookPayerBeneficiary[];
|
|
170
|
+
targets_eu: boolean | null;
|
|
171
|
+
eu: FacebookRegionTransparency | null;
|
|
172
|
+
uk: FacebookRegionTransparency | null;
|
|
173
|
+
brazil: unknown | null;
|
|
174
|
+
political_insights: FacebookPoliticalAdInsights;
|
|
175
|
+
financial_services: FacebookFinancialServicesDisclosure[];
|
|
176
|
+
verified_voice_types: FacebookCode[];
|
|
177
|
+
violation_types: string[];
|
|
178
|
+
}
|
|
179
|
+
export interface FacebookAdTransparencyStatus {
|
|
180
|
+
is_ad_taken_down: boolean | null;
|
|
181
|
+
has_violating_payer_beneficiary: boolean | null;
|
|
182
|
+
violates_eu_political_ad_rules: boolean | null;
|
|
183
|
+
is_eligible_for_eu_political_ai_disclosure: boolean | null;
|
|
184
|
+
}
|
|
185
|
+
export interface FacebookAdVersionsPage {
|
|
186
|
+
collation_id: string;
|
|
187
|
+
total_count: number | null;
|
|
188
|
+
ads: FacebookAdCard[];
|
|
189
|
+
pagination: FacebookCursorPagination;
|
|
190
|
+
}
|
|
191
|
+
export interface FacebookAdVideo {
|
|
192
|
+
hd_url: string | null;
|
|
193
|
+
sd_url: string | null;
|
|
194
|
+
watermarked_hd_url: string | null;
|
|
195
|
+
watermarked_sd_url: string | null;
|
|
196
|
+
preview_image_url: string | null;
|
|
197
|
+
}
|
|
198
|
+
export interface FacebookAdminCountry {
|
|
199
|
+
country_page_id: string | null;
|
|
200
|
+
admin_count: number | null;
|
|
201
|
+
country: string | null;
|
|
202
|
+
}
|
|
203
|
+
export interface FacebookAdvertiser {
|
|
204
|
+
transparency_node_id: string | null;
|
|
205
|
+
spend: FacebookAdvertiserSpend;
|
|
206
|
+
status: FacebookAdvertiserStatus;
|
|
207
|
+
service_status: FacebookServiceStatus;
|
|
208
|
+
page: FacebookPage;
|
|
209
|
+
owner: FacebookAdvertiserOwner;
|
|
210
|
+
admin_countries: FacebookAdminCountry[];
|
|
211
|
+
ads: FacebookAdvertiserAds;
|
|
212
|
+
alias: string | null;
|
|
213
|
+
about: string | null;
|
|
214
|
+
history: FacebookPageHistoryEvent[];
|
|
215
|
+
shared_disclaimer_pages: unknown[];
|
|
216
|
+
related_pages: unknown[];
|
|
217
|
+
is_delegate_page_with_linked_primary_profile: boolean | null;
|
|
218
|
+
supported_countries: string[];
|
|
219
|
+
state_media_label: string | null;
|
|
220
|
+
}
|
|
221
|
+
export interface FacebookAdvertiserAds {
|
|
222
|
+
total_count: number | null;
|
|
223
|
+
hidden_ad_count: number | null;
|
|
224
|
+
first_page: FacebookAdCard[];
|
|
225
|
+
has_blank_ads: boolean | null;
|
|
226
|
+
}
|
|
227
|
+
export interface FacebookAdvertiserAudience {
|
|
228
|
+
page_id: string;
|
|
229
|
+
summary: FacebookAudienceSummary;
|
|
230
|
+
locations: FacebookAudienceSlice[];
|
|
231
|
+
page_name: string | null;
|
|
232
|
+
gender: FacebookAudienceSlice[];
|
|
233
|
+
age: FacebookAudienceSlice[];
|
|
234
|
+
languages: FacebookAudienceSlice[];
|
|
235
|
+
custom_audiences: FacebookAudienceSlice[];
|
|
236
|
+
lookalike_audiences: FacebookAudienceSlice[];
|
|
237
|
+
detailed_targeting: FacebookAudienceSlice[];
|
|
238
|
+
period: string;
|
|
239
|
+
has_political_ads_in_period: boolean | null;
|
|
240
|
+
has_political_ads_ever: boolean | null;
|
|
241
|
+
}
|
|
242
|
+
export interface FacebookAdvertiserOwner {
|
|
243
|
+
business_id: string | null;
|
|
244
|
+
name: string | null;
|
|
245
|
+
address: string | null;
|
|
246
|
+
phone: string | null;
|
|
247
|
+
}
|
|
248
|
+
export interface FacebookAdvertiserSpend {
|
|
249
|
+
current_week: unknown | null;
|
|
250
|
+
lifetime_by_disclaimer: FacebookDisclaimerSpend[];
|
|
251
|
+
weekly_by_disclaimer: FacebookDisclaimerSpend[];
|
|
252
|
+
is_political_page?: boolean | null;
|
|
253
|
+
}
|
|
254
|
+
export interface FacebookAdvertiserStatus {
|
|
255
|
+
is_deleted: boolean | null;
|
|
256
|
+
is_actioned: boolean | null;
|
|
257
|
+
}
|
|
258
|
+
export interface FacebookAdvertiserSuggestion {
|
|
259
|
+
page: FacebookPage;
|
|
260
|
+
alias: string | null;
|
|
261
|
+
country: string | null;
|
|
262
|
+
}
|
|
263
|
+
export interface FacebookAdvertiserSuggestions {
|
|
264
|
+
advertisers: FacebookAdvertiserSuggestion[];
|
|
265
|
+
exact_phrase_query: string | null;
|
|
266
|
+
keywords: string[];
|
|
267
|
+
locations: unknown[];
|
|
268
|
+
query: string;
|
|
269
|
+
}
|
|
270
|
+
export interface FacebookAgeGenderShare {
|
|
271
|
+
age_range: string | null;
|
|
272
|
+
female_share: number | null;
|
|
273
|
+
male_share: number | null;
|
|
274
|
+
unknown_share: number | null;
|
|
275
|
+
}
|
|
276
|
+
export interface FacebookAgeRange {
|
|
277
|
+
min: number | null;
|
|
278
|
+
max: number | null;
|
|
279
|
+
}
|
|
280
|
+
export interface FacebookAudienceLocation {
|
|
281
|
+
name: string | null;
|
|
282
|
+
hidden_location_count: number | null;
|
|
283
|
+
type: FacebookCode;
|
|
284
|
+
is_excluded: boolean | null;
|
|
285
|
+
}
|
|
286
|
+
export interface FacebookAudienceSlice {
|
|
287
|
+
ad_count: number | null;
|
|
288
|
+
hidden_location_count?: number | null;
|
|
289
|
+
value: string | null;
|
|
290
|
+
spend_fraction: number | null;
|
|
291
|
+
type?: FacebookCode;
|
|
292
|
+
place_name?: string | null;
|
|
293
|
+
country?: string | null;
|
|
294
|
+
is_excluded?: boolean | null;
|
|
295
|
+
}
|
|
296
|
+
export interface FacebookAudienceSummary {
|
|
297
|
+
total_spend: FacebookMoney;
|
|
298
|
+
total_ads: number | null;
|
|
299
|
+
is_30_day_available: boolean | null;
|
|
300
|
+
is_90_day_available: boolean | null;
|
|
301
|
+
date: string | null;
|
|
302
|
+
detailed_spend: unknown[];
|
|
303
|
+
}
|
|
304
|
+
export interface FacebookCode {
|
|
305
|
+
code: string | null;
|
|
306
|
+
label: string | null;
|
|
307
|
+
}
|
|
308
|
+
export interface FacebookCountRange {
|
|
309
|
+
min: number | null;
|
|
310
|
+
max: number | null;
|
|
311
|
+
formatted: string | null;
|
|
312
|
+
}
|
|
313
|
+
export interface FacebookCoverPhoto {
|
|
314
|
+
id: string | null;
|
|
315
|
+
owner_id: string | null;
|
|
316
|
+
accessibility_caption: string | null;
|
|
317
|
+
url: string | null;
|
|
318
|
+
focus: FacebookFocus | null;
|
|
319
|
+
image: FacebookImage | null;
|
|
320
|
+
}
|
|
321
|
+
export interface FacebookCursorPagination {
|
|
322
|
+
next_cursor: string | null;
|
|
323
|
+
has_more: boolean | null;
|
|
324
|
+
}
|
|
325
|
+
export interface FacebookDisclaimerSpend {
|
|
326
|
+
spend: FacebookMoney;
|
|
327
|
+
paid_for_by: string | null;
|
|
328
|
+
}
|
|
329
|
+
export interface FacebookFinancialServicesDisclosure {
|
|
330
|
+
region: FacebookCode;
|
|
331
|
+
is_payer_beneficiary_same: boolean | null;
|
|
332
|
+
payer: FacebookAdParty;
|
|
333
|
+
beneficiary: FacebookAdParty;
|
|
334
|
+
}
|
|
335
|
+
export interface FacebookFocus {
|
|
336
|
+
x: number | null;
|
|
337
|
+
y: number | null;
|
|
338
|
+
}
|
|
339
|
+
export interface FacebookImage {
|
|
340
|
+
url: string | null;
|
|
341
|
+
width: number | null;
|
|
342
|
+
height: number | null;
|
|
343
|
+
}
|
|
344
|
+
export interface FacebookInstagramAccount {
|
|
345
|
+
username: string | null;
|
|
346
|
+
follower_count: number | null;
|
|
347
|
+
is_verified: boolean | null;
|
|
348
|
+
}
|
|
349
|
+
export interface FacebookMoney {
|
|
350
|
+
amount: number | null;
|
|
351
|
+
currency: string | null;
|
|
352
|
+
formatted: string | null;
|
|
353
|
+
}
|
|
354
|
+
export interface FacebookMoneyRange {
|
|
355
|
+
min: number | null;
|
|
356
|
+
max: number | null;
|
|
357
|
+
currency: string | null;
|
|
358
|
+
formatted: string | null;
|
|
359
|
+
}
|
|
360
|
+
export interface FacebookPage {
|
|
361
|
+
page_id: string | null;
|
|
362
|
+
profile_id: string | null;
|
|
363
|
+
username?: string | null;
|
|
364
|
+
story_bucket_ids?: string[];
|
|
365
|
+
name: string | null;
|
|
366
|
+
url: string | null;
|
|
367
|
+
metrics: FacebookPageMetrics;
|
|
368
|
+
status: FacebookPageStatus;
|
|
369
|
+
instagram?: FacebookInstagramAccount | null;
|
|
370
|
+
tabs?: FacebookPageTab[];
|
|
371
|
+
category?: string | null;
|
|
372
|
+
entity_type?: FacebookCode;
|
|
373
|
+
verification?: FacebookCode;
|
|
374
|
+
alternate_name?: string | null;
|
|
375
|
+
gender?: FacebookCode;
|
|
376
|
+
profile_type_transition?: FacebookCode;
|
|
377
|
+
social_context?: FacebookSocialContextItem[];
|
|
378
|
+
legal?: FacebookPageLegal;
|
|
379
|
+
profile_picture_url?: string | null;
|
|
380
|
+
profile_photo?: FacebookPhoto;
|
|
381
|
+
profile_pictures?: FacebookImage[];
|
|
382
|
+
cover_photo?: FacebookCoverPhoto | null;
|
|
383
|
+
}
|
|
384
|
+
export interface FacebookPageCollectionLink {
|
|
385
|
+
collection_id: string | null;
|
|
386
|
+
tab_key: string | null;
|
|
387
|
+
name: string | null;
|
|
388
|
+
url: string | null;
|
|
389
|
+
}
|
|
390
|
+
export interface FacebookPageHistoryEvent {
|
|
391
|
+
at: string | null;
|
|
392
|
+
type: FacebookCode;
|
|
393
|
+
}
|
|
394
|
+
export interface FacebookPageLegal {
|
|
395
|
+
dsa_reporting_url: string | null;
|
|
396
|
+
dsa_report_entrypoint: string | null;
|
|
397
|
+
is_dsa_legal_reporting_enabled: boolean | null;
|
|
398
|
+
}
|
|
399
|
+
export interface FacebookPageMetrics {
|
|
400
|
+
like_count?: number | null;
|
|
401
|
+
follower_count?: number | null;
|
|
402
|
+
talking_about_count?: number | null;
|
|
403
|
+
follower_count_approx?: number | null;
|
|
404
|
+
following_count_approx?: number | null;
|
|
405
|
+
}
|
|
406
|
+
export interface FacebookPageStatus {
|
|
407
|
+
is_deleted?: boolean | null;
|
|
408
|
+
is_verified?: boolean | null;
|
|
409
|
+
is_memorialized?: boolean | null;
|
|
410
|
+
restriction_violation_status?: string | null;
|
|
411
|
+
is_currently_live?: boolean | null;
|
|
412
|
+
is_business_page_active?: boolean | null;
|
|
413
|
+
is_additional_profile_plus?: boolean | null;
|
|
414
|
+
profile_picture_is_silhouette?: boolean | null;
|
|
415
|
+
}
|
|
416
|
+
export interface FacebookPageTab {
|
|
417
|
+
section_id: string | null;
|
|
418
|
+
tab_key: string | null;
|
|
419
|
+
name: string | null;
|
|
420
|
+
url: string | null;
|
|
421
|
+
displayable_count: number | null;
|
|
422
|
+
collections: FacebookPageCollectionLink[];
|
|
423
|
+
section_type: FacebookCode;
|
|
424
|
+
}
|
|
425
|
+
export interface FacebookPayerBeneficiary {
|
|
426
|
+
payer: string | null;
|
|
427
|
+
beneficiary: string | null;
|
|
428
|
+
}
|
|
429
|
+
export interface FacebookPhoto {
|
|
430
|
+
collection_item_id?: string | null;
|
|
431
|
+
id: string | null;
|
|
432
|
+
owner_id: string | null;
|
|
433
|
+
feedback_id: string | null;
|
|
434
|
+
creation_story_id: string | null;
|
|
435
|
+
accessibility_caption: string | null;
|
|
436
|
+
url: string | null;
|
|
437
|
+
focus: FacebookFocus | null;
|
|
438
|
+
type: string;
|
|
439
|
+
is_playable: boolean | null;
|
|
440
|
+
image: FacebookImage | null;
|
|
441
|
+
thumbnail_url: string | null;
|
|
442
|
+
}
|
|
443
|
+
export interface FacebookPoliticalAdInsights {
|
|
444
|
+
country: string | null;
|
|
445
|
+
is_currency_matched: boolean | null;
|
|
446
|
+
age_gender: FacebookAgeGenderShare[];
|
|
447
|
+
regions: FacebookRegionShare[];
|
|
448
|
+
}
|
|
449
|
+
export interface FacebookReachByAgeGender {
|
|
450
|
+
country: string | null;
|
|
451
|
+
age_range: string | null;
|
|
452
|
+
male: number | null;
|
|
453
|
+
female: number | null;
|
|
454
|
+
unknown: number | null;
|
|
455
|
+
}
|
|
456
|
+
export interface FacebookRegionShare {
|
|
457
|
+
region: string | null;
|
|
458
|
+
reach_share: number | null;
|
|
459
|
+
}
|
|
460
|
+
export interface FacebookRegionTransparency {
|
|
461
|
+
total_reach: number | null;
|
|
462
|
+
locations: FacebookAudienceLocation[];
|
|
463
|
+
age: FacebookAgeRange;
|
|
464
|
+
gender: FacebookCode;
|
|
465
|
+
reach_by_country_age_gender: FacebookReachByAgeGender[];
|
|
466
|
+
}
|
|
467
|
+
export interface FacebookReportAdvertiser {
|
|
468
|
+
report_row_id: string | null;
|
|
469
|
+
total_spend: FacebookMoney;
|
|
470
|
+
total_ads: number | null;
|
|
471
|
+
show_detailed_spends: boolean | null;
|
|
472
|
+
page: FacebookPage;
|
|
473
|
+
paid_for_by: string | null;
|
|
474
|
+
detailed_spends: FacebookMoney[];
|
|
475
|
+
}
|
|
476
|
+
export interface FacebookReportAdvertisers {
|
|
477
|
+
total_count: number | null;
|
|
478
|
+
items: FacebookReportAdvertiser[];
|
|
479
|
+
pagination: FacebookCursorPagination;
|
|
480
|
+
}
|
|
481
|
+
export interface FacebookReportDownload {
|
|
482
|
+
is_available: boolean | null;
|
|
483
|
+
date: string | null;
|
|
484
|
+
period: FacebookCode;
|
|
485
|
+
}
|
|
486
|
+
export interface FacebookReportLifetime {
|
|
487
|
+
total_ads: number | null;
|
|
488
|
+
total_spend: FacebookMoney;
|
|
489
|
+
top_keywords: string[];
|
|
490
|
+
}
|
|
491
|
+
export interface FacebookReportLocation {
|
|
492
|
+
name: string | null;
|
|
493
|
+
total_spend: FacebookMoney;
|
|
494
|
+
show_detailed_spends: boolean | null;
|
|
495
|
+
detailed_spends: FacebookMoney[];
|
|
496
|
+
}
|
|
497
|
+
export interface FacebookServiceIssue {
|
|
498
|
+
status: string | null;
|
|
499
|
+
product: string | null;
|
|
500
|
+
}
|
|
501
|
+
export interface FacebookServiceStatus {
|
|
502
|
+
status: string | null;
|
|
503
|
+
issues: FacebookServiceIssue[];
|
|
504
|
+
is_captcha_required: boolean | null;
|
|
505
|
+
}
|
|
506
|
+
export interface FacebookSocialContextItem {
|
|
507
|
+
text: string | null;
|
|
508
|
+
url: string | null;
|
|
509
|
+
count_approx: number | null;
|
|
510
|
+
}
|
|
511
|
+
export interface GetAdParams {
|
|
512
|
+
/** The ad's `ad_archive_id`. */
|
|
513
|
+
ad_id: string;
|
|
514
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
515
|
+
country?: string;
|
|
516
|
+
}
|
|
517
|
+
export interface GetAdReportParams {
|
|
518
|
+
/** ISO 3166-1 alpha-2 country, upper case. */
|
|
519
|
+
country?: string;
|
|
520
|
+
/** Time window; a report Facebook is still building answers 503 with `Retry-After`. */
|
|
521
|
+
period?: ReportPeriod;
|
|
522
|
+
/** Report day; defaults to the newest published day, two days ago. */
|
|
523
|
+
date?: string | null;
|
|
524
|
+
}
|
|
525
|
+
export interface GetAdTransparencyParams {
|
|
526
|
+
/** The ad's `ad_archive_id`. */
|
|
527
|
+
ad_id: string;
|
|
528
|
+
/** The ad's `page.page_id`; Facebook needs a page id but answers the same for any valid one. */
|
|
529
|
+
page_id: string;
|
|
530
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
531
|
+
country?: string;
|
|
532
|
+
}
|
|
533
|
+
export interface GetAdvertiserAudienceParams {
|
|
534
|
+
/** The advertiser's `page_id`: `page.page_id` of an ad or `advertisers[].page.page_id` from `/ad-library/advertisers/search`. */
|
|
535
|
+
page_id: string;
|
|
536
|
+
/** Time window. */
|
|
537
|
+
period?: AudiencePeriod;
|
|
538
|
+
}
|
|
539
|
+
export interface GetAdvertiserParams {
|
|
540
|
+
/** The advertiser's `page_id`: `page.page_id` of an ad or `advertisers[].page.page_id` from `/ad-library/advertisers/search`. */
|
|
541
|
+
page_id: string;
|
|
542
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
543
|
+
country?: string;
|
|
544
|
+
}
|
|
545
|
+
export interface ListAdReportAdvertisersParams {
|
|
546
|
+
/** ISO 3166-1 alpha-2 country, upper case. */
|
|
547
|
+
country?: string;
|
|
548
|
+
/** Time window. */
|
|
549
|
+
period?: ReportPeriod;
|
|
550
|
+
/** Search text. */
|
|
551
|
+
query?: string | null;
|
|
552
|
+
/** Order by spend or by number of ads. */
|
|
553
|
+
sort?: ReportSort;
|
|
554
|
+
/** `pagination.next_cursor` from the previous page; empty for the first page. */
|
|
555
|
+
cursor?: string;
|
|
556
|
+
/** Report day; defaults to the newest published day, two days ago. */
|
|
557
|
+
date?: string | null;
|
|
558
|
+
}
|
|
559
|
+
export interface ListAdVersionsParams {
|
|
560
|
+
/** `collation.id` of an ad. */
|
|
561
|
+
collation_id: string;
|
|
562
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
563
|
+
country?: string;
|
|
564
|
+
/** `pagination.next_cursor` from the previous page; empty for the first page. */
|
|
565
|
+
cursor?: string;
|
|
566
|
+
}
|
|
567
|
+
export type PublicError = "blocked" | "concurrency_exceeded" | "timeout" | "extraction_failed" | "upstream_blocked" | "upstream_unavailable" | "upstream_response_invalid" | "invalid_url_scheme" | "invalid_url_host" | "unauthenticated" | "forbidden" | "resource_forbidden" | "not_found" | "rate_limited" | "invalid_request" | "invalid_cursor" | "insufficient_credits" | "internal_error";
|
|
568
|
+
export type ReportPeriod = "yesterday" | "last_7_days" | "last_30_days" | "last_90_days" | "lifelong";
|
|
569
|
+
export type ReportSort = "spend" | "ads";
|
|
570
|
+
export interface SearchAdsParams {
|
|
571
|
+
/** `pagination.next_cursor` from the previous page; empty for the first page. */
|
|
572
|
+
cursor?: string;
|
|
573
|
+
/** Search text. */
|
|
574
|
+
query?: string | null;
|
|
575
|
+
/** Only this advertiser's ads: `advertisers[].page.page_id` from `/ad-library/advertisers/search`. Send this or `query`. */
|
|
576
|
+
page_id?: string | null;
|
|
577
|
+
/** Match any of the words or the exact phrase. */
|
|
578
|
+
match?: AdMatch;
|
|
579
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
580
|
+
country?: string;
|
|
581
|
+
/** Running, stopped or both. */
|
|
582
|
+
status?: AdStatus;
|
|
583
|
+
/** Ad category. */
|
|
584
|
+
ad_type?: AdType;
|
|
585
|
+
/** Creative format. */
|
|
586
|
+
media_type?: AdMediaType;
|
|
587
|
+
/** Only ads shown on these platforms; repeat the parameter for several. */
|
|
588
|
+
platforms?: AdPlatform[];
|
|
589
|
+
/** Only ads in these ISO 639-1 languages, such as `en`; repeat for several. */
|
|
590
|
+
languages?: string[];
|
|
591
|
+
/** Only ads shown on this day or later. */
|
|
592
|
+
delivered_after?: string | null;
|
|
593
|
+
/** Only ads shown on this day or earlier. */
|
|
594
|
+
delivered_before?: string | null;
|
|
595
|
+
/** Result order. */
|
|
596
|
+
sort?: AdSort;
|
|
597
|
+
}
|
|
598
|
+
export interface SearchAdvertisersParams {
|
|
599
|
+
/** Search text. */
|
|
600
|
+
query: string;
|
|
601
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
602
|
+
country?: string;
|
|
603
|
+
/** Ad category. */
|
|
604
|
+
ad_type?: AdType;
|
|
605
|
+
}
|
|
606
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/facebook_ad_library/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,cAAc,CAAC;AAEnD,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,MAAM,CAAC;AAEzF,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,kBAAkB,GAAG,WAAW,GAAG,SAAS,CAAC;AAEjG,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,aAAa,GAAG,2BAA2B,CAAC;AAE/E,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;AAErD,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,qBAAqB,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,iCAAiC,GAAG,eAAe,CAAC;AAE/I,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;AAE7E,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,cAAc,CAAC;IACnB,cAAc,EAAE,qBAAqB,CAAC;CACvC;AAED,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IACrB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,oBAAoB,CAAC;IACjC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,YAAY,EAAE,CAAC;IAC3B,UAAU,EAAE,oBAAoB,CAAC;IACjC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,WAAW,EAAE,qBAAqB,CAAC;IACnC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,UAAU,EAAE,oBAAoB,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,EAAE,YAAY,GAAG,IAAI,CAAC;IACrC,cAAc,EAAE,YAAY,CAAC;IAC7B,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,kBAAkB,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,YAAY,EAAE,eAAe,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,mBAAmB,EAAE,YAAY,EAAE,CAAC;IACpC,6BAA6B,EAAE,MAAM,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,gCAAgC,GAAG,IAAI,CAAC;CACvD;AAED,MAAM,WAAW,gCAAgC;IAC/C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,KAAK,EAAE,OAAO,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gBAAgB,EAAE,YAAY,CAAC;IAC/B,UAAU,EAAE,YAAY,CAAC;IACzB,4CAA4C,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7D,0BAA0B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3C,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,8BAA8B,EAAE,OAAO,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACjC,WAAW,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACvC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACjC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,wBAAwB,EAAE,OAAO,GAAG,IAAI,CAAC;IACzC,8BAA8B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/C,qCAAqC,EAAE,OAAO,GAAG,IAAI,CAAC;IACtD,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,EAAE,OAAO,EAAE,CAAC;IAC3B,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,sBAAsB,EAAE,CAAC;IACpC,WAAW,EAAE,yBAAyB,CAAC;IACvC,SAAS,EAAE,sBAAsB,EAAE,CAAC;IACpC,QAAQ,EAAE,sBAAsB,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,cAAc,EAAE,qBAAqB,CAAC;CACvC;AAED,MAAM,WAAW,+BAA+B;IAC9C,WAAW,EAAE,wBAAwB,EAAE,CAAC;IACxC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,wBAAwB,CAAC;CACtC;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,cAAc,EAAE,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;CACtC;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,4BAA4B,CAAC;IACrC,iBAAiB,EAAE,wBAAwB,EAAE,CAAC;IAC9C,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,EAAE,EAAE,0BAA0B,GAAG,IAAI,CAAC;IACtC,EAAE,EAAE,0BAA0B,GAAG,IAAI,CAAC;IACtC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IACvB,kBAAkB,EAAE,2BAA2B,CAAC;IAChD,kBAAkB,EAAE,mCAAmC,EAAE,CAAC;IAC1D,oBAAoB,EAAE,YAAY,EAAE,CAAC;IACrC,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,4BAA4B;IAC3C,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,+BAA+B,EAAE,OAAO,GAAG,IAAI,CAAC;IAChD,8BAA8B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/C,0CAA0C,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5D;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,EAAE,cAAc,EAAE,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;CACtC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,KAAK,EAAE,uBAAuB,CAAC;IAC/B,MAAM,EAAE,wBAAwB,CAAC;IACjC,cAAc,EAAE,qBAAqB,CAAC;IACtC,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,uBAAuB,CAAC;IAC/B,eAAe,EAAE,oBAAoB,EAAE,CAAC;IACxC,GAAG,EAAE,qBAAqB,CAAC;IAC3B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACpC,uBAAuB,EAAE,OAAO,EAAE,CAAC;IACnC,aAAa,EAAE,OAAO,EAAE,CAAC;IACzB,4CAA4C,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7D,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,uBAAuB,CAAC;IACjC,SAAS,EAAE,qBAAqB,EAAE,CAAC;IACnC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,qBAAqB,EAAE,CAAC;IAChC,GAAG,EAAE,qBAAqB,EAAE,CAAC;IAC7B,SAAS,EAAE,qBAAqB,EAAE,CAAC;IACnC,gBAAgB,EAAE,qBAAqB,EAAE,CAAC;IAC1C,mBAAmB,EAAE,qBAAqB,EAAE,CAAC;IAC7C,kBAAkB,EAAE,qBAAqB,EAAE,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5C,sBAAsB,EAAE,OAAO,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,sBAAsB,EAAE,uBAAuB,EAAE,CAAC;IAClD,oBAAoB,EAAE,uBAAuB,EAAE,CAAC;IAChD,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,6BAA6B;IAC5C,WAAW,EAAE,4BAA4B,EAAE,CAAC;IAC5C,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,aAAa,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,cAAc,EAAE,OAAO,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,aAAa,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,YAAY,CAAC;IACrB,yBAAyB,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1C,KAAK,EAAE,eAAe,CAAC;IACvB,WAAW,EAAE,eAAe,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC5C,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,uBAAuB,CAAC,EAAE,YAAY,CAAC;IACvC,cAAc,CAAC,EAAE,yBAAyB,EAAE,CAAC;IAC7C,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,CAAC,EAAE,aAAa,EAAE,CAAC;IACnC,WAAW,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACzC;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,8BAA8B,EAAE,OAAO,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,4BAA4B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,uBAAuB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzC,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5C,6BAA6B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,WAAW,EAAE,0BAA0B,EAAE,CAAC;IAC1C,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;IACpC,UAAU,EAAE,sBAAsB,EAAE,CAAC;IACrC,OAAO,EAAE,mBAAmB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,wBAAwB,EAAE,CAAC;IACtC,GAAG,EAAE,gBAAgB,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC;IACrB,2BAA2B,EAAE,wBAAwB,EAAE,CAAC;CACzD;AAED,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,aAAa,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,aAAa,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,wBAAwB,EAAE,CAAC;IAClC,UAAU,EAAE,wBAAwB,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,aAAa,CAAC;IAC3B,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,aAAa,CAAC;IAC3B,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAC;IACrC,eAAe,EAAE,aAAa,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,oBAAoB,EAAE,CAAC;IAC/B,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uFAAuF;IACvF,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,gGAAgG;IAChG,OAAO,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA2B;IAC1C,iIAAiI;IACjI,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,iIAAiI;IACjI,OAAO,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA6B;IAC5C,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,sBAAsB,GAAG,SAAS,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,sBAAsB,GAAG,2BAA2B,GAAG,oBAAoB,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,WAAW,GAAG,oBAAoB,GAAG,WAAW,GAAG,cAAc,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,gBAAgB,CAAC;AAElY,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,GAAG,UAAU,CAAC;AAEtG,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,CAAC;AAEzC,MAAM,WAAW,eAAe;IAC9B,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,4HAA4H;IAC5H,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,kDAAkD;IAClD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC;IACzB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,2CAA2C;IAC3C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/facebook_ad_library/types.ts"],"names":[],"mappings":"AAAA,oEAAoE"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { BaseClient } from '../../base.js';
|
|
2
|
+
import type { FacebookListing, FacebookListingPhotos, FacebookListingsPage, FacebookMarketplaceCategories, FacebookMarketplaceLocations, FacebookRentalsMap, GetMarketplaceListingParams, ListMarketplaceCategoryListingsParams, ListMarketplaceFeedParams, ListMarketplaceListingPhotosParams, ListMarketplaceRentalsParams, SearchMarketplaceLocationsParams, SearchMarketplaceParams } from './types.js';
|
|
3
|
+
export declare class FacebookMarketplaceClient {
|
|
4
|
+
private readonly base;
|
|
5
|
+
constructor(base: BaseClient);
|
|
6
|
+
/** List Marketplace's categories and subcategories. Costs 3 credits. */
|
|
7
|
+
getMarketplaceCategories(): Promise<FacebookMarketplaceCategories>;
|
|
8
|
+
/** List the listings of one Marketplace category around a point. Costs 3 credits. */
|
|
9
|
+
listMarketplaceCategoryListings(params: ListMarketplaceCategoryListingsParams): Promise<FacebookListingsPage>;
|
|
10
|
+
/** List the Marketplace home feed around a point. Costs 3 credits. */
|
|
11
|
+
listMarketplaceFeed(params: ListMarketplaceFeedParams): Promise<FacebookListingsPage>;
|
|
12
|
+
/** Search Marketplace listings around a point. A page can come back empty with a `next_cursor`; keep paging. Costs 3 credits. */
|
|
13
|
+
searchMarketplace(params: SearchMarketplaceParams): Promise<FacebookListingsPage>;
|
|
14
|
+
/** Get one Marketplace listing with its seller. Photos are on `/marketplace/listings/{listing_id}/photos`. Costs 4 credits. */
|
|
15
|
+
getMarketplaceListing(params: GetMarketplaceListingParams): Promise<FacebookListing>;
|
|
16
|
+
/** List every photo and video of a Marketplace listing. Costs 3 credits. */
|
|
17
|
+
listMarketplaceListingPhotos(params: ListMarketplaceListingPhotosParams): Promise<FacebookListingPhotos>;
|
|
18
|
+
/** Find places by name, with the coordinates the Marketplace routes take. Costs 3 credits. */
|
|
19
|
+
searchMarketplaceLocations(params: SearchMarketplaceLocationsParams): Promise<FacebookMarketplaceLocations>;
|
|
20
|
+
/** Get the rentals map around a point: pin clusters with a listing count each, no listings. Costs 3 credits. */
|
|
21
|
+
listMarketplaceRentals(params: ListMarketplaceRentalsParams): Promise<FacebookRentalsMap>;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/services/facebook_marketplace/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,qCAAqC,EAAE,yBAAyB,EAAE,kCAAkC,EAAE,4BAA4B,EAAE,gCAAgC,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAE5Y,qBAAa,yBAAyB;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,wEAAwE;IAClE,wBAAwB,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIxE,qFAAqF;IAC/E,+BAA+B,CAAC,MAAM,EAAE,qCAAqC,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAKnH,sEAAsE;IAChE,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI3F,iIAAiI;IAC3H,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIvF,+HAA+H;IACzH,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IAK1F,4EAA4E;IACtE,4BAA4B,CAAC,MAAM,EAAE,kCAAkC,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAK9G,8FAA8F;IACxF,0BAA0B,CAAC,MAAM,EAAE,gCAAgC,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAIjH,gHAAgH;IAC1G,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAGhG"}
|