Send callback information

Set up callbacks to run your own code when the Adtrace SDK sends information to Adtrace. You can set up callbacks for sessions and events.

Register these listeners on your AdTraceConfig instance before you call AdTrace.onCreate(). See Configuration for how to create the config.

For attribution listeners, see Get attribution information. For deferred deep link callbacks, see Deferred deep linking. For callback URL key-value data sent with every session and event, see Set session callback parameters.

Important

You must register your callbacks before initializing the SDK.

A successful callback means the SDK sent the package. It does not always mean the data appears in panel statistics. Events only show in the panel after the install was successfully tracked for that device.

Session callbacks

Set up session callbacks when the SDK sends session information.

• Success callbacks run when the SDK sends the session successfully.
• Failure callbacks run when sending fails.

Response data

Property	Type	Description
message	String	Message from the server, or an error logged by the SDK.
timestamp	String	Timestamp from Adtrace servers.
adid	String	Unique Adtrace device identifier.
jsonResponse	JSONObject	JSON object with the server response.
willRetry	boolean	On failure only. true if the SDK will try to resend the package later.

Success callbacks

Method signature

public void setOnSessionTrackingSucceededListener(OnSessionTrackingSucceededListener listener)

This example logs the timestamp when the SDK recorded the session.

Java

import android.util.Log;
import io.adtrace.sdk.AdTrace;
import io.adtrace.sdk.AdTraceConfig;
import io.adtrace.sdk.AdTraceSessionSuccess;
import io.adtrace.sdk.OnSessionTrackingSucceededListener;

AdTraceConfig config = new AdTraceConfig(this, appToken, environment);
config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() {
    @Override
    public void onFinishedSessionTrackingSucceeded(AdTraceSessionSuccess sessionSuccessResponseData) {
        Log.v("AdTrace", "Session recorded at " + sessionSuccessResponseData.timestamp);
    }
});
AdTrace.onCreate(config);

Kotlin

import android.util.Log
import io.adtrace.sdk.AdTrace
import io.adtrace.sdk.AdTraceConfig
import io.adtrace.sdk.OnSessionTrackingSucceededListener

val config = AdTraceConfig(this, appToken, environment)
config.setOnSessionTrackingSucceededListener(OnSessionTrackingSucceededListener { sessionSuccessResponseData ->
    Log.v("AdTrace", "Session recorded at ${sessionSuccessResponseData.timestamp}")
})
AdTrace.onCreate(config)

Javascript

function sessionSuccess(sessionSuccessResponseData) {
    console.log("Session recorded at " + sessionSuccessResponseData.timestamp);
}

let config = new AdTraceConfig(appToken, environment);
config.setSessionSuccessCallback(sessionSuccess);
AdTrace.onCreate(config);

Failure callbacks

Method signature

public void setOnSessionTrackingFailedListener(OnSessionTrackingFailedListener listener)

This example logs the session failure message.

Java

import android.util.Log;
import io.adtrace.sdk.AdTrace;
import io.adtrace.sdk.AdTraceConfig;
import io.adtrace.sdk.AdTraceSessionFailure;
import io.adtrace.sdk.OnSessionTrackingFailedListener;

AdTraceConfig config = new AdTraceConfig(this, appToken, environment);
config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() {
    @Override
    public void onFinishedSessionTrackingFailed(AdTraceSessionFailure sessionFailureResponseData) {
        Log.v("AdTrace", "Session recording failed. Response: " + sessionFailureResponseData.message);
    }
});
AdTrace.onCreate(config);

Kotlin

import android.util.Log
import io.adtrace.sdk.AdTrace
import io.adtrace.sdk.AdTraceConfig
import io.adtrace.sdk.OnSessionTrackingFailedListener

val config = AdTraceConfig(this, appToken, environment)
config.setOnSessionTrackingFailedListener(OnSessionTrackingFailedListener { sessionFailureResponseData ->
    Log.v("AdTrace", "Session recording failed. Response: ${sessionFailureResponseData.message}")
})
AdTrace.onCreate(config)

Javascript

function sessionFailure(sessionFailureResponseData) {
    console.log("Session recording failed. Response: " + sessionFailureResponseData.message);
}

let config = new AdTraceConfig(appToken, environment);
config.setSessionFailureCallback(sessionFailure);
AdTrace.onCreate(config);

Event callbacks

Set up event callbacks when the SDK sends event information.

• Success callbacks run when the SDK sends event information to Adtrace servers.
• Failure callbacks run when the SDK encounters a problem while sending the information.

Response data

Property	Type	Description
message	String	Message from the server, or an error logged by the SDK.
timestamp	String	Timestamp from Adtrace servers.
adid	String	Unique Adtrace device identifier.
eventToken	String	The event token.
callbackId	String	Custom callback ID set on the event with setCallbackId, if any.
jsonResponse	JSONObject	JSON object with the server response.
willRetry	boolean	On failure only. true if the SDK will try to resend the package later.

Success callbacks

Method signature

public void setOnEventTrackingSucceededListener(OnEventTrackingSucceededListener listener)

This example logs the timestamp when the SDK recorded the event.

Java

import android.util.Log;
import io.adtrace.sdk.AdTrace;
import io.adtrace.sdk.AdTraceConfig;
import io.adtrace.sdk.AdTraceEventSuccess;
import io.adtrace.sdk.OnEventTrackingSucceededListener;

AdTraceConfig config = new AdTraceConfig(this, appToken, environment);
config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() {
    @Override
    public void onFinishedEventTrackingSucceeded(AdTraceEventSuccess eventSuccessResponseData) {
        Log.v("AdTrace", "Event recorded at " + eventSuccessResponseData.timestamp);
    }
});
AdTrace.onCreate(config);

Kotlin

import android.util.Log
import io.adtrace.sdk.AdTrace
import io.adtrace.sdk.AdTraceConfig
import io.adtrace.sdk.OnEventTrackingSucceededListener

val config = AdTraceConfig(this, appToken, environment)
config.setOnEventTrackingSucceededListener(OnEventTrackingSucceededListener { eventSuccessResponseData ->
    Log.v("AdTrace", "Event recorded at ${eventSuccessResponseData.timestamp}")
})
AdTrace.onCreate(config)

Javascript

function eventSuccess(eventSuccessResponseData) {
    console.log("Event recorded at " + eventSuccessResponseData.timestamp);
}

let config = new AdTraceConfig(appToken, environment);
config.setEventSuccessCallback(eventSuccess);
AdTrace.onCreate(config);

Failure callbacks

Method signature

public void setOnEventTrackingFailedListener(OnEventTrackingFailedListener listener)

This example logs the event failure message.

Java

import android.util.Log;
import io.adtrace.sdk.AdTrace;
import io.adtrace.sdk.AdTraceConfig;
import io.adtrace.sdk.AdTraceEventFailure;
import io.adtrace.sdk.OnEventTrackingFailedListener;

AdTraceConfig config = new AdTraceConfig(this, appToken, environment);
config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() {
    @Override
    public void onFinishedEventTrackingFailed(AdTraceEventFailure eventFailureResponseData) {
        Log.v("AdTrace", "Event recording failed. Response: " + eventFailureResponseData.message);
    }
});
AdTrace.onCreate(config);

Kotlin

import android.util.Log
import io.adtrace.sdk.AdTrace
import io.adtrace.sdk.AdTraceConfig
import io.adtrace.sdk.OnEventTrackingFailedListener

val config = AdTraceConfig(this, appToken, environment)
config.setOnEventTrackingFailedListener(OnEventTrackingFailedListener { eventFailureResponseData ->
    Log.v("AdTrace", "Event recording failed. Response: ${eventFailureResponseData.message}")
})
AdTrace.onCreate(config)

Javascript

function eventFailure(eventFailureResponseData) {
    console.log("Event recording failed. Response: " + eventFailureResponseData.message);
}

let config = new AdTraceConfig(appToken, environment);
config.setEventFailureCallback(eventFailure);
AdTrace.onCreate(config);