# 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

quick-suggest:
  description: |
    A ping representing an impression, selection, or dismissmal of an AMP
    suggestion. It contains metrics in the `quick_suggest` category. Its type is
    defined in the `ping_type` metric. It does not contain a `client_id`,
    preferring a `context_id` instead. `follows_collection_enabled` is set to
    false because the ping is conditioned on Suggest and AMP suggestions being
    enabled. It will be enabled when Suggest and AMP suggestions are enabled and
    it will be disabled otherwise. When it becomes disabled, a separate
    `quick-suggest-deletion-request` ping will be submitted.
  include_client_id: false
  metadata:
    follows_collection_enabled: false
  uploader_capabilities:
    - ohttp
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1940808
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1968154
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1940808
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1968154
  notification_emails:
    - fx-search-telemetry@mozilla.com
    - disco-team@mozilla.com
    - ads-eng@mozilla.com

quick-suggest-deletion-request:
  description: |
    This ping is submitted when either AMP suggestions or the entire Suggest
    feature becomes disabled. Like the `quick-suggest` ping, it will contain a
    `context_id` metric in the `quick_suggest` category.
  include_client_id: false
  metadata:
    follows_collection_enabled: false
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1941161
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1941161
  notification_emails:
    - fx-search-telemetry@mozilla.com
    - disco-team@mozilla.com
    - ads-eng@mozilla.com

urlbar-keyword-exposure:
  description: |
    This ping is submitted only when urlbar keyword exposures are enabled. See
    the `keywordExposureResults` urlbar Nimbus variable. When enabled, the ping
    is submitted at the end of urlbar sessions during which one or more exposure
    results are matched. (A "session" begins when the user focuses the urlbar
    and ends with an engagement or abandonment.) Exposure results include all
    results defined in the `exposureResults` variable. They also include the
    "rust_exposure" result type if the `quickSuggestDynamicSuggestionTypes`
    variable is defined with a value that includes any hidden-exposure
    suggestion types. The ping will contain one `urlbar.keyword_exposure` event
    for each instance where a result is matched during the session. The ping is
    not submitted for sessions in private windows.
  include_client_id: false
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1881875
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1915507
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1881875
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1915507
  notification_emails:
    - fx-search-telemetry@mozilla.com