Get attribution information

When a user interacts with an Adjust link, their attribution information updates. This can happen if the user interacts with a deep link. Information about a user’s attribution is represented in the AdjustAttribution class.

AdjustAttribution class properties

The AdjustAttribution class contains details about the current attribution status of the device. Any values that aren’t populated for the user are returned as a null value.

Values	Data type	Description
`trackerToken`	`String`	The token of the link to which the device is currently attributed
`trackerName`	`String`	The name of the link to which the device is currently attributed
`network`	`String`	The name of the network to which the device is currently attributed
`campaign`	`String`	The name of the campaign to which the device is currently attributed
`adgroup`	`String`	The name of the adgroup to which the device is currently attributed
`creative`	`String`	The name of the creative to which the device is currently attributed
`clickLabel`	`String`	The click label that the install is tagged with
`costType`	`String`	The campaign pricing model (for example cpi)
`costAmount`	`Double`	The cost of the install.
`costCurrency`	`String`	The 3 character ISO 4217 code of the currency associated with the cost.
`fbInstallReferrer`	`String`	The Facebook install referrer.

Trigger a function when attribution changes

public void setOnAttributionChangedListener(OnAttributionChangedListener onAttributionChangedListener)

The SDK can listen for attribution changes and call a function when it detects an update. To configure your callback function, call the setOnAttributionChangedListener method with your function name as an argument.

Kotlin
Java

1
val config = AdjustConfig(this, appToken, environment)
2
//...
3
config.setOnAttributionChangedListener {
4
   override fun onAttributionChanged(attribution: AdjustAttribution) {}
5
   }
6
//...
7
Adjust.initSdk(config)

1
AdjustConfig config = new AdjustConfig(this, appToken, environment);
2
//...
3
config.setOnAttributionChangedListener(new OnAttributionChangedListener() {
4
   @Override
5
   public void onAttributionChanged(AdjustAttribution attribution) {}
6
});
7
//...
8
Adjust.initSdk(config);

Facebook install referrer

The Adjust SDK receives Facebook install referrer information as a String property in the AdjustAttribution object. You can access this information by serializing the content as a JSON object.

Kotlin
Java

1
val config = AdjustConfig(this, appToken, environment)
2
//...
3
config.setOnAttributionChangedListener {
4
   val fbInstallReferrerJSONObject = extractFBInstallReferrerJSON(it)
5
}
6

7
fun extractFBInstallReferrerJSON(adjustAttribution: AdjustAttribution): JSONObject? {
8
   try {
9
      return JSONObject(adjustAttribution.fbInstallReferrer)
10
   } catch (e: JSONException) {
11
      Log.d("example", e.message!!)
12
   }
13
   return null
14
}
15
//...
16
Adjust.initSdk(config)

1
AdjustConfig config = new AdjustConfig(this, appToken, environment);
2
//...
3
config.setOnAttributionChangedListener(new OnAttributionChangedListener() {
4
   @Override
5
   public void onAttributionChanged(AdjustAttribution adjustAttribution) {
6
   JSONObject fbInstallReferrerJSONObject = extractFBInstallReferrerJSON(adjustAttribution);
7
   }
8
});
9

10
@Nullable
11
JSONObject extractFBInstallReferrerJSON(AdjustAttribution adjustAttribution) {
12
   try {
13
      return new JSONObject(adjustAttribution.fbInstallReferrer);
14
   } catch (JSONException e) {
15
      Log.d("example", e.getMessage());
16
   }
17
   return null;
18
}
19
//...
20
Adjust.initSdk(config);

Get current attribution information

public static void getAttribution(final OnAttributionReadListener attributionReadListener)

When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, pass a listener function to the Adjust.getAttribution method. The SDK fetches the information asynchronously and passes it to your listener function as an AdjustAttribution object.

Kotlin
Java

1
Adjust.getAttribution {attribution ->
2
            // read attribution
3
        }

1
Adjust.getAttribution(new OnAttributionReadListener() {
2
    @Override
3
    public void onAttributionRead(AdjustAttribution attribution) {
4
    }
5
});