Show Menu
トピック×

Android methods

Experience Cloud ソリューション 4.x SDK 用 Xamarin コンポーネントの Android メソッド。

Configuration methods

  • DebugLogging
    現在のデバッグログの環境設定を返し、デフォルトはfalseです。
    • このメソッドの構文を次に示します。
      public static Boolean DebugLogging;
      
      
    • このメソッドのコードサンプルを次に示します。
      getter: var debuglog = Config.DebugLogging;
      setter: Config.DebugLogging = (Java.Lang.Boolean)true;
      
      
  • LifetimeValue
    現在のユーザーのライフタイム値を返します。
    • このメソッドの構文を次に示します。
      public static BigDecimal LifetimeValue; 
      
      
    • このメソッドのコードサンプルを次に示します。
       var lifetimeValue = Config.LifetimeValue;
      
      
  • PrivacyStatus
    現在のユーザーのプライバシーステータスの enum 表現を返します。
    • ADBMobilePrivacyStatus.OptIn — ヒットは直ちに送信されます。
    • ADBMobilePrivacyStatus.OptOut — ヒットは破棄されます。
    • ADBMobilePrivacyStatus.Unknown - オフライン追跡が有効になっている場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。オフライン追跡が有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。 デフォルト値は ADBMobileConfig.json ファイルに設定します。
    • このメソッドの構文を次に示します。
      public static MobilePrivacyStatus PrivacyStatus; 
      
      
    • このメソッドのコードサンプルを次に示します。
      getter: var privacyStatus = Config.PrivacyStatus; 
      setter: Config.PrivacyStatus = MobilePrivacyStatus.MobilePrivacyStatusUnknown;
      
      
  • UserIdentifier
    カスタム識別子が設定されている場合、この識別子を返します。 カスタム識別子が設定されていない場合は、nullを返します。 デフォルト値は null です。
    • このメソッドの構文を次に示します。
      public static UserIdentifier();
      
      
    • このメソッドのコードサンプルを次に示します。
      getter: var userId = Config.UserIdentifier;
      setter: Config.UserIdentifier = "imBatman";
      
      
  • Version
    ライブラリのバージョンを取得します。
    • このメソッドの構文を次に示します。
      public static string Version;
      
      
    • このメソッドのコードサンプルを次に示します。
      var version = ADBMobile.Version;
      
      
  • PauseCollectingLifecycleData
    ライフサイクル指標が正しく計算されるように、アプリが一時停止されたことを SDK に通知します。例えば、一時停止中にタイムスタンプを収集して、セッションの長さの計測を一時停止します。また、クラッシュ回数を正しく計測するためのフラグを設定します。詳しくは、 ライフサイクル指標 を参照してください。
    • このメソッドの構文を次に示します。
      public static void PauseCollectingLifecycleData (); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Config.PauseCollectingLifecycleData();
      
      
  • CollectLifecycleData(Activity アクティビティ)
    (4.2 以降)SDK のすべてのソリューションで使用するために、ライフサイクルデータが収集される必要があることを SDK に通知します。詳しくは、 ライフサイクル指標 を参照してください。
    • このメソッドの構文を次に示します。
      public static void collectLifecycleData(Activity activity); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Config.CollectLifecycleData (this);
      
      
  • CollectLifecycleData(Activity アクティビティ)
    (4.2 以降)SDK のすべてのソリューションで使用するために、ライフサイクルデータが収集される必要があることを SDK に通知します。詳しくは、 ライフサイクル指標 を参照してください。
    • このメソッドの構文を次に示します。
      public static void collectLifecycleData(Activity activity, IDictionary<string, Object> context));
      
      
    • このメソッドのコードサンプルを次に示します。
      IDictionary<string, Java.Lang.Object> context = new Dictionary<string, 
      Java.Lang.Object> ();
      context.Add ("key", "value");
      Config.CollectLifecycleData (this, context);
      
      
  • OverrideConfigStream
    (4.2 or later) Lets you load a different ADBMobile JSON config file when the application starts. アプリケーションが閉じられるまで、この設定が使用されます。
    • このメソッドの構文を次に示します。
      public static void OverrideConfigStream (Stream stream);
      
      
    • このメソッドのコードサンプルを次に示します。
      Stream st1 = Assets.Open ("ADBMobileConfig-2.json"); 
      Config.OverrideConfigStream (st1); 
      
      
  • SetLargeIconResourceId(int resourceId)
    (4.2以降)SDKによって作成される通知に使用する大きいアイコンを設定します。 This icon is the primary image that is displayed when the user sees the complete notification in the notification center.
    • このメソッドの構文を次に示します。
      public static void SetLargeIconResourceId( int resourceId);
      
      
    • このメソッドのコードサンプルを次に示します。
      Config.SetLargeIconResourceId(R.drawable.appIcon);
      
      
  • SetSmallIconResourceId(int resourceId)
    (4.2以降)SDKによって作成される通知に使用する小さいアイコンを設定します。 This icon displays in the status bar and is the secondary image shown when the user sees the complete notification in the notification center.
    • このメソッドの構文を次に示します。
      public static void SetSmallIconResourceId( int resourceId); 
      
      
    • このメソッドのコードサンプルを次に示します。
       Config.SetSmallIconResourceId(R.drawable.appIcon);
      
      

Analytics methods

  • TrackingIdentifier
    Analytics 用に自動的に生成された ID を返します。これは、初回起動時に生成され、その時点から保存および使用される、アプリ固有の一意のIDです。 このIDは、アプリのアップグレードの間も保持され、アンインストール時に削除されます。
    • このメソッドの構文を次に示します。
      public static string TrackingIdentifier;
      
      
    • このメソッドのコードサンプルを次に示します。
      Var trackingId = Analytics.TrackingIdentifier
      
      
  • TrackState
    オプションのコンテキストデータを使用してアプリの状態を追跡します。 States は、「title screen」、「level 1」、「pause」、など、アプリで表示される状態(画面)のことです。これらの状態は Web サイト上のページによく似ており、 TrackState コールはページビュー数を増分します。状態が空の場合、レポートに「app name app version (build)」と表示されます。レポートにこの値がある場合、各 TrackState 呼び出しで state を設定していることを確認してください。
    これは、ページビュー数を増やす唯一のトラッキングコールです。
    • このメソッドの構文を次に示します。
      public static void TrackState (string state, IDictionary<string, Object> cdata); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var cdata = new Dictionary<string, Java.Lang.Object>(); 
      cdata.Add ("key", (Java.Lang.Object)"value"); 
      Analytics.TrackState ("stateName", (IDictionary<string, 
      Java.Lang.Object>)cdata);
      
      
  • TrackAction
    アプリのアクションを追跡します。アクションとは、アプリ内で計測に価する重要な操作のことで、「deaths」、「level gained」、「feed subscriptions」などの指標があります。
    If you have code that might run while the app is in the background (for example, a background data retrieval), use trackActionFromBackground instead.
    • このメソッドの構文を次に示します。
      public static void TrackAction(string action, IDictionary<string,Object> cdata); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var cdata = new Dictionary<string, Java.Lang.Object> (); 
      cdata.Add ("key", (Java.Lang.Object)"value");
      Analytics.TrackAction ("actionName", (IDictionary<string, 
      Java.Lang.Object>)cdata);
      
      
  • TrackLocation
    現在地点の緯度と経度の座標を送信します。Also uses points of interest defined in the ADBMobileConfig.json file to determine whether the location that was provided as a parameter is in any of your POIs. 現在の座標が定義した目標地点内にある場合、コンテキストデータ変数に代入され、 TrackLocation コールで送信されます。
    • このメソッドの構文を次に示します。
      public static void TrackLocation(Location location, IDictionary<string, Object> cdata); 
      
      
    • このメソッドのコードサンプルを次に示します。
       Location loc = new Location(LocationManager.GpsProvider);;
       loc.Latitude = 111; 
       loc.Longitude = 44; 
       loc.Accuracy = 5; 
       Analytics.TrackLocation (loc, null);
      
      
  • TrackBeacon
    ユーザーがいつビーコンの Proximit (圏内) に入ったかを追跡します。
    • このメソッドの構文を次に示します。
      public static void TrackBeacon (string uuid, string major, string minor,  Analytics.BEACON_PROXIMITY prox, IDictionary<string, Object> cdata); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Analytics.TrackBeacon ("UUID", "1", "2", 
      Analytics.BEACON_PROXIMITY.ProximityImmediate, null); 
      
      
  • ClearBeacon
    ユーザーがビーコンの Proximity を離れた場合に、ビーコンデータをクリアします。
    • このメソッドの構文を次に示します。
      public static void TrackingClearCurrentBeacon();
      
      
    • このメソッドのコードサンプルを次に示します。
      Analytics.ClearBeacon(); 
      
      
  • TrackLifetimeValueIncrease
    ユーザーのライフタイム値に値を加算します。
    • このメソッドの構文を次に示します。
      public static void TrackLifetimeValueIncrease (double amount, IDictionary<string,Object> cdata); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Analytics.TrackLifetimeValueIncrease(5,null);
      
      
  • TrackTimedActionStart
    指定アクションの時間計測を開始します。既に開始しているアクションでこのメソッドを呼び出すと、以前の時間計測アクションが上書きされます。
    この呼び出しはヒットを送信しません。
    • このメソッドの構文を次に示します。
      public static void TrackTimedActionStart(string action,IDictionary<string, Object> cdata); 
      
      
    • Here is code sample for this method:
      Analytics.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    特定のアクションに関連付けられたコンテキストデータを指定データで更新します。渡されたデータは、特定のアクションの既存のデータに追加され、同じキーが既にアクションに定義されている場合は、データを上書きします。
    この呼び出しはヒットを送信しません。
    • このメソッドの構文を次に示します。
      public static void TrackTimedActionUpdate(string action, IDictionary<string, Object> cdata); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var updatedData = new Dictionary<string, Java.Lang.Object> (); 
      cdata.Add ("key", (Java.Lang.Object)"value"); 
      Analytics.TrackTimedActionUpdate("level2", updatedData); 
      
      
  • TrackTimedActionEnd
    時間計測アクションを終了します。
    • このメソッドの構文を次に示します。
      public static void TrackTimedActionEnd(string action,
        Analytics.ITimedActionBlock block);
      
      
    • このメソッドのコードサンプルを次に示します。
      Analytics.TrackTimedActionEnd ("level2", new TimedActionBlock()); 
           class TimedActionBlock: Java.Lang.Object, 
      Analytics.ITimedActionBlock{ 
           public Java.Lang.Object Call (long inAppDuration, long 
      totalDuration IDictionary<string, Java.Lang.Object> contextData){ 
           return Java.Lang.Boolean.True; 
        } 
      }
      
      
  • TrackingTimedActionExists
    時間計測アクションが進行中かどうかを返します。
    • このメソッドの構文を次に示します。
      public static bool TrackingTimedActionExists(string action); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var level2InProgress = Analytics.TrackingTimedActionExists("level2"); 
      
      
  • SendQueuedHits
    Forces the library to send all hits in the offline queue, regardless of how many hits are currently queued.
    • このメソッドの構文を次に示します。
      public static void SendQueuedHits();
      
      
    • このメソッドのコードサンプルを次に示します。
      Analytics.SendQueuedHits(); 
      
      
  • ClearQueue
    オフラインキューからすべてのヒットをクリアします。
    • このメソッドの構文を次に示します。
      public static void ClearQueue(); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Analytics.ClearQueue(); 
      
      
  • QueueSize
    現在オフラインキューにあるヒットの数を取得します。
    • このメソッドの構文を次に示します。
      public static long QueueSize(); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var queueSize = Analytics.QueueSize();
      
      

Experience Cloud ID methods

  • MarketingCloudId
    Experience Cloud ID を ID サービスから取得します。
    • このメソッドの構文を次に示します。
      public static string MarketingCloudId;
      
      
    • このメソッドのコードサンプルを次に示します。
      var mcid = Visitor.MarketingCloudId;
      
      
  • SyncIdentifiers
    Experience Cloud ID を使用すると、追加の顧客 ID を設定して、各訪問者に関連付けることができます。訪問者 API は、同じ訪問者に対して複数の顧客 ID と、異なる顧客 ID の範囲を区別するための顧客タイプ識別子を受け取ります。このメソッドは、JavaScript ライブラリの setCustomerIDs に相当します。
    • このメソッドの構文を次に示します。
      public static void SyncIdentifiers((IDictionary<string> identifiers);
      
      
    • このメソッドのコードサンプルを次に示します。
      IDictionary<string,string> ids = new Dictionary<string, string> ();
      ids.Add ("pushID", ;"value2");
      Visitor.SyncIdentifiers (ids);
      
      

Target メソッド

  • LoadRequest
    Sends a request to your configured Target server and returns the string value of the offer generated in a Action<NSDictionary> callback.
    • このメソッドの構文を次に示します。
      public static void LoadRequest (TargetLocationRequest request, Target.ITargetCallback callback); 
      
      
    • このメソッドのコードサンプルを次に示します。
      class TargetBlock: Java.Lang.Object, Target.ITargetCallback{ 
          public void Call (Java.Lang.Object content) 
         { 
          Console.WriteLine (content.ToString()); 
         } 
      } 
      var req = Target.CreateRequest ("AndroidTest", "defGal", parameters); 
           Target.LoadRequest (req, new TargetBlock()); 
      
      
  • CreateRequest
    指定したパラメーターを持つ ADBTargetLocationRequest オブジェクトを作成する便利なコンストラクターです。
    • このメソッドの構文を次に示します。
      public static TargetLocationRequest TargetCreateRequest(string name,string defaultContent,IDictionary<string,string> parameters); 
      
      
    • このメソッドのコードサンプルを次に示します。
      IDictionary<string, Java.Lang.Object> parameters = new Dictionary> string, Java.Lang.Object> (); 
          parameters.Add ("key1", "value2"); 
      var req = Target.CreateRequest ("AndroidTest", "defGal", parameters); 
      
      
  • CreateOrderConfirmRequest
    を作成しま ADBTargetLocationRequest す。
    • このメソッドの構文を次に示します。
      public static TargetLocationRequest TargetCreateRequest (string name, string defaultContent, IDictionary<;string, string> parameters);
      
      
    • このメソッドのコードサンプルを次に示します。
      var orderConfirm = Target.CreateOrderConfirmRequest ("myOrder", "12345", "29.41", "cool stuff", null); 
      
      
  • ClearCookies
    アプリからTargetのCookieをクリアします。
    • このメソッドの構文を次に示します。
      public static void ClearCookies(); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Target.ClearCookies (); 
      
      

Audience Manager

  • VisitorProfile
    取得された最も直近の訪問者プロファイルを返します。まだシグナルが送信されていない場合は nil を返します。訪問者プロファイルは、次回以降のアプリ起動時も簡単にアクセスできるように、 NSUserDefaults に保存されます。
    • このメソッドの構文を次に示します。
      public static IDictionary<string, Object> VisitorProfile; 
      
      
    • このメソッドのコードサンプルを次に示します。
      NSDictionary profile = AudienceManager.VisitorProfile; 
      
      
  • Dpid
    Returns the current DPID .
    • このメソッドの構文を次に示します。
      public static string Dpuuid; 
      
      
    • このメソッドのコードサンプルを次に示します。
      string currentDpid = AudienceManager.Dpid;
      
      
  • Dpuuid
    Returns the current DPUUID .
    • このメソッドの構文を次に示します。
      public static string AudienceDpuuid; 
      
      
    • このメソッドのコードサンプルを次に示します。
      string currentDpuuid = AudienceManager.Dpuuid;
      
      
  • AudienceSetDpidAndDpuuid
    とを設定し dpid ます dpuuid 。 If dpid and dpuuid are set, they are sent with each signal.
    • このメソッドの構文を次に示します。
      public static void AudienceSetDpidAndDpuuid (string Dpid, String Dpuuid);
      
      
    • このメソッドのコードサンプルを次に示します。
      AudienceManager.SetDpidAndDpuuid ("testDpid", "testDpuuid");
      
      
  • SignalWithData
    Sends audience management a signal with traits and get the matching segments returned in a Action<NSDictionary> callback.
    • このメソッドの構文を次に示します。
      public static void SignalWithData (IDictionary<string, Object> audienceData, AudienceManager.IAudienceManagerCallback callback); 
      
      
    • このメソッドのコードサンプルを次に示します。
      class AudienceManagerCallback: Java.Lang.Object, 
       AudienceManager.IAudienceManagerCallback{ 
         public void Call (Java.Lang.Object content) 
        {
          Console.WriteLine (content.ToString()); 
        }
      }
      IDictionary<string, Java.Lang.Object> traits = new Dictionary<string, 
      Java.Lang.Object> (); 
         traits.Add ("trait", "b");
      AudienceManager.SignalWithData (traits, new AudienceManagerCallback());
      
      
  • リセット
    Audience Manager UUID をリセットし、現在の訪問者プロファイルを削除します。
    • このメソッドの構文を次に示します。
      public static void Reset ();
      
      
    • このメソッドのコードサンプルを次に示します。
       AudienceManager.Reset ();
      
      

Video

ビデオ分析について詳しくは、ビデオ分析を参照 してください
  • MediaSettings
    指定したパラメーターと共に MediaSettings オブジェクトを返します。
    • このメソッドの構文を次に示します。
      public static MediaSettings SettingsWith (string name, double length, string playerName, string playerID);  
      
      
    • このメソッドのコードサンプルを次に示します。
      MediaSettings settings = Media.SettingsWith("name1", 10, "playerName1", "playerID1");
      
      
  • AdSettingsWith
    広告ビデオの追跡に使用する MediaSettings オブジェクトを返します。
    • このメソッドの構文を次に示します。
      public static MediaSettings AdSettingsWith ( string name, double length, 
        string playerName, string parentName, string parentPod, 
      double parentPodPosition, string CPM); 
      
      
    • このメソッドのコードサンプルを次に示します。
      MediaSettings adSettings = Media.AdSettingsWith ("adName1", 2, "playerName1", "name1", "podName1", 4, "CPM1"); 
      
      
  • Open
    追跡する ADBMediaSettings オブジェクトを開きます。
    • このメソッドの構文を次に示します。
      public static void Open (MediaSettings settings, Media.IMediaCallback callback);
      
      
    • このメソッドのコードサンプルを次に示します。
      MediaSettings settings = Media.SettingsWith ("name1", 10, "playerName1", "playerID1"); 
         Media.Open (settings, new MediaCallback()); 
         class MediaCallback: Java.Lang.Object, Media.IMediaCallback{ 
      public void Call (Java.Lang.Object content) 
      {
      }
      }
      
      
  • 閉じる
    指定された名前のメディアアイテムを閉じます。
    • このメソッドの構文を次に示します。
      public static void Close(string name);
      
      
    • このメソッドのコードサンプルを次に示します。
      Media.Close (settings.Name); 
      
      
  • Play
    指定された名前のメディアアイテムを指定されたオフセット(秒)で再生したことを記録します。
    • このメソッドの構文を次に示します。
      public static void Play ( string name, double offset); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Media.Play (settings.Name, 0); 
      
      
  • 完了
    指定されたオフセットでメディアアイテムが再生完了された、と手動で記録します。
    • このメソッドの構文を次に示します。
      public static void Complete (string name, double offset); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Media.Complete (settings.Name, 5); 
      
      
  • Stop
    指定されたオフセットでビデオが停止または一時停止されたことを記録します。
    • このメソッドの構文を次に示します。
      public static void Stop ( string name, double offset); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Media.Stop (settings.Name, 3);
      
      
  • クリック
    メディアアイテムがクリックされたことを記録します。
    • このメソッドの構文を次に示します。
      public static void Click ( string name, double offset); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Media.Click (settings.Name, 3); 
      
      
  • Track
    現在のメディア状態をトラックアクション呼び出し(ページビューがカウントされない方式)で送信します。
    • このメソッドの構文を次に示します。
      public static void Track ( string name, NSDictionary data); 
      
      
    • このメソッドのコードサンプルを次に示します。
      Media.Track (settings.Name, null);