Moments APIモジュール（現在はContext API）

Moments APIはContext APIに名称が変更されました。製品の完全なドキュメントについては、Context APIについてをご覧ください。

Context APIモジュールを使用すると、Tealium AudienceStreamから訪問プロファイルに関する詳細情報を取得できます。この情報を使用して、オーディエンス、バッジ、文字列、ブール値、日付、数値などのさまざまな属性にアクセスすることにより、アプリの顧客体験を向上させることができます。

対応プラットフォーム

以下のプラットフォームがContext APIモジュールをサポートしています：

• iOS
• macOS
• tvOS
• watchOS

インストール

Swift Package Manager、CocoaPods、またはCarthageを使用してContext APIモジュールをインストールします。

Swift Package Manager（推奨）

1. Xcodeプロジェクトで、File > Swift Packages > Add Package Dependency を選択します
2. リポジトリURLを入力します：https://github.com/tealium/tealium-swift
3. バージョンルールを構成します。通常は「“Up to next major”」が推奨されます。現在のTealium Swiftライブラリバージョンがリストに表示されない場合は、Swiftパッケージキャッシュをリセットしてください。
4. インストールして追加するモジュールのリストからTealiumMomentsAPI、TealiumCore、およびTealiumCollectまたはTealiumTagManagementモジュールを選択し、Xcodeプロジェクトの各アプリターゲットのFrameworks and Librariesの下に追加します。

CocoaPods

Podfileに以下のポッドを追加します：

pod 'tealium-swift/Core'
pod 'tealium-swift/Collect' // or 'tealium-swift/TagManagement'
pod 'tealium-swift/MomentsAPI'

Carthage

1. XcodeのアプリターゲットのGeneral構成ページに移動します。

2. 次のフレームワークをEmbedded Binariesセクションに追加します：

   TealiumMomentsAPI.xcframework
   

3. プロジェクトに必要なインポート文を追加します：

   import TealiumCore
   import TealiumCollect // or import TealiumTagManagement
   import TealiumMomentsAPI
   

使用方法

初期化

モジュールを初期化するには、TealiumConfigのcollectorsプロパティに指定する必要があります。

config.collectors = [Collectors.MomentsAPI]
config.momentsAPIRegion = .us_east // 下記の可能なリージョンオプションを参照

リージョンの構成は必須です。リージョンがない場合、Context APIモジュールは初期化されません。

訪問データの取得

fetchEngineResponseメソッドを呼び出してパーソナライズされた訪問データを取得します。これは、アプリ内パーソナライゼーションのユースケースをサポートするために、更新された訪問情報が必要な場合に呼び出す必要があります。

func fetchMoments(engineId: String, completion: @escaping (Result<EngineResponse, Error>) -> Void) {
    tealium?.momentsAPI?.fetchEngineResponse(engineID: engineId) { engineResponse in
        switch engineResponse {
        case .success(let response):
            print("String attributes:", response.strings ?? [])
            print("Boolean attributes:", response.booleans ?? [])
            print("Audiences:", response.audiences ?? [])
            print("Date attributes:", response.dates ?? [:])
            print("Badges:", response.badges ?? [])
            print("Numbers:", response.numbers ?? [:])
        case .failure(let error):
            print("Error fetching moments:", error.localizedDescription)
            if let suggestion = (error as? LocalizedError)?.recoverySuggestion {
                print("Recovery suggestion:", suggestion)
            }
        }
        completion(engineResponse)
    }
}

訪問プロファイルデータ

EngineResponseオブジェクトには、Context APIによって返されるさまざまなタイプの属性が含まれています。以下の表は、利用可能なプロパティとそのデータタイプを示しています：

構成オプション

リージョン

AudienceStreamプロファイルが存在するリージョンに応じてContext APIリージョンを構成します。不明な場合は、アカウントマネージャーに相談してください。

config.momentsAPIRegion = .us_east

カスタムオプションは将来の拡張のためにありますが、指示がない限り使用しないでください。

リファラー

セキュリティをエンリッチメントするために、リファラーURLを指定することができます。このURLはTealium UIの「ドメイン許可リスト」と一致する必要があります。そうでない場合、Context APIはデータを返しません。デフォルトのリファラーURLは以下の通りです：

https://tags.tiqcdn.com/utag/{account}/{profile}/{environment}/mobile.html

以下に示すようにカスタムリファラーURLを指定します：

let config = TealiumConfig(
    account: "tealiummobile",
    profile: "demo",
    environment: "prod"
)
config.momentsAPIReferrer = "https://example.com/"
tealium = Tealium(config: config) { _ in
    // 初期化完了
}

トラブルシューティング

一般的なエラー

Context APIからデータをリクエストする際にエラーが発生することがあります。以下の表は、発生可能なエラーを示しています：