リモート コマンド: Branch

要件

• Dashboard からの Branch Key
• これらのモバイル ライブラリのうちのいずれか:
  • Tealium for Android (Kotlin) (1.0.0 以降)
  • Tealium for Android (Java) (5.9.0 以降)
  • Tealium for iOS (Swift) (2.1.0 以降)
• これらのリモート コマンド統合のいずれか:
  • Branch Remote Command JSON File
  • Branch Remote Command タグ (Tealium iQ タグ管理)

仕組み

Branch 統合は、これらのアイテムを使用します:

1. Branch ネイティブ SDK
2. Branch メソッドをラップするリモート コマンド モジュール
3. イベント トラッキングをネイティブ Branch コールに翻訳する、JSON 構成ファイルまたは Remote Command タグのいずれか

Branch リモート コマンド モジュールをアプリに追加すると、必要な Branch ライブラリが自動的にインストールされ、ビルドされます。この際、ベンダー固有のコードをアプリに追加する必要はありません。依存関係マネージャのインストールを使用している場合、Branch SDK を個別にインストールする必要はありません。

リモート コマンド オプションは、次の 2 つがあります: A JSON 構成ファイル、または、マッピングを構成するための iQ タグ管理の使用。A JSON 構成ファイルは、リモートでホスティングするか、またはアプリ内でローカルでホスティングするかのいずれでも、ベンダー統合の推奨オプションです。iQ タグ管理を使用する場合は、ベンダー統合用のリモート コマンド タグを追加します。ベンダー統合の詳細は、こちらから参照してください。

インストール

依存関係マネージャ

次の依存関係マネージャのいずれかをインストールに使用することをお勧めします。

Tealium iOS（Objective-C）ライブラリを使用している場合は、手動インストール方法を使用してください。CocoaPodsおよびCarthageオプションは、Tealium iOS（Swift）ライブラリを使用している場合にのみ使用可能です。

pod "TealiumBranch"

'tealium-swift/Core'
'tealium-swift/RemoteCommands'
'tealium-swift/TagManagement'

github "tealium/tealium-ios-branch-remote-command"

dependencies {
      implementation 'com.tealium.remotecommands:branch:1.0.0'
}

手動による手順（iOS）

Brahch リモート コマンドを手動でインストールするには、 Tealium for Swift ライブラリがインストールされている必要があります。iOS プロジェクトの Branch リモート コマンドをインストールするには:

1. Branch SDK をまだインストールしていない場合はインストールします。

2. Tealium iOS Branch リモート コマンド レポジトリをクローンして、 Sources フォルダ内のファイルをプロジェクトにドラッグします。 GitHub リポジトリ: https://github.com/tealium/tealium-ios-branch-remote-command

3. remoteAPIEnabled 構成フラッグを trueに構成します。

手動（Android）

Branch リモート コマンドを手動でインストールするには、 Tealium for Android (Kotlin) または Tealium for Android (Java) がインストールされている必要があります。

Android プロジェクトの Branch リモート コマンドをインストールするには:

1. flatDirをプロジェクトのルートにあるbuild.gradleファイルに追加します。

allprojects {
      repositories {
         mavenCentral()
         flatDir {
             dirs 'libs'
         }
      }
}

2. tealium-branch.aar を <PROJECT_ROOT>/<MODULE>/libsに追加します。

3. Tealiumライブラリの依存関係をbuild.gradleファイルに追加します。

dependencies {
      implementation(name:'tealium-branch', ext:'aar')
}

初期化

すべての Tealium ライブラリについて、初期化時に Branch モバイル リモート コマンドを登録します。

Android (Kotlin)

Tealium の Kotlin ライブラリ用の JSON 構成ファイルまたはリモート コマンド タグを用いてリモート コマンドを初期化します。

val config = TealiumConfig(application,
      "ACCOUNT",
      "PROFILE",
      Environment.DEV,
      dispatchers = mutableSetOf(Dispatchers.RemoteCommands));

var tealium = Tealium.create(TEALIUM_MAIN, config) {
    val branch = BranchRemoteCommand(application);
    remoteCommands?.add(branch, filename = "branch.json");
}

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands));

var tealium = Tealium.create(TEALIUM_MAIN, config) {
    val branch = BranchRemoteCommand(application);
    remoteCommands?.add(branch);
}

Android (Java)

Tealium の Android (Java) ライブラリ用のリモート コマンド タグを用いてリモート コマンドを初期化します。

RemoteCommand branch = new BranchRemoteCommand(application);
teal.addRemoteCommand(branch);

iOS (Swift)

Tealium の iOS (Swift) ライブラリ用の JSON 構成ファイルまたはリモート コマンド タグを用いてリモート コマンドを初期化します。

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE")
config.remoteAPIEnabled = true

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }
    let branch = BranchRemoteCommand(type: .local(file: "branch"))
    remoteCommands.add(branch)
}

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE")
config.remoteAPIEnabled = true

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }
    let branch = BranchRemoteCommand()
    remoteCommands.add(branch)
}

JSON テンプレート

JSON 構成ファイルを使用してリモート コマンドを構成しようとする場合は、まず、以下のテンプレートを参照します。テンプレートには、標準的なインストールに用いられる共通マッピングが含まれいます。必要に応じて、マッピングを編集します。

{
  "config": {
    "settings": {
      "enable_logging": true,
      "branch_dev_key": "branch_key",
      "collect_device_id": true
    }
  },
  "mappings": {
    "tealium_event": "event.description",
    "description": "buo.description",
    "item_id": "buo.canonical_identifier",
    "title": "buo.title",
    "feature": "link.feature",
    "channel": "link.channel",
    "campaign": "link.campaign",
    "latitude": "metadata.latitude",
    "longitude": "metadata.longitude",
    "currency_code": "metadata.currency_type",
    "customer_id": "event.user_id",
    "coupon": "metadata.coupon",
    "product_brand": "metadata.product_brand",
    "product_category": "metadata.product_category",
    "product_id": "metadata.sku",
    "product_name": "metadata.product_name",
    "product_variant": "metadata.product_variant",
    "product_unit_price": "metadata.price",
    "product_quantity": "event.quantity",
    "currency_type": "event.currency",
    "order_tax": "event.tax"
  },
  "commands": {
    "launch": "initialize",
    "user_login": "login,setuserid",
    "user_register": "completeregistration",
    "show_offers": "clickad",
    "cart_add": "addtocart",
    "wishlist_add": "addtowishlist",
    "payment": "addpaymentinfo",
    "level_up": "achievelevel",
    "email_signup": "subscribe",
    "product": "viewitem",
    "share": "share",
    "rate": "rate",
    "search": "search",
    "invite": "invite",
    "order": "initiatepurchase",
    "record_score": "record_score",
    "teal_custom_event": "teal_custom_event"
  }
}

サポートされているメソッド

以下の Branch メソッドは、以下の Tealium コマンドを使用し、Branch リモート コマンド タグのデータ マッピングを使用してトリガーされます。

iOS Remote Commands リモート コマンド

Android Remote Commands リモート コマンド

標準イベント名

以下の標準イベント コマンド名は、 logEvent メソッドでサポートされています。コマンドが送信され、イベントに関してすべての必要な変数がマッピングされ、定義されたときは、Branch SDK でコマンドが自動的にトリガーされます。

SDKのセットアップ

Branch SDK の詳細は、こちらから参照してください:

• Branch iOS SDK
• Branch Android SDK

初期化

Branch SDK は起動時に自動的に初期化されます。Branch Key は、JSON 構成ファイル内の、Info.plist または branch_dev_key に構成されます。

Branch リモート コマンド タグに利用できる構成オプションは若干あります。以下のいずれかが起動時に構成された場合は、 configure() メソッドの実行中に送信されます。

構成オプション

アイデンティティ リンクの送信