docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/firebasedynamiclinks_v1.v1.html b/docs/dyn/firebasedynamiclinks_v1.v1.html
index 3dec584..5e3849c 100644
--- a/docs/dyn/firebasedynamiclinks_v1.v1.html
+++ b/docs/dyn/firebasedynamiclinks_v1.v1.html
@@ -75,7 +75,7 @@
<h1><a href="firebasedynamiclinks_v1.html">Firebase Dynamic Links API</a> . <a href="firebasedynamiclinks_v1.v1.html">v1</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#getLinkStats">getLinkStats(dynamicLink, sdkVersion=None, durationDays=None, x__xgafv=None)</a></code></p>
+ <code><a href="#getLinkStats">getLinkStats(dynamicLink, durationDays=None, sdkVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches analytics stats of a short Dynamic Link for a given</p>
<p class="toc_element">
<code><a href="#installAttribution">installAttribution(body=None, x__xgafv=None)</a></code></p>
@@ -85,15 +85,15 @@
<p class="firstline">Get iOS reopen attribution for app universal link open deeplinking.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="getLinkStats">getLinkStats(dynamicLink, sdkVersion=None, durationDays=None, x__xgafv=None)</code>
+ <code class="details" id="getLinkStats">getLinkStats(dynamicLink, durationDays=None, sdkVersion=None, x__xgafv=None)</code>
<pre>Fetches analytics stats of a short Dynamic Link for a given
duration. Metrics include number of clicks, redirects, installs,
app first opens, and app reopens.
Args:
dynamicLink: string, Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz (required)
- sdkVersion: string, Google SDK version. Version takes the form "$major.$minor.$patch"
durationDays: string, The span of time requested in days.
+ sdkVersion: string, Google SDK version. Version takes the form "$major.$minor.$patch"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -103,11 +103,11 @@
An object of the form:
{ # Analytics stats of a Dynamic Link for a given timeframe.
- "linkEventStats": [ # Dynamic Link event stats.
+ "linkEventStats": [ # Dynamic Link event stats.
{ # Dynamic Link event stat.
- "count": "A String", # The number of times this event occurred.
- "platform": "A String", # Requested platform.
- "event": "A String", # Link event.
+ "event": "A String", # Link event.
+ "count": "A String", # The number of times this event occurred.
+ "platform": "A String", # Requested platform.
},
],
}</pre>
@@ -124,33 +124,33 @@
{ # Request for iSDK to execute strong match flow for post-install attribution.
# This is meant for iOS requests only. Requests from other platforms will
# not be honored.
- "visualStyle": "A String", # Strong match page information. Disambiguates between default UI and
+ "visualStyle": "A String", # Strong match page information. Disambiguates between default UI and
# custom page to present when strong match succeeds/fails to find cookie.
- "sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
- "appInstallationTime": "A String", # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).
+ "appInstallationTime": "A String", # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).
# This is a client signal for a more accurate weak match.
- "uniqueMatchLinkToCheck": "A 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.
- "device": { # Signals associated with the device making the request. # Device information.
- "languageCode": "A String", # Device language code setting.
- "languageCodeRaw": "A String", # Device language code raw setting.
+ "iosVersion": "A String", # iOS version, ie: 9.3.5.
+ # Consider adding "build".
+ "device": { # Signals associated with the device making the request. # Device information.
+ "timezone": "A String", # Device timezone setting.
+ "languageCodeRaw": "A 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.
- "deviceModelName": "A String", # Device model name.
- "languageCodeFromWebview": "A String", # Device language code setting obtained by executing JavaScript code in
+ "screenResolutionHeight": "A String", # Device display resolution height.
+ "languageCodeFromWebview": "A String", # Device language code setting obtained by executing JavaScript code in
# WebView.
- "screenResolutionHeight": "A String", # Device display resolution height.
- "timezone": "A String", # Device timezone setting.
- "screenResolutionWidth": "A String", # Device display resolution width.
+ "screenResolutionWidth": "A String", # Device display resolution width.
+ "deviceModelName": "A String", # Device model name.
+ "languageCode": "A String", # Device language code setting.
},
- "retrievalMethod": "A String", # App post install attribution retrieval information. Disambiguates
+ "uniqueMatchLinkToCheck": "A 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.
+ "bundleId": "A String", # APP bundle ID.
+ "retrievalMethod": "A String", # App post install attribution retrieval information. Disambiguates
# mechanism (iSDK or developer invoked) to retrieve payload from
# clicked link.
- "iosVersion": "A String", # iOS version, ie: 9.3.5.
- # Consider adding "build".
- "bundleId": "A String", # APP bundle ID.
+ "sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
}
x__xgafv: string, V1 error format.
@@ -162,40 +162,40 @@
An object of the form:
{ # Response for iSDK to execute strong match flow for post-install attribution.
- "utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at post-install.
- "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at post-install.
- "appMinimumVersion": "A 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.
- "attributionConfidence": "A String", # The confidence of the returned attribution.
- "externalBrowserDestinationLink": "A String", # User-agent specific custom-scheme URIs for iSDK to open. This will be set
+ "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
+ "utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at post-install.
+ "externalBrowserDestinationLink": "A 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
- "isStrongMatchExecutable": True or False, # Instruction for iSDK to attemmpt to perform strong match. For instance,
+ "appMinimumVersion": "A 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.
+ "requestedLink": "A String", # Entire FDL (short or long) attributed post-install via one of several
+ # techniques (fingerprint, copy unique).
+ "utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
+ "deepLink": "A String", # The deep-link attributed post-install via one of several techniques
+ # (fingerprint, copy unique).
+ "requestIpVersion": "A String", # Which IP version the request was made from.
+ "isStrongMatchExecutable": True or False, # 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.
- "requestIpVersion": "A String", # Which IP version the request was made from.
- "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
- "utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
- "invitationId": "A String", # Invitation ID attributed post-install via one of several techniques
- # (fingerprint, copy unique).
- "resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the
+ "attributionConfidence": "A String", # The confidence of the returned attribution.
+ "matchMessage": "A String", # Describes why match failed, ie: "discarded due to low confidence".
+ # This message will be publicly visible.
+ "utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at post-install.
+ "fallbackLink": "A 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).
+ "resolvedLink": "A 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).
- "requestedLink": "A String", # Entire FDL (short or long) attributed post-install via one of several
- # techniques (fingerprint, copy unique).
- "fallbackLink": "A 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).
- "utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at post-install.
- "matchMessage": "A String", # Describes why match failed, ie: "discarded due to low confidence".
- # This message will be publicly visible.
- "deepLink": "A String", # The deep-link attributed post-install via one of several techniques
+ "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at post-install.
+ "invitationId": "A String", # Invitation ID attributed post-install via one of several techniques
# (fingerprint, copy unique).
}</pre>
</div>
@@ -210,8 +210,9 @@
{ # Request for iSDK to get reopen attribution for app universal link open
# deeplinking. This endpoint is meant for only iOS requests.
- "sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
- "requestedLink": "A String", # FDL link to be verified from an app universal link open.
+ "bundleId": "A String", # APP bundle ID.
+ "sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
+ "requestedLink": "A String", # FDL link to be verified from an app universal link open.
# The FDL link can be one of:
# 1) short FDL.
# e.g. <app_code>.page.link/<ddl_id>, or
@@ -219,7 +220,6 @@
# e.g. <app_code>.page.link/?{query params}, or
# 3) Invite FDL.
# e.g. <app_code>.page.link/i/<invite_id_or_alias>
- "bundleId": "A String", # APP bundle ID.
}
x__xgafv: string, V1 error format.
@@ -232,17 +232,17 @@
{ # Response for iSDK to get reopen attribution for app universal link open
# deeplinking. This endpoint is meant for only iOS requests.
- "utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at app-reopen.
- "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at app-reopen.
- "iosMinAppVersion": "A String", # FDL input value of the "&imv=" parameter, minimum app version to be
+ "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
+ "iosMinAppVersion": "A String", # FDL input value of the "&imv=" parameter, minimum app version to be
# returned to Google Firebase SDK running on iOS-9.
- "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
- "utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
- "invitationId": "A String", # Optional invitation ID, for only invite typed requested FDL links.
- "resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the
+ "utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at app-reopen.
+ "utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at app-reopen.
+ "resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the
# requested_link, if it is long.
- "utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at app-reopen.
- "deepLink": "A String", # The deep-link attributed the app universal link open. For both regular
+ "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at app-reopen.
+ "invitationId": "A String", # Optional invitation ID, for only invite typed requested FDL links.
+ "utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
+ "deepLink": "A String", # The deep-link attributed the app universal link open. For both regular
# FDL links and invite FDL links.
}</pre>
</div>