# 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/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Firefox :: New Tab Page'

newtab:
  locale:
    type: string
    description: >
      The application's locale as of when newtab's TelemetryFeed was init.
      Comes from `Services.local.appLocaleAsBCP47`.
      Looks like `en-US`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab
    lifetime: application

  newtab_category:
    type: string
    description: >
      The current setting of the newtab page.
      One of ["enabled", "disabled", "extension"] or any value from
      SiteClassifier like "known-hijacker" or "social-media".
      Similar to Activity Stream's PAGE_TAKEOVER_DATA event's
      `newtab_url_category`.
      Sampled once after newtab init.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab
    lifetime: application

  homepage_category:
    type: string
    description: >
      The current setting of the home page.
      One of ["enabled", "disabled", "extension"] or any value from
      SiteClassifier like "known-hijacker" or "social-media".
      Similar to Activity Stream's PAGE_TAKEOVER_DATA event's
      `home_url_category`.
      Sampled once after newtab init.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab
    lifetime: application

  opened:
    type: event
    description: >
      Recorded when newtab UI is opened via `about:newtab` or `about:home` or
      `about:welcome` and has been made visible (see `visibility_event_rcvd_ts`
      in
      [detect-user-session-start.js](https://searchfox.org/mozilla-central/source/browser/components/newtab/content-src/lib/detect-user-session-start.js)).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: &newtab_visit_id
        description: >
          The id of this newtab visit.
          Allows you to separate multiple simultaneous newtabs and
          build an event timeline of actions taken from this newtab.
        type: string
      source:
        description: >
          The source that opened this newtab.
          One of
            * `about:newtab`
            * `about:home`
            * `about:welcome`
            * `other`
          (See `ONBOARDING_ALLOWED_PAGE_VALUES`).
        type: string
    send_in_pings:
      - newtab

  closed:
    type: event
    description: >
      Recorded when newtab UI is closed by
      * navigation
      * closing the tab

      Doesn't mean that the newtab was ever visible to a user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
    send_in_pings:
      - newtab
  blocked_sponsors:
    type: string_list
    description: >
      The advertiser names that have been dismissed by the user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1828234
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1828234#c1
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
    expires: never
    send_in_pings:
      - newtab
    lifetime: application

newtab.search:
  enabled:
    lifetime: application
    type: boolean
    description: >
      Whether the search input is enabled on the newtab.
      Corresponds to the value of the
      `browser.newtabpage.activity-stream.showSearch` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

topsites:
  enabled:
    lifetime: application
    type: boolean
    description: >
      Whether "topsites" is enabled on the newtab.
      AKA the "Shortcuts" section.
      Corresponds to the value of the
      `browser.newtabpage.activity-stream.feeds.topsites` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

  sponsored_enabled:
    lifetime: application
    type: boolean
    description: >
      Whether sponsored topsites are enabled on the newtab.
      AKA the "Sponsored Shortcuts" section.
      Corresponds to the value of the
      `browser.newtabpage.activity-stream.showSponsoredTopSites` pref.
      Can be `true` even if topsites.enabled is `false`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

  impression:
    type: event
    description: >
      Recorded when topsite tiles are loaded.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824842#c7
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      advertiser_name: &advertiser_name
        description: >
          The name of the advertiser of the tile
        type: string
      tile_id: &tile_id
        description: >
          The tile id of the advertiser provided by Contile
        type: string
      newtab_visit_id: *newtab_visit_id
      is_sponsored: &is_sponsored
        description: Whether the topsite tile was sponsored.
        type: boolean
      position: &topsite_position
        description: The position (0-index) of the topsite tile.
        type: quantity
    send_in_pings:
      - newtab

  click:
    type: event
    description: >
      Recorded when a topsite tile is clicked.
      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
      options in the context menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824842#c7
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      advertiser_name: *advertiser_name
      tile_id: *tile_id
      newtab_visit_id: *newtab_visit_id
      is_sponsored: *is_sponsored
      position: *topsite_position
    send_in_pings:
      - newtab

  rows:
    lifetime: application
    type: quantity
    unit: integer
    description: >
      The number of topsite tile rows configured to be shown on the newtab
      page. Corresponds to the value of the
      `browser.newtabpage.activity-stream.topSitesRows` pref. This is not the
      number of rows actually seen by the user: if the browser window is
      partially off-screen, or isn't wide enough to accommodate eight tiles per
      row, the actual number of rows may be different.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556#c3
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

pocket:
  is_signed_in:
    lifetime: application
    type: boolean
    description: >
      Whether the Firefox user is signed in to Pocket.
      Does not correspond to a pref, so its value is resampled at newtab's
      component init and whenever there is a Discovery Stream user event.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

  enabled:
    lifetime: application
    type: boolean
    description: >
      Whether Pocket is enabled on the newtab.
      AKA the "Recommended by Pocket" section.
      Corresponds to the value of the
      `browser.newtabpage.activity-stream.feeds.section.topstories` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

  sponsored_stories_enabled:
    lifetime: application
    type: boolean
    description: >
      Whether Pocket sponsored stories are enabled on the newtab.
      Corresponds to the value of the
      `browser.newtabpage.activity-stream.showSponsored` pref.
      Can be `true` even if pocket.enabled is `false`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - technical
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    send_in_pings:
      - newtab

  impression:
    type: event
    description: >
      Recorded when a pocket tile is visible to the user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
      is_sponsored: &is_sponsored_pocket
        description: Whether the pocket tile was sponsored (has an ad shim).
        type: boolean
      position: &pocket_position
        description: The position (0-index) of the pocket tile.
        type: quantity
    send_in_pings:
      - newtab

  click:
    type: event
    description: >
      Recorded when a pocket tile is clicked.
      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
      options in the context menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
      is_sponsored: *is_sponsored_pocket
      position: *pocket_position
    send_in_pings:
      - newtab

  save:
    type: event
    description: >
      Recorded when a user decides to save a pocket tile.
      Does not mean it ends up successfully saved.
      Just that the user clicked on "Save to Pocket" in the little pocket
      tile menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
      is_sponsored: *is_sponsored_pocket
      position: *pocket_position
    send_in_pings:
      - newtab

  topic_click:
    type: event
    description: >
      Recorded when a pocket "Popular Topic" is clicked.
      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
      options in the context menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
      topic:
        description: The topic that was clicked on. Like "entertainment".
        type: string
    send_in_pings:
      - newtab


messaging_system:
  event_context_parse_error:
    type: counter
    lifetime: ping
    description: |
      How often we failed to parse event_context as JSON.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  event_reason:
    type: string
    lifetime: ping
    description: |
      The event_context's `reason`. Likely something like
      "welcome-window-closed" or "app-shut-down",.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  event_page:
    type: string
    lifetime: ping
    description: |
      The event_context's `page`. Almost always "about:welcome".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  event_source:
    type: string
    lifetime: ping
    description: |
      The event_context's `source`. Likely something like "primary_button".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  event_context:
    type: text
    lifetime: ping
    description: |
      The stringified JSON of `event_context`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - web_activity
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  message_id:
    type: text
    lifetime: ping
    description: |
      A string identifier of the message in Activity Stream Router.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - web_activity
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  event:
    type: string
    description: >
      The type of event. Any user defined string
      (e.g. “click”, “share”, “delete”, “more_items”)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  ping_type:
    type: string
    description: >
      Type of event the ping is capturing.
      e.g. "cfr", "whats-new-panel", "onboarding"
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  page:
    type: string
    description: >
      One of [”about:newtab”, “about:home”, “about:welcome”,
      “unknown” (which either means not-applicable or is a bug)].
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  source:
    type: string
    description: >
      The source of the interaction described by the other metrics.
      e.g. "frecent_links", "newtab", "CFR"
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  client_id:
    type: uuid
    lifetime: ping
    description: |
      The client_id according to Telemetry.
      Might not always have a value due to policy around specific types of
      ping being sent. Value may be the canary client id
      `c0ffeec0-ffee-c0ff-eec0-ffeec0ffeec0`
      in pings near when the data upload pref is disabled (if Telemetry gets
      to go first), or between when a client_id has been removed and when it
      has been regenerated.
      Present only in some circumstances (see
      [bug 1484035]https://bugzilla.mozilla.org/show_bug.cgi?id=1484035)).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1484035
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
    data_sensitivity:
      - technical
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  locale:
    type: string
    lifetime: ping
    description: >
      The locale as supplied to the messaging system by
      `Services.locale.appLocaleAsBCP47`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  browser_session_id:
    type: uuid
    lifetime: ping
    # Disable yamllint for long lines.
    # yamllint disable
    description: >
      The Legacy Telemetry browser "session id".
      Identifies a specific period from application start to shutdown.
      See [the "main" ping docs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/main-ping.html)
      for details.
    # yamllint enable
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  impression_id:
    type: uuid
    lifetime: ping
    description: >
      The unique impression identifier for a specific client.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  bucket_id:
    type: string
    lifetime: ping
    description: >
      A name shared between multiple messages that may individually be too
      targetted.
      e.g. a message that gets shown on specific websites or a message asking
      about personal information.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  action:
    type: string
    lifetime: ping
    description: >
      What type of action resulted in the event.
      One of "IMPRESSION" or "DISMISS".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system


  cfr_action:
    type: text
    lifetime: ping
    description: >
      The Contextual Feature Recommender's action.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - web_activity
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  addon_version:
    type: string
    lifetime: ping
    description: >
      Used to hold the system addon's version,
      now is almost certainly an echo of the app's build id.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - dmosedale@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  unknown_key_count:
    type: counter
    description: |
      The sum of all unknown keys counted.
      Useful for testing.
      Can be removed after bug 1600008 is resolved.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  unknown_keys:
    type: labeled_counter
    description: |
      Ping keys supplied to the messaging system for which
      we did not have a corresponding metric mapped to how often they attempted
      to be recorded.
      You may have forgotten to define an appropriate metric in
      `browser/components/newtab/metrics.yaml`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  glean_ping_for_ping_failures:
    type: counter
    description: |
      How often something went awry within
      `AboutWelcome.submitGleanPingForPing`, preventing ping submission.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
      - chutten@mozilla.com
    expires: never
    send_in_pings:
      - metrics

  invalid_nested_data:
    type: labeled_counter
    description: |
      We received a ping with non-scalar data on a field of this name.
      If this is existing pre-PingCentre-replacement data, you may need to
      augment the logic in
      `AboutWelcome.submitGleanPingForPing` like the other `handledKeys`.
      If this is for new, post-PingCentre-replacement data, you should
      probably prefer a flat structure.
      If you're unsure, please ask in
      [the #glean channel](https://chat.mozilla.org/#/room/#glean:mozilla.org).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
      - chutten@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system


messaging_system.attribution:
  source:
    type: string
    lifetime: ping
    description: |
      Attribution's source, possibly derived from the utm parameter of the same
      name.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  medium:
    type: string
    lifetime: ping
    description: |
      Attribution's medium, possibly derived from the utm parameter of the same
      name.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  campaign:
    type: string
    lifetime: ping
    description: |
      Attribution's campaign, possibly derived from the utm parameter of the
      same name.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  content:
    type: string
    lifetime: ping
    description: |
      Attribution's content, possibly derived from the utm parameter of the
      same name.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  experiment:
    type: string
    lifetime: ping
    description: |
      Attribution's experiment key.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  variation:
    type: string
    lifetime: ping
    description: |
      Attribution's variation key.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  ua:
    type: string
    lifetime: ping
    description: |
      Attribution's ua key.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  dltoken:
    type: string
    lifetime: ping
    description: |
      String representation of the dltoken identifying the particular
      installer used to install this Firefox.
      Likely a UUID, if present.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  msstoresignedin:
    type: string
    lifetime: ping
    description: |
      Either the string "true" or the string "false" to indicate whether the
      attributed install came from the Microsoft store and, if so, whether the
      user was signed in at the time.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1756209
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1756209
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  dlsource:
    type: string
    lifetime: ping
    description: |
      Mozilla-specific download "source" name. Could be something like
      "mozillaci" to identify that the installer came from
      `{archive|ftp}.mozilla.org`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1819997
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1819997
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - interaction
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system

  unknown_keys:
    type: labeled_counter
    description: |
      Attribution keys supplied to the messaging system for which
      we did not have a corresponding metric, and the count of how
      often that happened.
      Either add this key to a list of known attribution keys in
      `AboutWelcomeTelemetry` to suppress or define an appropriate metric in
      `browser/components/newtab/metrics.yaml` to collect.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863
    data_sensitivity:
      - technical
    notification_emails:
      - dmosedale@mozilla.com
      - pmcmanis@mozilla.com
    expires: never
    send_in_pings:
      - messaging-system