@tapline/client 0.2.14 → 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 +6 -2
- package/dist/cjs/client.d.ts +2 -0
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +29 -26
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/index.d.ts +2 -0
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +30 -27
- 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/types.d.ts +417 -430
- package/dist/cjs/services/facebook/types.d.ts.map +1 -1
- package/dist/cjs/services/facebook_ad_library/types.d.ts +259 -182
- package/dist/cjs/services/facebook_ad_library/types.d.ts.map +1 -1
- package/dist/cjs/services/facebook_marketplace/types.d.ts +162 -170
- package/dist/cjs/services/facebook_marketplace/types.d.ts.map +1 -1
- 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 +2 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +3 -0
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -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/types.d.ts +417 -430
- package/dist/services/facebook/types.d.ts.map +1 -1
- package/dist/services/facebook_ad_library/types.d.ts +259 -182
- package/dist/services/facebook_ad_library/types.d.ts.map +1 -1
- package/dist/services/facebook_marketplace/types.d.ts +162 -170
- package/dist/services/facebook_marketplace/types.d.ts.map +1 -1
- 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 +3 -2
|
@@ -6,18 +6,18 @@ export type AdStatus = "active" | "inactive" | "all";
|
|
|
6
6
|
export type AdType = "all" | "political_and_issue" | "housing" | "employment" | "credit" | "financial_products_and_services" | "uncategorized";
|
|
7
7
|
export type AudiencePeriod = "last_7_days" | "last_30_days" | "last_90_days";
|
|
8
8
|
export interface ErrorDetail {
|
|
9
|
-
|
|
10
|
-
input?: unknown | null;
|
|
9
|
+
type?: string | null;
|
|
11
10
|
loc?: (string | number)[] | null;
|
|
12
11
|
msg?: string | null;
|
|
13
|
-
|
|
12
|
+
input?: unknown | null;
|
|
13
|
+
ctx?: Record<string, unknown> | null;
|
|
14
14
|
}
|
|
15
15
|
export interface ErrorResponse {
|
|
16
16
|
code: PublicError;
|
|
17
|
-
details?: ErrorDetail[] | null;
|
|
18
|
-
domain?: string | null;
|
|
19
17
|
message: string;
|
|
20
18
|
request_id: string;
|
|
19
|
+
domain?: string | null;
|
|
20
|
+
details?: ErrorDetail[] | null;
|
|
21
21
|
upgrade_url?: string | null;
|
|
22
22
|
}
|
|
23
23
|
export interface FacebookAd {
|
|
@@ -27,239 +27,238 @@ export interface FacebookAd {
|
|
|
27
27
|
export interface FacebookAdCard {
|
|
28
28
|
ad_archive_id: string | null;
|
|
29
29
|
ad_id: string | null;
|
|
30
|
-
|
|
30
|
+
text: FacebookAdText;
|
|
31
|
+
url: string | null;
|
|
32
|
+
page: FacebookPage;
|
|
33
|
+
regulation: FacebookAdRegulation;
|
|
31
34
|
collation: FacebookAdCollation;
|
|
35
|
+
categories: FacebookCode[];
|
|
36
|
+
disclaimer: FacebookAdDisclaimer;
|
|
32
37
|
creative: FacebookAdCreative;
|
|
38
|
+
performance: FacebookAdPerformance;
|
|
33
39
|
delivery: FacebookAdDelivery;
|
|
34
|
-
disclaimer: FacebookAdDisclaimer;
|
|
35
40
|
moderation: FacebookAdModeration;
|
|
36
|
-
page: FacebookPageRef;
|
|
37
|
-
performance: FacebookAdPerformance;
|
|
38
|
-
regulation: FacebookAdRegulation;
|
|
39
|
-
text: FacebookAdText;
|
|
40
41
|
}
|
|
41
42
|
export interface FacebookAdCarouselCard {
|
|
43
|
+
title: string | null;
|
|
42
44
|
body: string | null;
|
|
43
45
|
caption: string | null;
|
|
44
|
-
cta_type: FacebookCode;
|
|
45
|
-
image: FacebookAdImage | null;
|
|
46
46
|
link_description: string | null;
|
|
47
47
|
link_url: string | null;
|
|
48
|
-
|
|
48
|
+
cta_type: FacebookCode;
|
|
49
|
+
image: FacebookAdImage | null;
|
|
49
50
|
video: FacebookAdVideo | null;
|
|
50
51
|
}
|
|
51
52
|
export interface FacebookAdCollation {
|
|
52
|
-
count: number | null;
|
|
53
53
|
id: string | null;
|
|
54
|
+
count: number | null;
|
|
54
55
|
}
|
|
55
56
|
export interface FacebookAdCreative {
|
|
56
|
-
|
|
57
|
-
cards: FacebookAdCarouselCard[];
|
|
58
|
-
cta_type: FacebookCode;
|
|
59
|
-
display_format: FacebookCode;
|
|
60
|
-
event: unknown | null;
|
|
61
|
-
extra_images: FacebookAdImage[];
|
|
57
|
+
link_url: string | null;
|
|
62
58
|
extra_links: string[];
|
|
63
|
-
|
|
64
|
-
|
|
59
|
+
branded_content: FacebookPage | null;
|
|
60
|
+
display_format: FacebookCode;
|
|
61
|
+
cta_type: FacebookCode;
|
|
62
|
+
cards: FacebookAdCarouselCard[];
|
|
65
63
|
is_reshared: boolean | null;
|
|
66
|
-
link_url: string | null;
|
|
67
64
|
root_reshared_post: unknown | null;
|
|
65
|
+
event: unknown | null;
|
|
66
|
+
images: FacebookAdImage[];
|
|
67
|
+
extra_images: FacebookAdImage[];
|
|
68
68
|
videos: FacebookAdVideo[];
|
|
69
|
+
extra_videos: FacebookAdVideo[];
|
|
69
70
|
}
|
|
70
71
|
export interface FacebookAdDelivery {
|
|
71
|
-
|
|
72
|
+
total_active_seconds: number | null;
|
|
72
73
|
is_active: boolean | null;
|
|
74
|
+
start_at: string | null;
|
|
75
|
+
end_at: string | null;
|
|
73
76
|
last_seen_at: string | null;
|
|
74
77
|
publisher_platforms: FacebookCode[];
|
|
75
|
-
start_at: string | null;
|
|
76
78
|
targeted_or_reached_countries: string[];
|
|
77
|
-
total_active_seconds: number | null;
|
|
78
79
|
}
|
|
79
80
|
export interface FacebookAdDisclaimer {
|
|
80
|
-
paid_for_by: string | null;
|
|
81
81
|
type: FacebookCode;
|
|
82
|
+
paid_for_by: string | null;
|
|
82
83
|
verification: FacebookAdDisclaimerVerification | null;
|
|
83
84
|
}
|
|
84
85
|
export interface FacebookAdDisclaimerVerification {
|
|
85
|
-
address: string | null;
|
|
86
|
-
email: string | null;
|
|
87
|
-
fec_info: string | null;
|
|
88
|
-
free_form_info: string | null;
|
|
89
86
|
help_text: string | null;
|
|
90
87
|
help_url: string | null;
|
|
88
|
+
website: string | null;
|
|
91
89
|
method: string | null;
|
|
90
|
+
submitted_on: string | null;
|
|
91
|
+
phone: string | null;
|
|
92
|
+
email: string | null;
|
|
93
|
+
address: string | null;
|
|
92
94
|
page_admin_info: string | null;
|
|
95
|
+
free_form_info: string | null;
|
|
93
96
|
page_name_info: string | null;
|
|
94
|
-
|
|
95
|
-
submitted_on: string | null;
|
|
96
|
-
website: string | null;
|
|
97
|
+
fec_info: string | null;
|
|
97
98
|
}
|
|
98
99
|
export interface FacebookAdImage {
|
|
99
|
-
crops: unknown[];
|
|
100
100
|
original_url: string | null;
|
|
101
101
|
resized_url: string | null;
|
|
102
102
|
watermarked_resized_url: string | null;
|
|
103
|
+
crops: unknown[];
|
|
103
104
|
}
|
|
104
105
|
export interface FacebookAdModeration {
|
|
105
|
-
|
|
106
|
-
contains_sensitive_content: boolean | null;
|
|
107
|
-
gated_type: FacebookCode;
|
|
108
|
-
has_user_reported: boolean | null;
|
|
106
|
+
report_count: number | null;
|
|
109
107
|
hide_data_status: FacebookCode;
|
|
108
|
+
gated_type: FacebookCode;
|
|
110
109
|
is_eligible_for_beneficiary_payer_disclosure: boolean | null;
|
|
111
|
-
|
|
112
|
-
report_count: number | null;
|
|
110
|
+
contains_sensitive_content: boolean | null;
|
|
113
111
|
state_media_label: string | null;
|
|
112
|
+
contains_digital_created_media: boolean | null;
|
|
114
113
|
}
|
|
115
114
|
export interface FacebookAdParty {
|
|
116
|
-
license_info: string | null;
|
|
117
|
-
license_info_list: string[];
|
|
118
|
-
location: string | null;
|
|
119
115
|
name: string | null;
|
|
120
116
|
website: string | null;
|
|
117
|
+
location: string | null;
|
|
118
|
+
license_info: string | null;
|
|
119
|
+
license_info_list: string[];
|
|
121
120
|
}
|
|
122
121
|
export interface FacebookAdPerformance {
|
|
122
|
+
spend: FacebookMoneyRange | null;
|
|
123
123
|
impressions: FacebookCountRange | null;
|
|
124
|
-
impressions_bucket: number | null;
|
|
125
124
|
reach: FacebookCountRange | null;
|
|
126
|
-
|
|
125
|
+
impressions_bucket: number | null;
|
|
127
126
|
}
|
|
128
127
|
export interface FacebookAdRegulation {
|
|
129
|
-
additional_info: unknown | null;
|
|
130
128
|
brazil_tax_id: string | null;
|
|
131
|
-
|
|
132
|
-
eu_certificates: unknown[];
|
|
129
|
+
is_financial_services_ad: boolean | null;
|
|
133
130
|
has_limited_financial_delivery: boolean | null;
|
|
134
131
|
has_limited_taiwan_anti_scam_delivery: boolean | null;
|
|
135
|
-
|
|
132
|
+
country_iso_code: string | null;
|
|
133
|
+
eu_certificates: unknown[];
|
|
134
|
+
additional_info: unknown | null;
|
|
136
135
|
}
|
|
137
136
|
export interface FacebookAdReport {
|
|
137
|
+
locations: FacebookReportLocation[];
|
|
138
138
|
advertisers: FacebookReportAdvertisers;
|
|
139
|
-
country: string;
|
|
140
|
-
date: string;
|
|
141
139
|
downloads: FacebookReportDownload[];
|
|
142
140
|
lifetime: FacebookReportLifetime;
|
|
143
|
-
|
|
141
|
+
country: string;
|
|
142
|
+
date: string;
|
|
144
143
|
period: string;
|
|
145
|
-
service_status: FacebookServiceStatus;
|
|
146
144
|
supported_countries: string[];
|
|
145
|
+
service_status: FacebookServiceStatus;
|
|
147
146
|
}
|
|
148
147
|
export interface FacebookAdReportAdvertisersPage {
|
|
149
148
|
advertisers: FacebookReportAdvertiser[];
|
|
149
|
+
total_count: number | null;
|
|
150
150
|
country: string;
|
|
151
151
|
date: string;
|
|
152
|
-
pagination: FacebookCursorPagination;
|
|
153
152
|
period: string;
|
|
154
|
-
|
|
153
|
+
pagination: FacebookCursorPagination;
|
|
155
154
|
}
|
|
156
155
|
export interface FacebookAdSearchPage {
|
|
157
156
|
ads: FacebookAdCard[];
|
|
158
157
|
pagination: FacebookCursorPagination;
|
|
159
158
|
}
|
|
160
159
|
export interface FacebookAdText {
|
|
160
|
+
title: string | null;
|
|
161
161
|
body: string | null;
|
|
162
162
|
caption: string | null;
|
|
163
|
-
extra_texts: string[];
|
|
164
163
|
link_description: string | null;
|
|
165
|
-
|
|
164
|
+
extra_texts: string[];
|
|
166
165
|
}
|
|
167
166
|
export interface FacebookAdTransparency {
|
|
168
167
|
ad_archive_id: string;
|
|
169
|
-
brazil: unknown | null;
|
|
170
|
-
eu: FacebookRegionTransparency | null;
|
|
171
|
-
financial_services: FacebookFinancialServicesDisclosure[];
|
|
172
|
-
payer_beneficiary: FacebookPayerBeneficiary[];
|
|
173
|
-
political_insights: FacebookPoliticalAdInsights;
|
|
174
168
|
status: FacebookAdTransparencyStatus;
|
|
169
|
+
payer_beneficiary: FacebookPayerBeneficiary[];
|
|
175
170
|
targets_eu: boolean | null;
|
|
171
|
+
eu: FacebookRegionTransparency | null;
|
|
176
172
|
uk: FacebookRegionTransparency | null;
|
|
173
|
+
brazil: unknown | null;
|
|
174
|
+
political_insights: FacebookPoliticalAdInsights;
|
|
175
|
+
financial_services: FacebookFinancialServicesDisclosure[];
|
|
177
176
|
verified_voice_types: FacebookCode[];
|
|
178
177
|
violation_types: string[];
|
|
179
178
|
}
|
|
180
179
|
export interface FacebookAdTransparencyStatus {
|
|
181
|
-
has_violating_payer_beneficiary: boolean | null;
|
|
182
180
|
is_ad_taken_down: boolean | null;
|
|
183
|
-
|
|
181
|
+
has_violating_payer_beneficiary: boolean | null;
|
|
184
182
|
violates_eu_political_ad_rules: boolean | null;
|
|
183
|
+
is_eligible_for_eu_political_ai_disclosure: boolean | null;
|
|
185
184
|
}
|
|
186
185
|
export interface FacebookAdVersionsPage {
|
|
187
|
-
ads: FacebookAdCard[];
|
|
188
186
|
collation_id: string;
|
|
189
|
-
pagination: FacebookCursorPagination;
|
|
190
187
|
total_count: number | null;
|
|
188
|
+
ads: FacebookAdCard[];
|
|
189
|
+
pagination: FacebookCursorPagination;
|
|
191
190
|
}
|
|
192
191
|
export interface FacebookAdVideo {
|
|
193
192
|
hd_url: string | null;
|
|
194
|
-
preview_image_url: string | null;
|
|
195
193
|
sd_url: string | null;
|
|
196
194
|
watermarked_hd_url: string | null;
|
|
197
195
|
watermarked_sd_url: string | null;
|
|
196
|
+
preview_image_url: string | null;
|
|
198
197
|
}
|
|
199
198
|
export interface FacebookAdminCountry {
|
|
199
|
+
country_page_id: string | null;
|
|
200
200
|
admin_count: number | null;
|
|
201
201
|
country: string | null;
|
|
202
|
-
country_page_id: string | null;
|
|
203
202
|
}
|
|
204
203
|
export interface FacebookAdvertiser {
|
|
205
|
-
|
|
204
|
+
transparency_node_id: string | null;
|
|
205
|
+
spend: FacebookAdvertiserSpend;
|
|
206
|
+
status: FacebookAdvertiserStatus;
|
|
207
|
+
service_status: FacebookServiceStatus;
|
|
208
|
+
page: FacebookPage;
|
|
209
|
+
owner: FacebookAdvertiserOwner;
|
|
206
210
|
admin_countries: FacebookAdminCountry[];
|
|
207
211
|
ads: FacebookAdvertiserAds;
|
|
208
212
|
alias: string | null;
|
|
213
|
+
about: string | null;
|
|
209
214
|
history: FacebookPageHistoryEvent[];
|
|
210
|
-
is_delegate_page_with_linked_primary_profile: boolean | null;
|
|
211
|
-
owner: FacebookAdvertiserOwner;
|
|
212
|
-
page: FacebookPageRef;
|
|
213
|
-
related_pages: unknown[];
|
|
214
|
-
service_status: FacebookServiceStatus;
|
|
215
215
|
shared_disclaimer_pages: unknown[];
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
status: FacebookAdvertiserStatus;
|
|
216
|
+
related_pages: unknown[];
|
|
217
|
+
is_delegate_page_with_linked_primary_profile: boolean | null;
|
|
219
218
|
supported_countries: string[];
|
|
220
|
-
|
|
219
|
+
state_media_label: string | null;
|
|
221
220
|
}
|
|
222
221
|
export interface FacebookAdvertiserAds {
|
|
222
|
+
total_count: number | null;
|
|
223
|
+
hidden_ad_count: number | null;
|
|
223
224
|
first_page: FacebookAdCard[];
|
|
224
225
|
has_blank_ads: boolean | null;
|
|
225
|
-
hidden_ad_count: number | null;
|
|
226
|
-
total_count: number | null;
|
|
227
226
|
}
|
|
228
227
|
export interface FacebookAdvertiserAudience {
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
228
|
+
page_id: string;
|
|
229
|
+
summary: FacebookAudienceSummary;
|
|
230
|
+
locations: FacebookAudienceSlice[];
|
|
231
|
+
page_name: string | null;
|
|
232
232
|
gender: FacebookAudienceSlice[];
|
|
233
|
-
|
|
234
|
-
has_political_ads_in_period: boolean | null;
|
|
233
|
+
age: FacebookAudienceSlice[];
|
|
235
234
|
languages: FacebookAudienceSlice[];
|
|
236
|
-
|
|
235
|
+
custom_audiences: FacebookAudienceSlice[];
|
|
237
236
|
lookalike_audiences: FacebookAudienceSlice[];
|
|
238
|
-
|
|
239
|
-
page_name: string | null;
|
|
237
|
+
detailed_targeting: FacebookAudienceSlice[];
|
|
240
238
|
period: string;
|
|
241
|
-
|
|
239
|
+
has_political_ads_in_period: boolean | null;
|
|
240
|
+
has_political_ads_ever: boolean | null;
|
|
242
241
|
}
|
|
243
242
|
export interface FacebookAdvertiserOwner {
|
|
244
|
-
address: string | null;
|
|
245
243
|
business_id: string | null;
|
|
246
244
|
name: string | null;
|
|
245
|
+
address: string | null;
|
|
247
246
|
phone: string | null;
|
|
248
247
|
}
|
|
249
248
|
export interface FacebookAdvertiserSpend {
|
|
250
249
|
current_week: unknown | null;
|
|
251
|
-
is_political_page?: boolean | null;
|
|
252
250
|
lifetime_by_disclaimer: FacebookDisclaimerSpend[];
|
|
253
251
|
weekly_by_disclaimer: FacebookDisclaimerSpend[];
|
|
252
|
+
is_political_page?: boolean | null;
|
|
254
253
|
}
|
|
255
254
|
export interface FacebookAdvertiserStatus {
|
|
256
|
-
is_actioned: boolean | null;
|
|
257
255
|
is_deleted: boolean | null;
|
|
256
|
+
is_actioned: boolean | null;
|
|
258
257
|
}
|
|
259
258
|
export interface FacebookAdvertiserSuggestion {
|
|
259
|
+
page: FacebookPage;
|
|
260
260
|
alias: string | null;
|
|
261
261
|
country: string | null;
|
|
262
|
-
page: FacebookPageRef;
|
|
263
262
|
}
|
|
264
263
|
export interface FacebookAdvertiserSuggestions {
|
|
265
264
|
advertisers: FacebookAdvertiserSuggestion[];
|
|
@@ -275,60 +274,77 @@ export interface FacebookAgeGenderShare {
|
|
|
275
274
|
unknown_share: number | null;
|
|
276
275
|
}
|
|
277
276
|
export interface FacebookAgeRange {
|
|
278
|
-
max: number | null;
|
|
279
277
|
min: number | null;
|
|
278
|
+
max: number | null;
|
|
280
279
|
}
|
|
281
280
|
export interface FacebookAudienceLocation {
|
|
282
|
-
hidden_location_count: number | null;
|
|
283
|
-
is_excluded: boolean | null;
|
|
284
281
|
name: string | null;
|
|
282
|
+
hidden_location_count: number | null;
|
|
285
283
|
type: FacebookCode;
|
|
284
|
+
is_excluded: boolean | null;
|
|
286
285
|
}
|
|
287
286
|
export interface FacebookAudienceSlice {
|
|
288
287
|
ad_count: number | null;
|
|
289
|
-
country?: string | null;
|
|
290
288
|
hidden_location_count?: number | null;
|
|
291
|
-
|
|
292
|
-
place_name?: string | null;
|
|
289
|
+
value: string | null;
|
|
293
290
|
spend_fraction: number | null;
|
|
294
291
|
type?: FacebookCode;
|
|
295
|
-
|
|
292
|
+
place_name?: string | null;
|
|
293
|
+
country?: string | null;
|
|
294
|
+
is_excluded?: boolean | null;
|
|
296
295
|
}
|
|
297
296
|
export interface FacebookAudienceSummary {
|
|
298
|
-
|
|
299
|
-
|
|
297
|
+
total_spend: FacebookMoney;
|
|
298
|
+
total_ads: number | null;
|
|
300
299
|
is_30_day_available: boolean | null;
|
|
301
300
|
is_90_day_available: boolean | null;
|
|
302
|
-
|
|
303
|
-
|
|
301
|
+
date: string | null;
|
|
302
|
+
detailed_spend: unknown[];
|
|
304
303
|
}
|
|
305
304
|
export interface FacebookCode {
|
|
306
305
|
code: string | null;
|
|
307
306
|
label: string | null;
|
|
308
307
|
}
|
|
309
308
|
export interface FacebookCountRange {
|
|
310
|
-
formatted: string | null;
|
|
311
|
-
max: number | null;
|
|
312
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;
|
|
313
320
|
}
|
|
314
321
|
export interface FacebookCursorPagination {
|
|
315
|
-
has_more: boolean | null;
|
|
316
322
|
next_cursor: string | null;
|
|
323
|
+
has_more: boolean | null;
|
|
317
324
|
}
|
|
318
325
|
export interface FacebookDisclaimerSpend {
|
|
319
|
-
paid_for_by: string | null;
|
|
320
326
|
spend: FacebookMoney;
|
|
327
|
+
paid_for_by: string | null;
|
|
321
328
|
}
|
|
322
329
|
export interface FacebookFinancialServicesDisclosure {
|
|
323
|
-
|
|
330
|
+
region: FacebookCode;
|
|
324
331
|
is_payer_beneficiary_same: boolean | null;
|
|
325
332
|
payer: FacebookAdParty;
|
|
326
|
-
|
|
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;
|
|
327
343
|
}
|
|
328
344
|
export interface FacebookInstagramAccount {
|
|
345
|
+
username: string | null;
|
|
329
346
|
follower_count: number | null;
|
|
330
347
|
is_verified: boolean | null;
|
|
331
|
-
username: string | null;
|
|
332
348
|
}
|
|
333
349
|
export interface FacebookMoney {
|
|
334
350
|
amount: number | null;
|
|
@@ -336,100 +352,161 @@ export interface FacebookMoney {
|
|
|
336
352
|
formatted: string | null;
|
|
337
353
|
}
|
|
338
354
|
export interface FacebookMoneyRange {
|
|
355
|
+
min: number | null;
|
|
356
|
+
max: number | null;
|
|
339
357
|
currency: string | null;
|
|
340
358
|
formatted: string | null;
|
|
341
|
-
|
|
342
|
-
|
|
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;
|
|
343
389
|
}
|
|
344
390
|
export interface FacebookPageHistoryEvent {
|
|
345
391
|
at: string | null;
|
|
346
392
|
type: FacebookCode;
|
|
347
393
|
}
|
|
348
|
-
export interface
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
394
|
+
export interface FacebookPageLegal {
|
|
395
|
+
dsa_reporting_url: string | null;
|
|
396
|
+
dsa_report_entrypoint: string | null;
|
|
397
|
+
is_dsa_legal_reporting_enabled: boolean | null;
|
|
352
398
|
}
|
|
353
|
-
export interface
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
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;
|
|
359
419
|
name: string | null;
|
|
360
|
-
page_id: string | null;
|
|
361
|
-
profile_id: string | null;
|
|
362
|
-
profile_picture_url: string | null;
|
|
363
420
|
url: string | null;
|
|
364
|
-
|
|
365
|
-
|
|
421
|
+
displayable_count: number | null;
|
|
422
|
+
collections: FacebookPageCollectionLink[];
|
|
423
|
+
section_type: FacebookCode;
|
|
366
424
|
}
|
|
367
425
|
export interface FacebookPayerBeneficiary {
|
|
368
|
-
beneficiary: string | null;
|
|
369
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;
|
|
370
442
|
}
|
|
371
443
|
export interface FacebookPoliticalAdInsights {
|
|
372
|
-
age_gender: FacebookAgeGenderShare[];
|
|
373
444
|
country: string | null;
|
|
374
445
|
is_currency_matched: boolean | null;
|
|
446
|
+
age_gender: FacebookAgeGenderShare[];
|
|
375
447
|
regions: FacebookRegionShare[];
|
|
376
448
|
}
|
|
377
449
|
export interface FacebookReachByAgeGender {
|
|
378
|
-
age_range: string | null;
|
|
379
450
|
country: string | null;
|
|
380
|
-
|
|
451
|
+
age_range: string | null;
|
|
381
452
|
male: number | null;
|
|
453
|
+
female: number | null;
|
|
382
454
|
unknown: number | null;
|
|
383
455
|
}
|
|
384
456
|
export interface FacebookRegionShare {
|
|
385
|
-
reach_share: number | null;
|
|
386
457
|
region: string | null;
|
|
458
|
+
reach_share: number | null;
|
|
387
459
|
}
|
|
388
460
|
export interface FacebookRegionTransparency {
|
|
461
|
+
total_reach: number | null;
|
|
462
|
+
locations: FacebookAudienceLocation[];
|
|
389
463
|
age: FacebookAgeRange;
|
|
390
464
|
gender: FacebookCode;
|
|
391
|
-
locations: FacebookAudienceLocation[];
|
|
392
465
|
reach_by_country_age_gender: FacebookReachByAgeGender[];
|
|
393
|
-
total_reach: number | null;
|
|
394
466
|
}
|
|
395
467
|
export interface FacebookReportAdvertiser {
|
|
396
|
-
detailed_spends: FacebookMoney[];
|
|
397
|
-
page: FacebookPageRef;
|
|
398
|
-
paid_for_by: string | null;
|
|
399
468
|
report_row_id: string | null;
|
|
400
|
-
show_detailed_spends: boolean | null;
|
|
401
|
-
total_ads: number | null;
|
|
402
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[];
|
|
403
475
|
}
|
|
404
476
|
export interface FacebookReportAdvertisers {
|
|
477
|
+
total_count: number | null;
|
|
405
478
|
items: FacebookReportAdvertiser[];
|
|
406
479
|
pagination: FacebookCursorPagination;
|
|
407
|
-
total_count: number | null;
|
|
408
480
|
}
|
|
409
481
|
export interface FacebookReportDownload {
|
|
410
|
-
date: string | null;
|
|
411
482
|
is_available: boolean | null;
|
|
483
|
+
date: string | null;
|
|
412
484
|
period: FacebookCode;
|
|
413
485
|
}
|
|
414
486
|
export interface FacebookReportLifetime {
|
|
415
|
-
top_keywords: string[];
|
|
416
487
|
total_ads: number | null;
|
|
417
488
|
total_spend: FacebookMoney;
|
|
489
|
+
top_keywords: string[];
|
|
418
490
|
}
|
|
419
491
|
export interface FacebookReportLocation {
|
|
420
|
-
detailed_spends: FacebookMoney[];
|
|
421
492
|
name: string | null;
|
|
422
|
-
show_detailed_spends: boolean | null;
|
|
423
493
|
total_spend: FacebookMoney;
|
|
494
|
+
show_detailed_spends: boolean | null;
|
|
495
|
+
detailed_spends: FacebookMoney[];
|
|
424
496
|
}
|
|
425
497
|
export interface FacebookServiceIssue {
|
|
426
|
-
product: string | null;
|
|
427
498
|
status: string | null;
|
|
499
|
+
product: string | null;
|
|
428
500
|
}
|
|
429
501
|
export interface FacebookServiceStatus {
|
|
430
|
-
is_captcha_required: boolean | null;
|
|
431
|
-
issues: FacebookServiceIssue[];
|
|
432
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;
|
|
433
510
|
}
|
|
434
511
|
export interface GetAdParams {
|
|
435
512
|
/** The ad's `ad_archive_id`. */
|
|
@@ -438,20 +515,20 @@ export interface GetAdParams {
|
|
|
438
515
|
country?: string;
|
|
439
516
|
}
|
|
440
517
|
export interface GetAdReportParams {
|
|
441
|
-
/** ISO 3166-1 alpha-2 country, upper case
|
|
518
|
+
/** ISO 3166-1 alpha-2 country, upper case. */
|
|
442
519
|
country?: string;
|
|
443
|
-
/** Report day; defaults to the newest published day, two days ago. */
|
|
444
|
-
date?: string | null;
|
|
445
520
|
/** Time window; a report Facebook is still building answers 503 with `Retry-After`. */
|
|
446
521
|
period?: ReportPeriod;
|
|
522
|
+
/** Report day; defaults to the newest published day, two days ago. */
|
|
523
|
+
date?: string | null;
|
|
447
524
|
}
|
|
448
525
|
export interface GetAdTransparencyParams {
|
|
449
526
|
/** The ad's `ad_archive_id`. */
|
|
450
527
|
ad_id: string;
|
|
451
|
-
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
452
|
-
country?: string;
|
|
453
528
|
/** The ad's `page.page_id`; Facebook needs a page id but answers the same for any valid one. */
|
|
454
529
|
page_id: string;
|
|
530
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
531
|
+
country?: string;
|
|
455
532
|
}
|
|
456
533
|
export interface GetAdvertiserAudienceParams {
|
|
457
534
|
/** The advertiser's `page_id`: `page.page_id` of an ad or `advertisers[].page.page_id` from `/ad-library/advertisers/search`. */
|
|
@@ -460,24 +537,24 @@ export interface GetAdvertiserAudienceParams {
|
|
|
460
537
|
period?: AudiencePeriod;
|
|
461
538
|
}
|
|
462
539
|
export interface GetAdvertiserParams {
|
|
463
|
-
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
464
|
-
country?: string;
|
|
465
540
|
/** The advertiser's `page_id`: `page.page_id` of an ad or `advertisers[].page.page_id` from `/ad-library/advertisers/search`. */
|
|
466
541
|
page_id: string;
|
|
542
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
543
|
+
country?: string;
|
|
467
544
|
}
|
|
468
545
|
export interface ListAdReportAdvertisersParams {
|
|
469
|
-
/** ISO 3166-1 alpha-2 country, upper case
|
|
546
|
+
/** ISO 3166-1 alpha-2 country, upper case. */
|
|
470
547
|
country?: string;
|
|
471
|
-
/** `pagination.next_cursor` from the previous page; empty for the first page. */
|
|
472
|
-
cursor?: string;
|
|
473
|
-
/** Report day; defaults to the newest published day, two days ago. */
|
|
474
|
-
date?: string | null;
|
|
475
548
|
/** Time window. */
|
|
476
549
|
period?: ReportPeriod;
|
|
477
550
|
/** Search text. */
|
|
478
551
|
query?: string | null;
|
|
479
552
|
/** Order by spend or by number of ads. */
|
|
480
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;
|
|
481
558
|
}
|
|
482
559
|
export interface ListAdVersionsParams {
|
|
483
560
|
/** `collation.id` of an ad. */
|
|
@@ -491,39 +568,39 @@ export type PublicError = "blocked" | "concurrency_exceeded" | "timeout" | "extr
|
|
|
491
568
|
export type ReportPeriod = "yesterday" | "last_7_days" | "last_30_days" | "last_90_days" | "lifelong";
|
|
492
569
|
export type ReportSort = "spend" | "ads";
|
|
493
570
|
export interface SearchAdsParams {
|
|
494
|
-
/** Ad category. */
|
|
495
|
-
ad_type?: AdType;
|
|
496
|
-
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
497
|
-
country?: string;
|
|
498
571
|
/** `pagination.next_cursor` from the previous page; empty for the first page. */
|
|
499
572
|
cursor?: string;
|
|
500
|
-
/**
|
|
501
|
-
|
|
502
|
-
/** Only ads
|
|
503
|
-
|
|
504
|
-
/** Only ads in these ISO 639-1 languages, such as `en`; repeat for several. */
|
|
505
|
-
languages?: 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;
|
|
506
577
|
/** Match any of the words or the exact phrase. */
|
|
507
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;
|
|
508
585
|
/** Creative format. */
|
|
509
586
|
media_type?: AdMediaType;
|
|
510
|
-
/** Only this advertiser's ads: `advertisers[].page.page_id` from `/ad-library/advertisers/search`. Send this or `query`. */
|
|
511
|
-
page_id?: string | null;
|
|
512
587
|
/** Only ads shown on these platforms; repeat the parameter for several. */
|
|
513
588
|
platforms?: AdPlatform[];
|
|
514
|
-
/**
|
|
515
|
-
|
|
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;
|
|
516
595
|
/** Result order. */
|
|
517
596
|
sort?: AdSort;
|
|
518
|
-
/** Running, stopped or both. */
|
|
519
|
-
status?: AdStatus;
|
|
520
597
|
}
|
|
521
598
|
export interface SearchAdvertisersParams {
|
|
522
|
-
/** Ad category. */
|
|
523
|
-
ad_type?: AdType;
|
|
524
|
-
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
525
|
-
country?: string;
|
|
526
599
|
/** Search text. */
|
|
527
600
|
query: string;
|
|
601
|
+
/** ISO 3166-1 alpha-2 country, upper case, or `ALL`. */
|
|
602
|
+
country?: string;
|
|
603
|
+
/** Ad category. */
|
|
604
|
+
ad_type?: AdType;
|
|
528
605
|
}
|
|
529
606
|
//# sourceMappingURL=types.d.ts.map
|