The Adjust SDK provides an AdjustEvent2dx
object which can be used to structure and send event information from your app to Adjust’s servers.
Instantiate an AdjustEvent2dx object
To send event information with the Adjust SDK, you need to instantiate an AdjustEvent2dx
object. This object contains variables that are sent to Adjust when an event occurs in your app.
To instantiate an event object, create a new AdjustEvent2dx
instance and pass the following parameters:
eventToken
(String): Your Adjust event token.
Send an event
You can associate your Adjust event tokens to actions in your app to record them. To record an event:
- Create a new Adjust event instance and pass your event token as a string argument.
- Call the
trackEvent
method with your event instance as an argument.
Example
This example shows how to record an event with the token g3mfiw
whenever a user interacts with a button.
Record event revenue
You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app.
To set these properties, call the setRevenue
method and pass the following arguments:
amount
(double): The amount of revenue generated by the eventcurrency
(string): The ISO 4217 code of the event currency.
Example
This example shows how to record an event with the token g3mfiw
whenever a user interacts with a button. The function sets the revenue
property of this event to 0.25
and the currency
property to EUR
.
Purchase verification
If you’ve enabled purchase verification, you must send additional information with your purchase events to verify them. When Adjust’s servers receive this information in an event object, they forward it to Apple to verify the purchase.
transactionId
(String): ThetransactionIdentifier
value of the successfully completed purchaseproductId
(String): The product identifier of the item that was successfully purchasedreceipt
(String): The signed receipt containing the information about the successfully completed purchase (not base64 encoded)
productId
(String): The product identifier (SKU
) of the item that was successfully purchasedpurchaseToken
(String): Thepurchase token
of the successfully completed purchase
Set a unique order ID
You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs.
To set the identifier, call the setTransactionId
method and pass your transaction ID as a string argument.
Example
This example shows how to record an event with the token g3mfiw
whenever a user interacts with a button. The function sets the orderId
to 5e85484b-1ebc-4141-aab7-25b869e54c49
using the setOrderId
method.
Add callback parameters
If you register a callback URL in the Adjust dashboard, the SDK sends a GET request to your callback URL when it records an event.
You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your callback URL. You can use this information to analyze your users’ in-app behavior with your BI system.
Add callback parameters to your event by calling the addCallbackParameter
method with string key-value arguments. You can add multiple parameters by calling this method multiple times.
The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL https://www.mydomain.com/callback
, your callback looks like this:
If you’re using CSV uploads, make sure to add the parameters to your CSV definition.
Adjust supports many placeholders which you can use to pass information from the SDK to your URL. For example, the {idfa}
placeholder for iOS and the {gps_adid}
placeholder for Android. The {publisher_parameter}
placeholder presents all callback parameters in a single string.
Example
This example shows how to record an event with the token g3mfiw
whenever a user interacts with a button. The following callback parameters are added:
- The
event_token
- The
revenue_amount
generated by the event
The resulting callback URL looks like this:
You can check the parameters were sent to Adjust by checking for callback_params
in your logs.
Add partner parameters
You can send extra information to your network partners by adding partner parameters.
Adjust sends partner parameters to external partners you have set up. This information is useful for more granular analysis and retargeting purposes. Adjust’s servers forward these parameters once you have set them up and enabled them for a partner.
Add partner parameters to your event by calling the addPartnerParameter
method with string key-value arguments. You can add multiple parameters by calling this method multiple times.
Example
This example shows how to record an event with the token g3mfiw
whenever a user interacts with a button. The following partner parameters are added:
- The
product_id
of the associated product - The
user_id
of the user who triggered the event
You can check the parameters were sent to Adjust by checking for partner_params
in your logs.
Add a callback identifier
You can add a custom string identifier to each event you want to measure. Adjust’s servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured.
Set up this identifier by calling the setCallbackId
method with your ID as a string argument.
Example
This example shows how to record an event with the token g3mfiw
whenever a user interacts with a button. In this example, the callbackId
is set to f2e728d8-271b-49ab-80ea-27830a215147
.