Android

A biblioteca Kotlin do Topsort permite que nossos clientes enviem facilmente solicitações de leilão e rastreiem eventos dentro de aplicações Android.

Requisitos mínimos: Java 11, Kotlin 2.1, minSdk 24 e compileSdk 36.

Instalação

Adicione a dependência ao seu arquivo build.gradle:

dependencies {
    implementation 'com.topsort:topsort-kt:4.1.0'
}

Configuração

Kotlin

import android.app.Application
import com.topsort.analytics.Analytics
import com.topsort.analytics.UserIdentity

class KotlinApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        Analytics.setup(
            application = this,
            identity = UserIdentity.of("<YOUR_OPAQUE_USER_ID>"),
            token = "<API token>"
        )
    }
}

UserIdentity.of converte um id nulo ou vazio em UserIdentity.Unidentified; nesse caso, o SDK gera um id e o mantém entre as execuções do aplicativo. Passe seu próprio id sempre que tiver um, com ou sem login.

Java

import android.app.Application;
import com.topsort.analytics.Analytics;
import com.topsort.analytics.UserIdentity;

public class JavaApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Analytics.INSTANCE.setup(this, UserIdentity.of("<opaqueUserId>"), "<API token>");
    }
}

Reportando Eventos

Renders

Um render registra que um anúncio patrocinado foi inserido na página, separadamente da impressão, que registra quando o anúncio se torna visível. Os renders são exclusivos de anúncios patrocinados, portanto não existe uma variante orgânica.

import com.topsort.analytics.Analytics
import com.topsort.analytics.model.Placement

Analytics.reportRender(
    resolvedBidId = "<The bid id from the auction winner>",
    placement = Placement(path = "search_results", position = 1)
)

Para reportar vários renders em um único evento, crie-os com Render.Factory e passe-os para Analytics.reportRenders(list). Render.Factory.build não tem valores padrão para resolvedBidId, placement, occurredAt (um timestamp RFC 3339), opaqueUserId e id, portanto passe-os para cada render, com um id único.

Impressões

Uma impressão registra que um anúncio ou produto ficou visível para o comprador.

Analytics.reportImpressionPromoted(
    resolvedBidId = "<The bid id from the auction winner>",
    placement = Placement(path = "search_results", position = 1)
)

Para resultados orgânicos, use Analytics.reportImpressionOrganic com entity = Entity(id = "<product id>", type = EntityType.PRODUCT) em vez de resolvedBidId. Importe Entity e EntityType de com.topsort.analytics.model: o callback de clique do banner usa um EntityType diferente.

Cliques

Um clique registra que o comprador clicou em um anúncio ou produto.

Analytics.reportClickPromoted(
    resolvedBidId = "<The bid id from the auction winner>",
    placement = Placement(path = "search_results", position = 1)
)

Para resultados orgânicos, use Analytics.reportClickOrganic com uma entity, assim como nas impressões.

Compras

Uma compra registra os produtos que o comprador adquiriu. O Topsort a atribui aos anúncios com os quais o comprador interagiu.

import com.topsort.analytics.model.PurchasedItem

val item = PurchasedItem(
    productId = "<Marketplace id for the item>",
    unitPrice = 1295,
    quantity = 20
)
Analytics.reportPurchase(
    id = "<Marketplace id for the entire purchase>",
    items = listOf(item),
)

Banners

Adicione BannerView ao XML da sua atividade:

<com.topsort.analytics.banners.BannerView
    android:id="@+id/bannerView"
    android:layout_width="353dp"
    android:layout_height="103dp" />

Configure na sua atividade:

class SampleActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.sample_activity)

        this.lifecycleScope.launch {
            val bannerView = findViewById<BannerView>(R.id.bannerView)
            val bannerConfig = BannerConfig.CategorySingle(slotId = "slot", category = "category")

            bannerView.setup(
                config = bannerConfig,
                path = "sample_activity",
                location = "hero-banner"
            ) { id, entityType -> onBannerClick(id, entityType) }
        }
    }
}

O BannerView reporta o render assim que o vencedor é exibido, a impressão quando o banner aparece na tela e o clique quando ele é tocado. Não reporte esses eventos por conta própria para os banners que ele exibe. Para documentação completa, consulte o repositório GitHub.

Visão Geral

Plataforma de Anúncios

Servidor de Anúncios

Toppie

Integrações Avançadas

API

Instalação

Configuração

Kotlin

Java

Reportando Eventos

Renders

Impressões

Cliques

Compras

Banners