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": "Firebase Dynamic Links API enables third party developers to
programmatically create and manage Dynamic Links.", | 15 "description": "Firebase Dynamic Links API enables third party developers to
programmatically create and manage 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 "key": { | |
29 "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.", | |
30 "location": "query", | |
31 "type": "string" | |
32 }, | |
33 "access_token": { | |
34 "description": "OAuth access token.", | |
35 "location": "query", | |
36 "type": "string" | |
37 }, | |
38 "quotaUser": { | |
39 "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.", | |
40 "location": "query", | |
41 "type": "string" | |
42 }, | |
43 "pp": { | |
44 "default": "true", | |
45 "description": "Pretty-print response.", | |
46 "location": "query", | |
47 "type": "boolean" | |
48 }, | |
49 "oauth_token": { | |
50 "description": "OAuth 2.0 token for the current user.", | |
51 "location": "query", | |
52 "type": "string" | |
53 }, | |
54 "bearer_token": { | |
55 "description": "OAuth bearer token.", | |
56 "location": "query", | |
57 "type": "string" | |
58 }, | |
59 "upload_protocol": { | |
60 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
61 "location": "query", | |
62 "type": "string" | |
63 }, | |
64 "prettyPrint": { | |
65 "default": "true", | |
66 "description": "Returns response with indentations and line breaks."
, | |
67 "location": "query", | |
68 "type": "boolean" | |
69 }, | |
70 "uploadType": { | 28 "uploadType": { |
71 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 29 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
72 "location": "query", | 30 "location": "query", |
73 "type": "string" | 31 "type": "string" |
74 }, | 32 }, |
75 "fields": { | 33 "fields": { |
76 "description": "Selector specifying which fields to include in a par
tial response.", | 34 "description": "Selector specifying which fields to include in a par
tial response.", |
77 "location": "query", | 35 "location": "query", |
78 "type": "string" | 36 "type": "string" |
79 }, | 37 }, |
(...skipping 23 matching lines...) Expand all Loading... |
103 "media", | 61 "media", |
104 "proto" | 62 "proto" |
105 ], | 63 ], |
106 "enumDescriptions": [ | 64 "enumDescriptions": [ |
107 "Responses with Content-Type of application/json", | 65 "Responses with Content-Type of application/json", |
108 "Media download with context-dependent Content-Type", | 66 "Media download with context-dependent Content-Type", |
109 "Responses with Content-Type of application/x-protobuf" | 67 "Responses with Content-Type of application/x-protobuf" |
110 ], | 68 ], |
111 "location": "query", | 69 "location": "query", |
112 "type": "string" | 70 "type": "string" |
| 71 }, |
| 72 "key": { |
| 73 "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.", |
| 74 "location": "query", |
| 75 "type": "string" |
| 76 }, |
| 77 "access_token": { |
| 78 "description": "OAuth access token.", |
| 79 "location": "query", |
| 80 "type": "string" |
| 81 }, |
| 82 "quotaUser": { |
| 83 "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.", |
| 84 "location": "query", |
| 85 "type": "string" |
| 86 }, |
| 87 "pp": { |
| 88 "default": "true", |
| 89 "description": "Pretty-print response.", |
| 90 "location": "query", |
| 91 "type": "boolean" |
| 92 }, |
| 93 "oauth_token": { |
| 94 "description": "OAuth 2.0 token for the current user.", |
| 95 "location": "query", |
| 96 "type": "string" |
| 97 }, |
| 98 "bearer_token": { |
| 99 "description": "OAuth bearer token.", |
| 100 "location": "query", |
| 101 "type": "string" |
| 102 }, |
| 103 "upload_protocol": { |
| 104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 105 "location": "query", |
| 106 "type": "string" |
| 107 }, |
| 108 "prettyPrint": { |
| 109 "default": "true", |
| 110 "description": "Returns response with indentations and line breaks."
, |
| 111 "location": "query", |
| 112 "type": "boolean" |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
117 "shortLinks": { | 117 "shortLinks": { |
118 "methods": { | 118 "methods": { |
119 "create": { | 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.", | 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", | 121 "httpMethod": "POST", |
122 "id": "firebasedynamiclinks.shortLinks.create", | 122 "id": "firebasedynamiclinks.shortLinks.create", |
123 "parameterOrder": [], | 123 "parameterOrder": [], |
124 "parameters": {}, | 124 "parameters": {}, |
125 "path": "v1/shortLinks", | 125 "path": "v1/shortLinks", |
126 "request": { | 126 "request": { |
127 "$ref": "CreateShortDynamicLinkRequest" | 127 "$ref": "CreateShortDynamicLinkRequest" |
128 }, | 128 }, |
129 "response": { | 129 "response": { |
130 "$ref": "CreateShortDynamicLinkResponse" | 130 "$ref": "CreateShortDynamicLinkResponse" |
131 }, | 131 }, |
132 "scopes": [ | 132 "scopes": [ |
133 "https://www.googleapis.com/auth/firebase" | 133 "https://www.googleapis.com/auth/firebase" |
134 ] | 134 ] |
135 } | 135 } |
136 } | 136 } |
137 } | 137 } |
138 }, | 138 }, |
139 "revision": "20170323", | 139 "revision": "20170405", |
140 "rootUrl": "https://firebasedynamiclinks.googleapis.com/", | 140 "rootUrl": "https://firebasedynamiclinks.googleapis.com/", |
141 "schemas": { | 141 "schemas": { |
| 142 "DynamicLinkWarning": { |
| 143 "description": "Dynamic Links warning messages.", |
| 144 "id": "DynamicLinkWarning", |
| 145 "properties": { |
| 146 "warningCode": { |
| 147 "description": "The warning code.", |
| 148 "enum": [ |
| 149 "CODE_UNSPECIFIED", |
| 150 "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME", |
| 151 "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION", |
| 152 "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION", |
| 153 "NOT_URI_ANDROID_LINK", |
| 154 "UNNECESSARY_ANDROID_LINK", |
| 155 "NOT_URI_ANDROID_FALLBACK_LINK", |
| 156 "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK", |
| 157 "NOT_IN_PROJECT_IOS_BUNDLE_ID", |
| 158 "NOT_IN_PROJECT_IPAD_BUNDLE_ID", |
| 159 "UNNECESSARY_IOS_URL_SCHEME", |
| 160 "NOT_NUMERIC_IOS_APP_STORE_ID", |
| 161 "UNNECESSARY_IOS_APP_STORE_ID", |
| 162 "NOT_URI_IOS_FALLBACK_LINK", |
| 163 "BAD_URI_SCHEME_IOS_FALLBACK_LINK", |
| 164 "NOT_URI_IPAD_FALLBACK_LINK", |
| 165 "BAD_URI_SCHEME_IPAD_FALLBACK_LINK", |
| 166 "BAD_DEBUG_PARAM", |
| 167 "BAD_AD_PARAM", |
| 168 "DEPRECATED_PARAM", |
| 169 "UNRECOGNIZED_PARAM", |
| 170 "TOO_LONG_PARAM", |
| 171 "NOT_URI_SOCIAL_IMAGE_LINK", |
| 172 "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK", |
| 173 "NOT_URI_SOCIAL_URL", |
| 174 "BAD_URI_SCHEME_SOCIAL_URL", |
| 175 "LINK_LENGTH_TOO_LONG", |
| 176 "LINK_WITH_FRAGMENTS", |
| 177 "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID" |
| 178 ], |
| 179 "enumDescriptions": [ |
| 180 "Unknown code.", |
| 181 "The Android package does not match any in developer's D
evConsole project.", |
| 182 "The Android minimum version code has to be a valid inte
ger.", |
| 183 "Android package min version param is not needed, e.g. w
hen\n'apn' is missing.", |
| 184 "Android link is not a valid URI.", |
| 185 "Android link param is not needed, e.g. when param 'al'
and 'link' have\nthe same value..", |
| 186 "Android fallback link is not a valid URI.", |
| 187 "Android fallback link has an invalid (non http/https) U
RI scheme.", |
| 188 "The iOS bundle ID does not match any in developer's Dev
Console project.", |
| 189 "The iPad bundle ID does not match any in developer's De
vConsole project.", |
| 190 "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi
' are all missing.", |
| 191 "iOS app store ID format is incorrect, e.g. not numeric.
", |
| 192 "iOS app store ID is not needed.", |
| 193 "iOS fallback link is not a valid URI.", |
| 194 "iOS fallback link has an invalid (non http/https) URI s
cheme.", |
| 195 "iPad fallback link is not a valid URI.", |
| 196 "iPad fallback link has an invalid (non http/https) URI
scheme.", |
| 197 "Debug param format is incorrect.", |
| 198 "isAd param format is incorrect.", |
| 199 "Indicates a certain param is deprecated.", |
| 200 "Indicates certain paramater is not recognized.", |
| 201 "Indicates certain paramater is too long.", |
| 202 "Social meta tag image link is not a valid URI.", |
| 203 "Social meta tag image link has an invalid (non http/htt
ps) URI scheme.", |
| 204 "", |
| 205 "", |
| 206 "Dynamic Link URL length is too long.", |
| 207 "Dynamic Link URL contains fragments.", |
| 208 "The iOS bundle ID does not match with the given iOS sto
re ID." |
| 209 ], |
| 210 "type": "string" |
| 211 }, |
| 212 "warningMessage": { |
| 213 "description": "The warning message to help developers impro
ve their requests.", |
| 214 "type": "string" |
| 215 } |
| 216 }, |
| 217 "type": "object" |
| 218 }, |
| 219 "AndroidInfo": { |
| 220 "description": "Android related attributes to the Dynamic Link.", |
| 221 "id": "AndroidInfo", |
| 222 "properties": { |
| 223 "androidPackageName": { |
| 224 "description": "Android package name of the app.", |
| 225 "type": "string" |
| 226 }, |
| 227 "androidMinPackageVersionCode": { |
| 228 "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.", |
| 229 "type": "string" |
| 230 }, |
| 231 "androidLink": { |
| 232 "description": "If specified, this overrides the ‘link’ para
meter on Android.", |
| 233 "type": "string" |
| 234 }, |
| 235 "androidFallbackLink": { |
| 236 "description": "Link to open on Android if the app is not in
stalled.", |
| 237 "type": "string" |
| 238 } |
| 239 }, |
| 240 "type": "object" |
| 241 }, |
| 242 "NavigationInfo": { |
| 243 "description": "Information of navigation behavior.", |
| 244 "id": "NavigationInfo", |
| 245 "properties": { |
| 246 "enableForcedRedirect": { |
| 247 "description": "If this option is on, FDL click will be forc
ed to redirect rather than\nshow an interstitial page.", |
| 248 "type": "boolean" |
| 249 } |
| 250 }, |
| 251 "type": "object" |
| 252 }, |
| 253 "IosInfo": { |
| 254 "description": "iOS related attributes to the Dynamic Link..", |
| 255 "id": "IosInfo", |
| 256 "properties": { |
| 257 "iosIpadBundleId": { |
| 258 "description": "iPad bundle ID of the app.", |
| 259 "type": "string" |
| 260 }, |
| 261 "iosCustomScheme": { |
| 262 "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.", |
| 263 "type": "string" |
| 264 }, |
| 265 "iosBundleId": { |
| 266 "description": "iOS bundle ID of the app.", |
| 267 "type": "string" |
| 268 }, |
| 269 "iosFallbackLink": { |
| 270 "description": "Link to open on iOS if the app is not instal
led.", |
| 271 "type": "string" |
| 272 }, |
| 273 "iosAppStoreId": { |
| 274 "description": "iOS App Store ID.", |
| 275 "type": "string" |
| 276 }, |
| 277 "iosIpadFallbackLink": { |
| 278 "description": "If specified, this overrides the ios_fallbac
k_link value on iPads.", |
| 279 "type": "string" |
| 280 } |
| 281 }, |
| 282 "type": "object" |
| 283 }, |
| 284 "AnalyticsInfo": { |
| 285 "description": "Tracking parameters supported by Dynamic Link.", |
| 286 "id": "AnalyticsInfo", |
| 287 "properties": { |
| 288 "itunesConnectAnalytics": { |
| 289 "$ref": "ITunesConnectAnalytics", |
| 290 "description": "iTunes Connect App Analytics." |
| 291 }, |
| 292 "googlePlayAnalytics": { |
| 293 "$ref": "GooglePlayAnalytics", |
| 294 "description": "Google Play Campaign Measurements." |
| 295 } |
| 296 }, |
| 297 "type": "object" |
| 298 }, |
| 299 "CreateShortDynamicLinkRequest": { |
| 300 "description": "Request to create a short Dynamic Link.", |
| 301 "id": "CreateShortDynamicLinkRequest", |
| 302 "properties": { |
| 303 "dynamicLinkInfo": { |
| 304 "$ref": "DynamicLinkInfo", |
| 305 "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)." |
| 306 }, |
| 307 "longDynamicLink": { |
| 308 "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).", |
| 309 "type": "string" |
| 310 }, |
| 311 "suffix": { |
| 312 "$ref": "Suffix", |
| 313 "description": "Short Dynamic Link suffix. Optional." |
| 314 } |
| 315 }, |
| 316 "type": "object" |
| 317 }, |
142 "CreateShortDynamicLinkResponse": { | 318 "CreateShortDynamicLinkResponse": { |
143 "description": "Response to create a short Dynamic Link.", | 319 "description": "Response to create a short Dynamic Link.", |
144 "id": "CreateShortDynamicLinkResponse", | 320 "id": "CreateShortDynamicLinkResponse", |
145 "properties": { | 321 "properties": { |
146 "shortLink": { | 322 "shortLink": { |
147 "description": "Short Dynamic Link value. e.g. https://abcd.
app.goo.gl/wxyz", | 323 "description": "Short Dynamic Link value. e.g. https://abcd.
app.goo.gl/wxyz", |
148 "type": "string" | 324 "type": "string" |
149 }, | 325 }, |
150 "previewLink": { | 326 "previewLink": { |
151 "description": "Preivew link to show the link flow chart.", | 327 "description": "Preivew link to show the link flow chart.", |
(...skipping 27 matching lines...) Expand all Loading... |
179 ], | 355 ], |
180 "type": "string" | 356 "type": "string" |
181 } | 357 } |
182 }, | 358 }, |
183 "type": "object" | 359 "type": "object" |
184 }, | 360 }, |
185 "GooglePlayAnalytics": { | 361 "GooglePlayAnalytics": { |
186 "description": "Parameters for Google Play Campaign Measurements.\n[
Learn more](https://developers.google.com/analytics/devguides/collection/android
/v4/campaigns#campaign-params)", | 362 "description": "Parameters for Google Play Campaign Measurements.\n[
Learn more](https://developers.google.com/analytics/devguides/collection/android
/v4/campaigns#campaign-params)", |
187 "id": "GooglePlayAnalytics", | 363 "id": "GooglePlayAnalytics", |
188 "properties": { | 364 "properties": { |
| 365 "utmContent": { |
| 366 "description": "Campaign content; used for A/B testing and c
ontent-targeted ads to\ndifferentiate ads or links that point to the same URL.", |
| 367 "type": "string" |
| 368 }, |
189 "utmMedium": { | 369 "utmMedium": { |
190 "description": "Campaign medium; used to identify a medium s
uch as email or cost-per-click.", | 370 "description": "Campaign medium; used to identify a medium s
uch as email or cost-per-click.", |
191 "type": "string" | 371 "type": "string" |
192 }, | 372 }, |
193 "utmTerm": { | 373 "utmTerm": { |
194 "description": "Campaign term; used with paid search to supp
ly the keywords for ads.", | 374 "description": "Campaign term; used with paid search to supp
ly the keywords for ads.", |
195 "type": "string" | 375 "type": "string" |
196 }, | 376 }, |
197 "utmSource": { | 377 "utmSource": { |
198 "description": "Campaign source; used to identify a search e
ngine, newsletter, or other\nsource.", | 378 "description": "Campaign source; used to identify a search e
ngine, newsletter, or other\nsource.", |
199 "type": "string" | 379 "type": "string" |
200 }, | 380 }, |
201 "utmCampaign": { | |
202 "description": "Campaign name; used for keyword analysis to
identify a specific product\npromotion or strategic campaign.", | |
203 "type": "string" | |
204 }, | |
205 "gclid": { | 381 "gclid": { |
206 "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.", | 382 "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.", |
207 "type": "string" | 383 "type": "string" |
208 }, | 384 }, |
209 "utmContent": { | 385 "utmCampaign": { |
210 "description": "Campaign content; used for A/B testing and c
ontent-targeted ads to\ndifferentiate ads or links that point to the same URL.", | 386 "description": "Campaign name; used for keyword analysis to
identify a specific product\npromotion or strategic campaign.", |
211 "type": "string" | 387 "type": "string" |
212 } | 388 } |
213 }, | 389 }, |
214 "type": "object" | 390 "type": "object" |
215 }, | 391 }, |
216 "DynamicLinkInfo": { | 392 "DynamicLinkInfo": { |
217 "description": "Information about a Dynamic Link.", | 393 "description": "Information about a Dynamic Link.", |
218 "id": "DynamicLinkInfo", | 394 "id": "DynamicLinkInfo", |
219 "properties": { | 395 "properties": { |
220 "analyticsInfo": { | |
221 "$ref": "AnalyticsInfo", | |
222 "description": "Parameters used for tracking. See all tracki
ng parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-l
inks/android#create-a-dynamic-link-programmatically)." | |
223 }, | |
224 "dynamicLinkDomain": { | 396 "dynamicLinkDomain": { |
225 "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#set-up-firebase-and-the-dynamic-links-sdk)\non how to set up Dynamic L
ink domain associated with your Firebase project.\n\nRequired.", | 397 "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#set-up-firebase-and-the-dynamic-links-sdk)\non how to set up Dynamic L
ink domain associated with your Firebase project.\n\nRequired.", |
226 "type": "string" | 398 "type": "string" |
227 }, | 399 }, |
228 "link": { | 400 "link": { |
229 "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/android#create-a
-dynamic-link-programmatically).\n\nRequired.", | 401 "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/android#create-a
-dynamic-link-programmatically).\n\nRequired.", |
230 "type": "string" | 402 "type": "string" |
231 }, | 403 }, |
232 "iosInfo": { | 404 "iosInfo": { |
233 "$ref": "IosInfo", | 405 "$ref": "IosInfo", |
234 "description": "iOS related information. See iOS related par
ameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/i
os#create-a-dynamic-link-programmatically)." | 406 "description": "iOS related information. See iOS related par
ameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/i
os#create-a-dynamic-link-programmatically)." |
235 }, | 407 }, |
236 "socialMetaTagInfo": { | 408 "socialMetaTagInfo": { |
237 "$ref": "SocialMetaTagInfo", | 409 "$ref": "SocialMetaTagInfo", |
238 "description": "Parameters for social meta tag params.\nUsed
to set meta tag data for link previews on social sites." | 410 "description": "Parameters for social meta tag params.\nUsed
to set meta tag data for link previews on social sites." |
239 }, | 411 }, |
240 "androidInfo": { | 412 "androidInfo": { |
241 "$ref": "AndroidInfo", | 413 "$ref": "AndroidInfo", |
242 "description": "Android related information. See Android rel
ated parameters in the\n[documentation](https://firebase.google.com/docs/dynamic
-links/android#create-a-dynamic-link-programmatically)." | 414 "description": "Android related information. See Android rel
ated parameters in the\n[documentation](https://firebase.google.com/docs/dynamic
-links/android#create-a-dynamic-link-programmatically)." |
243 }, | 415 }, |
244 "navigationInfo": { | 416 "navigationInfo": { |
245 "$ref": "NavigationInfo", | 417 "$ref": "NavigationInfo", |
246 "description": "Information of navigation behavior of a Fire
base Dynamic Links." | 418 "description": "Information of navigation behavior of a Fire
base Dynamic Links." |
| 419 }, |
| 420 "analyticsInfo": { |
| 421 "$ref": "AnalyticsInfo", |
| 422 "description": "Parameters used for tracking. See all tracki
ng parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-l
inks/android#create-a-dynamic-link-programmatically)." |
247 } | 423 } |
248 }, | 424 }, |
249 "type": "object" | 425 "type": "object" |
250 }, | 426 }, |
251 "ITunesConnectAnalytics": { | 427 "ITunesConnectAnalytics": { |
252 "description": "Parameters for iTunes Connect App Analytics.", | 428 "description": "Parameters for iTunes Connect App Analytics.", |
253 "id": "ITunesConnectAnalytics", | 429 "id": "ITunesConnectAnalytics", |
254 "properties": { | 430 "properties": { |
255 "at": { | 431 "at": { |
256 "description": "Affiliate token used to create affiliate-cod
ed links.", | 432 "description": "Affiliate token used to create affiliate-cod
ed links.", |
(...skipping 11 matching lines...) Expand all Loading... |
268 "description": "Provider token that enables analytics for Dy
namic Links from within iTunes\nConnect.", | 444 "description": "Provider token that enables analytics for Dy
namic Links from within iTunes\nConnect.", |
269 "type": "string" | 445 "type": "string" |
270 } | 446 } |
271 }, | 447 }, |
272 "type": "object" | 448 "type": "object" |
273 }, | 449 }, |
274 "SocialMetaTagInfo": { | 450 "SocialMetaTagInfo": { |
275 "description": "Parameters for social meta tag params.\nUsed to set
meta tag data for link previews on social sites.", | 451 "description": "Parameters for social meta tag params.\nUsed to set
meta tag data for link previews on social sites.", |
276 "id": "SocialMetaTagInfo", | 452 "id": "SocialMetaTagInfo", |
277 "properties": { | 453 "properties": { |
278 "socialDescription": { | |
279 "description": "A short description of the link. Optional.", | |
280 "type": "string" | |
281 }, | |
282 "socialTitle": { | 454 "socialTitle": { |
283 "description": "Title to be displayed. Optional.", | 455 "description": "Title to be displayed. Optional.", |
284 "type": "string" | 456 "type": "string" |
285 }, | 457 }, |
286 "socialImageLink": { | 458 "socialImageLink": { |
287 "description": "An image url string. Optional.", | 459 "description": "An image url string. Optional.", |
288 "type": "string" | 460 "type": "string" |
289 } | |
290 }, | |
291 "type": "object" | |
292 }, | |
293 "AndroidInfo": { | |
294 "description": "Android related attributes to the Dynamic Link.", | |
295 "id": "AndroidInfo", | |
296 "properties": { | |
297 "androidFallbackLink": { | |
298 "description": "Link to open on Android if the app is not in
stalled.", | |
299 "type": "string" | |
300 }, | 461 }, |
301 "androidPackageName": { | 462 "socialDescription": { |
302 "description": "Android package name of the app.", | 463 "description": "A short description of the link. Optional.", |
303 "type": "string" | |
304 }, | |
305 "androidMinPackageVersionCode": { | |
306 "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.", | |
307 "type": "string" | |
308 }, | |
309 "androidLink": { | |
310 "description": "If specified, this overrides the ‘link’ para
meter on Android.", | |
311 "type": "string" | 464 "type": "string" |
312 } | 465 } |
313 }, | 466 }, |
314 "type": "object" | |
315 }, | |
316 "DynamicLinkWarning": { | |
317 "description": "Dynamic Links warning messages.", | |
318 "id": "DynamicLinkWarning", | |
319 "properties": { | |
320 "warningCode": { | |
321 "description": "The warning code.", | |
322 "enum": [ | |
323 "CODE_UNSPECIFIED", | |
324 "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME", | |
325 "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION", | |
326 "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION", | |
327 "NOT_URI_ANDROID_LINK", | |
328 "UNNECESSARY_ANDROID_LINK", | |
329 "NOT_URI_ANDROID_FALLBACK_LINK", | |
330 "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK", | |
331 "NOT_IN_PROJECT_IOS_BUNDLE_ID", | |
332 "NOT_IN_PROJECT_IPAD_BUNDLE_ID", | |
333 "UNNECESSARY_IOS_URL_SCHEME", | |
334 "NOT_NUMERIC_IOS_APP_STORE_ID", | |
335 "UNNECESSARY_IOS_APP_STORE_ID", | |
336 "NOT_URI_IOS_FALLBACK_LINK", | |
337 "BAD_URI_SCHEME_IOS_FALLBACK_LINK", | |
338 "NOT_URI_IPAD_FALLBACK_LINK", | |
339 "BAD_URI_SCHEME_IPAD_FALLBACK_LINK", | |
340 "BAD_DEBUG_PARAM", | |
341 "BAD_AD_PARAM", | |
342 "DEPRECATED_PARAM", | |
343 "UNRECOGNIZED_PARAM", | |
344 "TOO_LONG_PARAM", | |
345 "NOT_URI_SOCIAL_IMAGE_LINK", | |
346 "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK", | |
347 "NOT_URI_SOCIAL_URL", | |
348 "BAD_URI_SCHEME_SOCIAL_URL", | |
349 "LINK_LENGTH_TOO_LONG", | |
350 "LINK_WITH_FRAGMENTS", | |
351 "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID" | |
352 ], | |
353 "enumDescriptions": [ | |
354 "Unknown code.", | |
355 "The Android package does not match any in developer's D
evConsole project.", | |
356 "The Android minimum version code has to be a valid inte
ger.", | |
357 "Android package min version param is not needed, e.g. w
hen\n'apn' is missing.", | |
358 "Android link is not a valid URI.", | |
359 "Android link param is not needed, e.g. when param 'al'
and 'link' have\nthe same value..", | |
360 "Android fallback link is not a valid URI.", | |
361 "Android fallback link has an invalid (non http/https) U
RI scheme.", | |
362 "The iOS bundle ID does not match any in developer's Dev
Console project.", | |
363 "The iPad bundle ID does not match any in developer's De
vConsole project.", | |
364 "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi
' are all missing.", | |
365 "iOS app store ID format is incorrect, e.g. not numeric.
", | |
366 "iOS app store ID is not needed.", | |
367 "iOS fallback link is not a valid URI.", | |
368 "iOS fallback link has an invalid (non http/https) URI s
cheme.", | |
369 "iPad fallback link is not a valid URI.", | |
370 "iPad fallback link has an invalid (non http/https) URI
scheme.", | |
371 "Debug param format is incorrect.", | |
372 "isAd param format is incorrect.", | |
373 "Indicates a certain param is deprecated.", | |
374 "Indicates certain paramater is not recognized.", | |
375 "Indicates certain paramater is too long.", | |
376 "Social meta tag image link is not a valid URI.", | |
377 "Social meta tag image link has an invalid (non http/htt
ps) URI scheme.", | |
378 "", | |
379 "", | |
380 "Dynamic Link URL length is too long.", | |
381 "Dynamic Link URL contains fragments.", | |
382 "The iOS bundle ID does not match with the given iOS sto
re ID." | |
383 ], | |
384 "type": "string" | |
385 }, | |
386 "warningMessage": { | |
387 "description": "The warning message to help developers impro
ve their requests.", | |
388 "type": "string" | |
389 } | |
390 }, | |
391 "type": "object" | |
392 }, | |
393 "NavigationInfo": { | |
394 "description": "Information of navigation behavior.", | |
395 "id": "NavigationInfo", | |
396 "properties": { | |
397 "enableForcedRedirect": { | |
398 "description": "If this option is on, FDL click will be forc
ed to redirect rather than\nshow an interstitial page.", | |
399 "type": "boolean" | |
400 } | |
401 }, | |
402 "type": "object" | |
403 }, | |
404 "IosInfo": { | |
405 "description": "iOS related attributes to the Dynamic Link..", | |
406 "id": "IosInfo", | |
407 "properties": { | |
408 "iosFallbackLink": { | |
409 "description": "Link to open on iOS if the app is not instal
led.", | |
410 "type": "string" | |
411 }, | |
412 "iosAppStoreId": { | |
413 "description": "iOS App Store ID.", | |
414 "type": "string" | |
415 }, | |
416 "iosIpadFallbackLink": { | |
417 "description": "If specified, this overrides the ios_fallbac
k_link value on iPads.", | |
418 "type": "string" | |
419 }, | |
420 "iosIpadBundleId": { | |
421 "description": "iPad bundle ID of the app.", | |
422 "type": "string" | |
423 }, | |
424 "iosCustomScheme": { | |
425 "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.", | |
426 "type": "string" | |
427 }, | |
428 "iosBundleId": { | |
429 "description": "iOS bundle ID of the app.", | |
430 "type": "string" | |
431 } | |
432 }, | |
433 "type": "object" | |
434 }, | |
435 "AnalyticsInfo": { | |
436 "description": "Tracking parameters supported by Dynamic Link.", | |
437 "id": "AnalyticsInfo", | |
438 "properties": { | |
439 "itunesConnectAnalytics": { | |
440 "$ref": "ITunesConnectAnalytics", | |
441 "description": "iTunes Connect App Analytics." | |
442 }, | |
443 "googlePlayAnalytics": { | |
444 "$ref": "GooglePlayAnalytics", | |
445 "description": "Google Play Campaign Measurements." | |
446 } | |
447 }, | |
448 "type": "object" | |
449 }, | |
450 "CreateShortDynamicLinkRequest": { | |
451 "description": "Request to create a short Dynamic Link.", | |
452 "id": "CreateShortDynamicLinkRequest", | |
453 "properties": { | |
454 "suffix": { | |
455 "$ref": "Suffix", | |
456 "description": "Short Dynamic Link suffix. Optional." | |
457 }, | |
458 "dynamicLinkInfo": { | |
459 "$ref": "DynamicLinkInfo", | |
460 "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)." | |
461 }, | |
462 "longDynamicLink": { | |
463 "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).", | |
464 "type": "string" | |
465 } | |
466 }, | |
467 "type": "object" | 467 "type": "object" |
468 } | 468 } |
469 }, | 469 }, |
470 "servicePath": "", | 470 "servicePath": "", |
471 "title": "Firebase Dynamic Links API", | 471 "title": "Firebase Dynamic Links API", |
472 "version": "v1" | 472 "version": "v1" |
473 } | 473 } |
OLD | NEW |