1. Package Managerウィンドウで

   • ボタンをクリックします。
   • "Add package from git URL" を選択
   • Singular Unity SDK の GitHub URL を入力します: https://github.com/singular-labs/Singular-Unity-SDK.git
     
   • Add "ボタンをクリックします。

1. SingularのS3バケットから必要な依存関係をダウンロードします。SDKバージョン5.2.1の場合、Plugins.zipは https://s3.us-west-2.amazonaws.com/maven.singular.net/unity/UPM-non-EDM4U/5.2.1/Plugins.zip。
2. 解凍したファイルをProjectPluginsフォルダに移動する。

1. Unity v2018.3以降では、PlayerウィンドウのCustom Main Manifestプロパティを有効にするだけで、独自のAndroidManifestファイルを追加できます（File > Build Settings > Player Settings > Publishing settingsでアクセスできます）。これにより、デフォルトのAndroidManifest.xmlファイルが生成され、編集することができます。

   このファイルはAssets/Plugins/Android/AndroidManifest.xmlの場所にあります。

   ソース：https://docs.unity3d.com/2023.2/Documentation/Manual/android-manifest.html

2. UnityのカスタムMain Manifestファイルを使用する代わりに、Unityからアプリをエクスポートした後、Android StudioからAndroidManifest.xmlにアクセスすることもできます。

1. Unity v2018.3以降では、PlayerウィンドウのCustom Gradle Templateプロパティを有効にするだけで、独自のGradleビルドファイルを追加できます（File > Build Settings > Player Settings > Publishing settingsでアクセスできます）。これは、あなたが編集するためのデフォルトのmainTemplate.gradleファイルを生成します。

   ファイルはAssets/Plugins/Android/mainTemplate.gradleになります。

   ソース: https://docs.unity3d.com/2023.2/Documentation/Manual/android-gradle-overview.html

2. UnityのカスタムGradleビルドファイルを使用する代わりに、Unityからアプリをエクスポートした後、Android Studioからアプリのbuild.gradleにアクセスすることができます。

Proguard を使用している場合は、 proguard-unity.txt ファイルに以下のコードを追加します：

-keep class com.singular.sdk.** { *; }
-keep public class com.android.installreferrer.** { *; }
-keep public class com.singular.unitybridge.** { *; }

Podsがあるフォルダから以下のコマンドを実行することをお勧めします。

pod repo update
pod update

iOSでテストする場合は、以下のコードを：Classes > UnityAppController > applicationDidBecomeActivefunction.

// Singular SDK コンソールで使用するための Xcode コンソールへのベンダ用識別子（IDFV）の印刷
NSLog(@"Singular === IDFV: %@", [[[UIDevice currentDevice] identifierForVendor] UUIDString]);

これにより、Xcode Logs の App Open でIDFV 識別子を取得できるようになります。Singular SDK コンソールでこの識別子を使用して、テストデバイスを追加します。

1. Signing & Capabilities で Associated Domain を追加します。関連ドメインが正しく設定されていないと、Singularトラッキングリンクをクリックしてもアプリは開きません。

2. チームIDがSingularプラットフォームのアプリのページにも追加されていることを確認してください。これにより、Singularはユニバーサルリンク機能を有効にするために必要なApple App Site Association Fileを作成し、ホストすることができます。

Singular プレハブオブジェクトを階層ペインに移動します。

• プロジェクトペインから次の場所に移動します：Packages > Singular > SingularSDK > Prefabs.
• SingularSDKObject を階層ペインに移動します。
  

階層ペインに

1. メインシーンに空のGameObjectを作成します。
2. GameObjectに名前を付ける：SingularSDKObjectと名付ける。
   重要： SingularのSDKを機能させるには、GameObjectの名前を "SingularSDKObject "にする必要があります。
3. SingularSDKObjectをクリックします。
4. Inspection Paneに移動します。
5. Inspectionペインから、Add Componentをクリックします。
6. 検索フィールドに「Singular」と入力し、「Singular SDK」スクリプトを選択します。
   

META Install Referrer Attributionメソッドをサポートするには、SingularSDKObjectのInspection PaneにFacebook App IDを追加します。

1. メインシーンで SingularSDKObject をクリックします。
2. Inspection Paneを開き、"Facebook App ID "フィールドを見つけます。
3. Facebook App IDを追加します。

古いバージョンのSDKを使用している場合、以下のいずれかの方法でSKAdNetworkを有効にする必要があります：

• SingularSDKObjectに移動し、SKANEnabledを Trueに設定します。
• アプリのコードでSingularSDK.SkanRegisterAppForAdNetworkAttribution() を呼び出します。

ロジックを使用してSKAN変換値を手動で管理する場合は、以下を実行する必要があります：

• SingularSDKObjectに移動し、manualSKANConversionManagementを Trueに設定します。
• コード内で以下のメソッドを使用して、変換値を設定および取得します。

// サイン会開催
Singular.Event("SignUp");

// 変換値を7に更新
SingularSDK.SkanUpdateConversionValue(7);

int? value = SingularSDK.SkanGetConversionValue();

public class Main : MonoBehaviour, SingularConversionValueUpdatedHandler {
  void Awake() {
    SingularSDK.SetConversionValueUpdatedHandler(this);
  }

  void OnConversionValueUpdated(int value) {
    // 変換値を使用する
  }
}

Androidでのディープリンクのサポート

1. Project > Assets > Plugins > Android > AndroidManifest.xmlファイルをエディタで開きます。
2. アクティビティ名のプロパティをデフォルトから更新します：

   <activity android:name="com.unity3d.player.UnityPlayerActivity"

   から

   <activity android:name="com.singular.unitybridge.SingularUnityActivity"

   または

   重要: カスタムアクティビティを実装している場合：

   1. onNewIntentを実装しているSingularUnityBridgeの インポート文を追加します。

      import com.singular.unitybridge.SingularUnityBridge;

   2. アクティビティのonNewIntentメソッドからSingularUnityBridge.onNewIntent(intent);を呼び出します：

      例

      @Override
      protected void onNewIntent(Intent intent) {
          setIntent(intent);
      
          // カスタム・アクティビティからonNewIntentでこのメソッドを呼び出します。
          SingularUnityBridge.onNewIntent(intent);
      }

   警告：アプリ用にカスタムアクティビティを作成し、それがUnity Playerアクティビティを継承していない場合は、現在のアクティビティオブジェクトがNULLである可能性がある場合に対処するために、onNewIntentメソッドにガードを追加することを検討してください。

3. 適切なアクティビティにIntent Filterを追加して、選択したスキームでAndroid App Schemeディープリンクをサポートします。
   • Singularは、アプリを開くためのAndroid App Schemeテクノロジーをサポートしています。柔軟性を高めるため、HOST属性を使用しないことをお勧めします。
   • Singularのアプリ設定からアプリを探し、Androidアプリの詳細設定を展開し、Androidアプリスキームフィールドに値を貼り付けます。これにより、ディープリンクが有効になっているSingularトラッキングリンクのリダイレクト中に、Singularがインテントとしてスキームを提供できるようになります。
     SingularプラットフォームのスキームがAndroidManifest.xmlのインテント・フィルター設定と一致しない場合、Singularトラッキングリンクはアプリを開きません。特定のスキームとホストの組み合わせを使用する場合は、同じ組み合わせをSingularプラットフォームで設定する必要があります。

   <!-- 特異なAndroidスキームのディープリンクにインテント・フィルタを追加 -->
   <!-- singular-exampleをあなたの値に置き換える -->
   
   <intent-filter>
       <data android:scheme="singular-example"/>
       <action android:name="android.intent.action.VIEW"/>
       <category android:name="android.intent.category.DEFAULT"/>
       <category android:name="android.intent.category.BROWSABLE"/>
   </intent-filter>

iOSでのディープリンクのサポート

SingularはiOSユニバーサルリンクと アプリスキームを使ってiOS上でディープリンクします。以下の手順に従って、Singular LinksでiOSユニバーサルリンクとアプリスキームのディープリンクを使用できるようにしてください。

1. SingularのAttribution > Manage Linksページで、リンク用に少なくとも1つのサブドメインを設定します。詳細については、Singular Links FAQを参照してください。
2. ユニバーサルリンク（iOSでのディープリンク）を設定するには：
   • Apple Developer Portalにログインします。

   • Identifiersに移動し、Universal Linksサポートを追加したいアプリを選択します。

     

   • Capabilitiesメニューで、Associated Domainsチェックボックスをチェックし、Saveをクリックします。

     

3. Associated Domains "権限をアプリに追加します：

   • XCodeで、Project settings > Capabilities > Associated Domainsに進みます。

   • Singular Linksドメインを追加します。

     

4. Apple Developer Portalから「App Prefix」（別名「Team ID」）をコピーします。

5. SingularでApps Configurationに行き、アプリを見つけ、iOS App Advanced Settingsを展開し、Team IDフィールドに値を貼り付けます。 これにより、Singularはユニバーサルリンク用の apple-app-site-associationファイルをSingularドメインでホストできるようになります。

   

6. 注意：このステップは、Universal Linksがディープリンクできない場合に必要です。
   チームID」の下に、iOSの「アプリスキーム」を入力し、ユニバーサルリンクのディープリンクのフォールバックとして、従来のアプリスキームのディープリンクを有効にします。
   
   
   あなたのアプリがディープリンクのためにiOSアプリスキームをサポートするのが初めての場合、アプリスキームがあなたのXcodeプロジェクトで "URLタイプ "として登録されていることを確認してください：
   
   
   iOS アプリのアプリスキームのサポートに関する詳細については、このトピックに関する Apple の開発者向けヘルプ記事を参照してください。

ディープリンクハンドラの追加

Singular SDKは、アプリが開かれるきっかけとなったトラッキングリンクの詳細を読み取るハンドラーメカニズムを提供します。

ハンドラを使用するには

1. MainクラスにSingular Link Handlerインターフェースを追加するか、クラスを作成してSingularSDKObjectにアタッチします。
2. スクリプトの一番上に以下の行を追加して、SingularLinkHandlerのディレクティブが正しいことを確認してください：

   using Singular;

3. クラスにSingularLinkHandlerインターフェイスを実装します。
4. クラスの任意の場所でSetSingularLinkHandlerメソッドを呼び出し、クラスをディープリンクのハンドラとして登録します。Awake() 関数を使用することをお勧めします。SetSingularLinkHandler を呼び出すと、Singular SDK はトラッキングリンクを取得し、OnSingularLinkResolvedメソッドを呼び出し、トラッキングリンクの詳細を渡します。リンクの詳細を読み込んで処理するには、このメソッドをオーバーライドします。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using Singular;

public class SingularMain : MonoBehaviour, SingularLinkHandler
{
    // Startは最初のフレームが更新される前に呼び出される
    void Start()
    {
        
    }
    
    void Awake () {
        Debug.Log("Singular === Awake");
        /* クラスをSingular Linkハンドラーとして登録します。このメソッドはアプリの実行中のどの時点でも呼び出すことができます。トラッキングリンクの詳細を取得し、OnSingularLnkResolvedを呼び出します。 */
        SingularSDK.SetSingularLinkHandler(this);
    }
    
    public void OnSingularLinkResolved(SingularLinkParams linkParams) {
        Debug.Log("Singular === OnSingularLinkResolved");
        
        // リンクの管理]ページで設定されたディープリンク先
        string deeplink = linkParams.Deeplink;

        // リンクにパススルー・パラメータが追加されている場合。
        string passthrough = linkParams.Passthrough;

        // 遅延ディープリンクとして設定されたリンクかどうか。
        bool isLinkDeferred = linkParams.IsDeferred;

        // ディープリンクを処理するコードをここに追加する
        Debug.Log("Singular === deeplink: "+deeplink);
        Debug.Log("Singular === passthrough: "+passthrough);
        Debug.Log("Singular === isLinkDeferred: "+isLinkDeferred);      
    }
}

メソッドリファレンス

public void SetSingularLinkHandler(SingularLinkHandler 
handler)

public class Main : MonoBehaviour, SingularLinkHandler {
    void Awake () {
        SingularSDK.SetSingularLinkHandler(this)
    }
}

public void OnSingularLinkResolved(SingularLinkParams
linkParams)

public void OnSingularLinkResolved(SingularLinkParams
linkParams){
    // トラッキング・リンクの詳細を読み、記録する
    Debug.Log("deeplink: " + linkParams.Deeplink);
    Debug.Log("passthrough: " + linkParams.Passthrough);
    Debug.Log("is_deferred: " + linkParams.IsDeferred);
}

レガシーリンクでディープリンクを処理する

もしあなたがSingularの古い顧客であれば、新しいSingular Linksではなくレガシーリンク（Singularの古いトラッキングリンクの仕組み）を使っているかもしれません。レガシーリンクはリンクの作成と リンクの表示ページで管理され、ディープリンクとディファードディープリンクの機能を提供します。

1. SingularDeferredDeepLinkHandlerインターフェースを実装します。
2. クラスの任意の場所でSetDeferredDeepLinkHandlerメソッドを呼び出し、クラスをディープリンクのハンドラとして登録します。
3. SetDeferredDeepLinkHandler を呼び出すと、Singular SDKはトラッキングリンクを取得し、OnDeferredDeepLinkメソッドを呼び出し、トラッキングリンクの詳細を渡します。リンクの詳細を読み込んで処理するには、このメソッドをオーバーライドします。

以下のサンプルコードは3つのステップを示しています：

public class Main : SingularDeferredDeepLinkHandler {
              
// ...
                
void Awake () {
    // ディープリンク・ハンドラとしてクラスを登録します。
    // このメソッドは、アプリの実行中のどの時点でも呼び出すことができます。
    SingularSDK.SetDeferredDeepLinkHandler(this);
}
                
public void OnDeferredDeepLink(string deeplink) {
    // ディープリンクを処理するコードはここにある。
    // この例では、ディープリンクはログに記録されるだけです。
    Debug.Log ("Deep link received:" + deeplink);
}
                
// ...

Singularはサーバー間の統合により、追加のモバイルイベント追跡データを受け取ることができます。この機能を利用するには、ユーザーIDをSingularのモバイルデバイス追跡識別子にマッピングする必要があります。

SingularSDK.SetDeviceCustomUserId('CustomUserId');

Unity IAPを使用できない場合、Singular SDKは購入に関する情報を "手動で "Singularに渡すための2つのメソッドを提供します：

• Revenueを使用すると、トランザクションの通貨、金額、その他のオプションの詳細情報をSingularに渡すことができます。
• CustomRevenueも同様ですが、イベントにカスタム名を付けることができます。

public static void Revenue(string currency, double amount)

public static void Revenue(string currency, double amount, string productSKU, string productName, string productCategory, int productQuantity, double productPrice)

public static void Revenue(string currency, double amount, Dictionary<string, object> attributes)

// 商品詳細のない収益イベントを送信する
SingularSDK.Revenue("USD", 1.99);

// 商品詳細を含む収益イベントを送信する
SingularSDK.Revenue("USD", 4.99, "coin_package_abc123", "Coin Pack 5", "Bundles", 1, 4.99);

// 属性用JSONディクショナリで収益イベントを送信する
Dictionary<string, object> attributes = new Dictionary<string, object>();

// 属性の追加
attributes["productSKU"] = "coin_package_abc123";
attributes["productName"] = "Coin Pack 5";
attributes["productCategory"] = "Bundles";
attributes["productQuantity"] = 2;
attributes["productPrice"] = 4.99;

SingularSDK.Revenue("USD", 9.98, attributes);

public static void CustomRevenue(string eventName, string currency, double amount)

public static void CustomRevenue(string eventName, string currency, double amount, string productSKU, string productName, string productCategory, int productQuantity, double productPrice)

public static void CustomRevenue(string eventName, string currency, double amount, Dictionary<string, object> attributes)

// カスタム名で収益イベントを送信する
SingularSDK.CustomRevenue("MyCustomRevenue", "USD", 9.99);

// カスタム名＋商品詳細で収益イベントを送信する
SingularSDK.CustomRevenue("MyCustomRevenue", "USD", 50.50, "abc123", "myProductName", "myProductCategory", 2, 25.50);

// カスタム名+属性用JSON辞書で収益イベントを送信する
// 属性辞書の作成
Dictionary<string, object> attributes = new Dictionary<string, object>();

// 属性の追加
attributes["productSKU"] = "coin_package_abc123";
attributes["productName"] = "Coin Pack 5";
attributes["productCategory"] = "Bundles";
attributes["productQuantity"] = 2;
attributes["productPrice"] = 4.99;
// 必要に応じて属性を追加する

SingularSDK.CustomRevenue("MyCustomRevenue", "USD", 9.98, attributes);

Singularはお客様のサーバーから収益に関するデータを収集し、キャンペーンのパフォーマンスやROIの分析に役立てることができます。

要件

• アプリ内登録またはログインイベントから、デバイス識別子を取得して渡し、このデータをユーザーIDと共にサーバーに保存します。デバイス識別子はユーザーによって変更される可能性があるため、ユーザーがアプリセッションを生成する際には必ず識別子を更新してください。これにより、サーバー側イベントが正しいデバイスに帰属することが保証されます。
• サーバー側イベントはプラットフォーム固有であるため、デバイスプラットフォーム（iOS デバイスの IDFA または IDFV など）に一致するデバイス識別子のみを使用して送信する必要があります。
• Singular 内部 BI ポストバック メカニズムを使用して、内部エンドポイントにリアルタイムでイベントをプッシュすると、サーバー側でデータセットを更新できます。内部 BI ポストバック FAQ を参照してください。
• 詳細については、『サーバー間統合』ガイドの「収益の追跡」セクションを参照してください。

これらのパートナーを有効にする方法の詳細については、以下のリンクを参照してください。

• 詳しくはRevenueCatのドキュメントをご覧ください。
• 詳細はadaptyのドキュメントをご覧ください。

SingularSDKと並行してSegmentからSingularにイベントを送信するには、Segmentに"Cloud-Mode "Destinationを追加する必要があります。こちらのガイドに従ってください。