Show Menu
トピック×

ADBMobile.cs methods

設定メソッド

  • CollectLifecycleData
    SDK のすべてのソリューションで使用するライフサイクルデータを収集するように SDK に指示します。詳しくは、「 ライフサイクル指標 」を参照してください。
    • このメソッドの構文を次に示します。
      public static void CollectLifecycleData();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.CollectLifecycleData();
      
      
  • EnableLocalNotifications(iOS のみ)
    アプリのローカル通知を有効にします。
    • このメソッドの構文を次に示します。
      public static void EnableLocalNotifications();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.EnableLocalNotifications();
      
      
  • GetDebugLogging
    現在のデバッグログの環境設定を返します。デフォルト値は false です。
    • このメソッドの構文を次に示します。
      public static bool GetDebugLogging();
      
      
    • このメソッドのコードサンプルを次に示します。
      var debugEnabled = ADBMobile.GetDebugLogging();
      
      
  • GetLifetimeValue
    現在のユーザーのライフタイム値を返します。
    • このメソッドの構文を次に示します。
      public static double GetLifetimeValue();
      
      
    • このメソッドのコードサンプルを次に示します。
      var lifetimeValuea = ADBMobile.GetLifetimeValue();
      
      
  • GetPrivacyStatus
    現在のユーザーのプライバシーステータスの enum 表現を返します。
    • MOBILE_PRIVACY_STATUS_OPT_IN :ヒットは即座に送信されます。
    • MOBILE_PRIVACY_STATUS_OPT_OUT :ヒットが破棄されます。
    • MOBILE_PRIVACY_STATUS_UNKNOWN :オフライン追跡が有効な場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。
      オフライン追跡が有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。デフォルト値は ADBMobileConfig.json ファイルに設定します。
    • このメソッドの構文を次に示します。
      public static ADBPrivacyStatus GetPrivacyStatus();
      
      
    • このメソッドのコードサンプルを次に示します。
      var privacyStatus = ADBMobile.GetPrivacyStatus();
      
      
  • GetUserIdentifier
    カスタム識別子が設定されている場合、カスタムユーザー識別子を返します。カスタム識別子が設定されていない場合、null を返します。デフォルト値は null です。
    • このメソッドの構文を次に示します。
      public static string GetUserIdentifier();
      
      
    • このメソッドのコードサンプルを次に示します。
      var userId = ADBMobile.GetUserIdentifier();
      
      
  • GetVersion
    ライブラリのバージョンを取得します。
    • このメソッドの構文を次に示します。
      public static string GetVersion();
      
      
    • このメソッドのコードサンプルを次に示します。
      var version = ADBMobile.GetVersion();
      
      
  • KeepLifecycleSessionAlive(iOS のみ)
    設定ファイル内のライフサイクルセッションのタイムアウト値にかかわらず、バックグラウンドから次に戻ったときに新しいセッションを開始しないように SDK に指示します。
    このメソッドは、バックグラウンドにある間に通知を登録するアプリで使用されることを目的としており、アプリがバックグラウンドにある間に実行されるコードからのみ呼び出す必要があります。
    • このメソッドの構文を次に示します。
      public static void KeepLifecycleSessionAlive();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.KeepLifecycleSessionAlive();
      
      
  • PauseCollectingLifecycleData(Android のみ)
    ライフサイクル指標が正しく計算されるように、アプリが一時停止されたことを SDK に通知します。例えば、一時停止中にタイムスタンプを収集して、セッションの長さの計測を一時停止します。また、クラッシュ回数を正しく計測するためのフラグを設定します。詳しくは、「 ライフサイクル指標 」を参照してください。
    • このメソッドの構文を次に示します。
      public static void PauseCollectingLifecycleData();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.PauseCollectingLifecycleData();
      
      
  • SetContext(Android のみ)
    UnityPlayerの現在のアクティビティからアプリケーションコンテキストを設定する必要があるSDKを示します。
    • このメソッドの構文を次に示します。
      public static void SetContext();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.SetContext();
      
      
  • SetDebugLogging
    デバッグログの環境設定を有効に設定します。
    • このメソッドの構文を次に示します。
      public static void SetDebugLogging (bool enabled);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.SetDebugLogging(true);
      
      
  • SetPrivacyStatus
    現在のユーザーのプライバシーステータスをステータスに設定します。次のいずれかの値に設定します。
    • MOBILE_PRIVACY_STATUS_OPT_IN :ヒットは即座に送信されます。
    • MOBILE_PRIVACY_STATUS_OPT_OUT :ヒットが破棄されます。
    • MOBILE_PRIVACY_STATUS_UNKNOWN :オフライン追跡が有効な場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。オフライン追跡が有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。
    • このメソッドの構文を次に示します。
      public static void SetPrivacyStatus(ADBPrivacyStatusstatus);
      
      
    • この構文のコード例を次に示します。
      ADBMobile.SetPrivacyStatus(ADBMobile.ADBPrivacyStatus.MOBILE_PRIVACY_STATUS_OPT_IN);
      
      
  • SetUserIdentifier
    ユーザー識別子を userId に設定します。
    • このメソッドの構文を次に示します。
      public static void SetUserIdentifier(string userId);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.SetUserIdentifier("myCustomUserId");
      
      

Analytics メソッド

  • GetTrackingIdentifier
    Analytics トラッキング識別子を取得します。
    • このメソッドの構文を次に示します。
      public static string GetTrackingIdentifier();
      
      
    • このメソッドのコードサンプルを次に示します。
      var trackingId = ADBMobile.GetTrackingIdentifier();
      
      
  • TrackState
    オプションのコンテキストデータを使用してアプリの状態を追跡します。状態は、「title screen」、「level 1」、「pause」など、アプリで利用できる表示です。これらの状態は Web サイト上のページによく似ており、 TrackState コールはページビュー数を増分します。
    If state is empty, it displays as app name app version (build) in reports. レポートにこの値がある場合、各 TrackState 呼び出しで state を設定していることを確認してください。
    これは、ページビュー数を増分する唯一のトラッキングコールです。
    • このメソッドの構文を次に示します。
      public static void TrackState(string state, Dictionary<string, object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      var contextData = new Dictionary<string, object>);
      contextData.Add ("user", "jim");
      ADBMobile.TrackState("title screen", contextData);
      
      
  • TrackAction
    アプリのアクションを追跡します。アクションとは、アプリ内で計測に価する重要な操作のことで、「deaths」、「level gained」、「feed subscriptions」などの指標があります。
    アプリがバックグラウンドになっているときに、コードが実行される(バックグラウンドデータの取得など)可能性がある場合は、代わりに trackActionFromBackground を使用します。
    • このメソッドの構文を次に示します。
      public static void TrackAction(string action, Dictionary<string, object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackAction("level gained", null);
      
      
  • TrackActionFromBackground(iOS のみ)
    バックグラウンドで発生したアクションを追跡します。これにより、特定の状況でライフサイクルイベントが発生するのを抑えます。
    このメソッドは、アプリがバックグラウンドになっているときに実行されるコードでのみ呼び出す必要があります。
    • このメソッドの構文を次に示します。
      public static void TrackActionFromBackground(string action, Dictionary<string,object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackActionFromBackground("majorLocationChange", null);
      
      
  • TrackLocation
    現在地点の緯度と経度の座標を送信します。また、現在位置が ADBMobileConfig.json ファイルで定義された目標地点内にあるかどうかを判定します。現在の座標が定義した目標地点内にある場合、コンテキストデータ変数に代入され、TrackLocation 呼び出しで送信されます。
    • このメソッドの構文を次に示します。
      public static void TrackLocation(float latValue, float lonValue, Dictionary<string, object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackLocation(28.418649, -81.581324, null);
      
      
  • TrackBeacon
    ユーザーがいつビーコンの Proximit (圏内) に入ったかを追跡します。
    • このメソッドの構文を次に示します。
      public static void TrackBeacon(int major, int minor, string uuid, ADBBeaconProximity proximity, Dictionary<string, object> cdata);
      
      
  • TrackingClearCurrentBeacon
    ユーザーがビーコンの Proximity を離れた場合に、ビーコンデータをクリアします。
    • このメソッドの構文を次に示します。
      public static void TrackingClearCurrentBeacon();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackingClearCurrentBeacon();
      
      
  • TrackLifetimeValueIncrease
    ユーザーのライフタイム値に値を加算します。
    • このメソッドの構文を次に示します。
      public static void TrackLifetimeValueIncrease(double amount, Dictionary<string, object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackLifetimeValueIncrease(5, null);
      
      
  • TrackTimedActionStart
    指定アクションの時間計測を開始します。既に開始しているアクションでこのメソッドを呼び出すと、以前の時間計測アクションが上書きされます。
    この呼び出しはヒットを送信しません。
    • このメソッドの構文を次に示します。
      public static void TrackTimedActionStart(string action, Dictionary<string,object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    特定のアクションに関連付けられたコンテキストデータを指定データで更新します。渡されたデータは、特定のアクションの既存のデータに追加され、同じキーが既にアクションに定義されている場合は、データを上書きします。
    この呼び出しはヒットを送信しません。
    • このメソッドの構文を次に示します。
      public static void TrackTimedActionUpdate(string action, Dictionary<string, object> cdata);
      
      
    • このメソッドのコードサンプルを次に示します。
      var contextData = new Dictionary<string, object>;
      contextData.Add("checkpoint", "1:32");
         ADBMobile.TrackTimedActionUpdate("level2", contextData);
      
      
  • TrackTimedActionEnd
    時間計測アクションを終了します。
    • このメソッドの構文を次に示します。
      public static void TrackTimedActionEnd(string action);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackTimedActionEnd("level2");
      
      
  • TrackingTimedActionExists
    時間計測が進行中かどうかを返します。
    • このメソッドの構文を次に示します。
      public static bool TrackingTimedActionExists(string action);
      
      
    • このメソッドのコードサンプルを次に示します。
       var level2InProgress = ADBMobile.TrackingTimedActionExists("level2");
      
      
  • TrackingSendQueuedHits
    現在キューに格納されている件数にかかわらず、オフラインキューのすべてのヒットを強制的に送信します。
    • このメソッドの構文を次に示します。
      public static void TrackingSendQueuedHits();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackingSendQueuedHits();
      
      
  • TrackingClearQueue
    オフラインキューからすべてのヒットをクリアします。
    • このメソッドの構文を次に示します。
      public static void TrackingClearQueue();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile.TrackingClearQueue();
      
      
  • TrackingGetQueueSize
    現在オフラインキュー内に格納されているヒットの数を取得します。
    • このメソッドの構文を次に示します。
      public static int TrackingGetQueueSize();
      
      
    • このメソッドのコードサンプルを次に示します。
      var queueSize = ADBMobile.TrackingGetQueueSize();
      
      

Experience Cloud IDの方法

  • GetMarketingCloudID
    Experience Cloud ID を ID サービスから取得します。
    • このメソッドの構文を次に示します。
      public static string GetMarketingCloudID();
      
      
    • このメソッドのコードサンプルを次に示します。
      var mcid = ADBMobile.GetMarketingCloudID();
      
      
  • VisitorSyncIdentifiers
    Experience Cloud ID を使用すると、追加の顧客 ID を設定して、各訪問者に関連付けることができます。独自の識別子を使えば、同じ訪問者に対して複数の顧客 ID をセットすることも可能です。このメソッドは、JavaScript ライブラリの setCustomerIDs に相当します。
    • このメソッドの構文を次に示します。
      public static void VisitorSyncIdentifiers(Dictionary<string, object> identifiers);
      
      
    • このメソッドのコードサンプルを次に示します。
      var ids = new Dictionary<string, object> ();
      ids.Add ("player1", "jimbob");
      ADBMobile.VisitorSyncIdentifiers(ids);
      
      

獲得メソッド

  • ProcessGooglePlayInstallReferrerUrl *(Androidのみ)*
    Google Play Install Referrer APIの呼び出しから返されたリファラーURLをこのメソッドに渡します。
    • このメソッドの構文を次に示します。
      public static void ProcessGooglePlayInstallReferrerUrl(string referrerUrl);
      
      
    • このメソッドのコードサンプルを次に示します。
      // in actual implementation, the referrer url should be retrieved
      // from the Google Play Install Referrer API.
      var myReferrer = "utm_source=unityTestSource&utm_content=unityTestContent&utm_campaign=unityTestCampaign";
      ADBMobile.ProcessGooglePlayInstallReferrerUrl(myReferrer);