APIリファレンス

クラス: Tealium

Tealium XamarinライブラリのTealiumクラスのメソッドと定数。

AddRemoteCommand()

リモートコマンドをリモートコマンドマネージャに追加します。

void AddRemoteCommand(IRemoteCommand remoteCommand);

例:

public class MyRemoteCommand : IRemoteCommand
    {
        public string CommandId => "my_remote_command";
        public string Description => "description of my remote command";
        public string Path => null;
        public string Url => null;

        public void Dispose()
        {
            //
        }

        public void HandleResponse(IRemoteCommandResponse response)
        {
            var str = response.Payload.GetValueForKey<String>("key");
            if (str == "")
            {
                // etc
            }
        }
    }

tealium.AddRemoteCommand(new MyRemoteCommand());

AddToDataLayer()

指定された有効期限のためにデータを永続データストレージに追加します。

void AddToDataLayer(IDictionary<string, object> data, Expiry expiry);

tealium.AddToDataLayer(new Dictionary<string, object> {
  { "user_language", lang }
}, Expiry.Forever);

ClearStoredVisitorIds()

保存されている訪問IDをクリアし、新しいIDを生成します。主に法的なコンプライアンスのために使用されます。

データレイヤーにvisitorIdentityKeyというキーが含まれている場合、訪問IDはそのキーに基づいて引き続き保存されます。

tealium.ClearStoredVisitorIds();

保存がクリアされた後に現在のアイデンティティと新しくリセットされたvisitorIdを保存しないようにするには、データレイヤーからアイデンティティキーを事前に削除する必要があります（RemoveFromDataLayer()を参照）。

ConsentCategory

同意カテゴリの値。GetConsentCategoriesおよびSetConsentCategoriesで使用します。

同意カテゴリは次のとおりです。

• ConsentManager.ConsentCategory.Analytics
• ConsentManager.ConsentCategory.Affiliates
• ConsentManager.ConsentCategory.BigData
• ConsentManager.ConsentCategory.Cdp
• ConsentManager.ConsentCategory.CookieMatch
• ConsentManager.ConsentCategory.Crm
• ConsentManager.ConsentCategory.DisplayAds
• ConsentManager.ConsentCategory.Email
• ConsentManager.ConsentCategory.Engagement
• ConsentManager.ConsentCategory.Misc
• ConsentManager.ConsentCategory.Mobile
• ConsentManager.ConsentCategory.Monitoring
• ConsentManager.ConsentCategory.Personalization
• ConsentManager.ConsentCategory.Search
• ConsentManager.ConsentCategory.Social

ConsentStatus

同意ステータスの値。SetConsentStatus()で使用します。

Environment

環境は、3つのデフォルト環境（Dev、QA、Prod）または公開する任意のカスタム環境のいずれかです。

Expiry

永続または揮発性データの有効期間を定義します。AddToDataLayer()で使用します。

GetFromDataLayer()

永続データレイヤーから指定されたキーの値を取得します。

object? GetFromDataLayer(string key);

string myString = (string)tealium.GetFromDataLayer("user_language");

GetConsentCategories()

ユーザーが同意したカテゴリのリストを取得します。

List<ConsentCategory>? GetConsentCategories();

例:

tealium.GetConsentCategories().ForEach((c) =>
{
    if (c == ConsentManager.ConsentCategory.Analytics)
    {
        // Analyticsに同意済み
    }
});

GetConsentStatus()

ユーザーの同意の現在の状態を取得します。ConsentStatusの値を返します。

ConsentStatus GetConsentStatus();

例:

switch (tealium.GetConsentStatus()) {
    case ConsentManager.ConsentStatus.Unknown:
        break;
    case ConsentManager.ConsentStatus.Consented:
        break;
    case ConsentManager.ConsentStatus.NotConsented:
        break;
}

GetVisitorId()

ユーザーの訪問IDを取得し、コールバック関数の形式で返します。

string? visitorId = tealium.GetVisitorId();

JoinTrace()

指定したIDでトレースに参加します。Tealium Customer Data Hubのトレース機能について詳しくは、リンクを参照してください。

tealium.JoinTrace(id);

LeaveTrace()

トレースは、leaveTrace()メソッドが呼び出されるまでアプリのセッションの間有効であり、以前に参加したトレースを終了し、訪問セッションを終了します。

tealium.LeaveTrace();

RemoveFromDataLayer()

AddToDataLayer()を使用して以前に構成された永続データを削除します。

void RemoveFromDataLayer(ICollection<string> keys);

tealium.RemoveFromDataLayer(new string[] { "key1", "key2" });

RemoveRemoteCommand()

リモートコマンドマネージャからリモートコマンドを削除します。

void RemoveRemoteCommand(string id);

tealium.RemoveRemoteCommand("firebase");

ResetVisitorId()

訪問IDをリセットし、新しいIDを生成します。

tealium.ResetVisitorId();

SetConsentCategories()

ユーザーが同意したカテゴリのリストを構成します。ConsentCategoryと一緒に使用します。

void SetConsentCategories(List<ConsentCategory> categories);

tealium.SetConsentCategories(new List<ConsentManager.ConsentCategory>()
{
    ConsentManager.ConsentCategory.DisplayAds,
    ConsentManager.ConsentCategory.Analytics
});

SetConsentExpiryListener()

同意の有効期限が切れたときに実行するコールバックメソッドを構成します。

void SetConsentExpiryListener(Action callback);

tealium.SetConsentExpiryListener(() =>
{
    System.Diagnostics.Debug.WriteLine("同意の有効期限が切れました");
});

SetConsentStatus()

ユーザーの同意ステータスを構成します。デフォルト値は.Unknownです。

void SetConsentStatus(ConsentStatus status);

tealium.SetConsentStatus(ConsentManager.ConsentStatus.NotConsented);

SetVisitorServiceListener()

訪問プロファイルが更新されたときに実行するコールバック関数を構成します。更新されたVisitorProfileはコールバック応答で提供されます。visitorServiceEnabledがtrueに構成されている場合に使用します。

Tealium AudienceStreamのライセンスを持っており、モバイルアプリケーションでユーザーエクスペリエンスを向上させるために訪問プロファイルを使用したい場合にこの機能を使用します。

void SetVisitorServiceListener(Action callback);

tealium.SetVisitorServiceListener((visitorProfile) =>
{
    System.Diagnostics.Debug.WriteLine("訪問が更新されました");
    System.Diagnostics.Debug.WriteLine($"訪問: {visitorProfile}");
});

TerminateIntance()

Tealiumライブラリを無効にし、すべてのモジュール参照を削除します。

tealium.TerminateIntance();

Track()

TealiumEventまたはTealiumViewディスパッチでイベントをトラッキングします。

tealium.Track(dispatch);

TealiumView

画面ビューをトラッキングするには、TealiumView(viewName, data)のインスタンスをTrack()メソッドに渡します。TealiumViewは、トラッキングコールでtealium_eventとして表示されるビュー名とオプションのデータディクショナリで構成されています。

let tealView = TealiumView("VIEW_NAME", {"key": "value"});
tealium.Track(tealView);

TealiumEvent

ビュー以外のイベントをトラッキングするには、TealiumEvent(eventName, data)のインスタンスをTrack()メソッドに渡します。TealiumEventは、トラッキングコールでtealium_eventとして表示されるイベント名とオプションのデータディクショナリで構成されています。

let tealEvent = TealiumEvent("EVENT_NAME", {"key": "value"});
tealium.Track(tealEvent);

クラス: TealiumConfig

TealiumConfigクラスのプロパティを要約します。

Collectors

コレクタは、デバイスから補足情報を収集し、Tealium Customer Data Hubに送信する前にデータレイヤーに追加するモジュールです。一部のコレクタはコアライブラリに含まれており、他のコレクタはオプションとして別のモジュールとしてインストールされます。

次のテーブルに、利用可能なコレクタをリストします。デフォルトのコレクタは、コレクタ名の横に*が付いています。

これらのモジュールは、TealiumConfigで構成されたCollectorsプロパティを使用して有効または無効にできます。

TealiumConfig tealConfig = new TealiumConfig(
    // ...
    new List<Collectors> {
        Collectors.LifeCycle, Collectors.Device
    }
    // ...
);

ConsentExpiry

TealiumConfigオブジェクトの同意構成の有効期限を構成します。

TealiumConfig config = new TealiumConfig(
  //...
  consentExpiry = new TimeUnit(90, TimeUnit.Days)),
  //...
);

ConsentPolicy

TealiumConfigオブジェクトで使用する同意ポリシーを構成します。同意ポリシーが構成されていない場合、同意マネージャーは無効になります。

TealiumConfig config = new TealiumConfig(
  //...
  consentPolicy = ConsentPolicy.GDPR,
  //...
);

同意値:

• ConsentPolicy.GDPR
• ConsentPolicy.CCPA

Dispatchers

ディスパッチャは、データをTealiumエンドポイントに送信するモジュールです。これらはTealiumConfigオブジェクトに構成されます。

TealiumConfig tealConfig = new TealiumConfig(
    // ...
    new List<Dispatchers> {
        Dispatchers.Collect, Dispatchers.RemoteCommands
    }
    // ...
);

次のディスパッチャが利用可能です。

• Dispatchers.Collect
• Dispatchers.RemoteCommands
• Dispatchers.TagManagement

少なくとも1つのディスパッチャが必要です。

LogLevel

ログレベルプロパティを構成し、ログに記録される情報量を制御します。次の値のいずれかを構成します。

IRemoteCommand

構成済みのリモートコマンドを定義するインターフェース。

IVisitorProfile

（TealiumConfig.visitorServiceEnabledで使用するため。）

訪問プロファイルオブジェクトには、訪問サービスから返される訪問属性が含まれています。currentVisitプロパティには、現在の訪問にスコープが限定された属性が含まれています。各属性の値は、サブスクリプトを使用してIDでアクセスします。属性が存在しない場合は、nullが返されます。

ICurrentVisit

現在の訪問にスコープが限定された属性を含むオブジェクト。