イベント情報の送信

Adjust SDKはADJEventオブジェクトを提供しており、アプリのイベント情報を構造化してAdjustのサーバーに送信することができます。

ADJEventオブジェクトをインスタンス化する

+ (nullable ADJEvent *)eventWithEventToken:(nonnull NSString *)eventToken;

Adjust SDKでイベント情報を送信するには、ADJEventオブジェクトをインスタンス化する必要があります。このオブジェクトには、アプリでイベントが発生した時にAdjustに送信される変数が含まれます。

イベントオブジェクトをインスタンス化するには、新しいADJEventインスタンスを作成して以下のパラメーターをパスしてください：

eventToken （NSString）：お客様のAdjustイベントトークン。

1
let event = ADJEvent(eventToken: "abc123")
2
Adjust.trackEvent(event)

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

1
var adjustEvent = new AdjustEvent("abc123");
2
Adjust.trackEvent(adjustEvent);

イベントを送信する

+ (void)trackEvent:(nullable ADJEvent *)event;

Adjustイベントトークンを関連付けることで、アプリ内のユーザー行動を記録できます。イベントを記録する方法：

Adjustイベントのインスタンスを新規作成し、イベントトークンを文字列引数としてパスします。
イベントのインスタンスを引数としてtrackEventメソッドを呼び出します。

1
let event = ADJEvent(eventToken: "abc123")
2
Adjust.trackEvent(event)

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

1
var adjustEvent = new AdjustEvent("abc123");
2
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。

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
      let event = ADJEvent(eventToken: "g3mfiw");
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 eventWithEventToken: @"g3mfiw"];
15

16
    [Adjust trackEvent:event];
17
}
18

19
@end

1
<html>
2
   <body>
3
      <script>
4
         setupWebViewJavascriptBridge(function(bridge) {
5
            let adjustConfig = new AdjustConfig('2fm9gkqubvpc', AdjustConfig.EnvironmentSandbox);
6
            adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
            Adjust.appDidLaunch(adjustConfig);
9

10
            var btnRecordDeduplicatedEvent = document.getElementById('btnRecordDeduplicatedEvent')
11
            btnRecordDeduplicatedEvent.onclick = function(e) {
12
                  e.preventDefault()
13
                  var adjustEvent = new AdjustEvent('g3mfiw')
14
                  Adjust.trackEvent(adjustEvent)
15
            }
16
         }
17
      </script>
18
      <div id="buttons">
19
         <div style="width:300px;height:35px;text-align:center;">
20
            <button id="btnRecordDeduplicatedEvent">Record simple event</button>
21
         </div>
22
      </div>
23
   </body>
24
</html>

Path:      /event
ClientSdk: ios4.38.4
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

イベント収益の記録

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

イベントインスタンスにrevenueとcurrencyプロパティを設定することで、イベントに関連する収益を記録できます。この機能を使用して、アプリ内で収益が生成されるアクションを記録しましょう。

これらのプロパティを設定するには、setRevenueメソッドを呼び出し、以下の引数をパスします。

revenue （double）：イベントによって発生した収益額
currency （NSString）：イベント通貨のISO 4217コード

1
let event = ADJEvent(eventToken: "abc123")
2
event?.setRevenue(0.01, currency: "EUR")
3
Adjust.trackEvent(event)

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

1
var adjustEvent = new AdjustEvent(eventToken);
2
adjustEvent.setRevenue(0.01, "EUR");
3
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。この関数はこのイベントのrevenueプロパティを 0.25 、currencyプロパティを EUR に設定します。

1
import Adjust
2
import UIKit
3

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

7
   @IBAction func btnRecordEventRevenue(_sender: UIButton) {
8
      let event = ADJEvent(eventToken: "g3mfiw");
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 eventWithEventToken:@"g3mfiw"];
15
   [event setRevenue:0.25 currency:@"EUR"];
16
   [Adjust trackEvent:event];
17
}
18

19
@end

1
<html>
2
   <body>
3
      <script>
4
         setupWebViewJavascriptBridge(function(bridge) {
5
            let adjustConfig = new AdjustConfig('2fm9gkqubvpc', AdjustConfig.EnvironmentSandbox);
6
            adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
            Adjust.appDidLaunch(adjustConfig);
9

10
            var btnRecordRevenueEvent = document.getElementById('btnRecordRevenueEvent')
11
            btnRecordRevenueEvent.onclick = function(e) {
12
                  e.preventDefault()
13
                  var adjustEvent = new AdjustEvent('g3mfiw')
14
                  adjustEvent.setRevenue(0.25, 'EUR')
15
                  Adjust.trackEvent(adjustEvent)
16
            }
17
         }
18
      </script>
19
      <div id="buttons">
20
         <div style="width:300px;height:35px;text-align:center;">
21
            <button id="btnRecordRevenueEvent">Record revenue event</button>
22
         </div>
23
      </div>
24
   </body>
25
</html>

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

収益イベントの重複排除

- (void)setTransactionId:(nonnull NSString *)transactionId;

イベントを重複して計測するのを防ぐため、オプションとして任意のIDをパスすることもできます。SDKが最新10件のIDを保存し、トランザクションIDが重複した収益イベントを排除します。

識別子を設定するには、イベントインスタンスのsetTransactionIdプロパティにトランザクションIDを割り当てます。

1
let event = ADJEvent(eventToken: "abc123")
2
event?.setTransactionId(transaction.transactionIdentifier)
3
Adjust.trackEvent(event)

1
ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"];
2
[event setTransactionId:transaction.transactionIdentifier];
3
[Adjust trackEvent:event];

1
var adjustEvent = new AdjustEvent(eventToken);
2
adjustEvent.setTransactionId(orderId);
3
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する例を示します。この関数はsetTransactionIdメソッドを使用して、uniqueIdを5e85484b-1ebc-4141-aab7-25b869e54c49に設定します。

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
      let event = ADJEvent(eventToken: "g3mfiw");
9
      event.setTransactionId("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 eventWithEventToken: @"g3mfiw"];
15
    [event setTransactionId: @"5e85484b-1ebc-4141-aab7-25b869e54c49"]
16
    [Adjust trackEvent:event];
17
}
18

19
@end

1
<html>
2
   <body>
3
      <script>
4
         setupWebViewJavascriptBridge(function(bridge) {
5
            let adjustConfig = new AdjustConfig('2fm9gkqubvpc', AdjustConfig.EnvironmentSandbox);
6
            adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
            Adjust.appDidLaunch(adjustConfig);
9

10
            var btnRecordDeduplicatedEvent = document.getElementById('btnRecordDeduplicatedEvent')
11
            btnRecordDeduplicatedEvent.onclick = function(e) {
12
                  e.preventDefault()
13
                  var adjustEvent = new AdjustEvent('g3mfiw')
14
                  adjustEvent.setTransactionId("5e85484b-1ebc-4141-aab7-25b869e54c49")
15
                  Adjust.trackEvent(adjustEvent)
16
            }
17
         }
18
      </script>
19
      <div id="buttons">
20
         <div style="width:300px;height:35px;text-align:center;">
21
            <button id="btnRecordDeduplicatedEvent">
22
               Record dedupicated event
23
            </button>
24
         </div>
25
      </div>
26
   </body>
27
</html>

Path:      /event
ClientSdk: ios4.38.4
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  transaction_id   5e85484b-1ebc-4141-aab7-25b869e54c49

コールバックパラメーターを追加する

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

AdjustダッシュボードでコールバックURLを登録した場合、SDKがイベントを記録する際にコールバックURLにGETリクエストを送信します。

サーバーに送信するコールバックパラメーターを設定できます。イベントにパラメーターを設定すると、SDKはそれらをコールバックURLに追加します。この情報を使用して、自社のBIシステムでユーザーのアプリ内行動を分析することが可能です。

イベントにコールバックパラメーターを追加するには、NSString key-value引数を指定してaddCallbackParameterメソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。

1
let event = ADJEvent(eventToken: "abc123")
2
event?.addCallbackParameter("key", value: "value")
3
event?.addCallbackParameter("foo", value: "bar")
4
Adjust.trackEvent(event)

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

1
var adjustEvent = new AdjustEvent(eventToken);
2
adjustEvent.addCallbackParameter("key", "value");
3
adjustEvent.addCallbackParameter("foo", "bar");
4
Adjust.trackEvent(adjustEvent);

Adjust SDKはイベントを計測し、コールバックパラメーターが追加されたURLにリクエストを送信します。例えば、URL https://www.mydomain.com/callbackが登録されている場合、コールバックは以下のようになります：

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

CSVレポートを使用している場合、CSVの定義欄にパラメーターを追加するようにしてください。

Adjustでは、SDKからURLに情報をパスするための様々なプレースホルダーをサポートしています。例えば、iOSの{idfa}プレースホルダーやAndroidの{gps_adid}プレースホルダーなどです。{publisher_parameter}プレースホルダーは、単一の文字列での全てのコールバックパラメーターを表示します。

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。次のコールバックパラメーターが追加されました：

- event_token
イベントごとに生成されるrevenue_amount

コールバックURLの結果は以下のようになります：

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
      let event = ADJEvent(eventToken: "g3mfiw");
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 eventWithEventToken:@"g3mfiw"];
   [event addCallbackParameter:@"event_token" value:@"g3mfiw"];
   [event addCallbackParameter:@"revenue_amount" value:@"0.05"];
   [Adjust trackEvent:event];
}

@end

1
<html>
2
   <body>
3
      <script>
4
         setupWebViewJavascriptBridge(function(bridge) {
5
            let adjustConfig = new AdjustConfig('2fm9gkqubvpc', AdjustConfig.EnvironmentSandbox);
6
            adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
            Adjust.appDidLaunch(adjustConfig);
9

10
            var btnRecordCallbackEvent = document.getElementById('btnRecordCallbackEvent')
11
            btnRecordCallbackEvent.onclick = function(e) {
12
                  e.preventDefault()
13
                  var adjustEvent = new AdjustEvent('g3mfiw');
14
                  adjustEvent.addCallbackParameter('event_token', 'g3mfiw');
15
                  adjustEvent.addCallbackParameter('revenue_amount', '0.05');
16
                  Adjust.trackEvent(adjustEvent);
17
            }
18
         }
19
      </script>
20
      <div id="buttons">
21
         <div style="width:300px;height:35px;text-align:center;">
22
            <button id="btnRecordCallbackEvent">
23
               Record event with callback parameters
24
            </button>
25
         </div>
26
      </div>
27
   </body>
28
</html>

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

パートナーパラメーターの追加

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

パートナーパラメーターを追加することで、ネットワークパートナーに追加情報を送信することができます。

Adjustは、設定した外部パートナーにパートナーパラメーターを送信します。この情報は、より詳細な分析やリターゲティング施策にご利用いただけます。パートナー用にパラメーターの設定が完了し、機能が有効化されると、Adjustのサーバーはデータ転送を開始します。

イベントにパートナーパラメーターを追加するには、NSString key-value引数を指定してaddPartnerParameterメソッドを呼び出してください。このメソッドを複回呼び出すことで、複数のパラメーターを追加することができます。

1
let event = ADJEvent(eventToken: "abc123")
2
event?.addPartnerParameter("key", value: "value")
3
event?.addPartnerParameter("foo", value: "bar")
4
Adjust.trackEvent(event)

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

1
var adjustEvent = new AdjustEvent(eventToken);
2
adjustEvent.addPartnerParameter("key", "value");
3
adjustEvent.addPartnerParameter("foo", "bar");
4
Adjust.trackEvent(adjustEvent);

例

この例では、ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する方法を示します。次のパートナーパラメーターが追加されました：

関連する製品のproduct_id
イベントをトリガーしたユーザーのuser_id

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
      let event = ADJEvent(eventToken: "g3mfiw");
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 eventWithEventToken:@"g3mfiw"];
15
   [event addPartnerParameter:@"product_id" value:@"29"];
16
   [event addPartnerParameter:@"user_id" value:@"835"];
17
   [Adjust trackEvent:event];
18
}
19

20
@end

1
<html>
2
   <body>
3
      <script>
4
         setupWebViewJavascriptBridge(function(bridge) {
5
            let adjustConfig = new AdjustConfig('2fm9gkqubvpc', AdjustConfig.EnvironmentSandbox);
6
            adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
            Adjust.appDidLaunch(adjustConfig);
9

10
            var btnRecordPartnerParamsEvent = document.getElementById('btnRecordPartnerParamsEvent')
11
            btnRecordPartnerParamsEvent.onclick = function(e) {
12
                  e.preventDefault()
13
                  var adjustEvent = new AdjustEvent('g3mfiw');
14
                  adjustEvent.addPartnerParameter('product_id', '29');
15
                  adjustEvent.addPartnerParameter('user_id', '835');
16
                  Adjust.trackEvent(adjustEvent);
17
            }
18
         }
19
      </script>
20
      <div id="buttons">
21
         <div style="width:300px;height:35px;text-align:center;">
22
            <button id="btnRecordPartnerParamsEvent">
23
               Record event with partner parameters
24
            </button>
25
         </div>
26
      </div>
27
   </body>
28
</html>

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

コールバック識別子を追加

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

計測したいイベントにカスタムの文字列識別子を追加できます。Adjustのサーバーが、この識別子をイベントコールバックでレポートします。これにより、どのイベントが正確に計測されたかを確認することが可能です。

この識別子を設定するには、IDをNSString引数としsetCallbackIdメソッドを呼び出してください。

1
let event = ADJEvent(eventToken: "abc123")
2
event?.setCallbackId("Your-Custom-ID")
3
Adjust.trackEvent(event)

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

1
var adjustEvent = new AdjustEvent("abc123");
2
adjustEvent.setCallbackId("Your-Custom-ID");
3
Adjust.trackEvent(adjustEvent);

例

ユーザーがボタンを操作する度にg3mfiwのトークンでイベントを計測する例を示します。この例では、callbackIdが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
      let event = ADJEvent(eventToken: "g3mfiw");
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 eventWithEventToken:@"g3mfiw"];
15
   [event setCallbackId:@"f2e728d8-271b-49ab-80ea-27830a215147"];
16
   [Adjust trackEvent:event];
17
}
18

19
@end

1
<html>
2
   <body>
3
      <script>
4
         setupWebViewJavascriptBridge(function(bridge) {
5
            let adjustConfig = new AdjustConfig('2fm9gkqubvpc', AdjustConfig.EnvironmentSandbox);
6
            adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
            Adjust.appDidLaunch(adjustConfig);
9

10
            var btnRecordCallbackIdEvent = document.getElementById('btnRecordCallbackIdEvent')
11
            btnRecordCallbackIdEvent.onclick = function(e) {
12
                  e.preventDefault()
13
                  var adjustEvent = new AdjustEvent('g3mfiw');
14
                  adjustEvent.setCallbackId('f2e728d8-271b-49ab-80ea-27830a215147');
15
                  Adjust.trackEvent(adjustEvent);
16
            }
17
         }
18
      </script>
19
      <div id="buttons">
20
         <div style="width:300px;height:35px;text-align:center;">
21
            <button id="btnRecordCallbackIdEvent">
22
               Record event with callback ID
23
            </button>
24
         </div>
25
      </div>
26
   </body>
27
</html>

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