Как отслеживать показатели для виджета

В Android 16 добавлены более подробные API для сбора показателей. Эти показатели отслеживают такие действия, как нажатия кнопок, прокрутка, показы, а также размер и положение виджета.

Основной API – AppWidgetEvent. Используйте WorkManager, чтобы создать периодический воркер, который будет отслеживать вовлеченность виджета ежедневно, еженедельно или при каждом открытии приложения.

Ниже приведен пример фрагмента кода, который позволяет отслеживать клики, прокрутки и продолжительность показа.

@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")
}

Чтобы не перегружать систему, по умолчанию события регистрируются раз в час, но производители устройств могут изменить этот интервал. Например, если пользователь на устройстве Pixel 10 раз прокрутит один и тот же список в вашем виджете в течение часа, будет зарегистрировано только одно событие прокрутки.

Для тестирования можно задать для следующего атрибута определенное время и перезапустить тестовое устройство. В приведенном ниже примере окно отчета установлено на 0 мс, и события регистрируются немедленно.

adb shell device_config override systemui widget_events_report_interval_ms 0

Чтобы задать пользовательский тег для отслеживания кликов и прокруток, используйте метод RemoteViews.setAppWidgetEventTag для представления в макете RemoteViews. Этот целочисленный тег используется при запросе AppWidgetEvents, которые включают клики или прокрутки в этом представлении.

Назад
Обработка взаимодействия пользователя с Glance
Далее
Как управлять GlanceAppWidget и обновлять его