@ad-execute-manager/ad 2.0.0-alpha.4 → 2.0.2
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/LICENSE +21 -21
- package/README.md +380 -149
- package/dist/index.cjs +1 -2
- package/dist/index.d.ts +3 -4
- package/dist/index.js +1 -2
- package/package.json +8 -4
- package/dist/InterstitialAdFather.d.ts +0 -163
- package/dist/InterstitialAdNovel.d.ts +0 -461
- package/dist/RewardAdFather.d.ts +0 -181
- package/dist/RewardAdNovel.d.ts +0 -553
- package/dist/const/const.d.ts +0 -20
- package/dist/typings/ad.d.ts +0 -208
- package/dist/typings/common.d.ts +0 -14
- package/dist/typings/create-interstitial-ad.d.ts +0 -42
- package/dist/typings/create-rewarded-video-ad.d.ts +0 -42
- package/dist/typings/tracker.d.ts +0 -1
- package/dist/utils/functional.d.ts +0 -13
package/dist/typings/ad.d.ts
DELETED
|
@@ -1,208 +0,0 @@
|
|
|
1
|
-
export type IRewordAdConfig = {
|
|
2
|
-
/**
|
|
3
|
-
* 激励视频广告id - 必填
|
|
4
|
-
*/
|
|
5
|
-
adUnitId: string;
|
|
6
|
-
/**
|
|
7
|
-
* 是否开启进度提醒。开启时广告文案为「再看 n 个xxx」,关闭时为「再看 1 个xxx」。其中 n 表示用户当前还需额外观看广告的次数
|
|
8
|
-
*/
|
|
9
|
-
progressTip?: boolean | undefined;
|
|
10
|
-
/**
|
|
11
|
-
* - 再得广告的奖励文案,用户每看完一个广告都会展示,multiton 为 true 时必填。
|
|
12
|
-
* - 文案完整内容为「再看 1 个xxx」,其中 xxx 是 multitonRewardMsg 配置的文案内容,最大长度为 7,
|
|
13
|
-
* - 文案内容根据 multitonRewardMsg 的配置按顺序展示。若 multitonRewardMsg 长度小于 multitonRewardTimes ,
|
|
14
|
-
* - 则后续的激励再得广告文案取 multitonRewardMsg 数组最后一个。
|
|
15
|
-
*/
|
|
16
|
-
multitonRewardMsg?: Array<string> | undefined;
|
|
17
|
-
/**
|
|
18
|
-
* 是否开启激励再得广告
|
|
19
|
-
*/
|
|
20
|
-
multiton?: boolean | undefined;
|
|
21
|
-
/**
|
|
22
|
-
* 额外观看广告的次数,合法的数据范围为 1~4,multiton 为 true 时必填
|
|
23
|
-
*/
|
|
24
|
-
multitonRewardTimes?: number | undefined;
|
|
25
|
-
/**
|
|
26
|
-
* 场景值 - 自用参数,非tt API要求的参数
|
|
27
|
-
*/
|
|
28
|
-
scene?: number | undefined;
|
|
29
|
-
/**
|
|
30
|
-
* 广告超时时间 单位ms - 自用参数,非tt API要求的参数
|
|
31
|
-
*/
|
|
32
|
-
timeout?: number | undefined;
|
|
33
|
-
/**
|
|
34
|
-
* 重试次数 - 自用参数 ,非tt API要求的参数
|
|
35
|
-
*/
|
|
36
|
-
retry: number;
|
|
37
|
-
/**
|
|
38
|
-
* 是否绑定永远的错误事件 - 自用参数,非tt API要求的参数
|
|
39
|
-
*/
|
|
40
|
-
foreverErrorBind?: boolean | undefined;
|
|
41
|
-
};
|
|
42
|
-
export type InterstitialAdConfig = {
|
|
43
|
-
/**
|
|
44
|
-
* 单个广告单元的 id。可从「开放平台控制台-进入对应小程序-运营-商业化变现-广告管理」中获取 - 必填
|
|
45
|
-
*/
|
|
46
|
-
adUnitId: string;
|
|
47
|
-
/**
|
|
48
|
-
* 场景值 - 自用参数
|
|
49
|
-
*/
|
|
50
|
-
scene?: number | undefined;
|
|
51
|
-
};
|
|
52
|
-
export type IExeCallbackArgs = {
|
|
53
|
-
/**
|
|
54
|
-
* 广告执行场景
|
|
55
|
-
*/
|
|
56
|
-
scene: number;
|
|
57
|
-
/**
|
|
58
|
-
* 是否看完
|
|
59
|
-
*/
|
|
60
|
-
isEnded: boolean;
|
|
61
|
-
/**
|
|
62
|
-
* 完整观看次数
|
|
63
|
-
*/
|
|
64
|
-
count: number;
|
|
65
|
-
/**
|
|
66
|
-
* 剩余观看次数
|
|
67
|
-
*/
|
|
68
|
-
remain?: number;
|
|
69
|
-
};
|
|
70
|
-
export type CallbackCollection = {
|
|
71
|
-
/**
|
|
72
|
-
* 每次外部回调
|
|
73
|
-
*/
|
|
74
|
-
always?: (ctx?: IExeCallbackArgs) => void;
|
|
75
|
-
/**
|
|
76
|
-
* 完整看完广告外部回调 不管一个还是几个
|
|
77
|
-
*/
|
|
78
|
-
finished?: (ctx?: IExeCallbackArgs) => void;
|
|
79
|
-
/**
|
|
80
|
-
* 半途退出广告外部回调
|
|
81
|
-
*/
|
|
82
|
-
halfway?: (ctx?: IExeCallbackArgs) => void;
|
|
83
|
-
/**
|
|
84
|
-
* 完成广告外部回调 不管看不看完
|
|
85
|
-
*/
|
|
86
|
-
complete?: (ctx?: IExeCallbackArgs) => void;
|
|
87
|
-
/**
|
|
88
|
-
* 取消广告外部回调
|
|
89
|
-
*/
|
|
90
|
-
onCancel?: (ctx?: IExeCallbackArgs) => void;
|
|
91
|
-
/**
|
|
92
|
-
* 展示广告外部回调
|
|
93
|
-
*/
|
|
94
|
-
before?: (ctx?: IExeCallbackArgs) => void;
|
|
95
|
-
/**
|
|
96
|
-
* 展示广告成功外部回调
|
|
97
|
-
*/
|
|
98
|
-
success?: (ctx?: IExeCallbackArgs) => void;
|
|
99
|
-
/**
|
|
100
|
-
* 计时回调
|
|
101
|
-
*/
|
|
102
|
-
prelude?: (ctx?: unknown) => void;
|
|
103
|
-
};
|
|
104
|
-
export type RecoveredInfo = {
|
|
105
|
-
/**
|
|
106
|
-
* 恢复重试次数
|
|
107
|
-
*/
|
|
108
|
-
count: number;
|
|
109
|
-
/**
|
|
110
|
-
* 是否恢复重试
|
|
111
|
-
*/
|
|
112
|
-
retry: boolean;
|
|
113
|
-
/**
|
|
114
|
-
* 恢复重试原因
|
|
115
|
-
*/
|
|
116
|
-
message: string;
|
|
117
|
-
};
|
|
118
|
-
export type ICallbackArgs = {
|
|
119
|
-
/**
|
|
120
|
-
* 广告执行场景
|
|
121
|
-
*/
|
|
122
|
-
scene: number;
|
|
123
|
-
/**
|
|
124
|
-
* 是否看完
|
|
125
|
-
*/
|
|
126
|
-
isEnded: boolean;
|
|
127
|
-
/**
|
|
128
|
-
* 完整观看次数
|
|
129
|
-
*/
|
|
130
|
-
count: number;
|
|
131
|
-
/**
|
|
132
|
-
* 剩余观看次数
|
|
133
|
-
*/
|
|
134
|
-
remain?: number;
|
|
135
|
-
/**
|
|
136
|
-
* 执行下一个任务的回调函数,手动调用以继续执行流程[end]
|
|
137
|
-
*/
|
|
138
|
-
end?: () => void;
|
|
139
|
-
/**
|
|
140
|
-
* 执行下一个任务的回调函数, 手动调用以继续执行流程[circle]
|
|
141
|
-
*/
|
|
142
|
-
circle?: (args: {
|
|
143
|
-
ignoreRemain: boolean;
|
|
144
|
-
scene: number;
|
|
145
|
-
}) => void;
|
|
146
|
-
};
|
|
147
|
-
export type IConnection = {
|
|
148
|
-
/**
|
|
149
|
-
* 广告中途退出回调
|
|
150
|
-
*/
|
|
151
|
-
onHalfway?: (args: ICallbackArgs) => void;
|
|
152
|
-
/**
|
|
153
|
-
* 广告展示回调
|
|
154
|
-
*/
|
|
155
|
-
onShow?: (args: ICallbackArgs) => void;
|
|
156
|
-
/**
|
|
157
|
-
* 广告执行成功回调
|
|
158
|
-
*/
|
|
159
|
-
onFinish?: (args: ICallbackArgs) => void;
|
|
160
|
-
/**
|
|
161
|
-
* 广告执行失败回调
|
|
162
|
-
*/
|
|
163
|
-
onError?: (e: unknown) => void;
|
|
164
|
-
};
|
|
165
|
-
export type IConstructArgs = {
|
|
166
|
-
/**
|
|
167
|
-
* 初始化标识
|
|
168
|
-
*/
|
|
169
|
-
sign: string;
|
|
170
|
-
/**
|
|
171
|
-
* 是否开启日志
|
|
172
|
-
*/
|
|
173
|
-
log?: boolean | undefined;
|
|
174
|
-
/**
|
|
175
|
-
* 重试次数
|
|
176
|
-
*/
|
|
177
|
-
retry: number;
|
|
178
|
-
/**
|
|
179
|
-
* 是否保留tt激励视频广告实例
|
|
180
|
-
*/
|
|
181
|
-
preserveOnEnd: boolean;
|
|
182
|
-
/**
|
|
183
|
-
* 激励视频参数 (可选)
|
|
184
|
-
*/
|
|
185
|
-
adConfig?: IRewordAdConfig | undefined;
|
|
186
|
-
/**
|
|
187
|
-
* 回调集合
|
|
188
|
-
*/
|
|
189
|
-
collection?: IConnection | undefined;
|
|
190
|
-
};
|
|
191
|
-
/**
|
|
192
|
-
* 广告场景类型映射对象
|
|
193
|
-
*/
|
|
194
|
-
export type SceneTypeMap = {
|
|
195
|
-
readonly [x: number]: string;
|
|
196
|
-
};
|
|
197
|
-
/**
|
|
198
|
-
* 广告场景类型文本映射对象(反向映射)
|
|
199
|
-
*/
|
|
200
|
-
export type SceneTextMap = { readonly [K in SceneTypeMap[keyof SceneTypeMap]]: { [P in keyof SceneTypeMap]: SceneTypeMap[P] extends K ? P : never; }[keyof SceneTypeMap]; };
|
|
201
|
-
/**
|
|
202
|
-
* 场景值枚举 可持续添加
|
|
203
|
-
*/
|
|
204
|
-
export type RewardAdTriggerScene = keyof SceneTextMap;
|
|
205
|
-
/**
|
|
206
|
-
* 场景值枚举 可持续添加
|
|
207
|
-
*/
|
|
208
|
-
export type RewardAdTriggerSceneType = keyof SceneTypeMap;
|
package/dist/typings/common.d.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
export type IAdType = {
|
|
2
|
-
/**
|
|
3
|
-
* 激励视频
|
|
4
|
-
*/
|
|
5
|
-
AD_TYPE_REWARD: 1;
|
|
6
|
-
/**
|
|
7
|
-
* 插屏广告
|
|
8
|
-
*/
|
|
9
|
-
AD_TYPE_INTERSTITIAL: 2;
|
|
10
|
-
};
|
|
11
|
-
/**
|
|
12
|
-
* 广告场景类型文本映射对象(反向映射)
|
|
13
|
-
*/
|
|
14
|
-
export type IAdTypeReverse = { readonly [K in IAdType[keyof IAdType]]: { [P in keyof IAdType]: IAdType[P] extends K ? P : never; }[keyof IAdType]; };
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 回调函数类型
|
|
3
|
-
*/
|
|
4
|
-
export type Callback = () => any;
|
|
5
|
-
export type InterstitialAd = {
|
|
6
|
-
/**
|
|
7
|
-
* 广告创建后默认是隐藏的,可以通过该方法显示广告
|
|
8
|
-
*/
|
|
9
|
-
show: () => Promise<any>;
|
|
10
|
-
/**
|
|
11
|
-
* 当广告素材加载出现错误时,可以通过 load 方法手动加载
|
|
12
|
-
*/
|
|
13
|
-
load: () => Promise<any>;
|
|
14
|
-
/**
|
|
15
|
-
* 销毁广告实例
|
|
16
|
-
*/
|
|
17
|
-
destroy: () => void;
|
|
18
|
-
/**
|
|
19
|
-
* 绑定广告 load 事件的监听器
|
|
20
|
-
*/
|
|
21
|
-
onLoad: (arg0: Callback) => void;
|
|
22
|
-
/**
|
|
23
|
-
* 解除绑定 load 事件的监听器
|
|
24
|
-
*/
|
|
25
|
-
offLoad: (arg0: Callback) => void;
|
|
26
|
-
/**
|
|
27
|
-
* 绑定 error 事件的监听器
|
|
28
|
-
*/
|
|
29
|
-
onError: (arg0: Callback) => void;
|
|
30
|
-
/**
|
|
31
|
-
* 解除绑定 error 事件的监听器
|
|
32
|
-
*/
|
|
33
|
-
offError: (arg0: Callback) => void;
|
|
34
|
-
/**
|
|
35
|
-
* 绑定 close 事件的监听器
|
|
36
|
-
*/
|
|
37
|
-
onClose: (arg0: Callback) => void;
|
|
38
|
-
/**
|
|
39
|
-
* 解除绑定 close 事件的监听器
|
|
40
|
-
*/
|
|
41
|
-
offClose: (arg0: Callback) => void;
|
|
42
|
-
};
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 回调函数类型
|
|
3
|
-
*/
|
|
4
|
-
export type Callback = () => any;
|
|
5
|
-
export type RewardedVideoAd = {
|
|
6
|
-
/**
|
|
7
|
-
* 广告创建后默认是隐藏的,可以通过该方法显示广告
|
|
8
|
-
*/
|
|
9
|
-
show: () => Promise<any>;
|
|
10
|
-
/**
|
|
11
|
-
* 当广告素材加载出现错误时,可以通过 load 方法手动加载
|
|
12
|
-
*/
|
|
13
|
-
load: () => Promise<any>;
|
|
14
|
-
/**
|
|
15
|
-
* 销毁广告实例
|
|
16
|
-
*/
|
|
17
|
-
destroy: () => void;
|
|
18
|
-
/**
|
|
19
|
-
* 绑定广告 load 事件的监听器
|
|
20
|
-
*/
|
|
21
|
-
onLoad: (arg0: Callback) => void;
|
|
22
|
-
/**
|
|
23
|
-
* 解除绑定 load 事件的监听器
|
|
24
|
-
*/
|
|
25
|
-
offLoad: (arg0: Callback) => void;
|
|
26
|
-
/**
|
|
27
|
-
* 绑定 error 事件的监听器
|
|
28
|
-
*/
|
|
29
|
-
onError: (arg0: Callback) => void;
|
|
30
|
-
/**
|
|
31
|
-
* 解除绑定 error 事件的监听器
|
|
32
|
-
*/
|
|
33
|
-
offError: (arg0: Callback) => void;
|
|
34
|
-
/**
|
|
35
|
-
* 绑定 close 事件的监听器
|
|
36
|
-
*/
|
|
37
|
-
onClose: (arg0: Callback) => void;
|
|
38
|
-
/**
|
|
39
|
-
* 解除绑定 close 事件的监听器
|
|
40
|
-
*/
|
|
41
|
-
offClose: (arg0: Callback) => void;
|
|
42
|
-
};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
*
|
|
3
|
-
* @param {string[]} ttErrorMsgs
|
|
4
|
-
* @param {string[]} keyword
|
|
5
|
-
* @returns
|
|
6
|
-
*/
|
|
7
|
-
export function matchErrorWithKeywords(ttErrorMsgs: string[], keyword: string[]): boolean;
|
|
8
|
-
/**
|
|
9
|
-
* 广告场景类型映射对象
|
|
10
|
-
* @param {import('../typings/ad.js').SceneTypeMap} scentTypeObj
|
|
11
|
-
* @returns {import('../typings/ad.js').SceneTextMap}
|
|
12
|
-
*/
|
|
13
|
-
export function getAdSceneTextObj(scentTypeObj: import("../typings/ad.js").SceneTypeMap): import("../typings/ad.js").SceneTextMap;
|