OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/firebase": { | 5 "https://www.googleapis.com/auth/firebase": { |
6 "description": "View and administer all your Firebase data a
nd settings" | 6 "description": "View and administer all your Firebase data a
nd settings" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://firebasedynamiclinks.googleapis.com/", | 12 "baseUrl": "https://firebasedynamiclinks.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "canonicalName": "Firebase Dynamic Links", | 14 "canonicalName": "Firebase Dynamic Links", |
15 "description": "Programmatically creates and manages Firebase Dynamic Links.
", | 15 "description": "Programmatically creates and manages Firebase Dynamic Links.
", |
16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
17 "documentationLink": "https://firebase.google.com/docs/dynamic-links/", | 17 "documentationLink": "https://firebase.google.com/docs/dynamic-links/", |
18 "icons": { | 18 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 21 }, |
22 "id": "firebasedynamiclinks:v1", | 22 "id": "firebasedynamiclinks:v1", |
23 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
24 "name": "firebasedynamiclinks", | 24 "name": "firebasedynamiclinks", |
25 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 26 "ownerName": "Google", |
27 "parameters": { | 27 "parameters": { |
| 28 "bearer_token": { |
| 29 "description": "OAuth bearer token.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
28 "oauth_token": { | 33 "oauth_token": { |
29 "description": "OAuth 2.0 token for the current user.", | 34 "description": "OAuth 2.0 token for the current user.", |
30 "location": "query", | 35 "location": "query", |
31 "type": "string" | 36 "type": "string" |
32 }, | 37 }, |
33 "bearer_token": { | |
34 "description": "OAuth bearer token.", | |
35 "location": "query", | |
36 "type": "string" | |
37 }, | |
38 "upload_protocol": { | 38 "upload_protocol": { |
39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
40 "location": "query", | 40 "location": "query", |
41 "type": "string" | 41 "type": "string" |
42 }, | 42 }, |
43 "prettyPrint": { | 43 "prettyPrint": { |
44 "default": "true", | 44 "default": "true", |
45 "description": "Returns response with indentations and line breaks."
, | 45 "description": "Returns response with indentations and line breaks."
, |
46 "location": "query", | 46 "location": "query", |
47 "type": "boolean" | 47 "type": "boolean" |
48 }, | 48 }, |
| 49 "uploadType": { |
| 50 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
49 "fields": { | 54 "fields": { |
50 "description": "Selector specifying which fields to include in a par
tial response.", | 55 "description": "Selector specifying which fields to include in a par
tial response.", |
51 "location": "query", | 56 "location": "query", |
52 "type": "string" | 57 "type": "string" |
53 }, | 58 }, |
54 "uploadType": { | |
55 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
56 "location": "query", | |
57 "type": "string" | |
58 }, | |
59 "callback": { | |
60 "description": "JSONP", | |
61 "location": "query", | |
62 "type": "string" | |
63 }, | |
64 "$.xgafv": { | 59 "$.xgafv": { |
65 "description": "V1 error format.", | 60 "description": "V1 error format.", |
66 "enum": [ | 61 "enum": [ |
67 "1", | 62 "1", |
68 "2" | 63 "2" |
69 ], | 64 ], |
70 "enumDescriptions": [ | 65 "enumDescriptions": [ |
71 "v1 error format", | 66 "v1 error format", |
72 "v2 error format" | 67 "v2 error format" |
73 ], | 68 ], |
74 "location": "query", | 69 "location": "query", |
75 "type": "string" | 70 "type": "string" |
76 }, | 71 }, |
| 72 "callback": { |
| 73 "description": "JSONP", |
| 74 "location": "query", |
| 75 "type": "string" |
| 76 }, |
77 "alt": { | 77 "alt": { |
78 "default": "json", | 78 "default": "json", |
79 "description": "Data format for response.", | 79 "description": "Data format for response.", |
80 "enum": [ | 80 "enum": [ |
81 "json", | 81 "json", |
82 "media", | 82 "media", |
83 "proto" | 83 "proto" |
84 ], | 84 ], |
85 "enumDescriptions": [ | 85 "enumDescriptions": [ |
86 "Responses with Content-Type of application/json", | 86 "Responses with Content-Type of application/json", |
87 "Media download with context-dependent Content-Type", | 87 "Media download with context-dependent Content-Type", |
88 "Responses with Content-Type of application/x-protobuf" | 88 "Responses with Content-Type of application/x-protobuf" |
89 ], | 89 ], |
90 "location": "query", | 90 "location": "query", |
91 "type": "string" | 91 "type": "string" |
92 }, | 92 }, |
| 93 "access_token": { |
| 94 "description": "OAuth access token.", |
| 95 "location": "query", |
| 96 "type": "string" |
| 97 }, |
93 "key": { | 98 "key": { |
94 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 99 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
95 "location": "query", | 100 "location": "query", |
96 "type": "string" | 101 "type": "string" |
97 }, | 102 }, |
98 "access_token": { | |
99 "description": "OAuth access token.", | |
100 "location": "query", | |
101 "type": "string" | |
102 }, | |
103 "quotaUser": { | 103 "quotaUser": { |
104 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 104 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
105 "location": "query", | 105 "location": "query", |
106 "type": "string" | 106 "type": "string" |
107 }, | 107 }, |
108 "pp": { | 108 "pp": { |
109 "default": "true", | 109 "default": "true", |
110 "description": "Pretty-print response.", | 110 "description": "Pretty-print response.", |
111 "location": "query", | 111 "location": "query", |
112 "type": "boolean" | 112 "type": "boolean" |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
| 117 "shortLinks": { |
| 118 "methods": { |
| 119 "create": { |
| 120 "description": "Creates a short Dynamic Link given either a
valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS
app information.\nThe created short Dynamic Link will not expire.\n\nRepeated c
alls with the same long Dynamic Link or Dynamic Link information\nwill produce t
he same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be ow
ned by requester's\nFirebase project.", |
| 121 "httpMethod": "POST", |
| 122 "id": "firebasedynamiclinks.shortLinks.create", |
| 123 "parameterOrder": [], |
| 124 "parameters": {}, |
| 125 "path": "v1/shortLinks", |
| 126 "request": { |
| 127 "$ref": "CreateShortDynamicLinkRequest" |
| 128 }, |
| 129 "response": { |
| 130 "$ref": "CreateShortDynamicLinkResponse" |
| 131 }, |
| 132 "scopes": [ |
| 133 "https://www.googleapis.com/auth/firebase" |
| 134 ] |
| 135 } |
| 136 } |
| 137 }, |
117 "v1": { | 138 "v1": { |
118 "methods": { | 139 "methods": { |
119 "getLinkStats": { | 140 "getLinkStats": { |
120 "description": "Fetches analytics stats of a short Dynamic L
ink for a given\nduration. Metrics include number of clicks, redirects, installs
,\napp first opens, and app reopens.", | 141 "description": "Fetches analytics stats of a short Dynamic L
ink for a given\nduration. Metrics include number of clicks, redirects, installs
,\napp first opens, and app reopens.", |
121 "httpMethod": "GET", | 142 "httpMethod": "GET", |
122 "id": "firebasedynamiclinks.getLinkStats", | 143 "id": "firebasedynamiclinks.getLinkStats", |
123 "parameterOrder": [ | 144 "parameterOrder": [ |
124 "dynamicLink" | 145 "dynamicLink" |
125 ], | 146 ], |
126 "parameters": { | 147 "parameters": { |
(...skipping 12 matching lines...) Expand all Loading... |
139 }, | 160 }, |
140 "path": "v1/{dynamicLink}/linkStats", | 161 "path": "v1/{dynamicLink}/linkStats", |
141 "response": { | 162 "response": { |
142 "$ref": "DynamicLinkStats" | 163 "$ref": "DynamicLinkStats" |
143 }, | 164 }, |
144 "scopes": [ | 165 "scopes": [ |
145 "https://www.googleapis.com/auth/firebase" | 166 "https://www.googleapis.com/auth/firebase" |
146 ] | 167 ] |
147 } | 168 } |
148 } | 169 } |
149 }, | |
150 "shortLinks": { | |
151 "methods": { | |
152 "create": { | |
153 "description": "Creates a short Dynamic Link given either a
valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS
app information.\nThe created short Dynamic Link will not expire.\n\nRepeated c
alls with the same long Dynamic Link or Dynamic Link information\nwill produce t
he same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be ow
ned by requester's\nFirebase project.", | |
154 "httpMethod": "POST", | |
155 "id": "firebasedynamiclinks.shortLinks.create", | |
156 "parameterOrder": [], | |
157 "parameters": {}, | |
158 "path": "v1/shortLinks", | |
159 "request": { | |
160 "$ref": "CreateShortDynamicLinkRequest" | |
161 }, | |
162 "response": { | |
163 "$ref": "CreateShortDynamicLinkResponse" | |
164 }, | |
165 "scopes": [ | |
166 "https://www.googleapis.com/auth/firebase" | |
167 ] | |
168 } | |
169 } | |
170 } | 170 } |
171 }, | 171 }, |
172 "revision": "20170605", | 172 "revision": "20170703", |
173 "rootUrl": "https://firebasedynamiclinks.googleapis.com/", | 173 "rootUrl": "https://firebasedynamiclinks.googleapis.com/", |
174 "schemas": { | 174 "schemas": { |
175 "DynamicLinkEventStat": { | |
176 "description": "Dynamic Link event stat.", | |
177 "id": "DynamicLinkEventStat", | |
178 "properties": { | |
179 "count": { | |
180 "description": "The number of times this event occurred.", | |
181 "format": "int64", | |
182 "type": "string" | |
183 }, | |
184 "event": { | |
185 "description": "Link event.", | |
186 "enum": [ | |
187 "DYNAMIC_LINK_EVENT_UNSPECIFIED", | |
188 "CLICK", | |
189 "REDIRECT", | |
190 "APP_INSTALL", | |
191 "APP_FIRST_OPEN", | |
192 "APP_RE_OPEN" | |
193 ], | |
194 "enumDescriptions": [ | |
195 "Unspecified type.", | |
196 "Indicates that an FDL is clicked by users.", | |
197 "Indicates that an FDL redirects users to fallback link.
", | |
198 "Indicates that an FDL triggers an app install from Play
store, currently\nit's impossible to get stats from App store.", | |
199 "Indicates that the app is opened for the first time aft
er an install\ntriggered by FDLs", | |
200 "Indicates that the app is opened via an FDL for non-fir
st time." | |
201 ], | |
202 "type": "string" | |
203 }, | |
204 "platform": { | |
205 "description": "Requested platform.", | |
206 "enum": [ | |
207 "DYNAMIC_LINK_PLATFORM_UNSPECIFIED", | |
208 "ANDROID", | |
209 "IOS", | |
210 "DESKTOP" | |
211 ], | |
212 "enumDescriptions": [ | |
213 "Unspecified platform.", | |
214 "Represents Android platform.\nAll apps and browsers on
Android are classfied in this category.", | |
215 "Represents iOS platform.\nAll apps and browsers on iOS
are classfied in this category.", | |
216 "Represents desktop.\nNote: other platforms like Windows
, Blackberry, Amazon fall into this\ncategory." | |
217 ], | |
218 "type": "string" | |
219 } | |
220 }, | |
221 "type": "object" | |
222 }, | |
223 "CreateShortDynamicLinkResponse": { | |
224 "description": "Response to create a short Dynamic Link.", | |
225 "id": "CreateShortDynamicLinkResponse", | |
226 "properties": { | |
227 "shortLink": { | |
228 "description": "Short Dynamic Link value. e.g. https://abcd.
app.goo.gl/wxyz", | |
229 "type": "string" | |
230 }, | |
231 "previewLink": { | |
232 "description": "Preivew link to show the link flow chart.", | |
233 "type": "string" | |
234 }, | |
235 "warning": { | |
236 "description": "Information about potential warnings on link
creation.", | |
237 "items": { | |
238 "$ref": "DynamicLinkWarning" | |
239 }, | |
240 "type": "array" | |
241 } | |
242 }, | |
243 "type": "object" | |
244 }, | |
245 "Suffix": { | |
246 "description": "Short Dynamic Link suffix.", | |
247 "id": "Suffix", | |
248 "properties": { | |
249 "option": { | |
250 "description": "Suffix option.", | |
251 "enum": [ | |
252 "OPTION_UNSPECIFIED", | |
253 "UNGUESSABLE", | |
254 "SHORT" | |
255 ], | |
256 "enumDescriptions": [ | |
257 "The suffix option is not specified, performs as NOT_GUE
SSABLE .", | |
258 "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encod
ed string of\na random generated 96 bit random number, which has a length of 17
chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guess
ing and crawling short Dynamic Links\nthat contain personal identifiable informa
tion.", | |
259 "Short Dynamic Link suffix is a base62 [0-9A-Za-z] strin
g starting with a\nlength of 4 chars. the length will increase when all the spac
e is\noccupied." | |
260 ], | |
261 "type": "string" | |
262 } | |
263 }, | |
264 "type": "object" | |
265 }, | |
266 "GooglePlayAnalytics": { | |
267 "description": "Parameters for Google Play Campaign Measurements.\n[
Learn more](https://developers.google.com/analytics/devguides/collection/android
/v4/campaigns#campaign-params)", | |
268 "id": "GooglePlayAnalytics", | |
269 "properties": { | |
270 "utmMedium": { | |
271 "description": "Campaign medium; used to identify a medium s
uch as email or cost-per-click.", | |
272 "type": "string" | |
273 }, | |
274 "utmTerm": { | |
275 "description": "Campaign term; used with paid search to supp
ly the keywords for ads.", | |
276 "type": "string" | |
277 }, | |
278 "utmSource": { | |
279 "description": "Campaign source; used to identify a search e
ngine, newsletter, or other\nsource.", | |
280 "type": "string" | |
281 }, | |
282 "gclid": { | |
283 "description": "[AdWords autotagging parameter](https://supp
ort.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords
ads. This value is generated dynamically\nand should never be modified.", | |
284 "type": "string" | |
285 }, | |
286 "utmCampaign": { | |
287 "description": "Campaign name; used for keyword analysis to
identify a specific product\npromotion or strategic campaign.", | |
288 "type": "string" | |
289 }, | |
290 "utmContent": { | |
291 "description": "Campaign content; used for A/B testing and c
ontent-targeted ads to\ndifferentiate ads or links that point to the same URL.", | |
292 "type": "string" | |
293 } | |
294 }, | |
295 "type": "object" | |
296 }, | |
297 "DynamicLinkInfo": { | |
298 "description": "Information about a Dynamic Link.", | |
299 "id": "DynamicLinkInfo", | |
300 "properties": { | |
301 "iosInfo": { | |
302 "$ref": "IosInfo", | |
303 "description": "iOS related information. See iOS related par
ameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/c
reate-manually)." | |
304 }, | |
305 "socialMetaTagInfo": { | |
306 "$ref": "SocialMetaTagInfo", | |
307 "description": "Parameters for social meta tag params.\nUsed
to set meta tag data for link previews on social sites." | |
308 }, | |
309 "androidInfo": { | |
310 "$ref": "AndroidInfo", | |
311 "description": "Android related information. See Android rel
ated parameters in the\n[documentation](https://firebase.google.com/docs/dynamic
-links/create-manually)." | |
312 }, | |
313 "navigationInfo": { | |
314 "$ref": "NavigationInfo", | |
315 "description": "Information of navigation behavior of a Fire
base Dynamic Links." | |
316 }, | |
317 "analyticsInfo": { | |
318 "$ref": "AnalyticsInfo", | |
319 "description": "Parameters used for tracking. See all tracki
ng parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-l
inks/create-manually)." | |
320 }, | |
321 "dynamicLinkDomain": { | |
322 "description": "Dynamic Links domain that the project owns,
e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-link
s/android/receive)\non how to set up Dynamic Link domain associated with your Fi
rebase project.\n\nRequired.", | |
323 "type": "string" | |
324 }, | |
325 "link": { | |
326 "description": "The link your app will open, You can specify
any URL your app can handle.\nThis link must be a well-formatted URL, be proper
ly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\
n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)
.\n\nRequired.", | |
327 "type": "string" | |
328 } | |
329 }, | |
330 "type": "object" | |
331 }, | |
332 "ITunesConnectAnalytics": { | |
333 "description": "Parameters for iTunes Connect App Analytics.", | |
334 "id": "ITunesConnectAnalytics", | |
335 "properties": { | |
336 "at": { | |
337 "description": "Affiliate token used to create affiliate-cod
ed links.", | |
338 "type": "string" | |
339 }, | |
340 "mt": { | |
341 "description": "iTune media types, including music, podcasts
, audiobooks and so on.", | |
342 "type": "string" | |
343 }, | |
344 "ct": { | |
345 "description": "Campaign text that developers can optionally
add to any link in order to\ntrack sales from a specific marketing campaign.", | |
346 "type": "string" | |
347 }, | |
348 "pt": { | |
349 "description": "Provider token that enables analytics for Dy
namic Links from within iTunes\nConnect.", | |
350 "type": "string" | |
351 } | |
352 }, | |
353 "type": "object" | |
354 }, | |
355 "SocialMetaTagInfo": { | 175 "SocialMetaTagInfo": { |
356 "description": "Parameters for social meta tag params.\nUsed to set
meta tag data for link previews on social sites.", | 176 "description": "Parameters for social meta tag params.\nUsed to set
meta tag data for link previews on social sites.", |
357 "id": "SocialMetaTagInfo", | 177 "id": "SocialMetaTagInfo", |
358 "properties": { | 178 "properties": { |
359 "socialImageLink": { | 179 "socialImageLink": { |
360 "description": "An image url string. Optional.", | 180 "description": "An image url string. Optional.", |
361 "type": "string" | 181 "type": "string" |
362 }, | 182 }, |
363 "socialTitle": { | 183 "socialTitle": { |
364 "description": "Title to be displayed. Optional.", | 184 "description": "Title to be displayed. Optional.", |
365 "type": "string" | 185 "type": "string" |
366 }, | 186 }, |
367 "socialDescription": { | 187 "socialDescription": { |
368 "description": "A short description of the link. Optional.", | 188 "description": "A short description of the link. Optional.", |
369 "type": "string" | 189 "type": "string" |
370 } | 190 } |
371 }, | 191 }, |
372 "type": "object" | 192 "type": "object" |
373 }, | 193 }, |
374 "AndroidInfo": { | 194 "DynamicLinkStats": { |
375 "description": "Android related attributes to the Dynamic Link.", | 195 "description": "Analytics stats of a Dynamic Link for a given timefr
ame.", |
376 "id": "AndroidInfo", | 196 "id": "DynamicLinkStats", |
377 "properties": { | 197 "properties": { |
378 "androidPackageName": { | 198 "linkEventStats": { |
379 "description": "Android package name of the app.", | 199 "description": "Dynamic Link event stats.", |
380 "type": "string" | 200 "items": { |
381 }, | 201 "$ref": "DynamicLinkEventStat" |
382 "androidMinPackageVersionCode": { | 202 }, |
383 "description": "Minimum version code for the Android app. If
the installed app’s version\ncode is lower, then the user is taken to the Play
Store.", | 203 "type": "array" |
384 "type": "string" | |
385 }, | |
386 "androidLink": { | |
387 "description": "If specified, this overrides the ‘link’ para
meter on Android.", | |
388 "type": "string" | |
389 }, | |
390 "androidFallbackLink": { | |
391 "description": "Link to open on Android if the app is not in
stalled.", | |
392 "type": "string" | |
393 } | 204 } |
394 }, | 205 }, |
395 "type": "object" | 206 "type": "object" |
396 }, | 207 }, |
397 "DynamicLinkWarning": { | 208 "DynamicLinkWarning": { |
398 "description": "Dynamic Links warning messages.", | 209 "description": "Dynamic Links warning messages.", |
399 "id": "DynamicLinkWarning", | 210 "id": "DynamicLinkWarning", |
400 "properties": { | 211 "properties": { |
| 212 "warningMessage": { |
| 213 "description": "The warning message to help developers impro
ve their requests.", |
| 214 "type": "string" |
| 215 }, |
401 "warningCode": { | 216 "warningCode": { |
402 "description": "The warning code.", | 217 "description": "The warning code.", |
403 "enum": [ | 218 "enum": [ |
404 "CODE_UNSPECIFIED", | 219 "CODE_UNSPECIFIED", |
405 "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME", | 220 "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME", |
406 "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION", | 221 "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION", |
407 "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION", | 222 "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION", |
408 "NOT_URI_ANDROID_LINK", | 223 "NOT_URI_ANDROID_LINK", |
409 "UNNECESSARY_ANDROID_LINK", | 224 "UNNECESSARY_ANDROID_LINK", |
410 "NOT_URI_ANDROID_FALLBACK_LINK", | 225 "NOT_URI_ANDROID_FALLBACK_LINK", |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
456 "Indicates certain paramater is too long.", | 271 "Indicates certain paramater is too long.", |
457 "Social meta tag image link is not a valid URI.", | 272 "Social meta tag image link is not a valid URI.", |
458 "Social meta tag image link has an invalid (non http/htt
ps) URI scheme.", | 273 "Social meta tag image link has an invalid (non http/htt
ps) URI scheme.", |
459 "", | 274 "", |
460 "", | 275 "", |
461 "Dynamic Link URL length is too long.", | 276 "Dynamic Link URL length is too long.", |
462 "Dynamic Link URL contains fragments.", | 277 "Dynamic Link URL contains fragments.", |
463 "The iOS bundle ID does not match with the given iOS sto
re ID." | 278 "The iOS bundle ID does not match with the given iOS sto
re ID." |
464 ], | 279 ], |
465 "type": "string" | 280 "type": "string" |
466 }, | |
467 "warningMessage": { | |
468 "description": "The warning message to help developers impro
ve their requests.", | |
469 "type": "string" | |
470 } | 281 } |
471 }, | 282 }, |
472 "type": "object" | 283 "type": "object" |
473 }, | 284 }, |
474 "DynamicLinkStats": { | 285 "AndroidInfo": { |
475 "description": "Analytics stats of a Dynamic Link for a given timefr
ame.", | 286 "description": "Android related attributes to the Dynamic Link.", |
476 "id": "DynamicLinkStats", | 287 "id": "AndroidInfo", |
477 "properties": { | 288 "properties": { |
478 "linkEventStats": { | 289 "androidLink": { |
479 "description": "Dynamic Link event stats.", | 290 "description": "If specified, this overrides the ‘link’ para
meter on Android.", |
480 "items": { | 291 "type": "string" |
481 "$ref": "DynamicLinkEventStat" | 292 }, |
482 }, | 293 "androidFallbackLink": { |
483 "type": "array" | 294 "description": "Link to open on Android if the app is not in
stalled.", |
| 295 "type": "string" |
| 296 }, |
| 297 "androidPackageName": { |
| 298 "description": "Android package name of the app.", |
| 299 "type": "string" |
| 300 }, |
| 301 "androidMinPackageVersionCode": { |
| 302 "description": "Minimum version code for the Android app. If
the installed app’s version\ncode is lower, then the user is taken to the Play
Store.", |
| 303 "type": "string" |
484 } | 304 } |
485 }, | 305 }, |
486 "type": "object" | 306 "type": "object" |
487 }, | 307 }, |
488 "NavigationInfo": { | 308 "NavigationInfo": { |
489 "description": "Information of navigation behavior.", | 309 "description": "Information of navigation behavior.", |
490 "id": "NavigationInfo", | 310 "id": "NavigationInfo", |
491 "properties": { | 311 "properties": { |
492 "enableForcedRedirect": { | 312 "enableForcedRedirect": { |
493 "description": "If this option is on, FDL click will be forc
ed to redirect rather than\nshow an interstitial page.", | 313 "description": "If this option is on, FDL click will be forc
ed to redirect rather than\nshow an interstitial page.", |
494 "type": "boolean" | 314 "type": "boolean" |
495 } | 315 } |
496 }, | 316 }, |
497 "type": "object" | 317 "type": "object" |
498 }, | 318 }, |
499 "IosInfo": { | 319 "IosInfo": { |
500 "description": "iOS related attributes to the Dynamic Link..", | 320 "description": "iOS related attributes to the Dynamic Link..", |
501 "id": "IosInfo", | 321 "id": "IosInfo", |
502 "properties": { | 322 "properties": { |
| 323 "iosFallbackLink": { |
| 324 "description": "Link to open on iOS if the app is not instal
led.", |
| 325 "type": "string" |
| 326 }, |
503 "iosAppStoreId": { | 327 "iosAppStoreId": { |
504 "description": "iOS App Store ID.", | 328 "description": "iOS App Store ID.", |
505 "type": "string" | 329 "type": "string" |
506 }, | 330 }, |
507 "iosIpadFallbackLink": { | 331 "iosIpadFallbackLink": { |
508 "description": "If specified, this overrides the ios_fallbac
k_link value on iPads.", | 332 "description": "If specified, this overrides the ios_fallbac
k_link value on iPads.", |
509 "type": "string" | 333 "type": "string" |
510 }, | 334 }, |
511 "iosIpadBundleId": { | 335 "iosIpadBundleId": { |
512 "description": "iPad bundle ID of the app.", | 336 "description": "iPad bundle ID of the app.", |
513 "type": "string" | 337 "type": "string" |
514 }, | 338 }, |
515 "iosCustomScheme": { | 339 "iosCustomScheme": { |
516 "description": "Custom (destination) scheme to use for iOS.
By default, we’ll use the\nbundle ID as the custom scheme. Developer can overrid
e this behavior using\nthis param.", | 340 "description": "Custom (destination) scheme to use for iOS.
By default, we’ll use the\nbundle ID as the custom scheme. Developer can overrid
e this behavior using\nthis param.", |
517 "type": "string" | 341 "type": "string" |
518 }, | 342 }, |
519 "iosBundleId": { | 343 "iosBundleId": { |
520 "description": "iOS bundle ID of the app.", | 344 "description": "iOS bundle ID of the app.", |
521 "type": "string" | 345 "type": "string" |
522 }, | |
523 "iosFallbackLink": { | |
524 "description": "Link to open on iOS if the app is not instal
led.", | |
525 "type": "string" | |
526 } | 346 } |
527 }, | 347 }, |
528 "type": "object" | 348 "type": "object" |
529 }, | 349 }, |
530 "AnalyticsInfo": { | 350 "AnalyticsInfo": { |
531 "description": "Tracking parameters supported by Dynamic Link.", | 351 "description": "Tracking parameters supported by Dynamic Link.", |
532 "id": "AnalyticsInfo", | 352 "id": "AnalyticsInfo", |
533 "properties": { | 353 "properties": { |
534 "itunesConnectAnalytics": { | 354 "itunesConnectAnalytics": { |
535 "$ref": "ITunesConnectAnalytics", | 355 "$ref": "ITunesConnectAnalytics", |
536 "description": "iTunes Connect App Analytics." | 356 "description": "iTunes Connect App Analytics." |
537 }, | 357 }, |
538 "googlePlayAnalytics": { | 358 "googlePlayAnalytics": { |
539 "$ref": "GooglePlayAnalytics", | 359 "$ref": "GooglePlayAnalytics", |
540 "description": "Google Play Campaign Measurements." | 360 "description": "Google Play Campaign Measurements." |
541 } | 361 } |
542 }, | 362 }, |
543 "type": "object" | 363 "type": "object" |
544 }, | 364 }, |
545 "CreateShortDynamicLinkRequest": { | 365 "CreateShortDynamicLinkRequest": { |
546 "description": "Request to create a short Dynamic Link.", | 366 "description": "Request to create a short Dynamic Link.", |
547 "id": "CreateShortDynamicLinkRequest", | 367 "id": "CreateShortDynamicLinkRequest", |
548 "properties": { | 368 "properties": { |
| 369 "longDynamicLink": { |
| 370 "description": "Full long Dynamic Link URL with desired quer
y parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://
www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/
dynamic-links/android#create-a-dynamic-link-programmatically).", |
| 371 "type": "string" |
| 372 }, |
549 "suffix": { | 373 "suffix": { |
550 "$ref": "Suffix", | 374 "$ref": "Suffix", |
551 "description": "Short Dynamic Link suffix. Optional." | 375 "description": "Short Dynamic Link suffix. Optional." |
552 }, | 376 }, |
553 "dynamicLinkInfo": { | 377 "dynamicLinkInfo": { |
554 "$ref": "DynamicLinkInfo", | 378 "$ref": "DynamicLinkInfo", |
555 "description": "Information about the Dynamic Link to be sho
rtened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#cre
ate-a-dynamic-link-programmatically)." | 379 "description": "Information about the Dynamic Link to be sho
rtened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#cre
ate-a-dynamic-link-programmatically)." |
| 380 } |
| 381 }, |
| 382 "type": "object" |
| 383 }, |
| 384 "DynamicLinkEventStat": { |
| 385 "description": "Dynamic Link event stat.", |
| 386 "id": "DynamicLinkEventStat", |
| 387 "properties": { |
| 388 "event": { |
| 389 "description": "Link event.", |
| 390 "enum": [ |
| 391 "DYNAMIC_LINK_EVENT_UNSPECIFIED", |
| 392 "CLICK", |
| 393 "REDIRECT", |
| 394 "APP_INSTALL", |
| 395 "APP_FIRST_OPEN", |
| 396 "APP_RE_OPEN" |
| 397 ], |
| 398 "enumDescriptions": [ |
| 399 "Unspecified type.", |
| 400 "Indicates that an FDL is clicked by users.", |
| 401 "Indicates that an FDL redirects users to fallback link.
", |
| 402 "Indicates that an FDL triggers an app install from Play
store, currently\nit's impossible to get stats from App store.", |
| 403 "Indicates that the app is opened for the first time aft
er an install\ntriggered by FDLs", |
| 404 "Indicates that the app is opened via an FDL for non-fir
st time." |
| 405 ], |
| 406 "type": "string" |
556 }, | 407 }, |
557 "longDynamicLink": { | 408 "platform": { |
558 "description": "Full long Dynamic Link URL with desired quer
y parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://
www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/
dynamic-links/android#create-a-dynamic-link-programmatically).", | 409 "description": "Requested platform.", |
| 410 "enum": [ |
| 411 "DYNAMIC_LINK_PLATFORM_UNSPECIFIED", |
| 412 "ANDROID", |
| 413 "IOS", |
| 414 "DESKTOP" |
| 415 ], |
| 416 "enumDescriptions": [ |
| 417 "Unspecified platform.", |
| 418 "Represents Android platform.\nAll apps and browsers on
Android are classfied in this category.", |
| 419 "Represents iOS platform.\nAll apps and browsers on iOS
are classfied in this category.", |
| 420 "Represents desktop.\nNote: other platforms like Windows
, Blackberry, Amazon fall into this\ncategory." |
| 421 ], |
| 422 "type": "string" |
| 423 }, |
| 424 "count": { |
| 425 "description": "The number of times this event occurred.", |
| 426 "format": "int64", |
559 "type": "string" | 427 "type": "string" |
560 } | 428 } |
561 }, | 429 }, |
| 430 "type": "object" |
| 431 }, |
| 432 "CreateShortDynamicLinkResponse": { |
| 433 "description": "Response to create a short Dynamic Link.", |
| 434 "id": "CreateShortDynamicLinkResponse", |
| 435 "properties": { |
| 436 "warning": { |
| 437 "description": "Information about potential warnings on link
creation.", |
| 438 "items": { |
| 439 "$ref": "DynamicLinkWarning" |
| 440 }, |
| 441 "type": "array" |
| 442 }, |
| 443 "shortLink": { |
| 444 "description": "Short Dynamic Link value. e.g. https://abcd.
app.goo.gl/wxyz", |
| 445 "type": "string" |
| 446 }, |
| 447 "previewLink": { |
| 448 "description": "Preivew link to show the link flow chart.", |
| 449 "type": "string" |
| 450 } |
| 451 }, |
| 452 "type": "object" |
| 453 }, |
| 454 "Suffix": { |
| 455 "description": "Short Dynamic Link suffix.", |
| 456 "id": "Suffix", |
| 457 "properties": { |
| 458 "option": { |
| 459 "description": "Suffix option.", |
| 460 "enum": [ |
| 461 "OPTION_UNSPECIFIED", |
| 462 "UNGUESSABLE", |
| 463 "SHORT" |
| 464 ], |
| 465 "enumDescriptions": [ |
| 466 "The suffix option is not specified, performs as NOT_GUE
SSABLE .", |
| 467 "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encod
ed string of\na random generated 96 bit random number, which has a length of 17
chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guess
ing and crawling short Dynamic Links\nthat contain personal identifiable informa
tion.", |
| 468 "Short Dynamic Link suffix is a base62 [0-9A-Za-z] strin
g starting with a\nlength of 4 chars. the length will increase when all the spac
e is\noccupied." |
| 469 ], |
| 470 "type": "string" |
| 471 } |
| 472 }, |
| 473 "type": "object" |
| 474 }, |
| 475 "GooglePlayAnalytics": { |
| 476 "description": "Parameters for Google Play Campaign Measurements.\n[
Learn more](https://developers.google.com/analytics/devguides/collection/android
/v4/campaigns#campaign-params)", |
| 477 "id": "GooglePlayAnalytics", |
| 478 "properties": { |
| 479 "utmContent": { |
| 480 "description": "Campaign content; used for A/B testing and c
ontent-targeted ads to\ndifferentiate ads or links that point to the same URL.", |
| 481 "type": "string" |
| 482 }, |
| 483 "utmMedium": { |
| 484 "description": "Campaign medium; used to identify a medium s
uch as email or cost-per-click.", |
| 485 "type": "string" |
| 486 }, |
| 487 "utmTerm": { |
| 488 "description": "Campaign term; used with paid search to supp
ly the keywords for ads.", |
| 489 "type": "string" |
| 490 }, |
| 491 "utmSource": { |
| 492 "description": "Campaign source; used to identify a search e
ngine, newsletter, or other\nsource.", |
| 493 "type": "string" |
| 494 }, |
| 495 "gclid": { |
| 496 "description": "[AdWords autotagging parameter](https://supp
ort.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords
ads. This value is generated dynamically\nand should never be modified.", |
| 497 "type": "string" |
| 498 }, |
| 499 "utmCampaign": { |
| 500 "description": "Campaign name; used for keyword analysis to
identify a specific product\npromotion or strategic campaign.", |
| 501 "type": "string" |
| 502 } |
| 503 }, |
| 504 "type": "object" |
| 505 }, |
| 506 "DynamicLinkInfo": { |
| 507 "description": "Information about a Dynamic Link.", |
| 508 "id": "DynamicLinkInfo", |
| 509 "properties": { |
| 510 "link": { |
| 511 "description": "The link your app will open, You can specify
any URL your app can handle.\nThis link must be a well-formatted URL, be proper
ly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\
n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)
.\n\nRequired.", |
| 512 "type": "string" |
| 513 }, |
| 514 "iosInfo": { |
| 515 "$ref": "IosInfo", |
| 516 "description": "iOS related information. See iOS related par
ameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/c
reate-manually)." |
| 517 }, |
| 518 "socialMetaTagInfo": { |
| 519 "$ref": "SocialMetaTagInfo", |
| 520 "description": "Parameters for social meta tag params.\nUsed
to set meta tag data for link previews on social sites." |
| 521 }, |
| 522 "androidInfo": { |
| 523 "$ref": "AndroidInfo", |
| 524 "description": "Android related information. See Android rel
ated parameters in the\n[documentation](https://firebase.google.com/docs/dynamic
-links/create-manually)." |
| 525 }, |
| 526 "navigationInfo": { |
| 527 "$ref": "NavigationInfo", |
| 528 "description": "Information of navigation behavior of a Fire
base Dynamic Links." |
| 529 }, |
| 530 "analyticsInfo": { |
| 531 "$ref": "AnalyticsInfo", |
| 532 "description": "Parameters used for tracking. See all tracki
ng parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-l
inks/create-manually)." |
| 533 }, |
| 534 "dynamicLinkDomain": { |
| 535 "description": "Dynamic Links domain that the project owns,
e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-link
s/android/receive)\non how to set up Dynamic Link domain associated with your Fi
rebase project.\n\nRequired.", |
| 536 "type": "string" |
| 537 } |
| 538 }, |
| 539 "type": "object" |
| 540 }, |
| 541 "ITunesConnectAnalytics": { |
| 542 "description": "Parameters for iTunes Connect App Analytics.", |
| 543 "id": "ITunesConnectAnalytics", |
| 544 "properties": { |
| 545 "at": { |
| 546 "description": "Affiliate token used to create affiliate-cod
ed links.", |
| 547 "type": "string" |
| 548 }, |
| 549 "mt": { |
| 550 "description": "iTune media types, including music, podcasts
, audiobooks and so on.", |
| 551 "type": "string" |
| 552 }, |
| 553 "ct": { |
| 554 "description": "Campaign text that developers can optionally
add to any link in order to\ntrack sales from a specific marketing campaign.", |
| 555 "type": "string" |
| 556 }, |
| 557 "pt": { |
| 558 "description": "Provider token that enables analytics for Dy
namic Links from within iTunes\nConnect.", |
| 559 "type": "string" |
| 560 } |
| 561 }, |
562 "type": "object" | 562 "type": "object" |
563 } | 563 } |
564 }, | 564 }, |
565 "servicePath": "", | 565 "servicePath": "", |
566 "title": "Firebase Dynamic Links API", | 566 "title": "Firebase Dynamic Links API", |
567 "version": "v1" | 567 "version": "v1" |
568 } | 568 } |
OLD | NEW |