Android

La bibliothèque Kotlin de Topsort permet à nos clients d’envoyer facilement des requêtes d’enchères et de suivre les événements au sein des applications Android.

Configuration minimale requise : Java 11, Kotlin 2.1, minSdk 24 et compileSdk 36.

Installation

Ajoutez la dépendance à votre fichier build.gradle :

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

Configuration

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 convertit un identifiant nul ou vide en UserIdentity.Unidentified. Dans ce cas, le SDK génère un identifiant et le conserve d’un lancement à l’autre. Transmettez votre propre identifiant chaque fois que vous en avez un, que l’utilisateur soit connecté ou non.

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

Signalement des événements

Renders

Un render enregistre qu’une publicité sponsorisée a été insérée dans la page, indépendamment de l’impression, qui enregistre le moment où la publicité devient visible. Les renders concernent uniquement les publicités sponsorisées, il n’existe donc pas de variante organique.

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)
)

Pour signaler plusieurs renders dans un seul événement, construisez-les avec Render.Factory et transmettez-les à Analytics.reportRenders(list). Render.Factory.build n’a pas de valeurs par défaut pour resolvedBidId, placement, occurredAt (un horodatage RFC 3339), opaqueUserId et id : transmettez-les donc pour chaque render, avec un id unique.

Impressions

Une impression enregistre qu’une publicité ou un produit est devenu visible pour l’acheteur.

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

Pour les résultats organiques, utilisez Analytics.reportImpressionOrganic avec entity = Entity(id = "<product id>", type = EntityType.PRODUCT) au lieu de resolvedBidId. Importez Entity et EntityType depuis com.topsort.analytics.model : le callback de clic sur bannière utilise un autre EntityType.

Clics

Un clic enregistre que l’acheteur a cliqué sur une publicité ou un produit.

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

Pour les résultats organiques, utilisez Analytics.reportClickOrganic avec une entity, comme pour les impressions.

Achats

Un achat enregistre les produits achetés par l’acheteur. Topsort l’attribue aux publicités avec lesquelles l’acheteur a interagi.

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),
)

Bannières publicitaires

Ajoutez BannerView à votre XML d’activité :

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

Configuration dans votre activité :

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

BannerView signale le render dès que le gagnant est affiché, l’impression une fois la bannière à l’écran et le clic lorsque l’utilisateur appuie dessus. Ne signalez pas vous-même ces événements pour les bannières qu’il affiche. Pour la documentation complète, consultez le dépôt GitHub.

Aperçu

Plateforme Publicitaire

Serveur Publicitaire

Toppie

Intégrations Avancées

API

Installation

Configuration

Kotlin

Java

Signalement des événements

Renders

Impressions

Clics

Achats

Bannières publicitaires

​Installation

​Configuration

​Kotlin

​Java

​Signalement des événements

​Renders

​Impressions

​Clics

​Achats

​Bannières publicitaires

Installation

Configuration

Kotlin

Java

Signalement des événements

Renders

Impressions

Clics

Achats

Bannières publicitaires