Get attribution information

When a user interacts with an Adjust link, their attribution information may update. This can happen, for example, if they click on a deep link.

Attribution table values

The attribution table contains details about the current attribution status of the device. Any values that aren’t populated for the user are returned as nil.

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`	`number`	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.
`jsonResponse`	`string`	The attribution response that the backend sends to the SDK.

Trigger a function when attribution changes

The SDK can listen for attribution changes and call a function whenever it detects an update. To configure your callback function, use the setAttributionCallback method.

1
local adjust = require "plugin.adjust"
2
local json = require "json"
3

4
-- attribution callback needs to be set before calling initSdk method
5
adjust.setAttributionCallback(function(event)
6
    local json_attribution = json.decode(event.message)
7
    print("Attribution changed!")
8
    print("Tracker token: " .. (json_attribution.trackerToken or "N/A"))
9
    print("Tracker name: " .. (json_attribution.trackerName or "N/A"))
10
    print("Campaign: " .. (json_attribution.campaign or "N/A"))
11
    print("Network: " .. (json_attribution.network or "N/A"))
12
    print("Creative: " .. (json_attribution.creative or "N/A"))
13
    print("Adgroup: " .. (json_attribution.adgroup or "N/A"))
14
    print("Cost type: " .. (json_attribution.costType or "N/A"))
15
    print("Cost amount: " .. (json_attribution.costAmount or "N/A"))
16
    print("Cost currency: " .. (json_attribution.costCurrency or "N/A"))
17
    print("FB install referrer: " .. (json_attribution.fbInstallReferrer or "N/A"))
18
    print("JSON response: " .. (json_attribution.jsonResponse or "N/A"))
19
end)
20

21
-- ...
22

23
adjust.initSdk({
24
    appToken = "YourAppToken",
25
    environment = "SANDBOX",
26
    logLevel = "VERBOSE"
27
})

Get current attribution information

When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to these attribution details for the current install. To retrieve this information, call the getAttribution method:

1
local adjust = require "plugin.adjust"
2
local json = require "json"
3

4
adjust.getAttribution(function(event)
5
    local json_attribution = json.decode(event.message)
6
    print("Tracker token: " .. (json_attribution.trackerToken or "N/A"))
7
    print("Tracker name: " .. (json_attribution.trackerName or "N/A"))
8
    print("Campaign: " .. (json_attribution.campaign or "N/A"))
9
    print("Network: " .. (json_attribution.network or "N/A"))
10
    print("Creative: " .. (json_attribution.creative or "N/A"))
11
    print("Adgroup: " .. (json_attribution.adgroup or "N/A"))
12
    print("Cost type: " .. (json_attribution.costType or "N/A"))
13
    print("Cost amount: " .. (json_attribution.costAmount or "N/A"))
14
    print("Cost currency: " .. (json_attribution.costCurrency or "N/A"))
15
    print("FB install referrer: " .. (json_attribution.fbInstallReferrer or "N/A"))
16
    print("JSON response: " .. (json_attribution.jsonResponse or "N/A"))
17
end)