Acompanhar métricas do widget

O Android 16 inclui APIs de métricas adicionais que são mais granulares. Essas métricas rastreiam ações de toque, como um clique em um botão, rolagem, impressões e o tamanho e a posição do widget.

A API principal é AppWidgetEvent. Use WorkManager para criar um worker periódico que capture o engajamento do widget uma vez por hora.

Confira o snippet a seguir para um exemplo de rastreamento de cliques, rolagens e duração da impressão.

@RequiresApi(Build.VERSION_CODES_FULL.BAKLAVA_1)
fun getWidgetEngagementMetrics(context: Context) {
    val manager = AppWidgetManager.getInstance(context)

    val endTime = System.currentTimeMillis()
    val startTime = endTime - (24 * 60 * 60 * 1000) // a day ago

    val events = manager.queryAppWidgetEvents(startTime, endTime)

    if (events.isEmpty()) {
        Log.d(TAG, "No events found for the given time range.")
    }

    val metrics = hashMapOf(
        "clicks" to 0L,
        "scrolls" to 0L,
        "totalImpressionLength" to 0L
    )

    for (event in events) {

        Log.d(TAG, "Event Start: ${event.start}")
        Log.d(TAG, "Event End: ${event.end}")

        val widgetId = event.appWidgetId

        // Tap actions
        val clickedIds = event.clickedIds
        if (clickedIds?.isNotEmpty() == true) {
            metrics["clicks"] = metrics.getValue("clicks") + clickedIds.size
            // Log or analyze which components were clicked.
            for (id in clickedIds) {
                Log.d(TAG, "Widget $widgetId: Tap event on component with ID $id")
            }
        }

        // Scroll events
        val scrolledIds = event.scrolledIds
        if (scrolledIds?.isNotEmpty() == true) {
            metrics["scrolls"] = metrics.getValue("scrolls") + scrolledIds.size
            // Log or analyze which lists were scrolled.
            for (id in scrolledIds) {
                Log.d(TAG, "Widget $widgetId: Scroll event in list with ID/tag $id")
            }
        }

        // Impressions
        metrics["totalImpressionLength"] = metrics.getValue("totalImpressionLength") + event.visibleDuration.toMillis()
        Log.d(
            TAG,
            "Widget $widgetId: Impression event with duration " + event.visibleDuration.toMillis() + "ms"
        )

        // Position
        val position = event.position
        if (position != null) {
            Log.d(
                TAG,
                "Widget $widgetId: left=${position.left}, right=${position.right}, top=${position.top}, bottom=${position.bottom}"
            )
        }
    }
    Log.d("WidgetMetrics", "Metrics: $metrics")
}

Para preservar a integridade do sistema, os eventos são informados uma vez por hora por padrão, embora os fabricantes de dispositivos possam mudar a janela de relatório. Por exemplo, em dispositivos Pixel, se um usuário rolar a mesma lista no widget 10 vezes em uma hora, apenas um evento de rolagem será contado para essa hora.

Para fins de teste, defina o atributo a seguir para um horário especificado e reinicie o dispositivo de teste. No exemplo a seguir, a janela de relatório é definida como 0 ms e os eventos são informados imediatamente.

adb shell device_config override systemui widget_events_report_interval_ms 0

Para definir uma tag personalizada para relatar cliques e rolagens, use RemoteViews.setAppWidgetEventTag em uma visualização no seu layout RemoteViews. Essa tag de número inteiro é usada quando você consulta AppWidgetEvents que incluem cliques ou rolagens nessa visualização.