リモートコマンド：Facebook

要件

• 以下のモバイルライブラリのいずれか：
  • Tealium for Android (Kotlin) (1.0.0+).
  • Tealium for Android (Java) (Facebook 1.0.0+の場合は5.9.0+、それ以前のバージョンの場合は<5.9.0).
  • Tealium for iOS (Swift).
• 以下のリモートコマンド統合のいずれか：
  • Facebook Remote Command JSON File (Android-Kotlin 1.0.0+またはiOS-Swift 2.1.0+が必要).
  • Tealium iQ Tag ManagementのFacebook Remote Commandタグ。

iOSおよびAndroidに必要な要件は以下の通りです：

<string name="facebook_app_id">[APP_ID]</string>
<string name="fb_login_protocol_scheme">fb[APP_ID]</string>
<string name="facebook_client_token">[CLIENT_TOKEN]</string>

<application android:label="@string/app_name" ...>
    ...
    <meta-data
      android:name="com.facebook.sdk.ApplicationId"
      android:value="@string/facebook_app_id" />
    <meta-data 
        android:name="com.facebook.sdk.ClientToken"
        android:value="@string/facebook_client_token" />
    ...
</application>

<key>CFBundleURLTypes</key>
<array>
  <dict>
  <key>CFBundleURLSchemes</key>
  <array>
    <string>fb[APP_ID]</string>
  </array>
  </dict>
</array>
<key>FacebookAppID</key>
<string>[APP_ID]</string>
<key>FacebookDisplayName</key>
<string>[APP_NAME]</string>
<key>FacebookClientToken</key>
<string>[CLIENT_TOKEN]</string>

動作原理

Facebook統合は3つの要素を使用します：

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

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

リモートコマンドのオプションは2つあります：JSON構成ファイル、またはiQ Tag Managementを使用してマッピングを構成します。ベンダー統合には、リモートまたはアプリ内にローカルでホストされたJSON構成ファイルが推奨されます。iQ Tag Managementを使用する場合は、ベンダー統合のためのRemote Commandタグを追加します。ベンダー統合についての詳細を学びましょう。

インストール

依存関係マネージャ

マニュアルインストール

初期化

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

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE")
config.dispatchers = [Dispatchers.TagManagement, Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // リモートコマンドを使用するために必要

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

    // Webviewタグ
    let facebook = FacebookRemoteCommand(launchOptions: launchOptions) 

    // ローカルJSON
    //let facebook = FacebookRemoteCommand(type: .local(file: "facebook"), launchOptions: launchOptions) 

    // リモートJSON
    //let facebook = FacebookRemoteCommand(type: .remote(url: "https://some.domain.com/facebook.json"), launchOptions: launchOptions) 

    remoteCommands.add(facebook)
}

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

var tealium = Tealium.create(TEALIUM_MAIN, config) {
    // Webviewタグ
    remoteCommands?.add(facebook); 

    // ローカルJSON
    //remoteCommands?.add(facebook, filename = "facebook.json"); 

    // リモートJSON
    //remoteCommands?.add(facebook, remoteUrl = "https://some.domain.com/facebook.json"); 
}

import com.tealium.remotecommands.facebook.FacebookRemoteCommand;

Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);

FacebookRemoteCommand facebook = new FacebookRemoteCommand(this);

// コマンドを登録
teal.addRemoteCommand(facebook);

JSONテンプレート

JSON構成ファイルを使用してリモートコマンドを構成する場合は、以下のテンプレートを参照してください。このテンプレートには、標準的なeコマースインストールで使用される一般的なマッピングが含まれています。必要に応じてマッピングを編集してください。

{
  "config": {
    "applicationid": "YOUR_APP_ID",
    "clienttoken": "YOUR_CLIENT_TOKEN",
    "accesstoken": "YOUR_ACCESS_TOKEN",
    "userid": "YOUR_USER_ID",
    "auto_log": true,
    "auto_log_events_enabled": true,
    "auto_initialized": true,
    "advertiser_id_collection_enabled": true,
    "advertiser_collection": true,
    "debug": true
  },
  "mappings": {
    "achievement_type": "event.fb_description",
    "ad_type": "event.ad_type",
    "content": "event.fb_content",
    "content_type": "event.fb_content_type",
    "currency_code": "event.fb_currency",
    "event_name": "event.fb_description",
    "current_level": "event.fb_level",
    "pet_count": "event.fb_max_rating_value",
    "number_of_items": "event.fb_num_items",
    "order_id": "event.fb_order_id",
    "payment_info_available": "event.fb_payment_info_available",
    "signup_method": "event.fb_registration_method",
    "search_keyword": "event.fb_search_string",
    "success": "event.fb_success",
    "customer_email": "user.em",
    "customer_first_name": "user.fn",
    "customer_last_name": "user.ln",
    "customer_phone": "user.ph",
    "customer_dob": "user.dob",
    "customer_gender": "user.ge",
    "customer_city": "user.ct",
    "customer_state": "user.st",
    "customer_zip": "user.zp",
    "customer_country": "user.country",
    "customer_id": "fb_user_id",
    "user_value": "fb_user_value",
    "user_key": "fb_user_key",
    "product_id": "product.fb_product_item_id,event.fb_content_id",
    "product_availability": "product.fb_product_availability",
    "product_condition": "product.fb_product_condition",
    "product_description": "product.fb_product_description,event.fb_product_description",
    "product_image_link": "product.fb_product_image_link",
    "product_link": "product.fb_product_link",
    "product_name": "product.fb_product_title",
    "product_variant": "product.fb_product_gtin",
    "product_brand": "product.fb_product_brand",
    "product_price": "product.fb_product_price_amount,event.fb_value_to_sum",
    "product_currency": "product.fb_product_price_currency",
    "product_alias": "product_parameters.product_alias",
    "product_color": "product_parameters.product_color",
    "order_total": "purchase.fb_purchase_amount",
    "order_currency": "purchase.fb_purchase_currency",
    "customer_status": "purchase_parameters.customer_status",
    "coupon": "purchase_parameters.coupon",
    "push_action": "push.fb_push_action",
    "push_payload": "push.fb_push_payload",
    "tealium_event": "command_name"
  },
  "commands": {
    "launch": "initialize,setautologappeventsenabled,setautoinitenabled,enableadvertiseridcollection",
    "user_login": "setuser,setuserid",
    "email_signup": "updateuservalue",
    "level_up": "achievedlevel",
    "user_register": "completedregistration",
    "unlock_achievement": "unlockedachievement",
    "cart_add": "addedtocart",
    "custom_attribute": "rated",
    "wishlist_add": "addedtowishlist",
    "payment": "initiatedcheckout",
    "product": "logproductitem",
    "order": "logpurchase",
    "flush": "flush",
    "customfbevent": "customfbevent"
  }
}

Pushメッセージ追跡（iOS）

Tealium Swiftライブラリには、TealiumおよびFacebook Remote Commandを通じてプッシュメッセージ追跡を処理するためのTealiumRegistrationプロトコルが含まれています。このプロトコルに準拠するラッパークラスFacebookInstanceを使用して、プッシュメッセージ認証イベント、プッシュメッセージオープンイベント、およびアンインストール追跡を送信します。プッシュメッセージ追跡機能を活用することをお勧めします。

以下は、iOSプロジェクトにプッシュメッセージ追跡を統合する手順です：

1. TealiumHelper.swiftファイルで、TealiumRegistrationプロトコルに準拠するオブジェクトの空の配列を初期化します。例：

   var pushMessagingHelpers = [TealiumRegistration]()
   

2. FacebookRemoteCommandの前にFacebookInstanceを初期化します。
3. 上記の配列にFacebookInstanceを追加します。

以下は、プッシュメッセージ追跡統合の例です：

var pushMessagingHelpers = [TealiumRegistration]()

//...

teal = Tealium(config: config) { responses in
      guard let remoteCommands = self.tealium?.remoteCommands() else {
            return
      }
      let facebookInstance = FacebookInstance()
      let facebookRemoteCommand = FacebookRemoteCommand(facebookInstance: facebookInstance)
      remoteCommands.add(facebookRemoteCommand)
      self.pushMessagingHelpers.append(facebookInstance)
}

TealiumHelper.swiftファイル全体を見るには、Facebook Remote Commandサンプルアプリを参照してください。ユーザーが通知に登録した後、プッシュメッセージを開いたり、アプリをアンインストールしたりした場合にFacebookにイベントを送信するには、AppDelegate.swiftファイルを参照してください。

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

各Facebookメソッドにコマンドをマッピングします。Facebookメソッドをトリガーするには、指定された形式で対応するコマンドを渡します。

標準イベント名

以下は、logEventメソッドでサポートされている標準イベント名のリストです。以下のコマンド名が送信された場合、それに対応するFacebook SDKで自動的にトリガーされます。これは、その特定のイベントに対して必要な変数もマッピングおよび定義されていると仮定しています。アプリ内イベントの記録について学ぶ。

Facebook SDKがTealium SDKと一緒にインストールされているため、対応するタグ構成が与えられた場合、任意のネイティブFacebook機能をトリガーできます。

ユーザークリア

現在のユーザーデータをクリアします。

• Facebook iOS SDK統合 - clearUserData
• Facebook Android SDK統合 - clearUserData

ユーザーIDクリア

現在構成されているユーザーIDをクリアします。

• Facebook iOS SDK統合 - clearUserId
• Facebook Android SDK統合 - clearUserId

広告主IDコレクションの構成

アプリケーションの広告主IDコレクションフラグを構成します。

• Facebook iOS SDK統合 - setAdvertiserIDCollectionEnabled
• Facebook Android SDK統合 - setAdvertiserIDCollectionEnabled

フラッシュ

Facebookにイベントのフラッシュを明示的に開始します。これは非同期メソッドですが、即時に開始されます。サーバーの障害はNotificationCenterを通じて通知ID FBSDKAppEventsLoggingResultNotificationで報告されます。

• Facebook iOS SDK統合 - flush
• Facebook Android SDK統合 - flush

初期化

アプリケーションの認証情報を使用してFacebook SDKを初期化します。

商品アイテムのログ

商品カタログの商品アイテムをアプリイベントとしてアップロードします。

gtin、mpn、またはbrandのいずれかが必要です。商品パラメーターはディープリンク仕様のための任意フィールドです。

• Facebook iOS SDK統合 - logProductItem
• Facebook Android SDK統合 - logProductItem

購入のログ

指定された金額と通貨で購入を記録し、オプションで購入の追加特性を提供します。

特性の任意パラメーター辞書。この辞書のキーはNSStringでなければならず、値はNSStringまたはNSNumberであることが期待されます。パラメーターの数と名前の構造に関する制限はFBSDKAppEventsのドキュメントに記載されています。一般的に使用されるパラメーター名はFBSDKAppEventParameterNameの定数で提供されています。

• Facebook iOS SDK統合 - logPurchase
• Facebook Android SDK統合 - logPurchase

自動初期化有効化の構成

アプリケーションの自動初期化SDKフラグを構成します。

• Facebook Android SDK統合 - setAutoInitEnabled

自動ログアプリイベント有効構成

アプリケーションの自動ログイベントフラグを構成します。

• Facebook iOS SDK 統合 - setAutoLogAppEventsEnabled
• Facebook Android SDK 統合 - setAutoLogAppEventsEnabled

フラッシュ動作構成

Facebook SDKがアプリイベントをサーバーにフラッシュするタイミングを構成します。

• Facebook iOS SDK 統合 - setFlushBehavior
• Facebook Android SDK 統合 - setFlushBehavior

プッシュ通知登録ID構成（Android）

Androidプラットフォームで利用可能な追加のプッシュ通知方法。

利用可能なフラッシュ動作値:

• auto - イベントは自動的にフラッシュされます（デフォルト）

• explicit_only - イベントは明示的に呼び出されたときのみフラッシュされます

• Facebook Android SDK 統合 - setPushNotificationsRegistrationId

ユーザー構成

すべてのアプリイベントに関連付けるカスタムユーザーデータを構成します。すべてのユーザーデータはハッシュ化され、このアプリケーションのインスタンスからFacebookユーザーを照合するために使用されます。ユーザーデータはアプリケーションインスタンス間で保持されます。

• Facebook iOS SDK ユーザー構成
• Facebook Android SDK 統合 - setUserData

ユーザーID構成

すべてのアプリイベントに関連付けるユーザーIDを構成します。このIDは、デバイス間のコンバージョン測定およびカスタムオーディエンスの構成に使用されます。

ユーザー値の更新

タイプ/キーに対するユーザー値を更新します。すべてのユーザーデータはハッシュ化され、このアプリケーションのインスタンスからFacebookユーザーを照合するために使用されます。ユーザーデータはアプリケーションインスタンス間で保持されます。

• Facebook iOS SDK 統合 - setUserData
• Facebook Android SDK 統合 - updateUserProperties

ログイベント

以下はFacebook標準イベントで、ペイロード内のオプショナルなパラメータを数多く受け入れます。

• activatedapp
• achievedlevel
• adclick
• adimpression
• addedpaymentinfo
• addedtocart
• addedtowishlist
• completedregistration
• completedtutorial
• contact
• customizeproduct
• deactivatedapp
• donate
• findlocation
• initiatedcheckout
• livestreamingstart
• livestreamingstop
• livestreamingpause
• livestreamingresume
• livestreamingerror
• livestreamingupdatestatus
• productcatalogupdate
• pushtokenobtained
• rated
• schedule
• searched
• sessioninterruptions
• spentcredits
• starttrial
• submitapplication
• subscribe
• timebetweensessions
• unlockedachievement
• viewedcontent

Facebook SDKはTealium SDKと一緒にインストールされているため、すべてのネイティブFacebook機能が利用可能です。

特性の任意のパラメータ辞書。この辞書のキーはNSStringでなければならず、値はNSStringまたはNSNumberであることが期待されます。パラメータの数と名前の構造に関する制限は、FBSDKAppEventsのドキュメントで与えられています。一般的に使用されるパラメータ名はFBSDKAppEventParameterName定数で提供されています。

• Facebook iOS SDK統合 - logEvent
• Facebook Android SDK統合 - logEvent