Blame - docs/dyn/firebasedynamiclinks_v1.v1.html - platform/external/python/google-api-python-client

2017-06-06 18:46:08 -0400

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="firebasedynamiclinks_v1.html">Firebase Dynamic Links API</a> . <a href="firebasedynamiclinks_v1.v1.html">v1</a></h1>

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

78

<code><a href="#getLinkStats">getLinkStats(dynamicLink, durationDays=None, sdkVersion=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

79

<p class="firstline">Fetches analytics stats of a short Dynamic Link for a given</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#installAttribution">installAttribution(body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Get iOS strong/weak-match info for post-install attribution.</p>

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Get iOS reopen attribution for app universal link open deeplinking.</p>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

86

<h3>Method Details</h3>

87

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

88

<code class="details" id="getLinkStats">getLinkStats(dynamicLink, durationDays=None, sdkVersion=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

89

<pre>Fetches analytics stats of a short Dynamic Link for a given

90

duration. Metrics include number of clicks, redirects, installs,

91

app first opens, and app reopens.

92

93

Args:

94

dynamicLink: string, Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz (required)

95

durationDays: string, The span of time requested in days.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

96

sdkVersion: string, Google SDK version. Version takes the form "$major.$minor.$patch"

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

97

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

104

105

{ # Analytics stats of a Dynamic Link for a given timeframe.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

106

"linkEventStats": [ # Dynamic Link event stats.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

107

{ # Dynamic Link event stat.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

108

"event": "A String", # Link event.

109

"count": "A String", # The number of times this event occurred.

110

"platform": "A String", # Requested platform.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

},

],

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

<code class="details" id="installAttribution">installAttribution(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

118

<pre>Get iOS strong/weak-match info for post-install attribution.

119

120

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

121

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

122

The object takes the form of:

123

124

{ # Request for iSDK to execute strong match flow for post-install attribution.

125

# This is meant for iOS requests only. Requests from other platforms will

126

# not be honored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

127

"visualStyle": "A String", # Strong match page information. Disambiguates between default UI and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

128

# custom page to present when strong match succeeds/fails to find cookie.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

129

"appInstallationTime": "A String", # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

130

# This is a client signal for a more accurate weak match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

131

"iosVersion": "A String", # iOS version, ie: 9.3.5.

132

# Consider adding "build".

133

"device": { # Signals associated with the device making the request. # Device information.

134

"timezone": "A String", # Device timezone setting.

135

"languageCodeRaw": "A String", # Device language code raw setting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

136

# iOS does returns language code in different format than iOS WebView.

137

# For example WebView returns en_US, but iOS returns en-US.

138

# Field below will return raw value returned by iOS.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

139

"screenResolutionHeight": "A String", # Device display resolution height.

140

"languageCodeFromWebview": "A String", # Device language code setting obtained by executing JavaScript code in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

141

# WebView.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

142

"screenResolutionWidth": "A String", # Device display resolution width.

143

"deviceModelName": "A String", # Device model name.

144

"languageCode": "A String", # Device language code setting.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

145

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

146

"uniqueMatchLinkToCheck": "A String", # Possible unique matched link that server need to check before performing

147

# fingerprint match. If passed link is short server need to expand the link.

148

# If link is long server need to vslidate the link.

149

"bundleId": "A String", # APP bundle ID.

150

"retrievalMethod": "A String", # App post install attribution retrieval information. Disambiguates

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

151

# mechanism (iSDK or developer invoked) to retrieve payload from

152

# clicked link.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

153

"sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

154

}

155

156

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

163

164

{ # Response for iSDK to execute strong match flow for post-install attribution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

165

"utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.

166

"utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at post-install.

167

"externalBrowserDestinationLink": "A String", # User-agent specific custom-scheme URIs for iSDK to open. This will be set

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

168

# according to the user-agent tha the click was originally made in. There is

169

# no Safari-equivalent custom-scheme open URLs.

170

# ie: googlechrome://www.example.com

171

# ie: firefox://open-url?url=http://www.example.com

172

# ie: opera-http://example.com

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

173

"appMinimumVersion": "A String", # The minimum version for app, specified by dev through ?imv= parameter.

174

# Return to iSDK to allow app to evaluate if current version meets this.

175

"requestedLink": "A String", # Entire FDL (short or long) attributed post-install via one of several

176

# techniques (fingerprint, copy unique).

177

"utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.

178

"deepLink": "A String", # The deep-link attributed post-install via one of several techniques

179

# (fingerprint, copy unique).

180

"requestIpVersion": "A String", # Which IP version the request was made from.

181

"isStrongMatchExecutable": True or False, # Instruction for iSDK to attemmpt to perform strong match. For instance,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

182

# if browser does not support/allow cookie or outside of support browsers,

183

# this will be false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

184

"attributionConfidence": "A String", # The confidence of the returned attribution.

185

"matchMessage": "A String", # Describes why match failed, ie: "discarded due to low confidence".

186

# This message will be publicly visible.

187

"utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at post-install.

188

"fallbackLink": "A String", # The link to navigate to update the app if min version is not met.

189

# This is either (in order): 1) fallback link (from ?ifl= parameter, if

190

# specified by developer) or 2) AppStore URL (from ?isi= parameter, if

191

# specified), or 3) the payload link (from required link= parameter).

192

"resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

193

# requested_link, if it is long. Parameters from this should not be

194

# used directly (ie: server can default utm_[campaign|medium|source]

195

# to a value when requested_link lack them, server determine the best

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

196

# fallback_link when requested_link specifies >1 fallback links).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

197

"utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at post-install.

198

"invitationId": "A String", # Invitation ID attributed post-install via one of several techniques

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

199

# (fingerprint, copy unique).

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

204

<code class="details" id="reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

205

<pre>Get iOS reopen attribution for app universal link open deeplinking.

206

207

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

208

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

209

The object takes the form of:

210

211

{ # Request for iSDK to get reopen attribution for app universal link open

212

# deeplinking. This endpoint is meant for only iOS requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

213

"bundleId": "A String", # APP bundle ID.

214

"sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"

215

"requestedLink": "A String", # FDL link to be verified from an app universal link open.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

216

# The FDL link can be one of:

217

# 1) short FDL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

218

# e.g. <app_code>.page.link/<ddl_id>, or

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

219

# 2) long FDL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

220

# e.g. <app_code>.page.link/?{query params}, or

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

221

# 3) Invite FDL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

222

# e.g. <app_code>.page.link/i/<invite_id_or_alias>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

223

}

224

225

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

232

233

{ # Response for iSDK to get reopen attribution for app universal link open

234

# deeplinking. This endpoint is meant for only iOS requests.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

235

"utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.

236

"iosMinAppVersion": "A String", # FDL input value of the "&imv=" parameter, minimum app version to be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

237

# returned to Google Firebase SDK running on iOS-9.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

238

"utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at app-reopen.

239

"utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at app-reopen.

240

"resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

241

# requested_link, if it is long.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

242

"utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at app-reopen.

243

"invitationId": "A String", # Optional invitation ID, for only invite typed requested FDL links.

244

"utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.

245

"deepLink": "A String", # The deep-link attributed the app universal link open. For both regular

Bu Sun Kim