Rudderstack - Singular Destination (デバイスモード)

RudderStack はオープンソースのカスタマーデータプラットフォーム (CDP) です 企業が顧客データを収集、統合し、さまざまな宛先へルーティングできるようにします。顧客データパイプラインを管理するための一元化されたプラットフォームを提供し、Webサイト、モバイルアプリ、サーバー、クラウドサービスなどのさまざまなソースから組織が簡単にデータを収集できるようにします。

Singular SDK は Rudderstack のプラグインとして提供されており、 「Device-Mode」宛先 と呼ばれます。以下の手順では、Rudderstack に Singular 宛先を追加する方法を説明します。

この統合は Rudderstack によって構築および保守されていることにご注意ください。実装中に問題が発生した場合は、Rudderstack にお問い合わせください。

対象ガイド エンジニアリングチーム
前提条件 この記事では、 Rudderstack iOS、Android、React Native、または Cordova SDK がすでにアプリに統合されていることを前提としています。 device-mode およびモバイル SDK の詳細については、Rudderstack のドキュメントを参照してください。

この統合を使用するには、次のいずれかの Rudderstack モバイル SDK を使用している必要があります。iOS (ネイティブ Obj-C または Swift)、Android (Java または Kotlin)、React Native、または Cordova。 この統合は他のフレームワークとは互換性がありません。

サポート対象
  1. 基本的なインストールアトリビューション
  2. SkAdNetwork サポート
  3. Apple Search Ads アトリビューション
  4. カスタムアプリ内イベントトラッキング
  5. 収益トラッキング
  6. カスタムユーザー ID
サポート対象外
  1. META インストールリファラーアトリビューション
  2. ディープリンク
  3. Limited Data Sharing サポート

他の フレームワーク のサポートが必要な場合、または Singular SDK が提供する「フル機能」をご利用になりたい場合は、Rudderstack とは別に Singular SDK を独自に実装する必要があります。SDK のオプションとフレームワークについては こちら をご覧ください。

はじめに

  1. RudderStack ダッシュボード からソースを追加します。次に、宛先のリストから Singular を選択します。
  2. 宛先に名前を割り当て、 Continue をクリックします。

接続設定

Singular を宛先として正常に構成するには、次の設定を構成する必要があります。



  • API Key: ここに Singular の 「SDK Key」 を入力します。これは必須フィールドです。
  • Secret: Singular のシークレットを入力します。これは必須フィールドで、RudderStack iOS および Android SDK とのデバイスモード統合には必須です。

    Singular の 「SDK KEY」 を取得します。これは Singular ダッシュボードの 「Developer Tools > SDK Integration > SDK Keys」 にあります。


    注: 「Cloud-Mode」統合の場合は、 API Key (SDK Key) の値のみを入力します
    「Secret」は空欄のままにしてください。

  • Session Event Name: この設定は、クラウドモード経由でイベントを送信する場合にのみ適用されます。
  • Use device mode to send events: Android または iOS プラットフォームを使用している場合、この設定を有効にすると、デバイスモード経由でイベントを送信できます。次に、Singular Device Mode ガイドに従って、プロジェクトに Singular を追加する手順を実行します。

    デバイスモード経由でイベントを送信する場合、RudderStack ではどのイベントを破棄し、どのイベントを通過させるかを指定することもできます。詳細については、 Client-side Event Filtering ガイドを参照してください。

デバイスモード統合の追加

RudderStack で Singular を宛先として設定したら、統合するプラットフォームに応じて、次の手順でプロジェクトに追加します。

React NativeCordovaiOS Obj-C (Legacy)iOS SDK v2 (Legacy)Android Java (Legacy)

React Native アプリに Singular を追加するには、次の手順に従います。

  1. 次のコマンドを実行して、 RudderStack-Singular モジュールをアプリに追加します。

    bash

    npm install @rudderstack/rudder-integration-singular-react-native
    // OR //
    yarn add @rudderstack/rudder-integration-singular-react-native
  2. プロジェクトレベルの android/build.gradle ファイルを開き、次のスニペットを追加します。

    groovy

    repositories {
      maven {
        url "https://maven.singular.net/"
      }
    }
    
  3. 上記のモジュールをインポートし、SDK の初期化に追加します。

    typescript

    import rudderClient from "@rudderstack/rudder-sdk-react-native"
    import singular from "@rudderstack/rudder-integration-singular-react-native"
    const config = {
    	dataPlaneUrl: <data_plane_url>,
    	trackAppLifecycleEvents: true,
    	withFactories: [singular],
    }
    rudderClient.setup(<write_key>, config)

Identify

デバイスモード統合の場合、Singular SDK は RudderStack の identify メソッドを使用して、ユーザー ID をカスタムユーザー ID にマッピングします。RudderStack は Singular の setCustomUserId API を使用して、識別されたユーザー ID を Singular へ転送します。

Android と iOS の両方の SDK のサンプル identify 呼び出しを以下に示します。

iOS (Obj-C) Android (Kotlin)
[[RSClient getInstance] identify:@"1hKOmRA4el9Zt1WSfVJIVo4GRlm"];

Track

track 呼び出しを使用すると、あらゆるユーザーアクションとそれに関連するプロパティをキャプチャできます。各ユーザーアクションはイベントとみなされます。

カスタムイベントのトラッキング

カスタム track 呼び出しを使用すると、アプリで発生するカスタムイベントをトラッキングできます。RudderStack はこれらの呼び出しを Singular へ送信し、そこでカスタムインストール後イベントとして処理され、関連レポートで利用できるようになります。

Android と iOS の両方の SDK のサンプルカスタム track 呼び出しを以下に示します。

iOS (Obj-C) Android (Kotlin)
[[RSClient getInstance] track:@"Product Reviewed" properties:@{
        @"product_id" : @"345676543",
        @"review_id" : @"123454387"
    }];

収益のトラッキング

Singular は収益イベントのトラッキングをサポートしています。 revenue プロパティを含むイベントが (ゼロ値を含めて) 送信されるたびに収益トラッキングを実行します。オプションで、 currency フィールドを ISO コード として渡すこともできます。

デフォルトの通貨は USD に設定されています。

サンプルの revenue track 呼び出しを以下に示します。

iOS (Obj-C) Android (Kotlin)
[[RSClient getInstance] track:@"Order Completed" properties:@{
        @"revenue" : @1251,
        @"currency" : @"INR"
    }];

Screen

screen メソッドを使用すると、ユーザーがモバイル画面を見るたびに、関連するオプションのプロパティとともに記録できます。この呼び出しは、Web アプリケーションの page 呼び出しに似ていますが、モバイルデバイス専用です。

Android と iOS の両方の SDK のサンプル screen 呼び出しを以下に示します。

iOS (Obj-C) Android (Kotlin)
[[RSClient sharedInstance] screen:@"Home" properties:@{
    @"category" : @"launcher"
}];

上記のスニペットでは、RudderStack は表示された画面に関連するすべての情報を、画面に関する追加情報とともにキャプチャします。

RudderStack は screen イベントをカスタムイベントとして Singular へ送信します。

Reset

reset メソッドは、現在のユーザーの ID をリセットし、新しい匿名セッションを作成します。ユーザーがログアウトしたときに呼び出す必要があります。

RudderStack は Singular の unsetCustomUserId メソッドを呼び出して、ユーザーの ID をリセットします。

Android と iOS の両方の SDK のサンプル reset 呼び出しを以下に示します。

iOS (Obj-C) Android (Kotlin)
[[RSClient getInstance] reset];

SKAdNetwork (SKAN) サポートの実装

SKAdNetwork 統合の制御を Singular に渡すには、iOS SDK の初期化前に次のコードを追加します。

重要:

  • manualSkanConversionManagement = true を設定すると、Conversion Value を手動で更新する必要があります。この場合、Singular の SKAN モデルがユーザーに代わって CV 値を更新することはできません。「managed」モードを有効にするには、これを「false」に設定します。
  • waitForTrackingAuthorizationWithTimeoutInterval の設定は、アプリが iOS App Tracking Transparency (ATT) プロンプトを使用する場合にのみ使用してください。ATT を表示する場合は、これを 300 に設定してください。

Obj-C

[RudderSingularIntegration setSKANOptions:YES
        isManualSkanConversionManagementMode:NO
withWaitForTrackingAuthorizationWithTimeoutInterval:@300
        withConversionValueUpdatedHandler:^(NSInteger conversionValue){
    // Receive a callback whenever the Conversion Value is updated
    NSLog(@"SKAN handler %ld",conversionValue);
}];