Tracking Specification Brainstorm

TrackingSpec.yml

version: "37"
info: 
  description: "This is the tracking data specification"
  maintainers:
    - "blahgblah@blah.com"
user_properties:
  - name: "userId"
    description: "The user's unique Identifier"
    rationale: "Needed for tracking unique user events"
events:
  - name: "card_viewed"
    description: "User taps on any card at the bottom of the map"
    rationale: "Being able to measure how often cards from the map are used"
    platform:
       ios: true
       android: true
    properties:
      - name: "card_name"
        description: "The name of the viewed card"
        platform:
           ios: true
           android: true
        options:
           - name: "catches_card"
             description: "The catches card"
             platform:
               ios: true
               android: true
            - name: "species_card"
              description: "The species card"
              platform:
                ios: true
                android: true
  - name: "catches_button_tapped"
    description: "User taps on any card at the bottom of the map"
    rationale: "Being able to measure how often cards from the map are used"
    platform:
      ios: true
      android: true
  - name: "old_event"
    description: "Something very old"
    deprecated: true
    platform: 
      ios: true
      android: true

Nice! However it'd be nice to know when something was introduced or deprecated, like a log of which app release it was added/removed in

Great starting point! I tried to simplify/shorten it a bit (see below) to make it easier to overview, and also added something I think we should have: the types of property values!

version: 42

info: 
  description: "This is the tracking data specification"
  maintainers:
    - "blahgblah@blah.com"

global_user_properties:
  - user_id:
      description: "The user's unique Identifier"
      rationale: "Needed for tracking unique user events"

events:
  - card_viewed:
      description: "User taps on any card at the bottom of the map"
      rationale: "Being able to measure how often cards from the map are used"
      properties:
        - card_name: 
            type: string
            description: "The name of the viewed card"
            possible_values:
              - catches_card: "The catches card"
              - species_card: "The species card"

  - catches_button_tapped:
      description: "User taps on any card at the bottom of the map"
      rationale: "Being able to measure how often cards from the map are used"
      platform: ios

  - old_event:
      description: "Something very old"
      deprecated: true