|
| 1 | +fields: |
| 2 | +- description: Timestamp when the ping is received on the server side. |
| 3 | + name: submission_timestamp |
| 4 | + type: TIMESTAMP |
| 5 | + mode: NULLABLE |
| 6 | +- description: A JSON string containing any payload properties not present in the |
| 7 | + schema |
| 8 | + name: additional_properties |
| 9 | + type: STRING |
| 10 | + mode: NULLABLE |
| 11 | +- description: Addon Version |
| 12 | + name: addon_version |
| 13 | + type: STRING |
| 14 | + mode: NULLABLE |
| 15 | +- description: A unique identifier (UUID) for the client. |
| 16 | + name: client_id |
| 17 | + type: STRING |
| 18 | + mode: NULLABLE |
| 19 | +- description: The document ID specified in the URI when the client sent this message. |
| 20 | + name: document_id |
| 21 | + type: STRING |
| 22 | + mode: NULLABLE |
| 23 | +- name: event |
| 24 | + type: STRING |
| 25 | + mode: NULLABLE |
| 26 | +- description: A string that describes the context about this event |
| 27 | + name: event_context |
| 28 | + type: STRING |
| 29 | + mode: NULLABLE |
| 30 | +- description: The event_context's page. Almost always "about:welcome". |
| 31 | + name: event_page |
| 32 | + type: STRING |
| 33 | + mode: NULLABLE |
| 34 | +- description: The event_context's reason. Likely something like "welcome-window-closed" |
| 35 | + or "app-shut-down". |
| 36 | + name: event_reason |
| 37 | + type: STRING |
| 38 | + mode: NULLABLE |
| 39 | +- description: The event_context's source. Likely something like "primary_button". |
| 40 | + name: event_source |
| 41 | + type: STRING |
| 42 | + mode: NULLABLE |
| 43 | +- name: locale |
| 44 | + type: STRING |
| 45 | + mode: NULLABLE |
| 46 | + description: Set of language- and/or country-based preferences for a user interface. |
| 47 | +- name: message_id |
| 48 | + type: STRING |
| 49 | + mode: NULLABLE |
| 50 | + description: Message ID |
| 51 | +- name: metadata |
| 52 | + type: RECORD |
| 53 | + mode: NULLABLE |
| 54 | + fields: |
| 55 | + - description: Results of a geographic lookup based on the client's IP address |
| 56 | + name: geo |
| 57 | + type: RECORD |
| 58 | + mode: NULLABLE |
| 59 | + fields: |
| 60 | + - name: city |
| 61 | + type: STRING |
| 62 | + mode: NULLABLE |
| 63 | + - description: An ISO 3166-1 alpha-2 country code |
| 64 | + name: country |
| 65 | + type: STRING |
| 66 | + mode: NULLABLE |
| 67 | + - description: The specific geo database version used for this lookup |
| 68 | + name: db_version |
| 69 | + type: STRING |
| 70 | + mode: NULLABLE |
| 71 | + - description: First major country subdivision, typically a state, province, or |
| 72 | + county |
| 73 | + name: subdivision1 |
| 74 | + type: STRING |
| 75 | + mode: NULLABLE |
| 76 | + - description: Second major country subdivision; not applicable for most countries |
| 77 | + name: subdivision2 |
| 78 | + type: STRING |
| 79 | + mode: NULLABLE |
| 80 | + - name: header |
| 81 | + type: RECORD |
| 82 | + mode: NULLABLE |
| 83 | + fields: |
| 84 | + - description: Date HTTP header |
| 85 | + mode: NULLABLE |
| 86 | + name: date |
| 87 | + type: STRING |
| 88 | + - description: DNT (Do Not Track) HTTP header |
| 89 | + mode: NULLABLE |
| 90 | + name: dnt |
| 91 | + type: STRING |
| 92 | + - description: X-Debug-Id HTTP header |
| 93 | + mode: NULLABLE |
| 94 | + name: x_debug_id |
| 95 | + type: STRING |
| 96 | + - description: X-PingSender-Version HTTP header |
| 97 | + mode: NULLABLE |
| 98 | + name: x_pingsender_version |
| 99 | + type: STRING |
| 100 | + - description: X-Source-Tags HTTP header |
| 101 | + mode: NULLABLE |
| 102 | + name: x_source_tags |
| 103 | + type: STRING |
| 104 | + - description: X-Telemetry-Agent HTTP header |
| 105 | + mode: NULLABLE |
| 106 | + name: x_telemetry_agent |
| 107 | + type: STRING |
| 108 | + - description: X-Foxsec-IP-Reputation header |
| 109 | + mode: NULLABLE |
| 110 | + name: x_foxsec_ip_reputation |
| 111 | + type: STRING |
| 112 | + - description: X-LB-Tags HTTP header |
| 113 | + mode: NULLABLE |
| 114 | + name: x_lb_tags |
| 115 | + type: STRING |
| 116 | + - description: Results of ISP lookup based on the client's IP address |
| 117 | + name: isp |
| 118 | + type: RECORD |
| 119 | + mode: NULLABLE |
| 120 | + fields: |
| 121 | + - description: The specific geo ISP database version used for this lookup |
| 122 | + mode: NULLABLE |
| 123 | + name: db_version |
| 124 | + type: STRING |
| 125 | + - description: The name of the ISP associated with the client's IP address |
| 126 | + mode: NULLABLE |
| 127 | + name: name |
| 128 | + type: STRING |
| 129 | + - description: The name of a specific business entity associated with the client's |
| 130 | + IP address when available; otherwise the ISP name |
| 131 | + mode: NULLABLE |
| 132 | + name: organization |
| 133 | + type: STRING |
| 134 | + - description: Parsed components of the client's user agent string |
| 135 | + name: user_agent |
| 136 | + type: RECORD |
| 137 | + mode: NULLABLE |
| 138 | + fields: |
| 139 | + - name: browser |
| 140 | + type: STRING |
| 141 | + mode: NULLABLE |
| 142 | + - name: os |
| 143 | + type: STRING |
| 144 | + mode: NULLABLE |
| 145 | + - name: version |
| 146 | + type: STRING |
| 147 | + mode: NULLABLE |
| 148 | +- description: Set to "Other" if this message contained an unrecognized app name |
| 149 | + mode: NULLABLE |
| 150 | + name: normalized_app_name |
| 151 | + type: STRING |
| 152 | +- description: The normalized channel the application is being distributed on. |
| 153 | + mode: NULLABLE |
| 154 | + name: normalized_channel |
| 155 | + type: STRING |
| 156 | +- description: Code of the country in which the activity took place, as determined |
| 157 | + by the IP geolocation. Unknown or NULL values are normally stored as '??'. |
| 158 | + mode: NULLABLE |
| 159 | + name: normalized_country_code |
| 160 | + type: STRING |
| 161 | +- description: The normalized name of the operating system running at the client. |
| 162 | + mode: NULLABLE |
| 163 | + name: normalized_os |
| 164 | + type: STRING |
| 165 | +- name: normalized_os_version |
| 166 | + mode: NULLABLE |
| 167 | + type: STRING |
| 168 | +- name: release_channel |
| 169 | + mode: NULLABLE |
| 170 | + type: STRING |
| 171 | +- name: sample_id |
| 172 | + mode: NULLABLE |
| 173 | + type: INTEGER |
| 174 | + description: A number, 0-99, that samples by client_id and allows filtering data |
| 175 | + for analysis. It is a pipeline-generated artifact that should match between pings. |
| 176 | +- name: version |
| 177 | + mode: NULLABLE |
| 178 | + type: STRING |
| 179 | + description: User visible version string (e.g. "1.0.3") for the browser. |
| 180 | +- description: A mirror of the browser sessionId, as defined in |
| 181 | + https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/schemas/telemetry/main/main.4.schema.json |
| 182 | + name: browser_session_id |
| 183 | + type: STRING |
| 184 | + mode: NULLABLE |
| 185 | +- name: experiments |
| 186 | + type: RECORD |
| 187 | + mode: REPEATED |
| 188 | + description: Experiment Information |
| 189 | + fields: |
| 190 | + - name: key |
| 191 | + type: STRING |
| 192 | + mode: NULLABLE |
| 193 | + - name: value |
| 194 | + type: RECORD |
| 195 | + mode: NULLABLE |
| 196 | + fields: |
| 197 | + - name: branch |
| 198 | + type: STRING |
| 199 | + mode: NULLABLE |
| 200 | + - name: extra |
| 201 | + type: RECORD |
| 202 | + mode: NULLABLE |
| 203 | + fields: |
| 204 | + - name: enrollment_id |
| 205 | + type: STRING |
| 206 | + mode: NULLABLE |
| 207 | + - name: type |
| 208 | + type: STRING |
| 209 | + mode: NULLABLE |
| 210 | +- name: attribution |
| 211 | + type: RECORD |
| 212 | + mode: NULLABLE |
| 213 | + fields: |
| 214 | + - description: Identifier of the particular campaign that led to the download of |
| 215 | + the product. |
| 216 | + name: campaign |
| 217 | + type: STRING |
| 218 | + mode: NULLABLE |
| 219 | + - description: Identifier to indicate the particular link within a campaign. |
| 220 | + name: content |
| 221 | + type: STRING |
| 222 | + mode: NULLABLE |
| 223 | + - description: Funnel experiment parameters, see bug 1567339 |
| 224 | + name: experiment |
| 225 | + type: STRING |
| 226 | + mode: NULLABLE |
| 227 | + - description: Category of the source, such as 'organic' for a search engine. |
| 228 | + name: medium |
| 229 | + type: STRING |
| 230 | + mode: NULLABLE |
| 231 | + - description: Referring partner domain, when install happens via a known partner. |
| 232 | + name: source |
| 233 | + type: STRING |
| 234 | + mode: NULLABLE |
| 235 | + - description: Derived user agent, see bug 1595063 |
| 236 | + name: ua |
| 237 | + type: STRING |
| 238 | + mode: NULLABLE |
| 239 | + - description: Funnel experiment parameters, see bug 1567339 |
| 240 | + name: variation |
| 241 | + type: STRING |
| 242 | + mode: NULLABLE |
| 243 | + - description: Unique token created at Firefox download time, see bug 1757451 |
| 244 | + name: dltoken |
| 245 | + type: STRING |
| 246 | + mode: NULLABLE |
| 247 | + - description: Identifier that indicates where installations of Firefox originate, |
| 248 | + see bug 1827238 |
| 249 | + name: dlsource |
| 250 | + type: STRING |
| 251 | + mode: NULLABLE |
| 252 | + - description: Either the string "true" or the string "false" to indicate whether |
| 253 | + the attributed install came from the Microsoft store and, if so, whether the |
| 254 | + user was signed in at the time. |
| 255 | + name: msstoresignedin |
| 256 | + type: STRING |
| 257 | + mode: NULLABLE |
0 commit comments