Bug 1449212 - update core ping docs describing the new accessibilityServices value. r=sdaswani
authorYura Zenevich <yura.zenevich@gmail.com>
Wed, 28 Mar 2018 14:17:17 -0400
changeset 776859 860ec10b301ba60b4a80194c16443495fec53f6c
parent 776858 8ab320324b9fea099696c4bea8b301baa148199a
child 776860 64682e402373b73e839314cf3229c1afa68288b4
push id105022
push userdholbert@mozilla.com
push dateTue, 03 Apr 2018 21:03:05 +0000
reviewerssdaswani
bugs1449212
milestone61.0a1
Bug 1449212 - update core ping docs describing the new accessibilityServices value. r=sdaswani MozReview-Commit-ID: 2c1wlyCYFtl
toolkit/components/telemetry/docs/data/core-ping.rst
--- a/toolkit/components/telemetry/docs/data/core-ping.rst
+++ b/toolkit/components/telemetry/docs/data/core-ping.rst
@@ -51,16 +51,19 @@ Structure:
       "sessions": <integer>, // number of sessions since last upload
       "durations": <integer>, // combined duration, in seconds, of all
                                     // sessions since last upload
       "searches": <object>, // Optional, object of search use counts in the
                             // format: { "engine.source": <pos integer> }
                             // e.g.: { "yahoo.suggestion": 3, "other.listitem": 1 }
       "experiments": [<string>, /* … */], // Optional, array of identifiers
                                     // for the active experiments
+      "accessibilityServices": [<string>, /* … */], // Optional, array of identifiers for
+                                                    // enabled accessibility services that
+                                                    // interact with our android products.
       "flashUsage": <integer>, // number of times flash plugin is played since last upload
       "defaultBrowser": <boolean> // true if the user has set Firefox as default browser
 
     }
 
 Field details
 -------------
 
@@ -169,32 +172,37 @@ we only record the search engine name wh
 
 * actionbar: the user types in the url bar and hits enter to use the default
   search engine
 * listitem: the user selects a search engine from the list of secondary search
   engines at the bottom of the screen
 * suggestion: the user clicks on a search suggestion or, in the case that
   suggestions are disabled, the row corresponding with the main engine
 
+accessibilityServices
+~~~~~~~~~~~~~~~~~~~~~
+This describes which accessibility services are currently enabled on user's device and could be interacting with out
+products. This is optional because users often do not have any accessibility services enabled. If present, the value is
+a list of accessibility service ids.
 
 Other parameters
 ----------------
 
 HTTP "Date" header
 ~~~~~~~~~~~~~~~~~~
 This header is used to track the submission date of the core ping in the format
 specified by
 `rfc 2616 sec 14.18 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18>`_,
 et al (e.g. "Tue, 01 Feb 2011 14:00:00 GMT").
 
 
 Version history
 ---------------
 * v10: added ``defaultBrowser`` to know if the user has set Firefox as default browser
-* v9: changed ``arch`` to contain device arch rather than the one we built against
+* v9: changed ``arch`` to contain device arch rather than the one we built against & ``accessibilityServices``
 * v8: added ``flashUsage``
 * v7: added ``sessionCount`` & ``sessionDuration``  & ``campaignId``
 * v6: added ``searches``
 * v5: added ``created`` & ``tz``
 * v4: ``profileDate`` will return package install time when times.json is not available
 * v3: added ``defaultSearch``
 * v2: added ``distributionId``
 * v1: initial version - shipped in `Fennec 45 <https://bugzilla.mozilla.org/show_bug.cgi?id=1205835>`_.