Send event information

The Adjust SDK provides an ADJEvent object which can be used to structure and send event information from your app to Adjust’s servers.

Instantiate an ADJEvent object

- (nullable id)initWithEventToken:(nonnull NSString *)eventToken;

To send event information with the Adjust SDK, you need to instantiate an ADJEvent 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 ADJEvent instance and pass the following parameters:

• eventToken (NSString): Your Adjust event token.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"abc123"];
2
[Adjust trackEvent:event];

Send an event

+ (void)trackEvent:(nullable ADJEvent *)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.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"abc123"];
2
[Adjust trackEvent:event];

Example

This example shows how to record an event with the token g3mfiw whenever a user interacts with a button.

1
import AdjustSdk
2
import UIKit
3

4
class ViewControllerSwift: UIViewController {
5
   @IBOutlet weak var btnRecordEventSimple: UIButton?
6

7
   @IBAction func btnRecordEventSimple(_sender: UIButton) {
8
      guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
9
      Adjust.trackEvent(event);
10
   }
11
}

1
#import "Adjust.h"
2
#import "Constants.h"
3
#import "ViewControllerObjC.h"
4

5
@interface ViewControllerObjC ()
6

7
@property (weak, nonatomic) IBOutlet UIButton *btnRecordDeduplicatedEvent;
8

9
@end
10

11
@implementation ViewControllerObjC
12

13
- (IBAction)clickRecordSimpleEvent:(UIButton *)sender {
14
    ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"g3mfiw"];
15
    [Adjust trackEvent:event];
16
}
17

18
@end

Path:      /event
ClientSdk: ios5.4.0
Parameters:
  app_token        2fm9gkqubvpc
  app_version      1.0
35 collapsed lines
  attribution_deeplink 1
  callback_params  {"key":"value","foo":"bar"}
  connectivity_type 1
  country          US
  cpu_type         arm64-v8a
  created_at       2024-01-25T14:13:16.151Z+0100
  currency         EUR
  device_manufacturer Apple
  device_type      phone
  display_height   2205
  display_width    1080
  environment      sandbox
  event_buffering_enabled 0
  event_count      3
  event_token      g3mfiw
  hardware_name    UE1A.230829.036
  language         en
  mcc              310
  mnc              260
  needs_response_details 1
  os_build         UE1A.230829.036
  os_name          ios
  os_version       14
  package_name     com.adjust.examples
  partner_params   {"key":"value","foo":"bar"}
  revenue          0.25
  screen_density   high
  screen_format    long
  screen_size      normal
  session_count    2
  session_length   23
  subsession_count 1
  time_spent       23
  tracking_enabled 1
  ui_mode          1

Record event revenue

- (void)setRevenue:(double)amount currency:(nonnull NSString *)currency;

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:

• revenue (double): The amount of revenue generated by the event
• currency (NSString): The ISO 4217 code of the event currency.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
event.setRevenue(0.01, currency: "EUR")
3
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"abc123"];
2
[event setRevenue:0.01 currency:@"EUR"];
3
[Adjust trackEvent:event];

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.

1
import AdjustSdk
2
import UIKit
3

4
class ViewControllerSwift: UIViewController {
5
   @IBOutlet weak var btnRecordEventRevenue: UIButton?
6

7
   @IBAction func btnRecordEventRevenue(_sender: UIButton) {
8
      guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
9
      event.setRevenue(0.25, currency: "EUR");
10
      Adjust.trackEvent(event);
11
   }
12
}

1
#import "Adjust.h"
2
#import "Constants.h"
3
#import "ViewControllerObjC.h"
4

5
@interface ViewControllerObjC ()
6

7
@property (weak, nonatomic) IBOutlet UIButton *btnRecordRevenueEvent;
8

9
@end
10

11
@implementation ViewControllerObjC
12

13
- (IBAction)clickRecordRevenueEvent:(UIButton *)sender {
14
   ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"g3mfiw"];
15
   [event setRevenue:0.25 currency:@"EUR"];
16
   [Adjust trackEvent:event];
17
}
18

19
@end

Path:      /event
ClientSdk: ios5.4.0
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  currency         EUR
  revenue          0.25

Deduplicate revenue events

- (void)setDeduplicationId:(nonnull NSString *)deduplicationId;

You can pass an optional deduplication identifier to avoid recording duplicate events. To set the identifier, assign your transaction ID to the setDeduplicationId property of your event instance. If the same event is sent multiple times, Adjust disregards the duplicated event information.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
event.setDeduplicationId("deduplication_id")
3
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:kEventToken3];
2
[event setDeduplicationId:@"deduplication_id"];
3
[Adjust trackEvent:event];

Set deduplication ID limit

You can set a custom limit on the number of deduplicationId that can be added to the list for identifying duplicate events. By default, the limit is set to 10.

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox
3
let adjustConfig = ADJConfig(
4
    appToken: yourAppToken,
5
    environment: environment)
6

7
adjustConfig.setEventDeduplicationIdsMaxSize(20)
8
Adjust.initSdk(adjustConfig)

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:@"{YourAppToken}"
4
                                            environment:ADJEnvironmentSandbox];
5

6
[adjustConfig setEventDeduplicationIdsMaxSize:20];
7
[Adjust initSdk:adjustConfig];

Example

This example shows how to record an event with the token g3mfiw whenever a user interacts with a button. The function sets the uniqueId to 5e85484b-1ebc-4141-aab7-25b869e54c49 using the setTransactionId method.

1
import Adjust
2
import UIKit
3

4
class ViewControllerSwift: UIViewController {
5
   @IBOutlet weak var btnRecordEventSimple: UIButton?
6

7
   @IBAction func btnRecordEventSimple(_sender: UIButton) {
8
      guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
9
      event.setDeduplicationId("5e85484b-1ebc-4141-aab7-25b869e54c49")
10
      Adjust.trackEvent(event);
11
   }
12
}

1
#import "Adjust.h"
2
#import "Constants.h"
3
#import "ViewControllerObjC.h"
4

5
@interface ViewControllerObjC ()
6

7
@property (weak, nonatomic) IBOutlet UIButton *btnRecordDeduplicatedEvent;
8

9
@end
10

11
@implementation ViewControllerObjC
12

13
- (IBAction)clickRecordSimpleEvent:(UIButton *)sender {
14
    ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"g3mfiw"];
15
    [event setDeduplicationId: @"5e85484b-1ebc-4141-aab7-25b869e54c49"]
16
    [Adjust trackEvent:event];
17
}
18

19
@end

Path:      /event
ClientSdk: ios5.4.0
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  deduplication_id   5e85484b-1ebc-4141-aab7-25b869e54c49

Add callback parameters

- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

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 NSString key-value arguments. You can add multiple parameters by calling this method multiple times.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
event.addCallbackParameter("key", value: "value")
3
event.addCallbackParameter("foo", value: "bar")
4
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"abc123"];
2
[event addCallbackParameter:@"key" value:@"value"];
3
[event addCallbackParameter:@"foo" value:@"bar"];
4
[Adjust trackEvent:event];

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:

1
https://www.mydomain.com/callback?key=value&foo=bar

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:

1
http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05

1
import Adjust
2
import UIKit
3

4
class ViewControllerSwift: UIViewController {
5
   @IBOutlet weak var btnRecordEventCallbacks: UIButton?
6

7
   @IBAction func btnRecordEventCallbacks(_sender: UIButton) {
8
      guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
9
      event.addCallbackParameter("event_token", value: "g3mfiw")
10
      event.addCallbackParameter("revenue_amount", value: "0.05")
11
      Adjust.trackEvent(event);
12
   }
13
}

#import "Adjust.h"
#import "Constants.h"
#import "ViewControllerObjC.h"

@interface ViewControllerObjC ()

@property (weak, nonatomic) IBOutlet UIButton *btnRecordCallbackEvent;

@end

@implementation ViewControllerObjC

- (IBAction)clickRecordCallbackEvent:(UIButton *)sender {
   ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"g3mfiw"];
   [event addCallbackParameter:@"event_token" value:@"g3mfiw"];
   [event addCallbackParameter:@"revenue_amount" value:@"0.05"];
   [Adjust trackEvent:event];
}

@end

Path:      /event
ClientSdk: ios5.4.0
Parameters:
  callback_params  {"event_token":"g3mfiw","revenue_amount":"0.05"}
  environment      sandbox
  event_count      1
  event_token      g3mfiw

Add partner parameters

- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

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 NSString key-value arguments. You can add multiple parameters by calling this method multiple times.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
event.addPartnerParameter("key", value: "value")
3
event.addPartnerParameter("foo", value: "bar")
4
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"abc123"];
2
[event addPartnerParameter:@"key" value:@"value"];
3
[event addPartnerParameter:@"foo" value:@"bar"];
4
[Adjust trackEvent:event];

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

1
import Adjust
2
import UIKit
3

4
class ViewControllerSwift: UIViewController {
5
   @IBOutlet weak var btnRecordEventPartnerParams: UIButton?
6

7
   @IBAction func btnRecordEventPartnerParams(_sender: UIButton) {
8
      guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
9
      event.addPartnerParameter("product_id", value: "29")
10
      event.addPartnerParameter("user_id", value: "835")
11
      Adjust.trackEvent(event);
12
   }
13
}

1
#import "Adjust.h"
2
#import "Constants.h"
3
#import "ViewControllerObjC.h"
4

5
@interface ViewControllerObjC ()
6

7
@property (weak, nonatomic) IBOutlet UIButton *btnRecordPartnerParamsEvent;
8

9
@end
10

11
@implementation ViewControllerObjC
12

13
- (IBAction)clickRecordPartnerParamsEvent:(UIButton *)sender {
14
   ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"g3mfiw"];
15
   [event addPartnerParameter:@"product_id" value:@"29"];
16
   [event addPartnerParameter:@"user_id" value:@"835"];
17
   [Adjust trackEvent:event];
18
}
19

20
@end

Path:      /event
ClientSdk: ios5.4.0
Parameters:
  partner_params  {"product_id":"29","user_id":"835"}
  environment      sandbox
  event_count      1
  event_token      g3mfiw

Add a callback identifier

- (void)setCallbackId:(nonnull NSString *)callbackId;

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 an NSString argument.

1
guard let event = ADJEvent(eventToken: "abc123") else { return }
2
event.setCallbackId("Your-Custom-ID")
3
Adjust.trackEvent(event)

1
ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"abc123"];
2
[event setCallbackId:@"Your-Custom-ID"];
3
[Adjust trackEvent:event];

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.

1
import Adjust
2
import UIKit
3

4
class ViewControllerSwift: UIViewController {
5
   @IBOutlet weak var btnRecordEventCallbackId: UIButton?
6

7
   @IBAction func btnRecordEventCallbackId(_sender: UIButton) {
8
      guard let event = ADJEvent(eventToken: "g3mfiw") else { return }
9
      event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147")
10
      Adjust.trackEvent(event);
11
   }
12
}

1
#import "Adjust.h"
2
#import "Constants.h"
3
#import "ViewControllerObjC.h"
4

5
@interface ViewControllerObjC ()
6

7
@property (weak, nonatomic) IBOutlet UIButton *btnRecordCallbackIdEvent;
8

9
@end
10

11
@implementation ViewControllerObjC
12

13
- (IBAction)clickRecordCallbackIdEvent:(UIButton *)sender {
14
   ADJEvent *event = [[ADJEvent alloc] initWithEventToken:@"g3mfiw"];
15
   [event setCallbackId:@"f2e728d8-271b-49ab-80ea-27830a215147"];
16
   [Adjust trackEvent:event];
17
}
18

19
@end

Path:      /event
ClientSdk: ios5.4.0
Parameters:
  callback_id      f2e728d8-271b-49ab-80ea-27830a215147
  environment      sandbox
  event_count      1
  event_token      g3mfiw