Api-roll 42: 2016-11-08

discovery/googleapis/firebasedynamiclinks__v1.json

+{
+    "auth": {
+        "oauth2": {
+            "scopes": {
+                "https://www.googleapis.com/auth/firebase": {
+                    "description": "View and administer all your Firebase data and settings"
+                }
+            }
+        }
+    },
+    "basePath": "",
+    "baseUrl": "https://firebasedynamiclinks.googleapis.com/",
+    "batchPath": "batch",
+    "canonicalName": "Firebase Dynamic Links",
+    "description": "Firebase Dynamic Links API enables third party developers to programmatically create and manage Dynamic Links.",
+    "discoveryVersion": "v1",
+    "documentationLink": "https://firebase.google.com/docs/dynamic-links/",
+    "icons": {
+        "x16": "http://www.google.com/images/icons/product/search-16.gif",
+        "x32": "http://www.google.com/images/icons/product/search-32.gif"
+    },
+    "id": "firebasedynamiclinks:v1",
+    "kind": "discovery#restDescription",
+    "name": "firebasedynamiclinks",
+    "ownerDomain": "google.com",
+    "ownerName": "Google",
+    "parameters": {
+        "access_token": {
+            "description": "OAuth access token.",
+            "location": "query",
+            "type": "string"
+        },
+        "prettyPrint": {
+            "default": "true",
+            "description": "Returns response with indentations and line breaks.",
+            "location": "query",
+            "type": "boolean"
+        },
+        "key": {
+            "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+            "location": "query",
+            "type": "string"
+        },
+        "quotaUser": {
+            "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+            "location": "query",
+            "type": "string"
+        },
+        "pp": {
+            "default": "true",
+            "description": "Pretty-print response.",
+            "location": "query",
+            "type": "boolean"
+        },
+        "fields": {
+            "description": "Selector specifying which fields to include in a partial response.",
+            "location": "query",
+            "type": "string"
+        },
+        "alt": {
+            "default": "json",
+            "description": "Data format for response.",
+            "enum": [
+                "json",
+                "media",
+                "proto"
+            ],
+            "enumDescriptions": [
+                "Responses with Content-Type of application/json",
+                "Media download with context-dependent Content-Type",
+                "Responses with Content-Type of application/x-protobuf"
+            ],
+            "location": "query",
+            "type": "string"
+        },
+        "$.xgafv": {
+            "description": "V1 error format.",
+            "enum": [
+                "1",
+                "2"
+            ],
+            "enumDescriptions": [
+                "v1 error format",
+                "v2 error format"
+            ],
+            "location": "query",
+            "type": "string"
+        },
+        "callback": {
+            "description": "JSONP",
+            "location": "query",
+            "type": "string"
+        },
+        "oauth_token": {
+            "description": "OAuth 2.0 token for the current user.",
+            "location": "query",
+            "type": "string"
+        },
+        "uploadType": {
+            "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+            "location": "query",
+            "type": "string"
+        },
+        "bearer_token": {
+            "description": "OAuth bearer token.",
+            "location": "query",
+            "type": "string"
+        },
+        "upload_protocol": {
+            "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+            "location": "query",
+            "type": "string"
+        }
+    },
+    "protocol": "rest",
+    "resources": {
+        "shortLinks": {
+            "methods": {
+                "create": {
+                    "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 calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
+                    "httpMethod": "POST",
+                    "id": "firebasedynamiclinks.shortLinks.create",
+                    "parameterOrder": [],
+                    "parameters": {},
+                    "path": "v1/shortLinks",
+                    "request": {
+                        "$ref": "CreateShortDynamicLinkRequest"
+                    },
+                    "response": {
+                        "$ref": "CreateShortDynamicLinkResponse"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/firebase"
+                    ]
+                }
+            }
+        }
+    },
+    "revision": "20161027",
+    "rootUrl": "https://firebasedynamiclinks.googleapis.com/",
+    "schemas": {
+        "DynamicLinkInfo": {
+            "description": "Information about a Dynamic Link.",
+            "id": "DynamicLinkInfo",
+            "properties": {
+                "isAd": {
+                    "description": "Declares that the Dynamic Link is used in an advertisement.\nSee the 'ad' parameter in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
+                    "type": "boolean"
+                },
+                "socialMetaTagInfo": {
+                    "$ref": "SocialMetaTagInfo",
+                    "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites."
+                },
+                "analyticsInfo": {
+                    "$ref": "AnalyticsInfo",
+                    "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+                },
+                "link": {
+                    "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 properly 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.",
+                    "type": "string"
+                },
+                "dynamicLinkDomain": {
+                    "description": "Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#set-up-firebase-and-the-dynamic-links-sdk)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
+                    "type": "string"
+                },
+                "iosInfo": {
+                    "$ref": "IosInfo",
+                    "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/ios#create-a-dynamic-link-programmatically)."
+                },
+                "androidInfo": {
+                    "$ref": "AndroidInfo",
+                    "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+                }
+            },
+            "type": "object"
+        },
+        "ITunesConnectAnalytics": {
+            "description": "Parameters for iTunes Connect App Analytics.",
+            "id": "ITunesConnectAnalytics",
+            "properties": {
+                "mt": {
+                    "description": "iTune media types, including music, podcasts, audiobooks and so on.",
+                    "type": "string"
+                },
+                "at": {
+                    "description": "Affiliate token used to create affiliate-coded links.",
+                    "type": "string"
+                },
+                "ct": {
+                    "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign.",
+                    "type": "string"
+                },
+                "pt": {
+                    "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "DynamicLinkWarning": {
+            "description": "Dynamic Links warning messages.",
+            "id": "DynamicLinkWarning",
+            "properties": {
+                "warningCode": {
+                    "description": "The warning code.",
+                    "enum": [
+                        "CODE_UNSPECIFIED",
+                        "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
+                        "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION",
+                        "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION",
+                        "NOT_URI_ANDROID_LINK",
+                        "UNNECESSARY_ANDROID_LINK",
+                        "NOT_URI_ANDROID_FALLBACK_LINK",
+                        "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK",
+                        "NOT_IN_PROJECT_IOS_BUNDLE_ID",
+                        "NOT_IN_PROJECT_IPAD_BUNDLE_ID",
+                        "UNNECESSARY_IOS_URL_SCHEME",
+                        "NOT_NUMERIC_IOS_APP_STORE_ID",
+                        "UNNECESSARY_IOS_APP_STORE_ID",
+                        "NOT_URI_IOS_FALLBACK_LINK",
+                        "BAD_URI_SCHEME_IOS_FALLBACK_LINK",
+                        "NOT_URI_IPAD_FALLBACK_LINK",
+                        "BAD_URI_SCHEME_IPAD_FALLBACK_LINK",
+                        "BAD_DEBUG_PARAM",
+                        "BAD_AD_PARAM",
+                        "DEPRECATED_PARAM",
+                        "UNRECOGNIZED_PARAM",
+                        "TOO_LONG_PARAM",
+                        "NOT_URI_SOCIAL_IMAGE_LINK",
+                        "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK",
+                        "NOT_URI_SOCIAL_URL",
+                        "BAD_URI_SCHEME_SOCIAL_URL",
+                        "LINK_LENGTH_TOO_LONG",
+                        "LINK_WITH_FRAGMENTS",
+                        "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID"
+                    ],
+                    "enumDescriptions": [
+                        "Unknown code.",
+                        "The Android package does not match any in developer's DevConsole project.",
+                        "The Android minimum version code has to be a valid integer.",
+                        "Android package min version param is not needed, e.g. when\n'apn' is missing.",
+                        "Android link is not a valid URI.",
+                        "Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
+                        "Android fallback link is not a valid URI.",
+                        "Android fallback link has an invalid (non http/https) URI scheme.",
+                        "The iOS bundle ID does not match any in developer's DevConsole project.",
+                        "The iPad bundle ID does not match any in developer's DevConsole project.",
+                        "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
+                        "iOS app store ID format is incorrect, e.g. not numeric.",
+                        "iOS app store ID is not needed.",
+                        "iOS fallback link is not a valid URI.",
+                        "iOS fallback link has an invalid (non http/https) URI scheme.",
+                        "iPad fallback link is not a valid URI.",
+                        "iPad fallback link has an invalid (non http/https) URI scheme.",
+                        "Debug param format is incorrect.",
+                        "isAd param format is incorrect.",
+                        "Indicates a certain param is deprecated.",
+                        "Indicates certain paramater is not recognized.",
+                        "Indicates certain paramater is too long.",
+                        "Social meta tag image link is not a valid URI.",
+                        "Social meta tag image link has an invalid (non http/https) URI scheme.",
+                        "",
+                        "",
+                        "Dynamic Link URL length is too long.",
+                        "Dynamic Link URL contains fragments.",
+                        "The iOS bundle ID does not match with the given iOS store ID."
+                    ],
+                    "type": "string"
+                },
+                "warningMessage": {
+                    "description": "The warning message to help developers improve their requests.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "CreateShortDynamicLinkRequest": {
+            "description": "Request to create a short Dynamic Link.",
+            "id": "CreateShortDynamicLinkRequest",
+            "properties": {
+                "dynamicLinkInfo": {
+                    "$ref": "DynamicLinkInfo",
+                    "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+                },
+                "longDynamicLink": {
+                    "description": "Full long Dynamic Link URL with desired query 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).",
+                    "type": "string"
+                },
+                "suffix": {
+                    "$ref": "Suffix",
+                    "description": "Short Dynamic Link suffix. Optional."
+                }
+            },
+            "type": "object"
+        },
+        "AnalyticsInfo": {
+            "description": "Tracking parameters supported by Dynamic Link.",
+            "id": "AnalyticsInfo",
+            "properties": {
+                "googlePlayAnalytics": {
+                    "$ref": "GooglePlayAnalytics",
+                    "description": "Google Play Campaign Measurements."
+                },
+                "itunesConnectAnalytics": {
+                    "$ref": "ITunesConnectAnalytics",
+                    "description": "iTunes Connect App Analytics."
+                }
+            },
+            "type": "object"
+        },
+        "Suffix": {
+            "description": "Short Dynamic Link suffix.",
+            "id": "Suffix",
+            "properties": {
+                "option": {
+                    "description": "Suffix option.",
+                    "enum": [
+                        "OPTION_UNSPECIFIED",
+                        "UNGUESSABLE",
+                        "SHORT"
+                    ],
+                    "enumDescriptions": [
+                        "The suffix option is not specified, performs as NOT_GUESSABLE .",
+                        "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
+                        "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
+                    ],
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "CreateShortDynamicLinkResponse": {
+            "description": "Response to create a short Dynamic Link.",
+            "id": "CreateShortDynamicLinkResponse",
+            "properties": {
+                "previewLink": {
+                    "description": "Preivew link to show the link flow chart.",
+                    "type": "string"
+                },
+                "warning": {
+                    "description": "Information about potential warnings on link creation.",
+                    "items": {
+                        "$ref": "DynamicLinkWarning"
+                    },
+                    "type": "array"
+                },
+                "shortLink": {
+                    "description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "IosInfo": {
+            "description": "iOS related attributes to the Dynamic Link..",
+            "id": "IosInfo",
+            "properties": {
+                "iosAppStoreId": {
+                    "description": "iOS App Store ID.",
+                    "type": "string"
+                },
+                "iosIpadFallbackLink": {
+                    "description": "If specified, this overrides the ios_fallback_link value on iPads.",
+                    "type": "string"
+                },
+                "iosBundleId": {
+                    "description": "iOS bundle ID of the app.",
+                    "type": "string"
+                },
+                "iosFallbackLink": {
+                    "description": "Link to open on iOS if the app is not installed.",
+                    "type": "string"
+                },
+                "iosIpadBundleId": {
+                    "description": "iPad bundle ID of the app.",
+                    "type": "string"
+                },
+                "iosCustomScheme": {
+                    "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "AndroidInfo": {
+            "description": "Android related attributes to the Dynamic Link.",
+            "id": "AndroidInfo",
+            "properties": {
+                "androidMinPackageVersionCode": {
+                    "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.",
+                    "type": "string"
+                },
+                "androidLink": {
+                    "description": "If specified, this overrides the ‘link’ parameter on Android.",
+                    "type": "string"
+                },
+                "androidFallbackLink": {
+                    "description": "Link to open on Android if the app is not installed.",
+                    "type": "string"
+                },
+                "androidPackageName": {
+                    "description": "Android package name of the app.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "SocialMetaTagInfo": {
+            "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
+            "id": "SocialMetaTagInfo",
+            "properties": {
+                "socialTitle": {
+                    "description": "Title to be displayed. Optional.",
+                    "type": "string"
+                },
+                "socialDescription": {
+                    "description": "A short description of the link. Optional.",
+                    "type": "string"
+                },
+                "socialImageLink": {
+                    "description": "An image url string. Optional.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "GooglePlayAnalytics": {
+            "description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
+            "id": "GooglePlayAnalytics",
+            "properties": {
+                "utmCampaign": {
+                    "description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.",
+                    "type": "string"
+                },
+                "utmTerm": {
+                    "description": "Campaign term; used with paid search to supply the keywords for ads.",
+                    "type": "string"
+                },
+                "gclid": {
+                    "description": "[AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords ads. This value is generated dynamically\nand should never be modified.",
+                    "type": "string"
+                },
+                "utmSource": {
+                    "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
+                    "type": "string"
+                },
+                "utmMedium": {
+                    "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
+                    "type": "string"
+                },
+                "utmContent": {
+                    "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        }
+    },
+    "servicePath": "",
+    "title": "Firebase Dynamic Links API",
+    "version": "v1"
+}