pings.yaml (9554B)
1 # This Source Code Form is subject to the terms of the Mozilla Public 2 # License, v. 2.0. If a copy of the MPL was not distributed with this 3 # file, You can obtain one at http://mozilla.org/MPL/2.0/. 4 --- 5 $schema: moz://mozilla.org/schemas/glean/pings/2-0-0 6 7 activation: 8 description: | 9 This ping is intended to provide a measure of the activation of mobile 10 products. It's generated when Fenix starts, right after Glean is 11 initialized. It doesn't include the client_id, since it might be reporting 12 an hashed version of the Google Advertising ID. 13 include_client_id: false 14 bugs: 15 - https://bugzilla.mozilla.com/1538011/ 16 - https://bugzilla.mozilla.com/1501822/ 17 data_reviews: 18 - https://github.com/mozilla-mobile/fenix/pull/1707#issuecomment-486972209 19 notification_emails: 20 - android-probes@mozilla.com 21 22 first-session: 23 description: | 24 **THIS IS NOT A GENERIC FIRST USE PING** This ping is intended to capture 25 Adjust attribution. Use of this ping for other analyses will result in 26 undesirable outcomes. 27 include_client_id: true 28 send_if_empty: true 29 bugs: 30 - https://github.com/mozilla-mobile/fenix/issues/7295 31 data_reviews: 32 - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202 33 notification_emails: 34 - android-probes@mozilla.com 35 36 play-store-attribution: 37 description: | 38 This ping captures the install referrer attribution data. 39 include_client_id: true 40 send_if_empty: true 41 bugs: 42 - https://bugzilla.mozilla.org/show_bug.cgi?id=1947786 43 data_reviews: 44 - https://phabricator.services.mozilla.com/D238284 45 notification_emails: 46 - android-probes@mozilla.com 47 48 adjust-attribution: 49 description: | 50 This ping captures the Adjust attribution data. 51 include_client_id: true 52 send_if_empty: true 53 bugs: 54 - https://bugzilla.mozilla.org/show_bug.cgi?id=1947786 55 data_reviews: 56 - https://phabricator.services.mozilla.com/D238284 57 notification_emails: 58 - android-probes@mozilla.com 59 60 home: 61 description: | 62 Homepage new tab related instrumentation. 63 include_client_id: true 64 bugs: 65 - https://bugzilla.mozilla.org/show_bug.cgi?id=1928577 66 data_reviews: 67 - https://phabricator.services.mozilla.com/D233815 68 notification_emails: 69 - android-probes@mozilla.com 70 71 topsites-impression: 72 description: | 73 Recorded when a sponsored top site is rendered and visible on the home 74 screen. Visibility is qualified as when the homepage is brought to the 75 front of the Browser, and sponsored tiles are 100% visible on screen. 76 include_client_id: false 77 bugs: 78 - https://github.com/mozilla-mobile/fenix/issues/23893 79 data_reviews: 80 - https://github.com/mozilla-mobile/fenix/pull/23945 81 notification_emails: 82 - android-probes@mozilla.com 83 84 spoc: 85 description: | 86 Contains data identifying with which Pocket sponsored story the user 87 interacted with and the type of interaction: story impression or click. 88 include_client_id: false 89 reasons: 90 impression: | 91 A sponsored story had more than 50% of it's content visible 92 on the screen. 93 click: | 94 A sponsored story was clicked by the user. 95 bugs: 96 - https://github.com/mozilla-mobile/fenix/issues/27549 97 - https://mozilla-hub.atlassian.net/browse/FNXV2-21791 98 data_reviews: 99 - https://github.com/mozilla-mobile/fenix/pull/27550#issuecomment-1295027631 100 notification_emails: 101 - android-probes@mozilla.com 102 103 cookie-banner-report-site: 104 description: | 105 This ping is needed when the cookie banner reducer doesn't work on 106 a website, and the user wants to report the site. 107 This ping doesn't include a client id. 108 include_client_id: false 109 bugs: 110 - https://bugzilla.mozilla.org/show_bug.cgi?id=1805450 111 data_reviews: 112 - https://github.com/mozilla-mobile/firefox-android/pull/1298#pullrequestreview-1350344223 113 notification_emails: 114 - android-probes@mozilla.com 115 116 fx-suggest: 117 description: | 118 A ping representing a single event occurring with or to a Firefox Suggestion. 119 Distinguishable by its `ping_type`. 120 Does not contain a `client_id`, preferring a `context_id` instead. 121 include_client_id: false 122 uploader_capabilities: 123 - ohttp 124 bugs: 125 - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092 126 - https://bugzilla.mozilla.org/show_bug.cgi?id=1969155 127 data_reviews: 128 - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1758607927 129 notification_emails: 130 - lina@mozilla.com 131 - ttran@mozilla.com 132 - najiang@mozilla.com 133 134 fx-suggest-api: 135 description: | 136 A ping representing a single interaction event with Firefox Suggestions API. 137 Distinguishable by its `ping_type`. 138 Does not contain a `client_id`. 139 include_client_id: false 140 uploader_capabilities: 141 - ohttp 142 bugs: 143 - https://bugzilla.mozilla.org/show_bug.cgi?id=1984499 144 data_reviews: [] 145 notification_emails: 146 - rmalicdem@mozilla.com 147 148 fx-accounts: 149 description: | 150 A ping for information about Mozilla Account usage. Sent at the same cadence 151 as the baseline ping. 152 include_client_id: true 153 send_if_empty: false 154 bugs: 155 - https://bugzilla.mozilla.org/show_bug.cgi?id=1970661 156 data_reviews: 157 - https://bugzilla.mozilla.org/show_bug.cgi?id=1970661 158 notification_emails: 159 - fmasalha@mozilla.com 160 - mtighe@mozilla.com 161 162 font-list: 163 description: | 164 List of fonts installed on the user's device 165 include_client_id: false 166 bugs: 167 - https://bugzilla.mozilla.org/show_bug.cgi?id=1858193 168 data_reviews: 169 - https://bugzilla.mozilla.org/show_bug.cgi?id=1858193#c2 170 notification_emails: 171 - android-probes@mozilla.com 172 - tom@mozilla.com 173 174 onboarding-opt-out: 175 description: | 176 Indicates the user has opted out of sending technical and interaction data. 177 include_client_id: false 178 send_if_empty: true 179 bugs: 180 - https://bugzilla.mozilla.org/show_bug.cgi?id=1936070 181 data_reviews: 182 - https://phabricator.services.mozilla.com/D231582 183 - https://phabricator.services.mozilla.com/D238034 184 notification_emails: 185 - android-probes@mozilla.com 186 metadata: 187 follows_collection_enabled: false 188 include_info_sections: false 189 190 dau-reporting: 191 description: | 192 Minimal ping to measure DAU. 193 Sent on the baseline schedule. 194 195 **NOTE**: This ping is deprecated and replaced by the `usage-reporting` ping. 196 include_client_id: true 197 send_if_empty: true 198 bugs: 199 - https://bugzilla.mozilla.org/show_bug.cgi?id=1923842 200 data_reviews: 201 - https://bugzilla.mozilla.org/show_bug.cgi?id=1923842 202 notification_emails: 203 - glean-team@mozilla.com 204 - jrediger@mozilla.com 205 - loines@mozilla.com 206 reasons: 207 dirty_startup: | 208 The ping was submitted at startup, because the application process was 209 killed before the Glean SDK had the chance to generate this ping, before 210 becoming inactive, in the last session. 211 inactive: | 212 The ping was submitted when becoming inactive. 213 active: | 214 The ping was submitted when the application became active again, 215 which includes when the application starts. 216 217 usage-reporting: 218 description: | 219 Minimal ping to measure the usage frequency of Firefox. 220 Sent on the baseline schedule. 221 include_client_id: false 222 send_if_empty: true 223 bugs: 224 - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440 225 - https://bugzilla.mozilla.org/show_bug.cgi?id=1929832 226 data_reviews: 227 - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440 228 notification_emails: 229 - glean-team@mozilla.com 230 - jrediger@mozilla.com 231 - loines@mozilla.com 232 metadata: 233 follows_collection_enabled: false 234 include_info_sections: false 235 reasons: 236 dirty_startup: | 237 Defined to avoid error logging. 238 *Note*: this ping will not actually send a ping reason. 239 inactive: | 240 Defined to avoid error logging. 241 *Note*: this ping will not actually send a ping reason. 242 active: | 243 Defined to avoid error logging. 244 *Note*: this ping will not actually send a ping reason. 245 246 usage-deletion-request: 247 description: | 248 This ping is submitted when a user opts out of sending usage 249 frequency of Firefox to Mozilla. 250 Sent in response to user action. 251 include_client_id: false 252 send_if_empty: true 253 bugs: 254 - https://bugzilla.mozilla.org/show_bug.cgi?id=1928975 255 data_reviews: 256 - https://phabricator.services.mozilla.com/D234677 257 notification_emails: 258 - glean-team@mozilla.com 259 - jrediger@mozilla.com 260 - loines@mozilla.com 261 metadata: 262 follows_collection_enabled: false 263 include_info_sections: false 264 reasons: 265 set_upload_enabled: | 266 The ping was submitted between Glean init and Glean shutdown. 267 After init but before shutdown the upload of usage reporting data changed 268 from enabled to disabled. 269 270 broken-site-report: 271 description: | 272 A ping containing the data for a user-initiated report for a broken site. 273 Does not contain a `client_id`. All report data is self contained. 274 include_client_id: false 275 bugs: 276 - https://bugzilla.mozilla.org/show_bug.cgi?id=1925088 277 data_reviews: 278 - https://phabricator.services.mozilla.com/D232122#8037249 279 notification_emails: 280 - twisniewski@mozilla.com 281 282 nimbus: 283 description: | 284 This ping is submitted by Nimbus code after the enrollment workflow has completed. 285 include_client_id: true 286 send_if_empty: true 287 bugs: 288 - https://bugzilla.mozilla.org/show_bug.cgi?id=1951125 289 data_reviews: 290 - https://bugzilla.mozilla.org/show_bug.cgi?id=1951125 291 notification_emails: 292 - chumphreys@mozilla.com 293 - project-nimbus@mozilla.com