@capawesome/capacitor-singular 0.0.1
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/CapawesomeCapacitorSingular.podspec +19 -0
- package/LICENSE +21 -0
- package/Package.swift +26 -0
- package/README.md +1262 -0
- package/android/build.gradle +61 -0
- package/android/src/main/AndroidManifest.xml +5 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/Singular.java +443 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/SingularHelper.java +53 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/SingularPlugin.java +336 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/CustomException.java +20 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/CustomExceptions.java +34 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/DeviceAttributionInfoReceivedEvent.java +48 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/SdidReceivedEvent.java +23 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/SdidSetEvent.java +23 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/SingularLinkResolvedEvent.java +44 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/CreateReferrerShortLinkOptions.java +61 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/InitializeOptions.java +168 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/SetCustomUserIdOptions.java +24 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/SetDeviceTokenOptions.java +24 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/SetGlobalPropertyOptions.java +44 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/SetLimitAdvertisingIdentifiersOptions.java +22 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/SetLimitDataSharingOptions.java +22 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/TrackAdRevenueOptions.java +157 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/TrackEventOptions.java +35 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/TrackRevenueOptions.java +56 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/UnsetGlobalPropertyOptions.java +24 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/results/CreateReferrerShortLinkResult.java +23 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/results/GetGlobalPropertiesResult.java +31 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/results/GetLimitDataSharingResult.java +22 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/results/IsAllTrackingStoppedResult.java +22 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/interfaces/Callback.java +5 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/interfaces/EmptyCallback.java +5 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/interfaces/NonEmptyResultCallback.java +7 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/interfaces/Result.java +7 -0
- package/android/src/main/res/.gitkeep +0 -0
- package/dist/docs.json +2014 -0
- package/dist/esm/definitions.d.ts +925 -0
- package/dist/esm/definitions.js +39 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/web.d.ts +27 -0
- package/dist/esm/web.js +73 -0
- package/dist/esm/web.js.map +1 -0
- package/dist/plugin.cjs.js +126 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +129 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Plugin/Classes/Events/DeviceAttributionInfoReceivedEvent.swift +43 -0
- package/ios/Plugin/Classes/Events/SdidReceivedEvent.swift +16 -0
- package/ios/Plugin/Classes/Events/SdidSetEvent.swift +16 -0
- package/ios/Plugin/Classes/Events/SingularLinkResolvedEvent.swift +28 -0
- package/ios/Plugin/Classes/Events/SkanConversionValueUpdatedEvent.swift +30 -0
- package/ios/Plugin/Classes/Options/CreateReferrerShortLinkOptions.swift +25 -0
- package/ios/Plugin/Classes/Options/InitializeOptions.swift +44 -0
- package/ios/Plugin/Classes/Options/SetCustomUserIdOptions.swift +13 -0
- package/ios/Plugin/Classes/Options/SetDeviceTokenOptions.swift +30 -0
- package/ios/Plugin/Classes/Options/SetGlobalPropertyOptions.swift +20 -0
- package/ios/Plugin/Classes/Options/SetLimitAdvertisingIdentifiersOptions.swift +13 -0
- package/ios/Plugin/Classes/Options/SetLimitDataSharingOptions.swift +13 -0
- package/ios/Plugin/Classes/Options/SkanUpdateConversionValueOptions.swift +27 -0
- package/ios/Plugin/Classes/Options/TrackAdRevenueOptions.swift +47 -0
- package/ios/Plugin/Classes/Options/TrackEventOptions.swift +15 -0
- package/ios/Plugin/Classes/Options/TrackRevenueOptions.swift +22 -0
- package/ios/Plugin/Classes/Options/UnsetGlobalPropertyOptions.swift +13 -0
- package/ios/Plugin/Classes/Results/CreateReferrerShortLinkResult.swift +16 -0
- package/ios/Plugin/Classes/Results/GetGlobalPropertiesResult.swift +16 -0
- package/ios/Plugin/Classes/Results/GetLimitDataSharingResult.swift +16 -0
- package/ios/Plugin/Classes/Results/IsAllTrackingStoppedResult.swift +16 -0
- package/ios/Plugin/Classes/Results/SkanGetConversionValueResult.swift +20 -0
- package/ios/Plugin/Enums/CustomError.swift +88 -0
- package/ios/Plugin/Enums/SkanCoarseConversionValue.swift +31 -0
- package/ios/Plugin/Info.plist +24 -0
- package/ios/Plugin/Protocols/Result.swift +6 -0
- package/ios/Plugin/Singular.swift +341 -0
- package/ios/Plugin/SingularHelper.swift +40 -0
- package/ios/Plugin/SingularPlugin.swift +340 -0
- package/package.json +102 -0
package/dist/docs.json
ADDED
|
@@ -0,0 +1,2014 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "SingularPlugin",
|
|
4
|
+
"slug": "singularplugin",
|
|
5
|
+
"docs": "",
|
|
6
|
+
"tags": [],
|
|
7
|
+
"methods": [
|
|
8
|
+
{
|
|
9
|
+
"name": "clearGlobalProperties",
|
|
10
|
+
"signature": "() => Promise<void>",
|
|
11
|
+
"parameters": [],
|
|
12
|
+
"returns": "Promise<void>",
|
|
13
|
+
"tags": [
|
|
14
|
+
{
|
|
15
|
+
"name": "since",
|
|
16
|
+
"text": "0.1.0"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"docs": "Remove all global properties.\n\nOnly available on Android and iOS.",
|
|
20
|
+
"complexTypes": [],
|
|
21
|
+
"slug": "clearglobalproperties"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "createReferrerShortLink",
|
|
25
|
+
"signature": "(options: CreateReferrerShortLinkOptions) => Promise<CreateReferrerShortLinkResult>",
|
|
26
|
+
"parameters": [
|
|
27
|
+
{
|
|
28
|
+
"name": "options",
|
|
29
|
+
"docs": "",
|
|
30
|
+
"type": "CreateReferrerShortLinkOptions"
|
|
31
|
+
}
|
|
32
|
+
],
|
|
33
|
+
"returns": "Promise<CreateReferrerShortLinkResult>",
|
|
34
|
+
"tags": [
|
|
35
|
+
{
|
|
36
|
+
"name": "since",
|
|
37
|
+
"text": "0.1.0"
|
|
38
|
+
}
|
|
39
|
+
],
|
|
40
|
+
"docs": "Create a short link that attributes installs to a referring user.\n\nThe short link expires after 30 days.\n\nOnly available on Android and iOS.",
|
|
41
|
+
"complexTypes": [
|
|
42
|
+
"CreateReferrerShortLinkResult",
|
|
43
|
+
"CreateReferrerShortLinkOptions"
|
|
44
|
+
],
|
|
45
|
+
"slug": "createreferrershortlink"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "getGlobalProperties",
|
|
49
|
+
"signature": "() => Promise<GetGlobalPropertiesResult>",
|
|
50
|
+
"parameters": [],
|
|
51
|
+
"returns": "Promise<GetGlobalPropertiesResult>",
|
|
52
|
+
"tags": [
|
|
53
|
+
{
|
|
54
|
+
"name": "since",
|
|
55
|
+
"text": "0.1.0"
|
|
56
|
+
}
|
|
57
|
+
],
|
|
58
|
+
"docs": "Get all global properties.\n\nOnly available on Android and iOS.",
|
|
59
|
+
"complexTypes": [
|
|
60
|
+
"GetGlobalPropertiesResult"
|
|
61
|
+
],
|
|
62
|
+
"slug": "getglobalproperties"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "getLimitDataSharing",
|
|
66
|
+
"signature": "() => Promise<GetLimitDataSharingResult>",
|
|
67
|
+
"parameters": [],
|
|
68
|
+
"returns": "Promise<GetLimitDataSharingResult>",
|
|
69
|
+
"tags": [
|
|
70
|
+
{
|
|
71
|
+
"name": "since",
|
|
72
|
+
"text": "0.1.0"
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
"docs": "Get whether data sharing is limited.\n\nOnly available on Android and iOS.",
|
|
76
|
+
"complexTypes": [
|
|
77
|
+
"GetLimitDataSharingResult"
|
|
78
|
+
],
|
|
79
|
+
"slug": "getlimitdatasharing"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"name": "initialize",
|
|
83
|
+
"signature": "(options: InitializeOptions) => Promise<void>",
|
|
84
|
+
"parameters": [
|
|
85
|
+
{
|
|
86
|
+
"name": "options",
|
|
87
|
+
"docs": "",
|
|
88
|
+
"type": "InitializeOptions"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"returns": "Promise<void>",
|
|
92
|
+
"tags": [
|
|
93
|
+
{
|
|
94
|
+
"name": "since",
|
|
95
|
+
"text": "0.1.0"
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"docs": "Initialize the Singular SDK and start the first session.\n\nThis method must be called before any other method.\nAdd your listeners before calling this method so that no\ndeferred deep link or attribution event is missed.\n\nOnly available on Android and iOS.",
|
|
99
|
+
"complexTypes": [
|
|
100
|
+
"InitializeOptions"
|
|
101
|
+
],
|
|
102
|
+
"slug": "initialize"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "isAllTrackingStopped",
|
|
106
|
+
"signature": "() => Promise<IsAllTrackingStoppedResult>",
|
|
107
|
+
"parameters": [],
|
|
108
|
+
"returns": "Promise<IsAllTrackingStoppedResult>",
|
|
109
|
+
"tags": [
|
|
110
|
+
{
|
|
111
|
+
"name": "since",
|
|
112
|
+
"text": "0.1.0"
|
|
113
|
+
}
|
|
114
|
+
],
|
|
115
|
+
"docs": "Get whether all tracking has been stopped via `stopAllTracking()`.\n\nOnly available on Android and iOS.",
|
|
116
|
+
"complexTypes": [
|
|
117
|
+
"IsAllTrackingStoppedResult"
|
|
118
|
+
],
|
|
119
|
+
"slug": "isalltrackingstopped"
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"name": "resumeAllTracking",
|
|
123
|
+
"signature": "() => Promise<void>",
|
|
124
|
+
"parameters": [],
|
|
125
|
+
"returns": "Promise<void>",
|
|
126
|
+
"tags": [
|
|
127
|
+
{
|
|
128
|
+
"name": "since",
|
|
129
|
+
"text": "0.1.0"
|
|
130
|
+
}
|
|
131
|
+
],
|
|
132
|
+
"docs": "Resume all tracking after it was stopped via `stopAllTracking()`.\n\nOnly available on Android and iOS.",
|
|
133
|
+
"complexTypes": [],
|
|
134
|
+
"slug": "resumealltracking"
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"name": "setCustomUserId",
|
|
138
|
+
"signature": "(options: SetCustomUserIdOptions) => Promise<void>",
|
|
139
|
+
"parameters": [
|
|
140
|
+
{
|
|
141
|
+
"name": "options",
|
|
142
|
+
"docs": "",
|
|
143
|
+
"type": "SetCustomUserIdOptions"
|
|
144
|
+
}
|
|
145
|
+
],
|
|
146
|
+
"returns": "Promise<void>",
|
|
147
|
+
"tags": [
|
|
148
|
+
{
|
|
149
|
+
"name": "since",
|
|
150
|
+
"text": "0.1.0"
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"docs": "Set the custom user ID that is attached to all sessions and events.\n\nOnly available on Android and iOS.",
|
|
154
|
+
"complexTypes": [
|
|
155
|
+
"SetCustomUserIdOptions"
|
|
156
|
+
],
|
|
157
|
+
"slug": "setcustomuserid"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "setDeviceToken",
|
|
161
|
+
"signature": "(options: SetDeviceTokenOptions) => Promise<void>",
|
|
162
|
+
"parameters": [
|
|
163
|
+
{
|
|
164
|
+
"name": "options",
|
|
165
|
+
"docs": "",
|
|
166
|
+
"type": "SetDeviceTokenOptions"
|
|
167
|
+
}
|
|
168
|
+
],
|
|
169
|
+
"returns": "Promise<void>",
|
|
170
|
+
"tags": [
|
|
171
|
+
{
|
|
172
|
+
"name": "since",
|
|
173
|
+
"text": "0.1.0"
|
|
174
|
+
}
|
|
175
|
+
],
|
|
176
|
+
"docs": "Set the push notification device token used for uninstall tracking.\n\nOnly available on Android and iOS.",
|
|
177
|
+
"complexTypes": [
|
|
178
|
+
"SetDeviceTokenOptions"
|
|
179
|
+
],
|
|
180
|
+
"slug": "setdevicetoken"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "setGlobalProperty",
|
|
184
|
+
"signature": "(options: SetGlobalPropertyOptions) => Promise<void>",
|
|
185
|
+
"parameters": [
|
|
186
|
+
{
|
|
187
|
+
"name": "options",
|
|
188
|
+
"docs": "",
|
|
189
|
+
"type": "SetGlobalPropertyOptions"
|
|
190
|
+
}
|
|
191
|
+
],
|
|
192
|
+
"returns": "Promise<void>",
|
|
193
|
+
"tags": [
|
|
194
|
+
{
|
|
195
|
+
"name": "since",
|
|
196
|
+
"text": "0.1.0"
|
|
197
|
+
}
|
|
198
|
+
],
|
|
199
|
+
"docs": "Set a global property that is attached to all events.\n\nAt most 5 global properties can be set.\nThe call is rejected if the property could not be set.\n\nOnly available on Android and iOS.",
|
|
200
|
+
"complexTypes": [
|
|
201
|
+
"SetGlobalPropertyOptions"
|
|
202
|
+
],
|
|
203
|
+
"slug": "setglobalproperty"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "setLimitAdvertisingIdentifiers",
|
|
207
|
+
"signature": "(options: SetLimitAdvertisingIdentifiersOptions) => Promise<void>",
|
|
208
|
+
"parameters": [
|
|
209
|
+
{
|
|
210
|
+
"name": "options",
|
|
211
|
+
"docs": "",
|
|
212
|
+
"type": "SetLimitAdvertisingIdentifiersOptions"
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"returns": "Promise<void>",
|
|
216
|
+
"tags": [
|
|
217
|
+
{
|
|
218
|
+
"name": "since",
|
|
219
|
+
"text": "0.1.0"
|
|
220
|
+
}
|
|
221
|
+
],
|
|
222
|
+
"docs": "Set whether the SDK is allowed to collect advertising identifiers\n(e.g. the Google Advertising ID or the IDFA).\n\nOnly available on Android and iOS.",
|
|
223
|
+
"complexTypes": [
|
|
224
|
+
"SetLimitAdvertisingIdentifiersOptions"
|
|
225
|
+
],
|
|
226
|
+
"slug": "setlimitadvertisingidentifiers"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"name": "setLimitDataSharing",
|
|
230
|
+
"signature": "(options: SetLimitDataSharingOptions) => Promise<void>",
|
|
231
|
+
"parameters": [
|
|
232
|
+
{
|
|
233
|
+
"name": "options",
|
|
234
|
+
"docs": "",
|
|
235
|
+
"type": "SetLimitDataSharingOptions"
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"returns": "Promise<void>",
|
|
239
|
+
"tags": [
|
|
240
|
+
{
|
|
241
|
+
"name": "since",
|
|
242
|
+
"text": "0.1.0"
|
|
243
|
+
}
|
|
244
|
+
],
|
|
245
|
+
"docs": "Set whether data sharing with third parties is limited\n(e.g. after the user opted out under CCPA).\n\nOnly available on Android and iOS.",
|
|
246
|
+
"complexTypes": [
|
|
247
|
+
"SetLimitDataSharingOptions"
|
|
248
|
+
],
|
|
249
|
+
"slug": "setlimitdatasharing"
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
"name": "skanGetConversionValue",
|
|
253
|
+
"signature": "() => Promise<SkanGetConversionValueResult>",
|
|
254
|
+
"parameters": [],
|
|
255
|
+
"returns": "Promise<SkanGetConversionValueResult>",
|
|
256
|
+
"tags": [
|
|
257
|
+
{
|
|
258
|
+
"name": "since",
|
|
259
|
+
"text": "0.1.0"
|
|
260
|
+
}
|
|
261
|
+
],
|
|
262
|
+
"docs": "Get the current SKAdNetwork conversion value.\n\nOnly available on iOS.",
|
|
263
|
+
"complexTypes": [
|
|
264
|
+
"SkanGetConversionValueResult"
|
|
265
|
+
],
|
|
266
|
+
"slug": "skangetconversionvalue"
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "skanRegisterAppForAdNetworkAttribution",
|
|
270
|
+
"signature": "() => Promise<void>",
|
|
271
|
+
"parameters": [],
|
|
272
|
+
"returns": "Promise<void>",
|
|
273
|
+
"tags": [
|
|
274
|
+
{
|
|
275
|
+
"name": "since",
|
|
276
|
+
"text": "0.1.0"
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"docs": "Register the app for SKAdNetwork attribution.\n\nOnly required if `iosManualSkanConversionManagement` is enabled.\n\nOnly available on iOS.",
|
|
280
|
+
"complexTypes": [],
|
|
281
|
+
"slug": "skanregisterappforadnetworkattribution"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "skanUpdateConversionValue",
|
|
285
|
+
"signature": "(options: SkanUpdateConversionValueOptions) => Promise<void>",
|
|
286
|
+
"parameters": [
|
|
287
|
+
{
|
|
288
|
+
"name": "options",
|
|
289
|
+
"docs": "",
|
|
290
|
+
"type": "SkanUpdateConversionValueOptions"
|
|
291
|
+
}
|
|
292
|
+
],
|
|
293
|
+
"returns": "Promise<void>",
|
|
294
|
+
"tags": [
|
|
295
|
+
{
|
|
296
|
+
"name": "since",
|
|
297
|
+
"text": "0.1.0"
|
|
298
|
+
}
|
|
299
|
+
],
|
|
300
|
+
"docs": "Update the SKAdNetwork conversion value.\n\nOnly required if `iosManualSkanConversionManagement` is enabled.\nThe call is rejected if the conversion value could not be updated.\n\nOnly available on iOS.",
|
|
301
|
+
"complexTypes": [
|
|
302
|
+
"SkanUpdateConversionValueOptions"
|
|
303
|
+
],
|
|
304
|
+
"slug": "skanupdateconversionvalue"
|
|
305
|
+
},
|
|
306
|
+
{
|
|
307
|
+
"name": "stopAllTracking",
|
|
308
|
+
"signature": "() => Promise<void>",
|
|
309
|
+
"parameters": [],
|
|
310
|
+
"returns": "Promise<void>",
|
|
311
|
+
"tags": [
|
|
312
|
+
{
|
|
313
|
+
"name": "since",
|
|
314
|
+
"text": "0.1.0"
|
|
315
|
+
}
|
|
316
|
+
],
|
|
317
|
+
"docs": "Stop all tracking.\n\nThis setting persists across app restarts until `resumeAllTracking()` is called.\n\nOnly available on Android and iOS.",
|
|
318
|
+
"complexTypes": [],
|
|
319
|
+
"slug": "stopalltracking"
|
|
320
|
+
},
|
|
321
|
+
{
|
|
322
|
+
"name": "trackAdRevenue",
|
|
323
|
+
"signature": "(options: TrackAdRevenueOptions) => Promise<void>",
|
|
324
|
+
"parameters": [
|
|
325
|
+
{
|
|
326
|
+
"name": "options",
|
|
327
|
+
"docs": "",
|
|
328
|
+
"type": "TrackAdRevenueOptions"
|
|
329
|
+
}
|
|
330
|
+
],
|
|
331
|
+
"returns": "Promise<void>",
|
|
332
|
+
"tags": [
|
|
333
|
+
{
|
|
334
|
+
"name": "since",
|
|
335
|
+
"text": "0.1.0"
|
|
336
|
+
}
|
|
337
|
+
],
|
|
338
|
+
"docs": "Track ad revenue.\n\nOnly available on Android and iOS.",
|
|
339
|
+
"complexTypes": [
|
|
340
|
+
"TrackAdRevenueOptions"
|
|
341
|
+
],
|
|
342
|
+
"slug": "trackadrevenue"
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"name": "trackEvent",
|
|
346
|
+
"signature": "(options: TrackEventOptions) => Promise<void>",
|
|
347
|
+
"parameters": [
|
|
348
|
+
{
|
|
349
|
+
"name": "options",
|
|
350
|
+
"docs": "",
|
|
351
|
+
"type": "TrackEventOptions"
|
|
352
|
+
}
|
|
353
|
+
],
|
|
354
|
+
"returns": "Promise<void>",
|
|
355
|
+
"tags": [
|
|
356
|
+
{
|
|
357
|
+
"name": "since",
|
|
358
|
+
"text": "0.1.0"
|
|
359
|
+
}
|
|
360
|
+
],
|
|
361
|
+
"docs": "Track an event.\n\nOnly available on Android and iOS.",
|
|
362
|
+
"complexTypes": [
|
|
363
|
+
"TrackEventOptions"
|
|
364
|
+
],
|
|
365
|
+
"slug": "trackevent"
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "trackRevenue",
|
|
369
|
+
"signature": "(options: TrackRevenueOptions) => Promise<void>",
|
|
370
|
+
"parameters": [
|
|
371
|
+
{
|
|
372
|
+
"name": "options",
|
|
373
|
+
"docs": "",
|
|
374
|
+
"type": "TrackRevenueOptions"
|
|
375
|
+
}
|
|
376
|
+
],
|
|
377
|
+
"returns": "Promise<void>",
|
|
378
|
+
"tags": [
|
|
379
|
+
{
|
|
380
|
+
"name": "since",
|
|
381
|
+
"text": "0.1.0"
|
|
382
|
+
}
|
|
383
|
+
],
|
|
384
|
+
"docs": "Track a revenue event.\n\nOnly available on Android and iOS.",
|
|
385
|
+
"complexTypes": [
|
|
386
|
+
"TrackRevenueOptions"
|
|
387
|
+
],
|
|
388
|
+
"slug": "trackrevenue"
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"name": "trackingOptIn",
|
|
392
|
+
"signature": "() => Promise<void>",
|
|
393
|
+
"parameters": [],
|
|
394
|
+
"returns": "Promise<void>",
|
|
395
|
+
"tags": [
|
|
396
|
+
{
|
|
397
|
+
"name": "since",
|
|
398
|
+
"text": "0.1.0"
|
|
399
|
+
}
|
|
400
|
+
],
|
|
401
|
+
"docs": "Notify the SDK that the user has opted in to tracking (e.g. under GDPR).\n\nOnly available on Android and iOS.",
|
|
402
|
+
"complexTypes": [],
|
|
403
|
+
"slug": "trackingoptin"
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
"name": "trackingUnder13",
|
|
407
|
+
"signature": "() => Promise<void>",
|
|
408
|
+
"parameters": [],
|
|
409
|
+
"returns": "Promise<void>",
|
|
410
|
+
"tags": [
|
|
411
|
+
{
|
|
412
|
+
"name": "since",
|
|
413
|
+
"text": "0.1.0"
|
|
414
|
+
}
|
|
415
|
+
],
|
|
416
|
+
"docs": "Notify the SDK that the user is under 13 years old\nso that the SDK does not collect advertising identifiers.\n\nOnly available on Android and iOS.",
|
|
417
|
+
"complexTypes": [],
|
|
418
|
+
"slug": "trackingunder13"
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
"name": "unsetCustomUserId",
|
|
422
|
+
"signature": "() => Promise<void>",
|
|
423
|
+
"parameters": [],
|
|
424
|
+
"returns": "Promise<void>",
|
|
425
|
+
"tags": [
|
|
426
|
+
{
|
|
427
|
+
"name": "since",
|
|
428
|
+
"text": "0.1.0"
|
|
429
|
+
}
|
|
430
|
+
],
|
|
431
|
+
"docs": "Remove the custom user ID.\n\nOnly available on Android and iOS.",
|
|
432
|
+
"complexTypes": [],
|
|
433
|
+
"slug": "unsetcustomuserid"
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "unsetGlobalProperty",
|
|
437
|
+
"signature": "(options: UnsetGlobalPropertyOptions) => Promise<void>",
|
|
438
|
+
"parameters": [
|
|
439
|
+
{
|
|
440
|
+
"name": "options",
|
|
441
|
+
"docs": "",
|
|
442
|
+
"type": "UnsetGlobalPropertyOptions"
|
|
443
|
+
}
|
|
444
|
+
],
|
|
445
|
+
"returns": "Promise<void>",
|
|
446
|
+
"tags": [
|
|
447
|
+
{
|
|
448
|
+
"name": "since",
|
|
449
|
+
"text": "0.1.0"
|
|
450
|
+
}
|
|
451
|
+
],
|
|
452
|
+
"docs": "Remove a global property.\n\nOnly available on Android and iOS.",
|
|
453
|
+
"complexTypes": [
|
|
454
|
+
"UnsetGlobalPropertyOptions"
|
|
455
|
+
],
|
|
456
|
+
"slug": "unsetglobalproperty"
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"name": "addListener",
|
|
460
|
+
"signature": "(eventName: 'deviceAttributionInfoReceived', listenerFunc: (event: DeviceAttributionInfoReceivedEvent) => void) => Promise<PluginListenerHandle>",
|
|
461
|
+
"parameters": [
|
|
462
|
+
{
|
|
463
|
+
"name": "eventName",
|
|
464
|
+
"docs": "",
|
|
465
|
+
"type": "'deviceAttributionInfoReceived'"
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
"name": "listenerFunc",
|
|
469
|
+
"docs": "",
|
|
470
|
+
"type": "(event: DeviceAttributionInfoReceivedEvent) => void"
|
|
471
|
+
}
|
|
472
|
+
],
|
|
473
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
474
|
+
"tags": [
|
|
475
|
+
{
|
|
476
|
+
"name": "since",
|
|
477
|
+
"text": "0.1.0"
|
|
478
|
+
}
|
|
479
|
+
],
|
|
480
|
+
"docs": "Add a listener for when the device attribution information is received.\n\nThe event is emitted once after the first session, and only if\ndevice attribution is enabled for your Singular account.\n\nOnly available on Android and iOS.",
|
|
481
|
+
"complexTypes": [
|
|
482
|
+
"PluginListenerHandle",
|
|
483
|
+
"DeviceAttributionInfoReceivedEvent"
|
|
484
|
+
],
|
|
485
|
+
"slug": "addlistenerdeviceattributioninforeceived-"
|
|
486
|
+
},
|
|
487
|
+
{
|
|
488
|
+
"name": "addListener",
|
|
489
|
+
"signature": "(eventName: 'sdidReceived', listenerFunc: (event: SdidReceivedEvent) => void) => Promise<PluginListenerHandle>",
|
|
490
|
+
"parameters": [
|
|
491
|
+
{
|
|
492
|
+
"name": "eventName",
|
|
493
|
+
"docs": "",
|
|
494
|
+
"type": "'sdidReceived'"
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
"name": "listenerFunc",
|
|
498
|
+
"docs": "",
|
|
499
|
+
"type": "(event: SdidReceivedEvent) => void"
|
|
500
|
+
}
|
|
501
|
+
],
|
|
502
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
503
|
+
"tags": [
|
|
504
|
+
{
|
|
505
|
+
"name": "since",
|
|
506
|
+
"text": "0.1.0"
|
|
507
|
+
}
|
|
508
|
+
],
|
|
509
|
+
"docs": "Add a listener for when the Singular Device ID (SDID) is received.\n\nThe event is emitted after the first session and on every\nsubsequent launch with the stored SDID.\n\nOnly available on Android and iOS.",
|
|
510
|
+
"complexTypes": [
|
|
511
|
+
"PluginListenerHandle",
|
|
512
|
+
"SdidReceivedEvent"
|
|
513
|
+
],
|
|
514
|
+
"slug": "addlistenersdidreceived-"
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"name": "addListener",
|
|
518
|
+
"signature": "(eventName: 'sdidSet', listenerFunc: (event: SdidSetEvent) => void) => Promise<PluginListenerHandle>",
|
|
519
|
+
"parameters": [
|
|
520
|
+
{
|
|
521
|
+
"name": "eventName",
|
|
522
|
+
"docs": "",
|
|
523
|
+
"type": "'sdidSet'"
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"name": "listenerFunc",
|
|
527
|
+
"docs": "",
|
|
528
|
+
"type": "(event: SdidSetEvent) => void"
|
|
529
|
+
}
|
|
530
|
+
],
|
|
531
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
532
|
+
"tags": [
|
|
533
|
+
{
|
|
534
|
+
"name": "since",
|
|
535
|
+
"text": "0.1.0"
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
"docs": "Add a listener for when a custom Singular Device ID (SDID) has been stored.\n\nOnly available on Android and iOS.",
|
|
539
|
+
"complexTypes": [
|
|
540
|
+
"PluginListenerHandle",
|
|
541
|
+
"SdidSetEvent"
|
|
542
|
+
],
|
|
543
|
+
"slug": "addlistenersdidset-"
|
|
544
|
+
},
|
|
545
|
+
{
|
|
546
|
+
"name": "addListener",
|
|
547
|
+
"signature": "(eventName: 'singularLinkResolved', listenerFunc: (event: SingularLinkResolvedEvent) => void) => Promise<PluginListenerHandle>",
|
|
548
|
+
"parameters": [
|
|
549
|
+
{
|
|
550
|
+
"name": "eventName",
|
|
551
|
+
"docs": "",
|
|
552
|
+
"type": "'singularLinkResolved'"
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "listenerFunc",
|
|
556
|
+
"docs": "",
|
|
557
|
+
"type": "(event: SingularLinkResolvedEvent) => void"
|
|
558
|
+
}
|
|
559
|
+
],
|
|
560
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
561
|
+
"tags": [
|
|
562
|
+
{
|
|
563
|
+
"name": "since",
|
|
564
|
+
"text": "0.1.0"
|
|
565
|
+
}
|
|
566
|
+
],
|
|
567
|
+
"docs": "Add a listener for when a Singular Link is resolved.\n\nThis includes deferred deep links after an install.\n\nOnly available on Android and iOS.",
|
|
568
|
+
"complexTypes": [
|
|
569
|
+
"PluginListenerHandle",
|
|
570
|
+
"SingularLinkResolvedEvent"
|
|
571
|
+
],
|
|
572
|
+
"slug": "addlistenersingularlinkresolved-"
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "addListener",
|
|
576
|
+
"signature": "(eventName: 'skanConversionValueUpdated', listenerFunc: (event: SkanConversionValueUpdatedEvent) => void) => Promise<PluginListenerHandle>",
|
|
577
|
+
"parameters": [
|
|
578
|
+
{
|
|
579
|
+
"name": "eventName",
|
|
580
|
+
"docs": "",
|
|
581
|
+
"type": "'skanConversionValueUpdated'"
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"name": "listenerFunc",
|
|
585
|
+
"docs": "",
|
|
586
|
+
"type": "(event: SkanConversionValueUpdatedEvent) => void"
|
|
587
|
+
}
|
|
588
|
+
],
|
|
589
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
590
|
+
"tags": [
|
|
591
|
+
{
|
|
592
|
+
"name": "since",
|
|
593
|
+
"text": "0.1.0"
|
|
594
|
+
}
|
|
595
|
+
],
|
|
596
|
+
"docs": "Add a listener for when the SDK updates the SKAdNetwork conversion value.\n\nOnly available on iOS.",
|
|
597
|
+
"complexTypes": [
|
|
598
|
+
"PluginListenerHandle",
|
|
599
|
+
"SkanConversionValueUpdatedEvent"
|
|
600
|
+
],
|
|
601
|
+
"slug": "addlistenerskanconversionvalueupdated-"
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
"name": "removeAllListeners",
|
|
605
|
+
"signature": "() => Promise<void>",
|
|
606
|
+
"parameters": [],
|
|
607
|
+
"returns": "Promise<void>",
|
|
608
|
+
"tags": [
|
|
609
|
+
{
|
|
610
|
+
"name": "since",
|
|
611
|
+
"text": "0.1.0"
|
|
612
|
+
}
|
|
613
|
+
],
|
|
614
|
+
"docs": "Remove all listeners for this plugin.",
|
|
615
|
+
"complexTypes": [],
|
|
616
|
+
"slug": "removealllisteners"
|
|
617
|
+
}
|
|
618
|
+
],
|
|
619
|
+
"properties": []
|
|
620
|
+
},
|
|
621
|
+
"interfaces": [
|
|
622
|
+
{
|
|
623
|
+
"name": "CreateReferrerShortLinkResult",
|
|
624
|
+
"slug": "createreferrershortlinkresult",
|
|
625
|
+
"docs": "",
|
|
626
|
+
"tags": [
|
|
627
|
+
{
|
|
628
|
+
"text": "0.1.0",
|
|
629
|
+
"name": "since"
|
|
630
|
+
}
|
|
631
|
+
],
|
|
632
|
+
"methods": [],
|
|
633
|
+
"properties": [
|
|
634
|
+
{
|
|
635
|
+
"name": "link",
|
|
636
|
+
"tags": [
|
|
637
|
+
{
|
|
638
|
+
"text": "0.1.0",
|
|
639
|
+
"name": "since"
|
|
640
|
+
}
|
|
641
|
+
],
|
|
642
|
+
"docs": "The generated short link.",
|
|
643
|
+
"complexTypes": [],
|
|
644
|
+
"type": "string"
|
|
645
|
+
}
|
|
646
|
+
]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "CreateReferrerShortLinkOptions",
|
|
650
|
+
"slug": "createreferrershortlinkoptions",
|
|
651
|
+
"docs": "",
|
|
652
|
+
"tags": [
|
|
653
|
+
{
|
|
654
|
+
"text": "0.1.0",
|
|
655
|
+
"name": "since"
|
|
656
|
+
}
|
|
657
|
+
],
|
|
658
|
+
"methods": [],
|
|
659
|
+
"properties": [
|
|
660
|
+
{
|
|
661
|
+
"name": "baseLink",
|
|
662
|
+
"tags": [
|
|
663
|
+
{
|
|
664
|
+
"text": "0.1.0",
|
|
665
|
+
"name": "since"
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
"text": "'https://myapp.sng.link/A1b2c/d3e4'",
|
|
669
|
+
"name": "example"
|
|
670
|
+
}
|
|
671
|
+
],
|
|
672
|
+
"docs": "The Singular Link to shorten.",
|
|
673
|
+
"complexTypes": [],
|
|
674
|
+
"type": "string"
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"name": "passthroughParameters",
|
|
678
|
+
"tags": [
|
|
679
|
+
{
|
|
680
|
+
"text": "0.1.0",
|
|
681
|
+
"name": "since"
|
|
682
|
+
}
|
|
683
|
+
],
|
|
684
|
+
"docs": "Additional parameters that are passed through to the installed app.",
|
|
685
|
+
"complexTypes": [
|
|
686
|
+
"Record"
|
|
687
|
+
],
|
|
688
|
+
"type": "Record<string, string>"
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "referrerId",
|
|
692
|
+
"tags": [
|
|
693
|
+
{
|
|
694
|
+
"text": "0.1.0",
|
|
695
|
+
"name": "since"
|
|
696
|
+
}
|
|
697
|
+
],
|
|
698
|
+
"docs": "The unique identifier of the referring user.",
|
|
699
|
+
"complexTypes": [],
|
|
700
|
+
"type": "string"
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"name": "referrerName",
|
|
704
|
+
"tags": [
|
|
705
|
+
{
|
|
706
|
+
"text": "0.1.0",
|
|
707
|
+
"name": "since"
|
|
708
|
+
}
|
|
709
|
+
],
|
|
710
|
+
"docs": "The name of the referring user.",
|
|
711
|
+
"complexTypes": [],
|
|
712
|
+
"type": "string"
|
|
713
|
+
}
|
|
714
|
+
]
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
"name": "GetGlobalPropertiesResult",
|
|
718
|
+
"slug": "getglobalpropertiesresult",
|
|
719
|
+
"docs": "",
|
|
720
|
+
"tags": [
|
|
721
|
+
{
|
|
722
|
+
"text": "0.1.0",
|
|
723
|
+
"name": "since"
|
|
724
|
+
}
|
|
725
|
+
],
|
|
726
|
+
"methods": [],
|
|
727
|
+
"properties": [
|
|
728
|
+
{
|
|
729
|
+
"name": "properties",
|
|
730
|
+
"tags": [
|
|
731
|
+
{
|
|
732
|
+
"text": "0.1.0",
|
|
733
|
+
"name": "since"
|
|
734
|
+
}
|
|
735
|
+
],
|
|
736
|
+
"docs": "The global properties.",
|
|
737
|
+
"complexTypes": [
|
|
738
|
+
"Record"
|
|
739
|
+
],
|
|
740
|
+
"type": "Record<string, string>"
|
|
741
|
+
}
|
|
742
|
+
]
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"name": "GetLimitDataSharingResult",
|
|
746
|
+
"slug": "getlimitdatasharingresult",
|
|
747
|
+
"docs": "",
|
|
748
|
+
"tags": [
|
|
749
|
+
{
|
|
750
|
+
"text": "0.1.0",
|
|
751
|
+
"name": "since"
|
|
752
|
+
}
|
|
753
|
+
],
|
|
754
|
+
"methods": [],
|
|
755
|
+
"properties": [
|
|
756
|
+
{
|
|
757
|
+
"name": "limit",
|
|
758
|
+
"tags": [
|
|
759
|
+
{
|
|
760
|
+
"text": "0.1.0",
|
|
761
|
+
"name": "since"
|
|
762
|
+
}
|
|
763
|
+
],
|
|
764
|
+
"docs": "Whether data sharing is limited.",
|
|
765
|
+
"complexTypes": [],
|
|
766
|
+
"type": "boolean"
|
|
767
|
+
}
|
|
768
|
+
]
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
"name": "InitializeOptions",
|
|
772
|
+
"slug": "initializeoptions",
|
|
773
|
+
"docs": "",
|
|
774
|
+
"tags": [
|
|
775
|
+
{
|
|
776
|
+
"text": "0.1.0",
|
|
777
|
+
"name": "since"
|
|
778
|
+
}
|
|
779
|
+
],
|
|
780
|
+
"methods": [],
|
|
781
|
+
"properties": [
|
|
782
|
+
{
|
|
783
|
+
"name": "androidFacebookAppId",
|
|
784
|
+
"tags": [
|
|
785
|
+
{
|
|
786
|
+
"text": "0.1.0",
|
|
787
|
+
"name": "since"
|
|
788
|
+
}
|
|
789
|
+
],
|
|
790
|
+
"docs": "The Facebook App ID used for Meta Install Referrer attribution.\n\nOnly available on Android.",
|
|
791
|
+
"complexTypes": [],
|
|
792
|
+
"type": "string | undefined"
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "apiKey",
|
|
796
|
+
"tags": [
|
|
797
|
+
{
|
|
798
|
+
"text": "0.1.0",
|
|
799
|
+
"name": "since"
|
|
800
|
+
}
|
|
801
|
+
],
|
|
802
|
+
"docs": "The SDK key of your Singular account.",
|
|
803
|
+
"complexTypes": [],
|
|
804
|
+
"type": "string"
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"name": "brandedDomains",
|
|
808
|
+
"tags": [
|
|
809
|
+
{
|
|
810
|
+
"text": "0.1.0",
|
|
811
|
+
"name": "since"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"text": "['links.myapp.com']",
|
|
815
|
+
"name": "example"
|
|
816
|
+
}
|
|
817
|
+
],
|
|
818
|
+
"docs": "The branded domains that should be resolved as Singular Links.",
|
|
819
|
+
"complexTypes": [],
|
|
820
|
+
"type": "string[] | undefined"
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "customSdid",
|
|
824
|
+
"tags": [
|
|
825
|
+
{
|
|
826
|
+
"text": "0.1.0",
|
|
827
|
+
"name": "since"
|
|
828
|
+
}
|
|
829
|
+
],
|
|
830
|
+
"docs": "A custom Singular Device ID (SDID) that is used instead of the one\ngenerated by Singular.",
|
|
831
|
+
"complexTypes": [],
|
|
832
|
+
"type": "string | undefined"
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
"name": "customUserId",
|
|
836
|
+
"tags": [
|
|
837
|
+
{
|
|
838
|
+
"text": "0.1.0",
|
|
839
|
+
"name": "since"
|
|
840
|
+
}
|
|
841
|
+
],
|
|
842
|
+
"docs": "The custom user ID that is attached to all sessions and events.",
|
|
843
|
+
"complexTypes": [],
|
|
844
|
+
"type": "string | undefined"
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "espDomains",
|
|
848
|
+
"tags": [
|
|
849
|
+
{
|
|
850
|
+
"text": "0.1.0",
|
|
851
|
+
"name": "since"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"text": "['click.myapp.com']",
|
|
855
|
+
"name": "example"
|
|
856
|
+
}
|
|
857
|
+
],
|
|
858
|
+
"docs": "The email service provider domains that should be resolved as Singular Links.",
|
|
859
|
+
"complexTypes": [],
|
|
860
|
+
"type": "string[] | undefined"
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"name": "globalProperties",
|
|
864
|
+
"tags": [
|
|
865
|
+
{
|
|
866
|
+
"text": "0.1.0",
|
|
867
|
+
"name": "since"
|
|
868
|
+
}
|
|
869
|
+
],
|
|
870
|
+
"docs": "Global properties that are attached to all events.\n\nExisting global properties with the same key are overridden.\nAt most 5 global properties can be set.",
|
|
871
|
+
"complexTypes": [
|
|
872
|
+
"Record"
|
|
873
|
+
],
|
|
874
|
+
"type": "Record<string, string>"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "iosManualSkanConversionManagement",
|
|
878
|
+
"tags": [
|
|
879
|
+
{
|
|
880
|
+
"text": "0.1.0",
|
|
881
|
+
"name": "since"
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"text": "false",
|
|
885
|
+
"name": "default"
|
|
886
|
+
}
|
|
887
|
+
],
|
|
888
|
+
"docs": "Whether the SKAdNetwork conversion value is managed by your app\ninstead of by the SDK.\n\nOnly available on iOS.",
|
|
889
|
+
"complexTypes": [],
|
|
890
|
+
"type": "boolean | undefined"
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "iosSkAdNetworkEnabled",
|
|
894
|
+
"tags": [
|
|
895
|
+
{
|
|
896
|
+
"text": "0.1.0",
|
|
897
|
+
"name": "since"
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
"text": "true",
|
|
901
|
+
"name": "default"
|
|
902
|
+
}
|
|
903
|
+
],
|
|
904
|
+
"docs": "Whether SKAdNetwork support is enabled.\n\nOnly available on iOS.",
|
|
905
|
+
"complexTypes": [],
|
|
906
|
+
"type": "boolean | undefined"
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"name": "iosWaitForTrackingAuthorizationTimeout",
|
|
910
|
+
"tags": [
|
|
911
|
+
{
|
|
912
|
+
"text": "0.1.0",
|
|
913
|
+
"name": "since"
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
"text": "0",
|
|
917
|
+
"name": "default"
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
"docs": "The number of seconds the SDK waits for the App Tracking Transparency\nauthorization before sending the first session.\n\nSet this to a value greater than `0` if you request the tracking\nauthorization right after the app launch.\n\nOnly available on iOS.",
|
|
921
|
+
"complexTypes": [],
|
|
922
|
+
"type": "number | undefined"
|
|
923
|
+
},
|
|
924
|
+
{
|
|
925
|
+
"name": "limitAdvertisingIdentifiers",
|
|
926
|
+
"tags": [
|
|
927
|
+
{
|
|
928
|
+
"text": "0.1.0",
|
|
929
|
+
"name": "since"
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"text": "false",
|
|
933
|
+
"name": "default"
|
|
934
|
+
}
|
|
935
|
+
],
|
|
936
|
+
"docs": "Whether the SDK is not allowed to collect advertising identifiers\n(e.g. the Google Advertising ID or the IDFA).",
|
|
937
|
+
"complexTypes": [],
|
|
938
|
+
"type": "boolean | undefined"
|
|
939
|
+
},
|
|
940
|
+
{
|
|
941
|
+
"name": "limitDataSharing",
|
|
942
|
+
"tags": [
|
|
943
|
+
{
|
|
944
|
+
"text": "0.1.0",
|
|
945
|
+
"name": "since"
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
"text": "false",
|
|
949
|
+
"name": "default"
|
|
950
|
+
}
|
|
951
|
+
],
|
|
952
|
+
"docs": "Whether data sharing with third parties is limited.",
|
|
953
|
+
"complexTypes": [],
|
|
954
|
+
"type": "boolean | undefined"
|
|
955
|
+
},
|
|
956
|
+
{
|
|
957
|
+
"name": "loggingEnabled",
|
|
958
|
+
"tags": [
|
|
959
|
+
{
|
|
960
|
+
"text": "0.1.0",
|
|
961
|
+
"name": "since"
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"text": "false",
|
|
965
|
+
"name": "default"
|
|
966
|
+
}
|
|
967
|
+
],
|
|
968
|
+
"docs": "Whether debug logging is enabled.",
|
|
969
|
+
"complexTypes": [],
|
|
970
|
+
"type": "boolean | undefined"
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "secret",
|
|
974
|
+
"tags": [
|
|
975
|
+
{
|
|
976
|
+
"text": "0.1.0",
|
|
977
|
+
"name": "since"
|
|
978
|
+
}
|
|
979
|
+
],
|
|
980
|
+
"docs": "The SDK secret of your Singular account.",
|
|
981
|
+
"complexTypes": [],
|
|
982
|
+
"type": "string"
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"name": "sessionTimeout",
|
|
986
|
+
"tags": [
|
|
987
|
+
{
|
|
988
|
+
"text": "0.1.0",
|
|
989
|
+
"name": "since"
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
"text": "60",
|
|
993
|
+
"name": "default"
|
|
994
|
+
}
|
|
995
|
+
],
|
|
996
|
+
"docs": "The number of seconds the app can stay in the background\nbefore a new session is started.",
|
|
997
|
+
"complexTypes": [],
|
|
998
|
+
"type": "number | undefined"
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"name": "shortLinkResolveTimeout",
|
|
1002
|
+
"tags": [
|
|
1003
|
+
{
|
|
1004
|
+
"text": "0.1.0",
|
|
1005
|
+
"name": "since"
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
"text": "10",
|
|
1009
|
+
"name": "default"
|
|
1010
|
+
}
|
|
1011
|
+
],
|
|
1012
|
+
"docs": "The number of seconds the SDK waits for a short link to be resolved.",
|
|
1013
|
+
"complexTypes": [],
|
|
1014
|
+
"type": "number | undefined"
|
|
1015
|
+
}
|
|
1016
|
+
]
|
|
1017
|
+
},
|
|
1018
|
+
{
|
|
1019
|
+
"name": "IsAllTrackingStoppedResult",
|
|
1020
|
+
"slug": "isalltrackingstoppedresult",
|
|
1021
|
+
"docs": "",
|
|
1022
|
+
"tags": [
|
|
1023
|
+
{
|
|
1024
|
+
"text": "0.1.0",
|
|
1025
|
+
"name": "since"
|
|
1026
|
+
}
|
|
1027
|
+
],
|
|
1028
|
+
"methods": [],
|
|
1029
|
+
"properties": [
|
|
1030
|
+
{
|
|
1031
|
+
"name": "stopped",
|
|
1032
|
+
"tags": [
|
|
1033
|
+
{
|
|
1034
|
+
"text": "0.1.0",
|
|
1035
|
+
"name": "since"
|
|
1036
|
+
}
|
|
1037
|
+
],
|
|
1038
|
+
"docs": "Whether all tracking has been stopped.",
|
|
1039
|
+
"complexTypes": [],
|
|
1040
|
+
"type": "boolean"
|
|
1041
|
+
}
|
|
1042
|
+
]
|
|
1043
|
+
},
|
|
1044
|
+
{
|
|
1045
|
+
"name": "SetCustomUserIdOptions",
|
|
1046
|
+
"slug": "setcustomuseridoptions",
|
|
1047
|
+
"docs": "",
|
|
1048
|
+
"tags": [
|
|
1049
|
+
{
|
|
1050
|
+
"text": "0.1.0",
|
|
1051
|
+
"name": "since"
|
|
1052
|
+
}
|
|
1053
|
+
],
|
|
1054
|
+
"methods": [],
|
|
1055
|
+
"properties": [
|
|
1056
|
+
{
|
|
1057
|
+
"name": "customUserId",
|
|
1058
|
+
"tags": [
|
|
1059
|
+
{
|
|
1060
|
+
"text": "0.1.0",
|
|
1061
|
+
"name": "since"
|
|
1062
|
+
}
|
|
1063
|
+
],
|
|
1064
|
+
"docs": "The custom user ID.",
|
|
1065
|
+
"complexTypes": [],
|
|
1066
|
+
"type": "string"
|
|
1067
|
+
}
|
|
1068
|
+
]
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "SetDeviceTokenOptions",
|
|
1072
|
+
"slug": "setdevicetokenoptions",
|
|
1073
|
+
"docs": "",
|
|
1074
|
+
"tags": [
|
|
1075
|
+
{
|
|
1076
|
+
"text": "0.1.0",
|
|
1077
|
+
"name": "since"
|
|
1078
|
+
}
|
|
1079
|
+
],
|
|
1080
|
+
"methods": [],
|
|
1081
|
+
"properties": [
|
|
1082
|
+
{
|
|
1083
|
+
"name": "token",
|
|
1084
|
+
"tags": [
|
|
1085
|
+
{
|
|
1086
|
+
"text": "0.1.0",
|
|
1087
|
+
"name": "since"
|
|
1088
|
+
}
|
|
1089
|
+
],
|
|
1090
|
+
"docs": "The push notification device token.\n\nOn Android, this is the FCM registration token.\nOn iOS, this is the hex-encoded APNs device token.",
|
|
1091
|
+
"complexTypes": [],
|
|
1092
|
+
"type": "string"
|
|
1093
|
+
}
|
|
1094
|
+
]
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"name": "SetGlobalPropertyOptions",
|
|
1098
|
+
"slug": "setglobalpropertyoptions",
|
|
1099
|
+
"docs": "",
|
|
1100
|
+
"tags": [
|
|
1101
|
+
{
|
|
1102
|
+
"text": "0.1.0",
|
|
1103
|
+
"name": "since"
|
|
1104
|
+
}
|
|
1105
|
+
],
|
|
1106
|
+
"methods": [],
|
|
1107
|
+
"properties": [
|
|
1108
|
+
{
|
|
1109
|
+
"name": "key",
|
|
1110
|
+
"tags": [
|
|
1111
|
+
{
|
|
1112
|
+
"text": "0.1.0",
|
|
1113
|
+
"name": "since"
|
|
1114
|
+
}
|
|
1115
|
+
],
|
|
1116
|
+
"docs": "The key of the global property.",
|
|
1117
|
+
"complexTypes": [],
|
|
1118
|
+
"type": "string"
|
|
1119
|
+
},
|
|
1120
|
+
{
|
|
1121
|
+
"name": "overrideExisting",
|
|
1122
|
+
"tags": [
|
|
1123
|
+
{
|
|
1124
|
+
"text": "0.1.0",
|
|
1125
|
+
"name": "since"
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"text": "true",
|
|
1129
|
+
"name": "default"
|
|
1130
|
+
}
|
|
1131
|
+
],
|
|
1132
|
+
"docs": "Whether an existing global property with the same key is overridden.",
|
|
1133
|
+
"complexTypes": [],
|
|
1134
|
+
"type": "boolean | undefined"
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"name": "value",
|
|
1138
|
+
"tags": [
|
|
1139
|
+
{
|
|
1140
|
+
"text": "0.1.0",
|
|
1141
|
+
"name": "since"
|
|
1142
|
+
}
|
|
1143
|
+
],
|
|
1144
|
+
"docs": "The value of the global property.",
|
|
1145
|
+
"complexTypes": [],
|
|
1146
|
+
"type": "string"
|
|
1147
|
+
}
|
|
1148
|
+
]
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "SetLimitAdvertisingIdentifiersOptions",
|
|
1152
|
+
"slug": "setlimitadvertisingidentifiersoptions",
|
|
1153
|
+
"docs": "",
|
|
1154
|
+
"tags": [
|
|
1155
|
+
{
|
|
1156
|
+
"text": "0.1.0",
|
|
1157
|
+
"name": "since"
|
|
1158
|
+
}
|
|
1159
|
+
],
|
|
1160
|
+
"methods": [],
|
|
1161
|
+
"properties": [
|
|
1162
|
+
{
|
|
1163
|
+
"name": "limit",
|
|
1164
|
+
"tags": [
|
|
1165
|
+
{
|
|
1166
|
+
"text": "0.1.0",
|
|
1167
|
+
"name": "since"
|
|
1168
|
+
}
|
|
1169
|
+
],
|
|
1170
|
+
"docs": "Whether the SDK is not allowed to collect advertising identifiers.",
|
|
1171
|
+
"complexTypes": [],
|
|
1172
|
+
"type": "boolean"
|
|
1173
|
+
}
|
|
1174
|
+
]
|
|
1175
|
+
},
|
|
1176
|
+
{
|
|
1177
|
+
"name": "SetLimitDataSharingOptions",
|
|
1178
|
+
"slug": "setlimitdatasharingoptions",
|
|
1179
|
+
"docs": "",
|
|
1180
|
+
"tags": [
|
|
1181
|
+
{
|
|
1182
|
+
"text": "0.1.0",
|
|
1183
|
+
"name": "since"
|
|
1184
|
+
}
|
|
1185
|
+
],
|
|
1186
|
+
"methods": [],
|
|
1187
|
+
"properties": [
|
|
1188
|
+
{
|
|
1189
|
+
"name": "limit",
|
|
1190
|
+
"tags": [
|
|
1191
|
+
{
|
|
1192
|
+
"text": "0.1.0",
|
|
1193
|
+
"name": "since"
|
|
1194
|
+
}
|
|
1195
|
+
],
|
|
1196
|
+
"docs": "Whether data sharing with third parties is limited.",
|
|
1197
|
+
"complexTypes": [],
|
|
1198
|
+
"type": "boolean"
|
|
1199
|
+
}
|
|
1200
|
+
]
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "SkanGetConversionValueResult",
|
|
1204
|
+
"slug": "skangetconversionvalueresult",
|
|
1205
|
+
"docs": "",
|
|
1206
|
+
"tags": [
|
|
1207
|
+
{
|
|
1208
|
+
"text": "0.1.0",
|
|
1209
|
+
"name": "since"
|
|
1210
|
+
}
|
|
1211
|
+
],
|
|
1212
|
+
"methods": [],
|
|
1213
|
+
"properties": [
|
|
1214
|
+
{
|
|
1215
|
+
"name": "value",
|
|
1216
|
+
"tags": [
|
|
1217
|
+
{
|
|
1218
|
+
"text": "0.1.0",
|
|
1219
|
+
"name": "since"
|
|
1220
|
+
}
|
|
1221
|
+
],
|
|
1222
|
+
"docs": "The fine-grained conversion value (`0` - `63`)\nor `null` if no value has been set yet.",
|
|
1223
|
+
"complexTypes": [],
|
|
1224
|
+
"type": "number | null"
|
|
1225
|
+
}
|
|
1226
|
+
]
|
|
1227
|
+
},
|
|
1228
|
+
{
|
|
1229
|
+
"name": "SkanUpdateConversionValueOptions",
|
|
1230
|
+
"slug": "skanupdateconversionvalueoptions",
|
|
1231
|
+
"docs": "",
|
|
1232
|
+
"tags": [
|
|
1233
|
+
{
|
|
1234
|
+
"text": "0.1.0",
|
|
1235
|
+
"name": "since"
|
|
1236
|
+
}
|
|
1237
|
+
],
|
|
1238
|
+
"methods": [],
|
|
1239
|
+
"properties": [
|
|
1240
|
+
{
|
|
1241
|
+
"name": "coarseValue",
|
|
1242
|
+
"tags": [
|
|
1243
|
+
{
|
|
1244
|
+
"text": "0.1.0",
|
|
1245
|
+
"name": "since"
|
|
1246
|
+
}
|
|
1247
|
+
],
|
|
1248
|
+
"docs": "The coarse conversion value.\n\nOnly available on iOS 16.1+.",
|
|
1249
|
+
"complexTypes": [
|
|
1250
|
+
"SkanCoarseConversionValue"
|
|
1251
|
+
],
|
|
1252
|
+
"type": "SkanCoarseConversionValue"
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "lockWindow",
|
|
1256
|
+
"tags": [
|
|
1257
|
+
{
|
|
1258
|
+
"text": "0.1.0",
|
|
1259
|
+
"name": "since"
|
|
1260
|
+
},
|
|
1261
|
+
{
|
|
1262
|
+
"text": "false",
|
|
1263
|
+
"name": "default"
|
|
1264
|
+
}
|
|
1265
|
+
],
|
|
1266
|
+
"docs": "Whether the conversion window should be locked.\n\nOnly available on iOS 16.1+.",
|
|
1267
|
+
"complexTypes": [],
|
|
1268
|
+
"type": "boolean | undefined"
|
|
1269
|
+
},
|
|
1270
|
+
{
|
|
1271
|
+
"name": "value",
|
|
1272
|
+
"tags": [
|
|
1273
|
+
{
|
|
1274
|
+
"text": "0.1.0",
|
|
1275
|
+
"name": "since"
|
|
1276
|
+
}
|
|
1277
|
+
],
|
|
1278
|
+
"docs": "The fine-grained conversion value (`0` - `63`).",
|
|
1279
|
+
"complexTypes": [],
|
|
1280
|
+
"type": "number"
|
|
1281
|
+
}
|
|
1282
|
+
]
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"name": "TrackAdRevenueOptions",
|
|
1286
|
+
"slug": "trackadrevenueoptions",
|
|
1287
|
+
"docs": "",
|
|
1288
|
+
"tags": [
|
|
1289
|
+
{
|
|
1290
|
+
"text": "0.1.0",
|
|
1291
|
+
"name": "since"
|
|
1292
|
+
}
|
|
1293
|
+
],
|
|
1294
|
+
"methods": [],
|
|
1295
|
+
"properties": [
|
|
1296
|
+
{
|
|
1297
|
+
"name": "adGroupId",
|
|
1298
|
+
"tags": [
|
|
1299
|
+
{
|
|
1300
|
+
"text": "0.1.0",
|
|
1301
|
+
"name": "since"
|
|
1302
|
+
}
|
|
1303
|
+
],
|
|
1304
|
+
"docs": "The identifier of the ad group.",
|
|
1305
|
+
"complexTypes": [],
|
|
1306
|
+
"type": "string | undefined"
|
|
1307
|
+
},
|
|
1308
|
+
{
|
|
1309
|
+
"name": "adGroupName",
|
|
1310
|
+
"tags": [
|
|
1311
|
+
{
|
|
1312
|
+
"text": "0.1.0",
|
|
1313
|
+
"name": "since"
|
|
1314
|
+
}
|
|
1315
|
+
],
|
|
1316
|
+
"docs": "The name of the ad group.",
|
|
1317
|
+
"complexTypes": [],
|
|
1318
|
+
"type": "string | undefined"
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
"name": "adGroupPriority",
|
|
1322
|
+
"tags": [
|
|
1323
|
+
{
|
|
1324
|
+
"text": "0.1.0",
|
|
1325
|
+
"name": "since"
|
|
1326
|
+
}
|
|
1327
|
+
],
|
|
1328
|
+
"docs": "The priority of the ad group.",
|
|
1329
|
+
"complexTypes": [],
|
|
1330
|
+
"type": "string | undefined"
|
|
1331
|
+
},
|
|
1332
|
+
{
|
|
1333
|
+
"name": "adGroupType",
|
|
1334
|
+
"tags": [
|
|
1335
|
+
{
|
|
1336
|
+
"text": "0.1.0",
|
|
1337
|
+
"name": "since"
|
|
1338
|
+
}
|
|
1339
|
+
],
|
|
1340
|
+
"docs": "The type of the ad group.",
|
|
1341
|
+
"complexTypes": [],
|
|
1342
|
+
"type": "string | undefined"
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"name": "adPlacementName",
|
|
1346
|
+
"tags": [
|
|
1347
|
+
{
|
|
1348
|
+
"text": "0.1.0",
|
|
1349
|
+
"name": "since"
|
|
1350
|
+
}
|
|
1351
|
+
],
|
|
1352
|
+
"docs": "The name of the ad placement.",
|
|
1353
|
+
"complexTypes": [],
|
|
1354
|
+
"type": "string | undefined"
|
|
1355
|
+
},
|
|
1356
|
+
{
|
|
1357
|
+
"name": "adPlatform",
|
|
1358
|
+
"tags": [
|
|
1359
|
+
{
|
|
1360
|
+
"text": "0.1.0",
|
|
1361
|
+
"name": "since"
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"text": "'AdMob'",
|
|
1365
|
+
"name": "example"
|
|
1366
|
+
}
|
|
1367
|
+
],
|
|
1368
|
+
"docs": "The ad mediation platform that reported the revenue.",
|
|
1369
|
+
"complexTypes": [],
|
|
1370
|
+
"type": "string"
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"name": "adType",
|
|
1374
|
+
"tags": [
|
|
1375
|
+
{
|
|
1376
|
+
"text": "0.1.0",
|
|
1377
|
+
"name": "since"
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"text": "'Rewarded'",
|
|
1381
|
+
"name": "example"
|
|
1382
|
+
}
|
|
1383
|
+
],
|
|
1384
|
+
"docs": "The type of the ad.",
|
|
1385
|
+
"complexTypes": [],
|
|
1386
|
+
"type": "string | undefined"
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"name": "adUnitId",
|
|
1390
|
+
"tags": [
|
|
1391
|
+
{
|
|
1392
|
+
"text": "0.1.0",
|
|
1393
|
+
"name": "since"
|
|
1394
|
+
}
|
|
1395
|
+
],
|
|
1396
|
+
"docs": "The identifier of the ad unit.",
|
|
1397
|
+
"complexTypes": [],
|
|
1398
|
+
"type": "string | undefined"
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
"name": "adUnitName",
|
|
1402
|
+
"tags": [
|
|
1403
|
+
{
|
|
1404
|
+
"text": "0.1.0",
|
|
1405
|
+
"name": "since"
|
|
1406
|
+
}
|
|
1407
|
+
],
|
|
1408
|
+
"docs": "The name of the ad unit.",
|
|
1409
|
+
"complexTypes": [],
|
|
1410
|
+
"type": "string | undefined"
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"name": "currency",
|
|
1414
|
+
"tags": [
|
|
1415
|
+
{
|
|
1416
|
+
"text": "0.1.0",
|
|
1417
|
+
"name": "since"
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"text": "'USD'",
|
|
1421
|
+
"name": "example"
|
|
1422
|
+
}
|
|
1423
|
+
],
|
|
1424
|
+
"docs": "The currency of the revenue as ISO 4217 code.",
|
|
1425
|
+
"complexTypes": [],
|
|
1426
|
+
"type": "string"
|
|
1427
|
+
},
|
|
1428
|
+
{
|
|
1429
|
+
"name": "impressionId",
|
|
1430
|
+
"tags": [
|
|
1431
|
+
{
|
|
1432
|
+
"text": "0.1.0",
|
|
1433
|
+
"name": "since"
|
|
1434
|
+
}
|
|
1435
|
+
],
|
|
1436
|
+
"docs": "The identifier of the ad impression.",
|
|
1437
|
+
"complexTypes": [],
|
|
1438
|
+
"type": "string | undefined"
|
|
1439
|
+
},
|
|
1440
|
+
{
|
|
1441
|
+
"name": "networkName",
|
|
1442
|
+
"tags": [
|
|
1443
|
+
{
|
|
1444
|
+
"text": "0.1.0",
|
|
1445
|
+
"name": "since"
|
|
1446
|
+
}
|
|
1447
|
+
],
|
|
1448
|
+
"docs": "The name of the ad network that served the ad.",
|
|
1449
|
+
"complexTypes": [],
|
|
1450
|
+
"type": "string | undefined"
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"name": "placementId",
|
|
1454
|
+
"tags": [
|
|
1455
|
+
{
|
|
1456
|
+
"text": "0.1.0",
|
|
1457
|
+
"name": "since"
|
|
1458
|
+
}
|
|
1459
|
+
],
|
|
1460
|
+
"docs": "The identifier of the placement.",
|
|
1461
|
+
"complexTypes": [],
|
|
1462
|
+
"type": "string | undefined"
|
|
1463
|
+
},
|
|
1464
|
+
{
|
|
1465
|
+
"name": "precision",
|
|
1466
|
+
"tags": [
|
|
1467
|
+
{
|
|
1468
|
+
"text": "0.1.0",
|
|
1469
|
+
"name": "since"
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
"text": "'estimated'",
|
|
1473
|
+
"name": "example"
|
|
1474
|
+
}
|
|
1475
|
+
],
|
|
1476
|
+
"docs": "The precision of the reported revenue.",
|
|
1477
|
+
"complexTypes": [],
|
|
1478
|
+
"type": "string | undefined"
|
|
1479
|
+
},
|
|
1480
|
+
{
|
|
1481
|
+
"name": "revenue",
|
|
1482
|
+
"tags": [
|
|
1483
|
+
{
|
|
1484
|
+
"text": "0.1.0",
|
|
1485
|
+
"name": "since"
|
|
1486
|
+
},
|
|
1487
|
+
{
|
|
1488
|
+
"text": "0.05",
|
|
1489
|
+
"name": "example"
|
|
1490
|
+
}
|
|
1491
|
+
],
|
|
1492
|
+
"docs": "The revenue amount.",
|
|
1493
|
+
"complexTypes": [],
|
|
1494
|
+
"type": "number"
|
|
1495
|
+
}
|
|
1496
|
+
]
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"name": "TrackEventOptions",
|
|
1500
|
+
"slug": "trackeventoptions",
|
|
1501
|
+
"docs": "",
|
|
1502
|
+
"tags": [
|
|
1503
|
+
{
|
|
1504
|
+
"text": "0.1.0",
|
|
1505
|
+
"name": "since"
|
|
1506
|
+
}
|
|
1507
|
+
],
|
|
1508
|
+
"methods": [],
|
|
1509
|
+
"properties": [
|
|
1510
|
+
{
|
|
1511
|
+
"name": "attributes",
|
|
1512
|
+
"tags": [
|
|
1513
|
+
{
|
|
1514
|
+
"text": "0.1.0",
|
|
1515
|
+
"name": "since"
|
|
1516
|
+
},
|
|
1517
|
+
{
|
|
1518
|
+
"text": "{ level: 3, character: 'warrior' }",
|
|
1519
|
+
"name": "example"
|
|
1520
|
+
}
|
|
1521
|
+
],
|
|
1522
|
+
"docs": "The attributes of the event.\n\nAttribute keys and values are limited to 500 characters.",
|
|
1523
|
+
"complexTypes": [
|
|
1524
|
+
"Record"
|
|
1525
|
+
],
|
|
1526
|
+
"type": "Record<string, string | number | boolean>"
|
|
1527
|
+
},
|
|
1528
|
+
{
|
|
1529
|
+
"name": "name",
|
|
1530
|
+
"tags": [
|
|
1531
|
+
{
|
|
1532
|
+
"text": "0.1.0",
|
|
1533
|
+
"name": "since"
|
|
1534
|
+
},
|
|
1535
|
+
{
|
|
1536
|
+
"text": "'sng_login'",
|
|
1537
|
+
"name": "example"
|
|
1538
|
+
}
|
|
1539
|
+
],
|
|
1540
|
+
"docs": "The name of the event.\n\nCan be a standard event name (e.g. `sng_login`, `sng_tutorial_complete`)\nor a custom event name. Limited to 32 characters.",
|
|
1541
|
+
"complexTypes": [],
|
|
1542
|
+
"type": "string"
|
|
1543
|
+
}
|
|
1544
|
+
]
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"name": "TrackRevenueOptions",
|
|
1548
|
+
"slug": "trackrevenueoptions",
|
|
1549
|
+
"docs": "",
|
|
1550
|
+
"tags": [
|
|
1551
|
+
{
|
|
1552
|
+
"text": "0.1.0",
|
|
1553
|
+
"name": "since"
|
|
1554
|
+
}
|
|
1555
|
+
],
|
|
1556
|
+
"methods": [],
|
|
1557
|
+
"properties": [
|
|
1558
|
+
{
|
|
1559
|
+
"name": "amount",
|
|
1560
|
+
"tags": [
|
|
1561
|
+
{
|
|
1562
|
+
"text": "0.1.0",
|
|
1563
|
+
"name": "since"
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
"text": "9.99",
|
|
1567
|
+
"name": "example"
|
|
1568
|
+
}
|
|
1569
|
+
],
|
|
1570
|
+
"docs": "The revenue amount.",
|
|
1571
|
+
"complexTypes": [],
|
|
1572
|
+
"type": "number"
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "attributes",
|
|
1576
|
+
"tags": [
|
|
1577
|
+
{
|
|
1578
|
+
"text": "0.1.0",
|
|
1579
|
+
"name": "since"
|
|
1580
|
+
}
|
|
1581
|
+
],
|
|
1582
|
+
"docs": "The attributes of the event.",
|
|
1583
|
+
"complexTypes": [
|
|
1584
|
+
"Record"
|
|
1585
|
+
],
|
|
1586
|
+
"type": "Record<string, string | number | boolean>"
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"name": "currency",
|
|
1590
|
+
"tags": [
|
|
1591
|
+
{
|
|
1592
|
+
"text": "0.1.0",
|
|
1593
|
+
"name": "since"
|
|
1594
|
+
},
|
|
1595
|
+
{
|
|
1596
|
+
"text": "'USD'",
|
|
1597
|
+
"name": "example"
|
|
1598
|
+
}
|
|
1599
|
+
],
|
|
1600
|
+
"docs": "The currency of the revenue as ISO 4217 code.",
|
|
1601
|
+
"complexTypes": [],
|
|
1602
|
+
"type": "string"
|
|
1603
|
+
},
|
|
1604
|
+
{
|
|
1605
|
+
"name": "eventName",
|
|
1606
|
+
"tags": [
|
|
1607
|
+
{
|
|
1608
|
+
"text": "0.1.0",
|
|
1609
|
+
"name": "since"
|
|
1610
|
+
},
|
|
1611
|
+
{
|
|
1612
|
+
"text": "'subscription_purchase'",
|
|
1613
|
+
"name": "example"
|
|
1614
|
+
}
|
|
1615
|
+
],
|
|
1616
|
+
"docs": "The name of the event.\n\nIf provided, a custom revenue event with this name is tracked\ninstead of the default revenue event.",
|
|
1617
|
+
"complexTypes": [],
|
|
1618
|
+
"type": "string | undefined"
|
|
1619
|
+
}
|
|
1620
|
+
]
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
"name": "UnsetGlobalPropertyOptions",
|
|
1624
|
+
"slug": "unsetglobalpropertyoptions",
|
|
1625
|
+
"docs": "",
|
|
1626
|
+
"tags": [
|
|
1627
|
+
{
|
|
1628
|
+
"text": "0.1.0",
|
|
1629
|
+
"name": "since"
|
|
1630
|
+
}
|
|
1631
|
+
],
|
|
1632
|
+
"methods": [],
|
|
1633
|
+
"properties": [
|
|
1634
|
+
{
|
|
1635
|
+
"name": "key",
|
|
1636
|
+
"tags": [
|
|
1637
|
+
{
|
|
1638
|
+
"text": "0.1.0",
|
|
1639
|
+
"name": "since"
|
|
1640
|
+
}
|
|
1641
|
+
],
|
|
1642
|
+
"docs": "The key of the global property.",
|
|
1643
|
+
"complexTypes": [],
|
|
1644
|
+
"type": "string"
|
|
1645
|
+
}
|
|
1646
|
+
]
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"name": "PluginListenerHandle",
|
|
1650
|
+
"slug": "pluginlistenerhandle",
|
|
1651
|
+
"docs": "",
|
|
1652
|
+
"tags": [],
|
|
1653
|
+
"methods": [],
|
|
1654
|
+
"properties": [
|
|
1655
|
+
{
|
|
1656
|
+
"name": "remove",
|
|
1657
|
+
"tags": [],
|
|
1658
|
+
"docs": "",
|
|
1659
|
+
"complexTypes": [],
|
|
1660
|
+
"type": "() => Promise<void>"
|
|
1661
|
+
}
|
|
1662
|
+
]
|
|
1663
|
+
},
|
|
1664
|
+
{
|
|
1665
|
+
"name": "DeviceAttributionInfoReceivedEvent",
|
|
1666
|
+
"slug": "deviceattributioninforeceivedevent",
|
|
1667
|
+
"docs": "",
|
|
1668
|
+
"tags": [
|
|
1669
|
+
{
|
|
1670
|
+
"text": "0.1.0",
|
|
1671
|
+
"name": "since"
|
|
1672
|
+
}
|
|
1673
|
+
],
|
|
1674
|
+
"methods": [],
|
|
1675
|
+
"properties": [
|
|
1676
|
+
{
|
|
1677
|
+
"name": "campaignId",
|
|
1678
|
+
"tags": [
|
|
1679
|
+
{
|
|
1680
|
+
"text": "0.1.0",
|
|
1681
|
+
"name": "since"
|
|
1682
|
+
}
|
|
1683
|
+
],
|
|
1684
|
+
"docs": "The identifier of the campaign.",
|
|
1685
|
+
"complexTypes": [],
|
|
1686
|
+
"type": "string | undefined"
|
|
1687
|
+
},
|
|
1688
|
+
{
|
|
1689
|
+
"name": "campaignName",
|
|
1690
|
+
"tags": [
|
|
1691
|
+
{
|
|
1692
|
+
"text": "0.1.0",
|
|
1693
|
+
"name": "since"
|
|
1694
|
+
}
|
|
1695
|
+
],
|
|
1696
|
+
"docs": "The name of the campaign.",
|
|
1697
|
+
"complexTypes": [],
|
|
1698
|
+
"type": "string | undefined"
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
"name": "clickTimestamp",
|
|
1702
|
+
"tags": [
|
|
1703
|
+
{
|
|
1704
|
+
"text": "0.1.0",
|
|
1705
|
+
"name": "since"
|
|
1706
|
+
}
|
|
1707
|
+
],
|
|
1708
|
+
"docs": "The timestamp of the attributed click in milliseconds since the Unix epoch.",
|
|
1709
|
+
"complexTypes": [],
|
|
1710
|
+
"type": "number | undefined"
|
|
1711
|
+
},
|
|
1712
|
+
{
|
|
1713
|
+
"name": "creativeId",
|
|
1714
|
+
"tags": [
|
|
1715
|
+
{
|
|
1716
|
+
"text": "0.1.0",
|
|
1717
|
+
"name": "since"
|
|
1718
|
+
}
|
|
1719
|
+
],
|
|
1720
|
+
"docs": "The identifier of the creative.",
|
|
1721
|
+
"complexTypes": [],
|
|
1722
|
+
"type": "string | undefined"
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"name": "creativeName",
|
|
1726
|
+
"tags": [
|
|
1727
|
+
{
|
|
1728
|
+
"text": "0.1.0",
|
|
1729
|
+
"name": "since"
|
|
1730
|
+
}
|
|
1731
|
+
],
|
|
1732
|
+
"docs": "The name of the creative.",
|
|
1733
|
+
"complexTypes": [],
|
|
1734
|
+
"type": "string | undefined"
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"name": "matchType",
|
|
1738
|
+
"tags": [
|
|
1739
|
+
{
|
|
1740
|
+
"text": "0.1.0",
|
|
1741
|
+
"name": "since"
|
|
1742
|
+
}
|
|
1743
|
+
],
|
|
1744
|
+
"docs": "The type of the attribution match.",
|
|
1745
|
+
"complexTypes": [],
|
|
1746
|
+
"type": "string | undefined"
|
|
1747
|
+
},
|
|
1748
|
+
{
|
|
1749
|
+
"name": "network",
|
|
1750
|
+
"tags": [
|
|
1751
|
+
{
|
|
1752
|
+
"text": "0.1.0",
|
|
1753
|
+
"name": "since"
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"text": "'Organic'",
|
|
1757
|
+
"name": "example"
|
|
1758
|
+
}
|
|
1759
|
+
],
|
|
1760
|
+
"docs": "The name of the attributed network.",
|
|
1761
|
+
"complexTypes": [],
|
|
1762
|
+
"type": "string"
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"name": "passthrough",
|
|
1766
|
+
"tags": [
|
|
1767
|
+
{
|
|
1768
|
+
"text": "0.1.0",
|
|
1769
|
+
"name": "since"
|
|
1770
|
+
}
|
|
1771
|
+
],
|
|
1772
|
+
"docs": "The passthrough parameters of the attributed link.",
|
|
1773
|
+
"complexTypes": [],
|
|
1774
|
+
"type": "string | undefined"
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"name": "subcampaignId",
|
|
1778
|
+
"tags": [
|
|
1779
|
+
{
|
|
1780
|
+
"text": "0.1.0",
|
|
1781
|
+
"name": "since"
|
|
1782
|
+
}
|
|
1783
|
+
],
|
|
1784
|
+
"docs": "The identifier of the sub campaign.",
|
|
1785
|
+
"complexTypes": [],
|
|
1786
|
+
"type": "string | undefined"
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"name": "subcampaignName",
|
|
1790
|
+
"tags": [
|
|
1791
|
+
{
|
|
1792
|
+
"text": "0.1.0",
|
|
1793
|
+
"name": "since"
|
|
1794
|
+
}
|
|
1795
|
+
],
|
|
1796
|
+
"docs": "The name of the sub campaign.",
|
|
1797
|
+
"complexTypes": [],
|
|
1798
|
+
"type": "string | undefined"
|
|
1799
|
+
}
|
|
1800
|
+
]
|
|
1801
|
+
},
|
|
1802
|
+
{
|
|
1803
|
+
"name": "SdidReceivedEvent",
|
|
1804
|
+
"slug": "sdidreceivedevent",
|
|
1805
|
+
"docs": "",
|
|
1806
|
+
"tags": [
|
|
1807
|
+
{
|
|
1808
|
+
"text": "0.1.0",
|
|
1809
|
+
"name": "since"
|
|
1810
|
+
}
|
|
1811
|
+
],
|
|
1812
|
+
"methods": [],
|
|
1813
|
+
"properties": [
|
|
1814
|
+
{
|
|
1815
|
+
"name": "sdid",
|
|
1816
|
+
"tags": [
|
|
1817
|
+
{
|
|
1818
|
+
"text": "0.1.0",
|
|
1819
|
+
"name": "since"
|
|
1820
|
+
}
|
|
1821
|
+
],
|
|
1822
|
+
"docs": "The Singular Device ID.",
|
|
1823
|
+
"complexTypes": [],
|
|
1824
|
+
"type": "string"
|
|
1825
|
+
}
|
|
1826
|
+
]
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"name": "SdidSetEvent",
|
|
1830
|
+
"slug": "sdidsetevent",
|
|
1831
|
+
"docs": "",
|
|
1832
|
+
"tags": [
|
|
1833
|
+
{
|
|
1834
|
+
"text": "0.1.0",
|
|
1835
|
+
"name": "since"
|
|
1836
|
+
}
|
|
1837
|
+
],
|
|
1838
|
+
"methods": [],
|
|
1839
|
+
"properties": [
|
|
1840
|
+
{
|
|
1841
|
+
"name": "sdid",
|
|
1842
|
+
"tags": [
|
|
1843
|
+
{
|
|
1844
|
+
"text": "0.1.0",
|
|
1845
|
+
"name": "since"
|
|
1846
|
+
}
|
|
1847
|
+
],
|
|
1848
|
+
"docs": "The Singular Device ID.",
|
|
1849
|
+
"complexTypes": [],
|
|
1850
|
+
"type": "string"
|
|
1851
|
+
}
|
|
1852
|
+
]
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "SingularLinkResolvedEvent",
|
|
1856
|
+
"slug": "singularlinkresolvedevent",
|
|
1857
|
+
"docs": "",
|
|
1858
|
+
"tags": [
|
|
1859
|
+
{
|
|
1860
|
+
"text": "0.1.0",
|
|
1861
|
+
"name": "since"
|
|
1862
|
+
}
|
|
1863
|
+
],
|
|
1864
|
+
"methods": [],
|
|
1865
|
+
"properties": [
|
|
1866
|
+
{
|
|
1867
|
+
"name": "deepLink",
|
|
1868
|
+
"tags": [
|
|
1869
|
+
{
|
|
1870
|
+
"text": "0.1.0",
|
|
1871
|
+
"name": "since"
|
|
1872
|
+
}
|
|
1873
|
+
],
|
|
1874
|
+
"docs": "The deep link value of the Singular Link.",
|
|
1875
|
+
"complexTypes": [],
|
|
1876
|
+
"type": "string | null"
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"name": "isDeferred",
|
|
1880
|
+
"tags": [
|
|
1881
|
+
{
|
|
1882
|
+
"text": "0.1.0",
|
|
1883
|
+
"name": "since"
|
|
1884
|
+
}
|
|
1885
|
+
],
|
|
1886
|
+
"docs": "Whether the link is a deferred deep link (i.e. resolved after an install).",
|
|
1887
|
+
"complexTypes": [],
|
|
1888
|
+
"type": "boolean"
|
|
1889
|
+
},
|
|
1890
|
+
{
|
|
1891
|
+
"name": "passthrough",
|
|
1892
|
+
"tags": [
|
|
1893
|
+
{
|
|
1894
|
+
"text": "0.1.0",
|
|
1895
|
+
"name": "since"
|
|
1896
|
+
}
|
|
1897
|
+
],
|
|
1898
|
+
"docs": "The passthrough value of the Singular Link.",
|
|
1899
|
+
"complexTypes": [],
|
|
1900
|
+
"type": "string | null"
|
|
1901
|
+
},
|
|
1902
|
+
{
|
|
1903
|
+
"name": "urlParameters",
|
|
1904
|
+
"tags": [
|
|
1905
|
+
{
|
|
1906
|
+
"text": "0.1.0",
|
|
1907
|
+
"name": "since"
|
|
1908
|
+
}
|
|
1909
|
+
],
|
|
1910
|
+
"docs": "The query parameters of the Singular Link.",
|
|
1911
|
+
"complexTypes": [
|
|
1912
|
+
"Record"
|
|
1913
|
+
],
|
|
1914
|
+
"type": "Record<string, string>"
|
|
1915
|
+
}
|
|
1916
|
+
]
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
"name": "SkanConversionValueUpdatedEvent",
|
|
1920
|
+
"slug": "skanconversionvalueupdatedevent",
|
|
1921
|
+
"docs": "",
|
|
1922
|
+
"tags": [
|
|
1923
|
+
{
|
|
1924
|
+
"text": "0.1.0",
|
|
1925
|
+
"name": "since"
|
|
1926
|
+
}
|
|
1927
|
+
],
|
|
1928
|
+
"methods": [],
|
|
1929
|
+
"properties": [
|
|
1930
|
+
{
|
|
1931
|
+
"name": "coarseValue",
|
|
1932
|
+
"tags": [
|
|
1933
|
+
{
|
|
1934
|
+
"text": "0.1.0",
|
|
1935
|
+
"name": "since"
|
|
1936
|
+
}
|
|
1937
|
+
],
|
|
1938
|
+
"docs": "The coarse conversion value.\n\nOnly available on iOS 16.1+.",
|
|
1939
|
+
"complexTypes": [
|
|
1940
|
+
"SkanCoarseConversionValue"
|
|
1941
|
+
],
|
|
1942
|
+
"type": "SkanCoarseConversionValue | null"
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"name": "lockWindow",
|
|
1946
|
+
"tags": [
|
|
1947
|
+
{
|
|
1948
|
+
"text": "0.1.0",
|
|
1949
|
+
"name": "since"
|
|
1950
|
+
}
|
|
1951
|
+
],
|
|
1952
|
+
"docs": "Whether the conversion window is locked.\n\nOnly available on iOS 16.1+.",
|
|
1953
|
+
"complexTypes": [],
|
|
1954
|
+
"type": "boolean"
|
|
1955
|
+
},
|
|
1956
|
+
{
|
|
1957
|
+
"name": "value",
|
|
1958
|
+
"tags": [
|
|
1959
|
+
{
|
|
1960
|
+
"text": "0.1.0",
|
|
1961
|
+
"name": "since"
|
|
1962
|
+
}
|
|
1963
|
+
],
|
|
1964
|
+
"docs": "The fine-grained conversion value (`0` - `63`).",
|
|
1965
|
+
"complexTypes": [],
|
|
1966
|
+
"type": "number | null"
|
|
1967
|
+
}
|
|
1968
|
+
]
|
|
1969
|
+
}
|
|
1970
|
+
],
|
|
1971
|
+
"enums": [
|
|
1972
|
+
{
|
|
1973
|
+
"name": "SkanCoarseConversionValue",
|
|
1974
|
+
"slug": "skancoarseconversionvalue",
|
|
1975
|
+
"members": [
|
|
1976
|
+
{
|
|
1977
|
+
"name": "High",
|
|
1978
|
+
"value": "'HIGH'",
|
|
1979
|
+
"tags": [
|
|
1980
|
+
{
|
|
1981
|
+
"text": "0.1.0",
|
|
1982
|
+
"name": "since"
|
|
1983
|
+
}
|
|
1984
|
+
],
|
|
1985
|
+
"docs": ""
|
|
1986
|
+
},
|
|
1987
|
+
{
|
|
1988
|
+
"name": "Low",
|
|
1989
|
+
"value": "'LOW'",
|
|
1990
|
+
"tags": [
|
|
1991
|
+
{
|
|
1992
|
+
"text": "0.1.0",
|
|
1993
|
+
"name": "since"
|
|
1994
|
+
}
|
|
1995
|
+
],
|
|
1996
|
+
"docs": ""
|
|
1997
|
+
},
|
|
1998
|
+
{
|
|
1999
|
+
"name": "Medium",
|
|
2000
|
+
"value": "'MEDIUM'",
|
|
2001
|
+
"tags": [
|
|
2002
|
+
{
|
|
2003
|
+
"text": "0.1.0",
|
|
2004
|
+
"name": "since"
|
|
2005
|
+
}
|
|
2006
|
+
],
|
|
2007
|
+
"docs": ""
|
|
2008
|
+
}
|
|
2009
|
+
]
|
|
2010
|
+
}
|
|
2011
|
+
],
|
|
2012
|
+
"typeAliases": [],
|
|
2013
|
+
"pluginConfigs": []
|
|
2014
|
+
}
|