"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"
},
"bearer_token":{
"description":"OAuth bearer token.",
"location":"query",
"type":"string"
},
"callback":{
"description":"JSONP",
"location":"query",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"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"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"pp":{
"default":"true",
"description":"Pretty-print response.",
"location":"query",
"type":"boolean"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"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"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location":"query",
"type":"string"
},
"upload_protocol":{
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"description":"Creates a managed short Dynamic Link given either a valid long Dynamic Link\nor details such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nThis differs from CreateShortDynamicLink in the following ways:\n - The request will also contain a name for the link (non unique name\n for the front end).\n - The response must be authenticated with an auth token (generated with\n the admin service account).\n - The link will appear in the FDL list of links in the console front end.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
"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.",
"description":"Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
"description":"Request to create a managed Short Dynamic Link.",
"id":"CreateManagedShortLinkRequest",
"properties":{
"dynamicLinkInfo":{
"$ref":"DynamicLinkInfo",
"description":"Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener)."
},
"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\u0026apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener).",
"type":"string"
},
"name":{
"description":"Link name to associate with the link. It's used for marketer to identify\nmanually-created links in the Firebase console\n(https://console.firebase.google.com/).\nLinks must be named to be tracked.",
"type":"string"
},
"suffix":{
"$ref":"Suffix",
"description":"Short Dynamic Link suffix. Optional."
}
},
"type":"object"
},
"CreateManagedShortLinkResponse":{
"description":"Response to create a short Dynamic Link.",
"id":"CreateManagedShortLinkResponse",
"properties":{
"managedShortLink":{
"$ref":"ManagedShortLink",
"description":"Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz"
},
"previewLink":{
"description":"Preview link to show the link flow chart. (debug info.)",
"type":"string"
},
"warning":{
"description":"Information about potential warnings on link creation.",
"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/reference/dynamic-links/link-shortener)."
"description":"Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com\u0026apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener).",
"description":"Device language code raw setting.\niOS does returns language code in different format than iOS WebView.\nFor example WebView returns en_US, but iOS returns en-US.\nField below will return raw value returned by iOS.",
"description":"Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
"description":"Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
"description":"Desktop related information. See desktop related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
"description":"E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps\nMore examples can be found in description of getNormalizedUriPrefix in\nj/c/g/firebase/dynamiclinks/uri/DdlDomain.java",
"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/receive)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
"description":"iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
"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/create-manually).\n\nRequired.",
"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.",
"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.",
"description":"Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.",
"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.",
"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"
},
"deepLink":{
"description":"The deep-link attributed post-install via one of several techniques\n(fingerprint, copy unique).",
"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"
},
"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"
},
"invitationId":{
"description":"Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
"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"
},
"matchMessage":{
"description":"Describes why match failed, ie: \"discarded due to low confidence\".\nThis message will be publicly visible.",
"description":"Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
"type":"string"
},
"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 \u003e1 fallback links).",
"type":"string"
},
"utmCampaign":{
"description":"Scion campaign value to be propagated by iSDK to Scion at post-install.",
"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.",
"description":"Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
"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.",
"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.",
"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.",
"Custom DDL suffix is a client specified string, for example,\n\"buy2get1free\".\nNOTE: custom suffix should only be available to managed short link\ncreation"
