Android

Übersicht über die Kotlin-Bibliothek von Topsort für Auktionsanfragen und Ereignisverfolgung in Android-Apps

Die Kotlin-Bibliothek von Topsort ermöglicht es unseren Kunden, Auktionsanfragen einfach zu senden und Ereignisse innerhalb von Android-Apps zu verfolgen.

Mindestanforderungen: Java 11, Kotlin 2.1, minSdk 24 und compileSdk 36.

Installation

Fügen Sie die Abhängigkeit zu Ihrer build.gradle-Datei hinzu:

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

Konfiguration

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 wandelt eine null- oder leere ID in UserIdentity.Unidentified um. In diesem Fall erzeugt das SDK eine ID und behält sie über App-Starts hinweg bei. Übergeben Sie Ihre eigene ID, wann immer Sie eine haben, ob angemeldet oder nicht.

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

Ereignismeldung

Renders

Ein Render erfasst, dass eine gesponserte Anzeige in die Seite eingefügt wurde, getrennt von der Impression, die erfasst, wann die Anzeige sichtbar wird. Renders gibt es nur für gesponserte Anzeigen, daher gibt es keine organische Variante.

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

Um mehrere Renders in einem Ereignis zu melden, erstellen Sie sie mit Render.Factory und übergeben Sie sie an Analytics.reportRenders(list). Render.Factory.build hat keine Standardwerte für resolvedBidId, placement, occurredAt (ein RFC-3339-Zeitstempel), opaqueUserId und id. Übergeben Sie diese daher für jeden Render, mit einer eindeutigen id.

Impressionen

Eine Impression erfasst, dass eine Anzeige oder ein Produkt für den Käufer sichtbar wurde.

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

Für organische Ergebnisse verwenden Sie Analytics.reportImpressionOrganic mit entity = Entity(id = "<product id>", type = EntityType.PRODUCT) anstelle von resolvedBidId. Importieren Sie Entity und EntityType aus com.topsort.analytics.model: Der Klick-Callback für Banner verwendet einen anderen EntityType.

Klicks

Ein Klick erfasst, dass der Käufer auf eine Anzeige oder ein Produkt geklickt hat.

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

Für organische Ergebnisse verwenden Sie Analytics.reportClickOrganic mit einer entity, wie bei Impressionen.

Käufe

Ein Kauf erfasst die Produkte, die der Käufer gekauft hat. Topsort ordnet ihn den Anzeigen zu, mit denen der Käufer interagiert hat.

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

Werbebanner

Fügen Sie BannerView zu Ihrem Aktivitäts-XML hinzu:

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

Konfiguration in Ihrer Aktivität:

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 meldet den Render, sobald der Gewinner angezeigt wird, die Impression, sobald das Banner auf dem Bildschirm ist, und den Klick, wenn darauf getippt wird. Melden Sie diese Ereignisse für die von ihm angezeigten Banner nicht selbst.

Für die vollständige Dokumentation besuchen Sie das GitHub-Repository.