Install Attribution
|
|||||
|
|
Get iOS strong/weak-match info for post-install attribution
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and administer all your Firebase data and settings
Input
This building block consumes 15 input parameters
Name | Format | Description |
---|---|---|
device |
OBJECT |
Signals associated with the device making the request |
device.languageCodeFromWebview |
STRING |
Device language code setting obtained by executing JavaScript code in WebView |
device.languageCodeRaw |
STRING |
Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS |
device.screenResolutionWidth |
INTEGER |
Device display resolution width |
device.timezone |
STRING |
Device timezone setting |
device.screenResolutionHeight |
INTEGER |
Device display resolution height |
device.languageCode |
STRING |
Device language code setting |
device.deviceModelName |
STRING |
Device model name |
uniqueMatchLinkToCheck |
STRING |
Possible unique matched link that server need to check before performing fingerprint match. If passed link is short server need to expand the link. If link is long server need to vslidate the link |
appInstallationTime |
INTEGER |
App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match |
iosVersion |
STRING |
iOS version, ie: 9.3.5. Consider adding "build" |
retrievalMethod |
ENUMERATION |
App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link |
visualStyle |
ENUMERATION |
Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie |
sdkVersion |
STRING |
Google SDK version. Version takes the form "$major.$minor.$patch" |
bundleId |
STRING |
APP bundle ID |
= Parameter name
= Format
device OBJECT Signals associated with the device making the request |
device.languageCodeFromWebview STRING Device language code setting obtained by executing JavaScript code in WebView |
device.languageCodeRaw STRING Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS |
device.screenResolutionWidth INTEGER Device display resolution width |
device.timezone STRING Device timezone setting |
device.screenResolutionHeight INTEGER Device display resolution height |
device.languageCode STRING Device language code setting |
device.deviceModelName STRING Device model name |
uniqueMatchLinkToCheck STRING Possible unique matched link that server need to check before performing fingerprint match. If passed link is short server need to expand the link. If link is long server need to vslidate the link |
appInstallationTime INTEGER App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match |
iosVersion STRING iOS version, ie: 9.3.5. Consider adding "build" |
retrievalMethod ENUMERATION App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link |
visualStyle ENUMERATION Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie |
sdkVersion STRING Google SDK version. Version takes the form "$major.$minor.$patch" |
bundleId STRING APP bundle ID |
Output
This building block provides 16 output parameters
Name | Format | Description |
---|---|---|
utmMedium |
STRING |
Scion medium value to be propagated by iSDK to Scion at post-install |
utmSource |
STRING |
Scion source value to be propagated by iSDK to Scion at post-install |
isStrongMatchExecutable |
BOOLEAN |
Instruction for iSDK to attemmpt to perform strong match. For instance, if browser does not support/allow cookie or outside of support browsers, this will be false |
appMinimumVersion |
STRING |
The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this |
invitationId |
STRING |
Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique) |
deepLink |
STRING |
The deep-link attributed post-install via one of several techniques (fingerprint, copy unique) |
externalBrowserDestinationLink |
STRING |
User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com |
attributionConfidence |
ENUMERATION |
The confidence of the returned attribution |
matchMessage |
STRING |
Describes why match failed, ie: "discarded due to low confidence". This message will be publicly visible |
resolvedLink |
STRING |
The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign|medium|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links) |
utmTerm |
STRING |
Scion term value to be propagated by iSDK to Scion at app-reopen |
utmCampaign |
STRING |
Scion campaign value to be propagated by iSDK to Scion at post-install |
requestIpVersion |
ENUMERATION |
Which IP version the request was made from |
utmContent |
STRING |
Scion content value to be propagated by iSDK to Scion at app-reopen |
fallbackLink |
STRING |
The link to navigate to update the app if min version is not met. This is either (in order): 1) fallback link (from ?ifl= parameter, if specified by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the payload link (from required link= parameter) |
requestedLink |
STRING |
Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique) |
= Parameter name
= Format
utmMedium STRING Scion medium value to be propagated by iSDK to Scion at post-install |
utmSource STRING Scion source value to be propagated by iSDK to Scion at post-install |
isStrongMatchExecutable BOOLEAN Instruction for iSDK to attemmpt to perform strong match. For instance, if browser does not support/allow cookie or outside of support browsers, this will be false |
appMinimumVersion STRING The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this |
invitationId STRING Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique) |
deepLink STRING The deep-link attributed post-install via one of several techniques (fingerprint, copy unique) |
externalBrowserDestinationLink STRING User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com |
attributionConfidence ENUMERATION The confidence of the returned attribution |
matchMessage STRING Describes why match failed, ie: "discarded due to low confidence". This message will be publicly visible |
resolvedLink STRING The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign|medium|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links) |
utmTerm STRING Scion term value to be propagated by iSDK to Scion at app-reopen |
utmCampaign STRING Scion campaign value to be propagated by iSDK to Scion at post-install |
requestIpVersion ENUMERATION Which IP version the request was made from |
utmContent STRING Scion content value to be propagated by iSDK to Scion at app-reopen |
fallbackLink STRING The link to navigate to update the app if min version is not met. This is either (in order): 1) fallback link (from ?ifl= parameter, if specified by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the payload link (from required link= parameter) |
requestedLink STRING Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique) |