# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
---
$schema: moz://mozilla.org/schemas/glean/pings/2-0-0

activation:
  description: |
    This ping is intended to provide a measure of the activation of mobile
    products. It's generated when Fenix starts, right after Glean is
    initialized. It doesn't include the client_id, since it might be reporting
    an hashed version of the Google Advertising ID.
  include_client_id: false
  bugs:
    - https://bugzilla.mozilla.com/1538011/
    - https://bugzilla.mozilla.com/1501822/
  data_reviews:
    - https://github.com/mozilla-mobile/fenix/pull/1707#issuecomment-486972209
  notification_emails:
    - android-probes@mozilla.com

first-session:
  description: |
    **THIS IS NOT A GENERIC FIRST USE PING** This ping is intended to capture
    Adjust attribution. Use of this ping for other analyses will result in
    undesirable outcomes.
  include_client_id: true
  send_if_empty: true
  bugs:
    - https://github.com/mozilla-mobile/fenix/issues/7295
  data_reviews:
    - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202
  notification_emails:
    - android-probes@mozilla.com

play-store-attribution:
  description: |
    This ping captures the install referrer attribution data.
  include_client_id: true
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1947786
  data_reviews:
    - https://phabricator.services.mozilla.com/D238284
  notification_emails:
    - android-probes@mozilla.com

adjust-attribution:
  description: |
    This ping captures the Adjust attribution data.
  include_client_id: true
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1947786
  data_reviews:
    - https://phabricator.services.mozilla.com/D238284
  notification_emails:
    - android-probes@mozilla.com

home:
  description: |
    Homepage new tab related instrumentation.
  include_client_id: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1928577
  data_reviews:
    - https://phabricator.services.mozilla.com/D233815
  notification_emails:
    - android-probes@mozilla.com

topsites-impression:
  description: |
    Recorded when a sponsored top site is rendered and visible on the home
    screen. Visibility is qualified as when the homepage is brought to the
    front of the Browser, and sponsored tiles are 100% visible on screen.
  include_client_id: false
  bugs:
    - https://github.com/mozilla-mobile/fenix/issues/23893
  data_reviews:
    - https://github.com/mozilla-mobile/fenix/pull/23945
  notification_emails:
    - android-probes@mozilla.com

spoc:
  description: |
    Contains data identifying with which Pocket sponsored story the user
    interacted with and the type of interaction: story impression or click.
  include_client_id: false
  reasons:
    impression: |
      A sponsored story had more than 50% of it's content visible
      on the screen.
    click: |
      A sponsored story was clicked by the user.
  bugs:
    - https://github.com/mozilla-mobile/fenix/issues/27549
    - https://mozilla-hub.atlassian.net/browse/FNXV2-21791
  data_reviews:
    - https://github.com/mozilla-mobile/fenix/pull/27550#issuecomment-1295027631
  notification_emails:
    - android-probes@mozilla.com

cookie-banner-report-site:
  description: |
    This ping is needed when the cookie banner reducer doesn't work on
    a website, and the user wants to report the site.
    This ping doesn't include a client id.
  include_client_id: false
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1805450
  data_reviews:
    - https://github.com/mozilla-mobile/firefox-android/pull/1298#pullrequestreview-1350344223
  notification_emails:
    - android-probes@mozilla.com

fx-suggest:
  description: |
    A ping representing a single event occurring with or to a Firefox Suggestion.
    Distinguishable by its `ping_type`.
    Does not contain a `client_id`, preferring a `context_id` instead.
  include_client_id: false
  uploader_capabilities:
    - ohttp
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1969155
  data_reviews:
    - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1758607927
  notification_emails:
    - lina@mozilla.com
    - ttran@mozilla.com
    - najiang@mozilla.com

fx-suggest-api:
  description: |
    A ping representing a single interaction event with Firefox Suggestions API.
    Distinguishable by its `ping_type`.
    Does not contain a `client_id`.
  include_client_id: false
  uploader_capabilities:
    - ohttp
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1984499
  data_reviews: []
  notification_emails:
    - rmalicdem@mozilla.com

fx-accounts:
  description: |
    A ping for information about Mozilla Account usage. Sent at the same cadence
    as the baseline ping.
  include_client_id: true
  send_if_empty: false
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1970661
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1970661
  notification_emails:
    - fmasalha@mozilla.com
    - mtighe@mozilla.com

font-list:
  description: |
      List of fonts installed on the user's device
  include_client_id: false
  bugs:
   - https://bugzilla.mozilla.org/show_bug.cgi?id=1858193
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1858193#c2
  notification_emails:
    - android-probes@mozilla.com
    - tom@mozilla.com

onboarding-opt-out:
  description: |
    Indicates the user has opted out of sending technical and interaction data.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1936070
  data_reviews:
    - https://phabricator.services.mozilla.com/D231582
    - https://phabricator.services.mozilla.com/D238034
  notification_emails:
    - android-probes@mozilla.com
  metadata:
    follows_collection_enabled: false
    include_info_sections: false

dau-reporting:
  description: |
    Minimal ping to measure DAU.
    Sent on the baseline schedule.

    **NOTE**: This ping is deprecated and replaced by the `usage-reporting` ping.
  include_client_id: true
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1923842
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1923842
  notification_emails:
    - glean-team@mozilla.com
    - jrediger@mozilla.com
    - loines@mozilla.com
  reasons:
    dirty_startup: |
      The ping was submitted at startup, because the application process was
      killed before the Glean SDK had the chance to generate this ping, before
      becoming inactive, in the last session.
    inactive: |
      The ping was submitted when becoming inactive.
    active: |
      The ping was submitted when the application became active again,
      which includes when the application starts.

usage-reporting:
  description: |
    Minimal ping to measure the usage frequency of Firefox.
    Sent on the baseline schedule.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1929832
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440
  notification_emails:
    - glean-team@mozilla.com
    - jrediger@mozilla.com
    - loines@mozilla.com
  metadata:
    follows_collection_enabled: false
    include_info_sections: false
  reasons:
    dirty_startup: |
      Defined to avoid error logging.
      *Note*: this ping will not actually send a ping reason.
    inactive: |
      Defined to avoid error logging.
      *Note*: this ping will not actually send a ping reason.
    active: |
      Defined to avoid error logging.
      *Note*: this ping will not actually send a ping reason.

usage-deletion-request:
  description: |
    This ping is submitted when a user opts out of sending usage
    frequency of Firefox to Mozilla.
    Sent in response to user action.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1928975
  data_reviews:
    - https://phabricator.services.mozilla.com/D234677
  notification_emails:
    - glean-team@mozilla.com
    - jrediger@mozilla.com
    - loines@mozilla.com
  metadata:
    follows_collection_enabled: false
    include_info_sections: false
  reasons:
    set_upload_enabled: |
      The ping was submitted between Glean init and Glean shutdown.
      After init but before shutdown the upload of usage reporting data changed
      from enabled to disabled.

broken-site-report:
  description: |
    A ping containing the data for a user-initiated report for a broken site.
    Does not contain a `client_id`. All report data is self contained.
  include_client_id: false
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1925088
  data_reviews:
    - https://phabricator.services.mozilla.com/D232122#8037249
  notification_emails:
    - twisniewski@mozilla.com

nimbus:
  description: |
    This ping is submitted by Nimbus code after the enrollment workflow has completed.
  include_client_id: true
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1951125
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1951125
  notification_emails:
    - chumphreys@mozilla.com
    - project-nimbus@mozilla.com

onboarding:
  description: |
    This ping is submitted multiple times during onboarding: once after every card/screen is completed.
    Usually (or always?) the first card/screen asks permission to submit metrics, so the first
    `onboarding` ping is the logical negation of the `onboarding-opt-out` ping.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=2010810
  data_reviews:
    - https://phabricator.services.mozilla.com/D280983
  notification_emails:
    - android-probes@mozilla.com
