PPI-1027 api for configuring deep links

Author: auto200

data_collection/web/javascript_tracking_client/api.rst

@@ -2973,7 +2973,7 @@ JavaScript Tracking Client configuration
 
     Returns list of internal domains (set with :func:`setDomains` and used in :ref:`outlink tracking<jtc-api-download-and-outlink>`).
 
-    :return: List of internal domains (e.g. ``[".example.com", ".example.co.uk"]``
+    :return: List of internal domains (e.g. ``[".example.com", ".example.co.uk"]``)
     :rtype: string[]
 
     Example of usage:
@@ -2994,6 +2994,55 @@ JavaScript Tracking Client configuration
 
                 console.log(jstc.getDomains());
 
+.. function:: setDeepLinkPrefixes(prefixes)
+
+    Allows to define a list of mobile app prefixes (URIs). Used in :ref:`outlink tracking<jtc-api-download-and-outlink>`
+    for determining whether a link is an outlink and in :ref:`cross domain linking<jtc-api-cross-domain-linking>`
+    for determining which links should have visitor ID parameter injected.
+
+    :param Array<string> prefixes: **Required** A list of app prefixes.
+
+    Example of usage:
+
+    .. tabs::
+
+        .. group-tab:: Command queue
+
+            .. code-block:: javascript
+
+                _paq.push(["setDeepLinkPrefixes", ["piwik://", "myApp://"]]);
+
+        .. group-tab:: JavaScript Tracking Client object
+
+            .. code-block:: javascript
+
+                jstc.setDeepLinkPrefixes(["piwik://", "myApp://"]);
+
+.. function:: getDeepLinkPrefixes()
+
+    Returns list of prefixes (URIs) (set with :func:`setDeepLinkPrefixes` and used in :ref:`outlink tracking<jtc-api-download-and-outlink>`).
+
+    :return: List of prefixes (e.g. ``["piwik://", "myApp://"]``)
+    :rtype: string[]
+
+    Example of usage:
+
+    .. tabs::
+
+        .. group-tab:: Command queue
+
+            .. code-block:: javascript
+
+                _paq.push([function () {
+                    console.log(this.getDeepLinkPrefixes());
+                }]);
+
+        .. group-tab:: JavaScript Tracking Client object
+
+            .. code-block:: javascript
+
+                console.log(jstc.getDeepLinkPrefixes());
+
 .. function:: setCustomUrl(customUrl)
 
     The function that will override tracked page URL. Tracker will use current page URL if custom URL was not set.