@maxim_mazurok/gapi.client.firebasedynamiclinks-v1 0.1.20260316 → 0.2.20260601
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/index.d.ts +82 -29
- package/package.json +1 -1
- package/readme.md +17 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260601
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -106,9 +106,20 @@ declare namespace gapi.client {
|
|
|
106
106
|
/** The number of times this event occurred. */
|
|
107
107
|
count?: string;
|
|
108
108
|
/** Link event. */
|
|
109
|
-
event?:
|
|
109
|
+
event?:
|
|
110
|
+
| 'DYNAMIC_LINK_EVENT_UNSPECIFIED'
|
|
111
|
+
| 'CLICK'
|
|
112
|
+
| 'REDIRECT'
|
|
113
|
+
| 'APP_INSTALL'
|
|
114
|
+
| 'APP_FIRST_OPEN'
|
|
115
|
+
| 'APP_RE_OPEN';
|
|
110
116
|
/** Requested platform. */
|
|
111
|
-
platform?:
|
|
117
|
+
platform?:
|
|
118
|
+
| 'DYNAMIC_LINK_PLATFORM_UNSPECIFIED'
|
|
119
|
+
| 'ANDROID'
|
|
120
|
+
| 'IOS'
|
|
121
|
+
| 'DESKTOP'
|
|
122
|
+
| 'OTHER';
|
|
112
123
|
}
|
|
113
124
|
interface DynamicLinkInfo {
|
|
114
125
|
/** Parameters used for tracking. See all tracking parameters in the [documentation](https://firebase.google.com/docs/dynamic-links/create-manually). */
|
|
@@ -138,7 +149,37 @@ declare namespace gapi.client {
|
|
|
138
149
|
}
|
|
139
150
|
interface DynamicLinkWarning {
|
|
140
151
|
/** The warning code. */
|
|
141
|
-
warningCode?:
|
|
152
|
+
warningCode?:
|
|
153
|
+
| 'CODE_UNSPECIFIED'
|
|
154
|
+
| 'NOT_IN_PROJECT_ANDROID_PACKAGE_NAME'
|
|
155
|
+
| 'NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION'
|
|
156
|
+
| 'UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION'
|
|
157
|
+
| 'NOT_URI_ANDROID_LINK'
|
|
158
|
+
| 'UNNECESSARY_ANDROID_LINK'
|
|
159
|
+
| 'NOT_URI_ANDROID_FALLBACK_LINK'
|
|
160
|
+
| 'BAD_URI_SCHEME_ANDROID_FALLBACK_LINK'
|
|
161
|
+
| 'NOT_IN_PROJECT_IOS_BUNDLE_ID'
|
|
162
|
+
| 'NOT_IN_PROJECT_IPAD_BUNDLE_ID'
|
|
163
|
+
| 'UNNECESSARY_IOS_URL_SCHEME'
|
|
164
|
+
| 'NOT_NUMERIC_IOS_APP_STORE_ID'
|
|
165
|
+
| 'UNNECESSARY_IOS_APP_STORE_ID'
|
|
166
|
+
| 'NOT_URI_IOS_FALLBACK_LINK'
|
|
167
|
+
| 'BAD_URI_SCHEME_IOS_FALLBACK_LINK'
|
|
168
|
+
| 'NOT_URI_IPAD_FALLBACK_LINK'
|
|
169
|
+
| 'BAD_URI_SCHEME_IPAD_FALLBACK_LINK'
|
|
170
|
+
| 'BAD_DEBUG_PARAM'
|
|
171
|
+
| 'BAD_AD_PARAM'
|
|
172
|
+
| 'DEPRECATED_PARAM'
|
|
173
|
+
| 'UNRECOGNIZED_PARAM'
|
|
174
|
+
| 'TOO_LONG_PARAM'
|
|
175
|
+
| 'NOT_URI_SOCIAL_IMAGE_LINK'
|
|
176
|
+
| 'BAD_URI_SCHEME_SOCIAL_IMAGE_LINK'
|
|
177
|
+
| 'NOT_URI_SOCIAL_URL'
|
|
178
|
+
| 'BAD_URI_SCHEME_SOCIAL_URL'
|
|
179
|
+
| 'LINK_LENGTH_TOO_LONG'
|
|
180
|
+
| 'LINK_WITH_FRAGMENTS'
|
|
181
|
+
| 'NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID'
|
|
182
|
+
| 'API_DEPRECATED';
|
|
142
183
|
/** The document describing the warning, and helps resolve. */
|
|
143
184
|
warningDocumentLink?: string;
|
|
144
185
|
/** The warning message to help developers improve their requests. */
|
|
@@ -154,19 +195,27 @@ declare namespace gapi.client {
|
|
|
154
195
|
/** iOS version, ie: 9.3.5. Consider adding "build". */
|
|
155
196
|
iosVersion?: string;
|
|
156
197
|
/** App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link. */
|
|
157
|
-
retrievalMethod?:
|
|
198
|
+
retrievalMethod?:
|
|
199
|
+
| 'UNKNOWN_PAYLOAD_RETRIEVAL_METHOD'
|
|
200
|
+
| 'IMPLICIT_WEAK_MATCH'
|
|
201
|
+
| 'EXPLICIT_WEAK_MATCH'
|
|
202
|
+
| 'EXPLICIT_STRONG_AFTER_WEAK_MATCH';
|
|
158
203
|
/** Google SDK version. Version takes the form "$major.$minor.$patch" */
|
|
159
204
|
sdkVersion?: string;
|
|
160
205
|
/** Possible unique matched link that server need to check before performing device heuristics match. If passed link is short server need to expand the link. If link is long server need to vslidate the link. */
|
|
161
206
|
uniqueMatchLinkToCheck?: string;
|
|
162
207
|
/** Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie. */
|
|
163
|
-
visualStyle?:
|
|
208
|
+
visualStyle?: 'UNKNOWN_VISUAL_STYLE' | 'DEFAULT_STYLE' | 'CUSTOM_STYLE';
|
|
164
209
|
}
|
|
165
210
|
interface GetIosPostInstallAttributionResponse {
|
|
166
211
|
/** The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this. */
|
|
167
212
|
appMinimumVersion?: string;
|
|
168
213
|
/** The confidence of the returned attribution. */
|
|
169
|
-
attributionConfidence?:
|
|
214
|
+
attributionConfidence?:
|
|
215
|
+
| 'UNKNOWN_ATTRIBUTION_CONFIDENCE'
|
|
216
|
+
| 'WEAK'
|
|
217
|
+
| 'DEFAULT'
|
|
218
|
+
| 'UNIQUE';
|
|
170
219
|
/** The deep-link attributed post-install via one of several techniques (device heuristics, copy unique). */
|
|
171
220
|
deepLink?: string;
|
|
172
221
|
/** User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com */
|
|
@@ -182,7 +231,7 @@ declare namespace gapi.client {
|
|
|
182
231
|
/** Entire FDL (short or long) attributed post-install via one of several techniques (device heuristics, copy unique). */
|
|
183
232
|
requestedLink?: string;
|
|
184
233
|
/** Which IP version the request was made from. */
|
|
185
|
-
requestIpVersion?:
|
|
234
|
+
requestIpVersion?: 'UNKNOWN_IP_VERSION' | 'IP_V4' | 'IP_V6';
|
|
186
235
|
/** The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign|medium|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links). */
|
|
187
236
|
resolvedLink?: string;
|
|
188
237
|
/** Scion campaign value to be propagated by iSDK to Scion at post-install. */
|
|
@@ -270,7 +319,7 @@ declare namespace gapi.client {
|
|
|
270
319
|
/** Creation timestamp of the short link. */
|
|
271
320
|
creationTime?: string;
|
|
272
321
|
/** Attributes that have been flagged about this short url. */
|
|
273
|
-
flaggedAttribute?:
|
|
322
|
+
flaggedAttribute?: 'UNSPECIFIED_ATTRIBUTE' | 'SPAM'[];
|
|
274
323
|
/** Full Dyamic Link info */
|
|
275
324
|
info?: DynamicLinkInfo;
|
|
276
325
|
/** Short durable link url, for example, "https://sample.app.goo.gl/xyz123". Required. */
|
|
@@ -278,7 +327,11 @@ declare namespace gapi.client {
|
|
|
278
327
|
/** Link name defined by the creator. Required. */
|
|
279
328
|
linkName?: string;
|
|
280
329
|
/** Visibility status of link. */
|
|
281
|
-
visibility?:
|
|
330
|
+
visibility?:
|
|
331
|
+
| 'UNSPECIFIED_VISIBILITY'
|
|
332
|
+
| 'UNARCHIVED'
|
|
333
|
+
| 'ARCHIVED'
|
|
334
|
+
| 'NEVER_SHOWN';
|
|
282
335
|
}
|
|
283
336
|
interface NavigationInfo {
|
|
284
337
|
/** If this option is on, FDL click will be forced to redirect rather than show an interstitial page. */
|
|
@@ -296,17 +349,17 @@ declare namespace gapi.client {
|
|
|
296
349
|
/** Only applies to Option.CUSTOM. */
|
|
297
350
|
customSuffix?: string;
|
|
298
351
|
/** Suffix option. */
|
|
299
|
-
option?:
|
|
352
|
+
option?: 'OPTION_UNSPECIFIED' | 'UNGUESSABLE' | 'SHORT' | 'CUSTOM';
|
|
300
353
|
}
|
|
301
354
|
interface ManagedShortLinksResource {
|
|
302
355
|
/** Creates a managed short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. This differs from CreateShortDynamicLink in the following ways: - The request will also contain a name for the link (non unique name for the front end). - The response must be authenticated with an auth token (generated with the admin service account). - The link will appear in the FDL list of links in the console front end. The Dynamic Link domain in the request must be owned by requester's Firebase project. */
|
|
303
356
|
create(request: {
|
|
304
357
|
/** V1 error format. */
|
|
305
|
-
'$.xgafv'?:
|
|
358
|
+
'$.xgafv'?: '1' | '2';
|
|
306
359
|
/** OAuth access token. */
|
|
307
360
|
access_token?: string;
|
|
308
361
|
/** Data format for response. */
|
|
309
|
-
alt?:
|
|
362
|
+
alt?: 'json' | 'media' | 'proto';
|
|
310
363
|
/** JSONP */
|
|
311
364
|
callback?: string;
|
|
312
365
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -329,11 +382,11 @@ declare namespace gapi.client {
|
|
|
329
382
|
create(
|
|
330
383
|
request: {
|
|
331
384
|
/** V1 error format. */
|
|
332
|
-
'$.xgafv'?:
|
|
385
|
+
'$.xgafv'?: '1' | '2';
|
|
333
386
|
/** OAuth access token. */
|
|
334
387
|
access_token?: string;
|
|
335
388
|
/** Data format for response. */
|
|
336
|
-
alt?:
|
|
389
|
+
alt?: 'json' | 'media' | 'proto';
|
|
337
390
|
/** JSONP */
|
|
338
391
|
callback?: string;
|
|
339
392
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -358,11 +411,11 @@ declare namespace gapi.client {
|
|
|
358
411
|
/** Creates a short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire. Repeated calls with the same long Dynamic Link or Dynamic Link information will produce the same short Dynamic Link. The Dynamic Link domain in the request must be owned by requester's Firebase project. */
|
|
359
412
|
create(request: {
|
|
360
413
|
/** V1 error format. */
|
|
361
|
-
'$.xgafv'?:
|
|
414
|
+
'$.xgafv'?: '1' | '2';
|
|
362
415
|
/** OAuth access token. */
|
|
363
416
|
access_token?: string;
|
|
364
417
|
/** Data format for response. */
|
|
365
|
-
alt?:
|
|
418
|
+
alt?: 'json' | 'media' | 'proto';
|
|
366
419
|
/** JSONP */
|
|
367
420
|
callback?: string;
|
|
368
421
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -385,11 +438,11 @@ declare namespace gapi.client {
|
|
|
385
438
|
create(
|
|
386
439
|
request: {
|
|
387
440
|
/** V1 error format. */
|
|
388
|
-
'$.xgafv'?:
|
|
441
|
+
'$.xgafv'?: '1' | '2';
|
|
389
442
|
/** OAuth access token. */
|
|
390
443
|
access_token?: string;
|
|
391
444
|
/** Data format for response. */
|
|
392
|
-
alt?:
|
|
445
|
+
alt?: 'json' | 'media' | 'proto';
|
|
393
446
|
/** JSONP */
|
|
394
447
|
callback?: string;
|
|
395
448
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -414,11 +467,11 @@ declare namespace gapi.client {
|
|
|
414
467
|
/** Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens. */
|
|
415
468
|
getLinkStats(request?: {
|
|
416
469
|
/** V1 error format. */
|
|
417
|
-
'$.xgafv'?:
|
|
470
|
+
'$.xgafv'?: '1' | '2';
|
|
418
471
|
/** OAuth access token. */
|
|
419
472
|
access_token?: string;
|
|
420
473
|
/** Data format for response. */
|
|
421
|
-
alt?:
|
|
474
|
+
alt?: 'json' | 'media' | 'proto';
|
|
422
475
|
/** JSONP */
|
|
423
476
|
callback?: string;
|
|
424
477
|
/** The span of time requested in days. */
|
|
@@ -445,11 +498,11 @@ declare namespace gapi.client {
|
|
|
445
498
|
/** Get iOS strong/weak-match info for post-install attribution. */
|
|
446
499
|
installAttribution(request: {
|
|
447
500
|
/** V1 error format. */
|
|
448
|
-
'$.xgafv'?:
|
|
501
|
+
'$.xgafv'?: '1' | '2';
|
|
449
502
|
/** OAuth access token. */
|
|
450
503
|
access_token?: string;
|
|
451
504
|
/** Data format for response. */
|
|
452
|
-
alt?:
|
|
505
|
+
alt?: 'json' | 'media' | 'proto';
|
|
453
506
|
/** JSONP */
|
|
454
507
|
callback?: string;
|
|
455
508
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -472,11 +525,11 @@ declare namespace gapi.client {
|
|
|
472
525
|
installAttribution(
|
|
473
526
|
request: {
|
|
474
527
|
/** V1 error format. */
|
|
475
|
-
'$.xgafv'?:
|
|
528
|
+
'$.xgafv'?: '1' | '2';
|
|
476
529
|
/** OAuth access token. */
|
|
477
530
|
access_token?: string;
|
|
478
531
|
/** Data format for response. */
|
|
479
|
-
alt?:
|
|
532
|
+
alt?: 'json' | 'media' | 'proto';
|
|
480
533
|
/** JSONP */
|
|
481
534
|
callback?: string;
|
|
482
535
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -499,11 +552,11 @@ declare namespace gapi.client {
|
|
|
499
552
|
/** Get iOS reopen attribution for app universal link open deeplinking. */
|
|
500
553
|
reopenAttribution(request: {
|
|
501
554
|
/** V1 error format. */
|
|
502
|
-
'$.xgafv'?:
|
|
555
|
+
'$.xgafv'?: '1' | '2';
|
|
503
556
|
/** OAuth access token. */
|
|
504
557
|
access_token?: string;
|
|
505
558
|
/** Data format for response. */
|
|
506
|
-
alt?:
|
|
559
|
+
alt?: 'json' | 'media' | 'proto';
|
|
507
560
|
/** JSONP */
|
|
508
561
|
callback?: string;
|
|
509
562
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -526,11 +579,11 @@ declare namespace gapi.client {
|
|
|
526
579
|
reopenAttribution(
|
|
527
580
|
request: {
|
|
528
581
|
/** V1 error format. */
|
|
529
|
-
'$.xgafv'?:
|
|
582
|
+
'$.xgafv'?: '1' | '2';
|
|
530
583
|
/** OAuth access token. */
|
|
531
584
|
access_token?: string;
|
|
532
585
|
/** Data format for response. */
|
|
533
|
-
alt?:
|
|
586
|
+
alt?: 'json' | 'media' | 'proto';
|
|
534
587
|
/** JSONP */
|
|
535
588
|
callback?: string;
|
|
536
589
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Firebase Dynamic Links API:
|
|
|
11
11
|
npm install @types/gapi.client.firebasedynamiclinks-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.firebasedynamiclinks-v1"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|