Api-Roll 54: 2017-09-11

discovery/googleapis/firebasedynamiclinks__v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/firebase": {
                     "description": "View and administer all your Firebase data and settings"
                 }
             }
         }
     },
@@ skipping 17 matching lines @@
         "fields": {
             "description": "Selector specifying which fields to include in a partial response.",
             "location": "query",
             "type": "string"
         },
         "uploadType": {
             "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
             "location": "query",
             "type": "string"
         },
+        "callback": {
+            "description": "JSONP",
+            "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"
-        },
         "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"
         },
+        "access_token": {
+            "description": "OAuth access token.",
+            "location": "query",
+            "type": "string"
+        },
         "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"
         },
-        "access_token": {
-            "description": "OAuth access 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"
@@ skipping 66 matching lines @@
                             "type": "string"
                         }
                     },
                     "path": "v1/{dynamicLink}/linkStats",
                     "response": {
                         "$ref": "DynamicLinkStats"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/firebase"
                     ]
+                },
+                "installAttribution": {
+                    "description": "Get iOS strong/weak-match info for post-install attribution.",
+                    "httpMethod": "POST",
+                    "id": "firebasedynamiclinks.installAttribution",
+                    "parameterOrder": [],
+                    "parameters": {},
+                    "path": "v1/installAttribution",
+                    "request": {
+                        "$ref": "GetIosPostInstallAttributionRequest"
+                    },
+                    "response": {
+                        "$ref": "GetIosPostInstallAttributionResponse"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/firebase"
+                    ]
                 }
             }
         }
     },
-    "revision": "20170816",
+    "revision": "20170907",
     "rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
     "schemas": {
         "CreateShortDynamicLinkResponse": {
             "description": "Response to create a short Dynamic Link.",
             "id": "CreateShortDynamicLinkResponse",
             "properties": {
-                "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"
                 },
                 "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"
                 }
             },
             "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"
         },
         "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": {
-                "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"
-                },
                 "utmMedium": {
                     "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
                     "type": "string"
                 },
                 "utmTerm": {
                     "description": "Campaign term; used with paid search to supply the keywords for ads.",
                     "type": "string"
                 },
                 "utmSource": {
                     "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
                     "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"
+                },
                 "utmCampaign": {
                     "description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.",
                     "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.",
+                "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"
         },
         "DynamicLinkInfo": {
             "description": "Information about a Dynamic Link.",
             "id": "DynamicLinkInfo",
             "properties": {
                 "dynamicLinkDomain": {
@@ skipping 20 matching lines @@
                     "$ref": "NavigationInfo",
                     "description": "Information of navigation behavior of a Firebase Dynamic Links."
                 },
                 "analyticsInfo": {
                     "$ref": "AnalyticsInfo",
                     "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
                 }
             },
             "type": "object"
         },
+        "DeviceInfo": {
+            "description": "Signals associated with the device making the request.",
+            "id": "DeviceInfo",
+            "properties": {
+                "screenResolutionWidth": {
+                    "description": "Device display resolution width.",
+                    "format": "int64",
+                    "type": "string"
+                },
+                "deviceModelName": {
+                    "description": "Device model name.",
+                    "type": "string"
+                },
+                "screenResolutionHeight": {
+                    "description": "Device display resolution height.",
+                    "format": "int64",
+                    "type": "string"
+                },
+                "languageCode": {
+                    "description": "Device language code setting.",
+                    "type": "string"
+                },
+                "timezone": {
+                    "description": "Device timezone setting.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "ITunesConnectAnalytics": {
             "description": "Parameters for iTunes Connect App Analytics.",
             "id": "ITunesConnectAnalytics",
             "properties": {
-                "at": {
-                    "description": "Affiliate token used to create affiliate-coded links.",
+                "ct": {
+                    "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign.",
                     "type": "string"
                 },
                 "mt": {
                     "description": "iTune media types, including music, podcasts, audiobooks and so on.",
                     "type": "string"
                 },
-                "ct": {
-                    "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign.",
+                "pt": {
+                    "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
                     "type": "string"
                 },
-                "pt": {
-                    "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
+                "at": {
+                    "description": "Affiliate token used to create affiliate-coded links.",
                     "type": "string"
                 }
             },
             "type": "object"
+        },
+        "GetIosPostInstallAttributionResponse": {
+            "description": "Response for iSDK to execute strong match flow for post-install attribution.",
+            "id": "GetIosPostInstallAttributionResponse",
+            "properties": {
+                "resolvedLink": {
+                    "description": "The entire FDL, expanded from a short link. It is the same as the\nrequested_link, if it is long. Parameters from this should not be\nused directly (ie: server can default utm_[campaign|medium|source]\nto a value when requested_link lack them, server determine the best\nfallback_link when requested_link specifies >1 fallback links).",
+                    "type": "string"
+                },
+                "utmCampaign": {
+                    "description": "Scion campaign value to be propagated by iSDK to Scion at post-install.",
+                    "type": "string"
+                },
+                "fallbackLink": {
+                    "description": "The link to navigate to update the app if min version is not met.\nThis is either (in order): 1) fallback link (from ?ifl= parameter, if\nspecified by developer) or 2) AppStore URL (from ?isi= parameter, if\nspecified), or 3) the payload link (from required link= parameter).",
+                    "type": "string"
+                },
+                "requestedLink": {
+                    "description": "Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
+                    "type": "string"
+                },
+                "utmMedium": {
+                    "description": "Scion medium value to be propagated by iSDK to Scion at post-install.",
+                    "type": "string"
+                },
+                "utmSource": {
+                    "description": "Scion source value to be propagated by iSDK to Scion at post-install.",
+                    "type": "string"
+                },
+                "isStrongMatchExecutable": {
+                    "description": "Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false.",
+                    "type": "boolean"
+                },
+                "appMinimumVersion": {
+                    "description": "The minimum version for app, specified by dev through ?imv= parameter.\nReturn to iSDK to allow app to evaluate if current version meets this.",
+                    "type": "string"
+                },
+                "deepLink": {
+                    "description": "The deep-link attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+                    "type": "string"
+                },
+                "invitationId": {
+                    "description": "Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+                    "type": "string"
+                },
+                "attributionConfidence": {
+                    "description": "The confidence of the returned attribution.",
+                    "enum": [
+                        "UNKNOWN_ATTRIBUTION_CONFIDENCE",
+                        "WEAK",
+                        "DEFAULT",
+                        "UNIQUE"
+                    ],
+                    "enumDescriptions": [
+                        "Unset.",
+                        "Weak confidence, more than one matching link found or link suspected to\nbe false positive",
+                        "Default confidence, match based on fingerprint",
+                        "Unique confidence, match based on \"unique match link to check\" or other\nmeans"
+                    ],
+                    "type": "string"
+                },
+                "externalBrowserDestinationLink": {
+                    "description": "User-agent specific custom-scheme URIs for iSDK to open. This will be set\naccording to the user-agent tha the click was originally made in. There is\nno Safari-equivalent custom-scheme open URLs.\nie: googlechrome://www.example.com\nie: firefox://open-url?url=http://www.example.com\nie: opera-http://example.com",
+                    "type": "string"
+                },
+                "matchMessage": {
+                    "description": "Describes why match failed, ie: \"discarded due to low confidence\".\nThis message will be publicly visible.",
+                    "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": {
                 "socialDescription": {
                     "description": "A short description of the link. Optional.",
                     "type": "string"
                 },
+                "socialTitle": {
+                    "description": "Title to be displayed. Optional.",
+                    "type": "string"
+                },
                 "socialImageLink": {
                     "description": "An image url string. Optional.",
                     "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "AndroidInfo": {
+            "description": "Android related attributes to the Dynamic Link.",
+            "id": "AndroidInfo",
+            "properties": {
+                "androidLink": {
+                    "description": "If specified, this overrides the ‘link’ parameter on Android.",
+                    "type": "string"
                 },
-                "socialTitle": {
-                    "description": "Title to be displayed. Optional.",
+                "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"
+                },
+                "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"
                 }
             },
             "type": "object"
         },
         "DynamicLinkStats": {
             "description": "Analytics stats of a Dynamic Link for a given timeframe.",
             "id": "DynamicLinkStats",
             "properties": {
                 "linkEventStats": {
                     "description": "Dynamic Link event stats.",
                     "items": {
                         "$ref": "DynamicLinkEventStat"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "DynamicLinkWarning": {
             "description": "Dynamic Links warning messages.",
             "id": "DynamicLinkWarning",
             "properties": {
+                "warningMessage": {
+                    "description": "The warning message to help developers improve their requests.",
+                    "type": "string"
+                },
                 "warningDocumentLink": {
                     "description": "The document describing the warning, and helps resolve.",
                     "type": "string"
                 },
                 "warningCode": {
                     "description": "The warning code.",
                     "enum": [
                         "CODE_UNSPECIFIED",
                         "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
                         "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION",
@@ skipping 49 matching lines @@
                         "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"
-        },
-        "AndroidInfo": {
-            "description": "Android related attributes to the Dynamic Link.",
-            "id": "AndroidInfo",
-            "properties": {
-                "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"
-                },
-                "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"
-                }
-            },
-            "type": "object"
         },
         "NavigationInfo": {
             "description": "Information of navigation behavior.",
             "id": "NavigationInfo",
             "properties": {
                 "enableForcedRedirect": {
                     "description": "If this option is on, FDL click will be forced to redirect rather than\nshow an interstitial page.",
                     "type": "boolean"
                 }
             },
             "type": "object"
         },
         "IosInfo": {
             "description": "iOS related attributes to the Dynamic Link..",
             "id": "IosInfo",
             "properties": {
+                "iosFallbackLink": {
+                    "description": "Link to open on iOS if the app is not installed.",
+                    "type": "string"
+                },
                 "iosAppStoreId": {
                     "description": "iOS App Store ID.",
                     "type": "string"
                 },
                 "iosIpadFallbackLink": {
                     "description": "If specified, this overrides the ios_fallback_link value on iPads.",
                     "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"
                 },
                 "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"
                 }
             },
             "type": "object"
         },
         "AnalyticsInfo": {
             "description": "Tracking parameters supported by Dynamic Link.",
             "id": "AnalyticsInfo",
             "properties": {
                 "itunesConnectAnalytics": {
                     "$ref": "ITunesConnectAnalytics",
@@ skipping 22 matching lines @@
                     "$ref": "Suffix",
                     "description": "Short Dynamic Link suffix. Optional."
                 }
             },
             "type": "object"
         },
         "DynamicLinkEventStat": {
             "description": "Dynamic Link event stat.",
             "id": "DynamicLinkEventStat",
             "properties": {
+                "platform": {
+                    "description": "Requested platform.",
+                    "enum": [
+                        "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
+                        "ANDROID",
+                        "IOS",
+                        "DESKTOP"
+                    ],
+                    "enumDescriptions": [
+                        "Unspecified platform.",
+                        "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
+                        "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.",
+                        "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory."
+                    ],
+                    "type": "string"
+                },
                 "count": {
                     "description": "The number of times this event occurred.",
                     "format": "int64",
                     "type": "string"
                 },
                 "event": {
                     "description": "Link event.",
                     "enum": [
                         "DYNAMIC_LINK_EVENT_UNSPECIFIED",
                         "CLICK",
                         "REDIRECT",
                         "APP_INSTALL",
                         "APP_FIRST_OPEN",
                         "APP_RE_OPEN"
                     ],
                     "enumDescriptions": [
                         "Unspecified type.",
                         "Indicates that an FDL is clicked by users.",
                         "Indicates that an FDL redirects users to fallback link.",
                         "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.",
                         "Indicates that the app is opened for the first time after an install\ntriggered by FDLs",
                         "Indicates that the app is opened via an FDL for non-first time."
                     ],
                     "type": "string"
-                },
-                "platform": {
-                    "description": "Requested platform.",
-                    "enum": [
-                        "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
-                        "ANDROID",
-                        "IOS",
-                        "DESKTOP"
-                    ],
-                    "enumDescriptions": [
-                        "Unspecified platform.",
-                        "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
-                        "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.",
-                        "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory."
-                    ],
-                    "type": "string"
                 }
             },
             "type": "object"
+        },
+        "GetIosPostInstallAttributionRequest": {
+            "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
+            "id": "GetIosPostInstallAttributionRequest",
+            "properties": {
+                "retrievalMethod": {
+                    "description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.",
+                    "enum": [
+                        "UNKNOWN_PAYLOAD_RETRIEVAL_METHOD",
+                        "IMPLICIT_WEAK_MATCH",
+                        "EXPLICIT_WEAK_MATCH",
+                        "EXPLICIT_STRONG_AFTER_WEAK_MATCH"
+                    ],
+                    "enumDescriptions": [
+                        "Unknown method.",
+                        "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.",
+                        "iSDK performs a server lookup by device fingerprint upon a dev API call.",
+                        "iSDK performs a strong match only if weak match is found upon a dev\nAPI call."
+                    ],
+                    "type": "string"
+                },
+                "visualStyle": {
+                    "description": "Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.",
+                    "enum": [
+                        "UNKNOWN_VISUAL_STYLE",
+                        "DEFAULT_STYLE",
+                        "CUSTOM_STYLE"
+                    ],
+                    "enumDescriptions": [
+                        "Unknown style.",
+                        "Default style.",
+                        "Custom style."
+                    ],
+                    "type": "string"
+                },
+                "sdkVersion": {
+                    "description": "Google SDK version.",
+                    "type": "string"
+                },
+                "bundleId": {
+                    "description": "APP bundle ID.",
+                    "type": "string"
+                },
+                "device": {
+                    "$ref": "DeviceInfo",
+                    "description": "Device information."
+                },
+                "uniqueMatchLinkToCheck": {
+                    "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.",
+                    "type": "string"
+                },
+                "appInstallationTime": {
+                    "description": "App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.",
+                    "format": "int64",
+                    "type": "string"
+                },
+                "iosVersion": {
+                    "description": "iOS version, ie: 9.3.5.\nConsider adding \"build\".",
+                    "type": "string"
+                }
+            },
+            "type": "object"
         }
     },
     "servicePath": "",
     "title": "Firebase Dynamic Links API",
     "version": "v1"
 }