You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
1.3 KiB
Kotlin
37 lines
1.3 KiB
Kotlin
/* 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/. */
|
|
|
|
package org.mozilla.fenix.search.telemetry
|
|
|
|
import java.util.Locale
|
|
|
|
/**
|
|
* A data class that tracks key information about a Search Engine Result Page (SERP).
|
|
*
|
|
* @property provider The name of the search provider.
|
|
* @property type The search access point type (SAP). This is either "organic", "sap" or
|
|
* "sap-follow-on".
|
|
* @property code The search URL's `code` query parameter.
|
|
* @property channel The search URL's `channel` query parameter.
|
|
*/
|
|
internal data class TrackKeyInfo(
|
|
var provider: String,
|
|
var type: String,
|
|
var code: String?,
|
|
var channel: String? = null
|
|
) {
|
|
/**
|
|
* Returns the track key information into the following string format:
|
|
* `<provider>.in-content.[sap|sap-follow-on|organic].[code|none](.[channel])?`.
|
|
*/
|
|
fun createTrackKey(): String {
|
|
return "${provider.toLowerCase(Locale.ROOT)}.in-content" +
|
|
".${type.toLowerCase(Locale.ROOT)}" +
|
|
".${code?.toLowerCase(Locale.ROOT) ?: "none"}" +
|
|
if (!channel?.toLowerCase(Locale.ROOT).isNullOrBlank())
|
|
".${channel?.toLowerCase(Locale.ROOT)}"
|
|
else ""
|
|
}
|
|
}
|