こんにちは、Customer Engineerのkohaです！

今回はKARTEのLINE連携機能を導入する際に活用できるソリューションを紹介します。

KARTEではLINEログイン連携機能を使うことで、サイト来訪者を識別するためにKARTE内で持つWeb上のCookieに付与したvisitor_idや、サービス側から連携されたログインIDとLINE IDを紐付けることができます。

これにより、Web上の行動やサービス側で取得した属性情報を使ってLINEメッセージの出し分けるといったことが可能になります。

一方で、KARTEのLINE連携機能の導入前から独自にLINEログイン施策をしていた場合、すでにログインIDとLINE IDとの対応データを自社で蓄積している場合がございます。

これまでは、サイトやアプリのログインIDとLINE IDの対応データをKARTEにLINE連携用データとして直接連携することができず、エンドユーザーに再びKARTE経由でのLINEログインをしてもらわないといけないという制約があり、あまりユーザー体験が良くありませんでした。

そうした課題に対し、今回のソリューションを用いるとエンドユーザーにKARTE経由でのLINEログインをしてもらわなくても、DatahubでインポートしたLINE IDリストを使ってKARTE側のユーザーとLINE IDとを一括で関連付けることができます！

アウトプットイメージ

イベントのフィールドにline_user_idが存在し、subscribeが「true」である「plugin_line_identify」というイベントが計測された状態を作る、というのが最終的なアウトプットとなります。これでKARTEが持つデータとLINEを活用し接客配信やメッセージの送信が可能になります。

より詳細については以下の記事をご覧ください。
LINEメッセージが送信可能なユーザーの定義

そして、上記の状態は「Personal Data (line identify)」というKARTEデフォルトの紐付けテーブルにIDを格納することで作ることができるので、以下の画像のようにデータが入っていたら成功です。

スクリーンショット2024-02-2712.25.53.png

構成図は次の通り。（小さくてごめんさい。ブラウザで拡大してご覧ください。）

だいぶ複雑な構成に見えますが、端的に書くとAPI経由でKARTEにユーザーID（ログインID）等とLINE IDの対応データをイベントとして送信するというものです。
しかし、APIには分間リクエスト上限がありちょっとずつAPIを叩く必要があります。そのために、Datahubを介して一度に送る件数を絞り込んで送れるようにするという構成をとっています。

注意点

前提として、次の点に注意をしてください。

LINE IDとログインIDの対応が間違った状態でイベント発生すると簡単には元に戻せなくなるので、十分に注意して実行してください
実際に行う場合は、少量データで十分に検証した上で、設定に問題がないことを確認してから実施してください
KARTE Datahub、KARTE Craft（Growthプラン以上）を利用している必要があります
「LINE ID」と「KARTEに連携しているuser_id」との対応リストを自社DB等に予め保持していて、CSVファイル等に出力できる必要があります。
API v2の分間リクエスト制限に引っかからないよう、後述のID読み込み行数はご契約のプランに合わせてクエリを作成する必要があります

設定手順

設定の手順は次の通りです。

API v2 アプリを作成する
API v2 アプリのアクセストークンを Craft Secret Manager に登録する
Datahubにテーブルを作成しLINE IDリストをアップロードする
Datahubに読み込み済の行番号を保持しておくテーブルを作成し初期データをアップロードする
Datahubのクエリを作成する
Craft Functionsのファンクションを作成する
Datahubのジョブフローを作成する
Craft Functionsの実行スケジュールを設定する

順番に見てみましょう。

1. API v2 アプリを作成する

KARTEのAPIを利用するために、API v2アプリを作成します。

[ストア > API v2設定] からアプリを新規作成
[アプリタイプ] を token に設定
必要なscopeを追加
- datahub.jobflow.get
- datahub.jobflow.exec
- track.event.write
アプリを保存し、一度だけ表示されるアクセストークンをメモしておく

2. API v2 アプリのアクセストークンを Craft Secret Manager に登録する

API v2 アプリのアクセストークンをCraft Functionsから安全に利用するために、Craft Secret Manager に登録します。

[Craft > シークレット] からシークレットを新規作成
[名前] に、わかりやすい名前を入力
メモしておいたAPI v2 アプリのアクセストークンを [シークレットの値] に入力し、作成
シークレット名をメモしておく

3. Datahubにテーブルを作成しLINE IDリストをアップロードする

KARTEイベントに送る元のデータを用意するために、以下の手順でDatahubにテーブルを作成しをデータをアップロードします。

（1）Datahubのデータセット画面を開く
（2）作成ボタン押して任意の名前を指定し以下のスキーマを指定する
※ここでは例として「lineid_migration」というテーブル名を指定します。

スキーマ	型	NULL可否
user_id	STRING	REQUIRED
line_user_id	STRING	REQUIRED

※user_id → KARTEに認識させるuser_idを格納します
※line_user_id → LINE IDを格納します

（3）事前に用意したcsvアップロードする
　※いきなり本番データを使うのではなく初めは5行程度用意したテストIDをアップロードし、最後の手順完了後テストすることをお勧めします。
スクリーンショット2024-02-299.03.35.png

4. Datahubに読み込み済の行番号を保持しておくテーブルを作成し初期データをアップロードする

Craftを介して順次IDを送る形になるため、一回の送信処理でどの行まで送信した（読み込んだ）かを保持しておくためのテーブルを作り、一行挿入します。

（1）Datahubのデータセット画面を開く
（2）作成ボタン押して任意の名前を指定し以下のスキーマを指定する
※ここでは例として「line_id_migrate_current_row」というテーブル名を指定します。

スキーマ	型	NULL可否
current_row	INTEGER	REQUIRED

（3）以下のような1カラム1行のcsvファイルを作る

current_row
0

（4）csvアップロードする
スクリーンショット2024-02-299.04.04.png

5. Datahubのクエリを作成する

以下2つのクエリを作成します。
（1）手順3で作成したテーブルから任意の行数を抽出するクエリ
※クエリ例

WITH current_row as (
SELECT
  current_row
FROM 
 --読み込み済み行を保持したテーブル
 `prd-karte-per-client.koha_test_{projectのidが入ります}.line_id_migrate_current_row`
),
sup as (SELECT
   ROW_NUMBER() OVER (ORDER BY id_index) AS row_num
  ,user_id
  ,line_user_id 
FROM 
 --IDリストを保持したテーブル
  `prd-karte-per-client.koha_test_{projectのidが入ります}.lineid_migration
ORDER BY id_index
)
SELECT
  sup.user_id
, sup.line_user_id
from 
  sup
, current_row
WHERE
 sup.row_num BETWEEN current_row.current_row AND current_row.current_row + 500 --1度に読み込む行数。何行指定すべきかは後述の手順7を確認してください。
order by sup.user_id

（2）上記クエリで抽出した行数を、手順4で作成したテーブルへ置き換えするクエリ

SELECT
  --読み込み済行数 + 今回読み込んだ行数。何行指定すべきかは後述の手順7を確認してください。
　 current_row + 500 as current_row 
FROM
 --読み込み済み行を保持したテーブル
 `prd-karte-per-client.koha_test_{projectのidが入ります}.line_id_migrate_current_row`

6. Craft Functionsのファンクションを作成する

Craft Functionsのファンクションを作成します。作成手順は次の通りです。

[Craft > ファンクション > 新規作成 > テンプレートから作成] を選択
「 KARTE CraftとDatahubでLINE IDを一括でKARTEユーザーIDに関連付けする 」というテンプレートを検索し[取得]ボタンをクリック
[反映] ボタンをクリック
[変数] タブで次の変数の値を設定する
- LOG_LEVEL
  - 出力するログのレベルです。ERROR/WARN/INFO/DEBUGから指定します
- SECRET_KEY_API
  - 手順2で作成したシークレット名を指定します
- TARGET_JOBFLOW_ID
  - 手順4で作成したジョブフローのIDを指定します
- [設定 > ファンクションの有効化] にチェックを付けて [保存]

なお、テンプレートのソースコードはGitHubで公開しています。
craft-codes/craft-functions/bulk-send-karte-event at main · plaidev/craft-codes

7. Datahubのジョブフローを作成する

作成したクエリを実行するためのジョブフローを作成します。

ジョブフロー画面を開く
画面右上の「作成」ボタンをクリック
「ジョブを追加」ボタンをクリック
ジョブは以下2つを作成してださい。

・1つ目

設定項目	指定する内容
ジョブタイプ	クエリ実行結果のエクスポート
エクスポート元	クエリ手順5で作成した1つ目のクエリ
エクスポート先	外部サービス
接続先	Craft
function名	手順6で作成したファンクション
行ごとにqueueをpubliushする	チェックをつける

・2つ目

設定項目	指定する内容
ジョブタイプ	データテーブルへインポート
インポート元	クエリ手順5で作成した2つ目のクエリ
インポート先	手順4で作成したテーブル
ルール	置き換え

任意のジョブ名とジョブフロー名を指定し保存

8. Craft Functionsの実行スケジュールを設定する

今回のCraft Functionsにはジョブフローの実行と、ジョブフロー実行結果を受け取りイベント送信を行うという二つの機能を持たせており、スケジュール実行するとジョブフローをキックするようになっています。（イベント送信する機能はジョブフローを実行すると再度Craft Functionsを実行しイベント送信機能が働きます。）

そのためにCraft Functionsの実行スケジュールを設定しましょう。

今回作成したCraft Functionsを開く
設定タブを開く
スケジュール欄の「作成」ボタンをクリック
表示された説明に従いCron式でスケジュールを設定する

この時、何分毎に実行するかは以下を参考に決定してください。
APIのリクエスト分間制限

今回実行しているAPIとStandardプランの場合の設定
/v2/track/event/write：1000回/分（※1実行で2回リクエスト送っています）
/v2/datahub/jobflow/get：50回/分
/v2/datahub/jobflow/exec：30回/分
→
1分に1000回イベントを書き込みますが今回のCraft Functionsは1実行につき2回イベント送信を行うため1分に500行のIDが送信可能です。またジョブフローは直列実行であり、起動まで1-2分を要する場合があります。

この制約からStandardプランの場合は、手順5の「一度に読み込む行数」を指定するクエリで500を指定すれば1分に1回実行できますが、ジョブフローが起動しきっていない可能性があるので、実際は「*/3 * * * *」の形式で3分に1回程度で実行するのが良いです。
スクリーンショット2024-02-298.43.58.png

実際に動かしてみる

それでは実際に動作を確認してみましょう。

仕組みとしては以下の流れになります。
ジョブフローを実行
↓
1つ目のジョブが起動しIDリストを抽出してCraft Functionsを実行する
↓
Craft FunctionsがKARTEのイベントを起こす
↓
2つ目のジョブが起動し読み込み済行番号を置き換えし、次回実行時にはまだ読み込んでいない行から開始可能。

問題なく設定と実行できていれば、連携対象のユーザーストーリー画面の左帯でTalkパーミッションの許可中のプラグインにLINEが表示されています！

LINEメッセージが送信可能なユーザーの定義
スクリーンショット2024-02-299.30.55.png

改めてとなりますが以下2点の注意事項についてはご留意ください。

LINE IDとログインIDの対応が間違った状態でイベント発生すると簡単には元に戻せなくなるので、十分に注意して実行してください
実際に行う場合は、少量データで十分に検証した上で、設定に問題がないことを確認してから実施してください

おわりに

今回はKARTE CraftとDatahubを使ってLINE IDを一括でKARTEユーザーIDに関連付けする方法について紹介しました。

KARTEのLINE連携機能を導入する際は、必要であればぜひ利用を検討してみてください！

プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！ぜひ気軽にお問い合わせください。

↓ パートナー企業になりたい

CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem

↓ PLAIDで働きたい