Alli User Guide - Alli SDK実装（JavaScript）

WEBサイトへの実装

Alli Javascriptの実装は次のコードをコピーしてWebサイトに貼り付けるだけです。

<head>
<script src="https://sdk.alli.ai/latest/alli.js"></script>
</head>

<body>
<!-- ...Your website content... -->

<!-- Start of Alli Code -->
<script>
  // YOUR_API_KEYにはAlli Dashboard > プロジェクト設定に記載の一意の値を入力します。 
  Alli.initialize({
    apiKey: "YOUR_API_KEY",
    debug: false, //これをオンにすると、デバッグ情報がコンソールに出力されます。
    backButton: true, //[オプション]デフォルト値は true。ヘッダーの戻るボタンを削除する場合は、このオプションをオフに設定します。
    providerLink: true, // [オプション]デフォルト値は true。Alliロゴのリンクを削除する場合は、このオプションをオフにします。
    styleOptions: { //[オプション]スタイルをカスタマイズします。
      conversationContainer: {
        right: 50, //画面右側からの間隔設定（チャット画面の位置が右に設定されている場合に適用)
        left: 50, //画面左側からの間隔設定（チャット画面の位置が左に設定されている場合に適用)
        bottom: 50 //画面下部からの間隔設定
      }
    }
  });
  if (window.Alli) {
    window.Alli.event();
  }
</script>
<!-- End of Alli Code -->
</body>

API_KEYはDashboard　設定 > 全般タブより取得し、"YOUR_API_KEY"に入力します。

ブラウザをリフレッシュ後、Webサイトの右下にAlliのチャットダイアログポップアップが表示されたら、実装完了です。

SDKの初期化

コードをコピーして、ウェブページの<head>ブロックに貼り付けます。

<head>
<script src="https://sdk.alli.ai/latest/alli.js"></script>
</head>

<body>
<!-- ...Your website content... -->

<!-- Start of Alli Code -->
<script>
  if (window.Alli) {
    //apiKey is unique identifier provided by Alli 
    Alli.initialize({
      apiKey: "YOUR_API_KEY",
      debug: false,
      backButton: true
    });
  }
</script>
<!-- End of Alli Code -->
</body>

会話の開始

SDKを初期化したら、以下のオプションのいずれかを使用して次のコマンドを呼び出し、会話を開始してください。

if (window.Alli) {
    window.Alli.event();    
}

SDKを実装後、次の迅速かつ簡単な統合手順のいずれかを実行できます。

１．ターゲティング及びプレイスメントを指定しない場合

window.Alli.event();

２．ターゲティングとプレイスメントを指定する場合

window.Alli.event({
    user: {id: "YOUR_USER_ID"},
    placement: "YOUR_PLACEMENT"
});

プレイスメント情報は、Webページにロードするキャンペーンを識別するために使用されます。 Alliダッシュボード >キャンペーン内で、各キャンペーンの配置を設定できます。

SDKの高度な設定

高度な設定については以下を参照ください。

Alli toggle icon の位置を調整する

メインのターゲットブラウザに応じて、Alli toggleボタンの位置を調整できます。

script内の以下コードの値を変更し位置を変更します。
StyleOptions> ConversationContainer> right、left、bottomの値を変更。
デフォルト値は５０となっています。

Alli.initialize({
  styleOptions: { //[オプション]スタイルをカスタマイズします。
    conversationContainer: {
      right: 50, //画面右側からの間隔設定（チャット画面の位置が右に設定されている場合に適用)
      left: 50, //画面左側からの間隔設定（チャット画面の位置が左に設定されている場合に適用)
      bottom: 50 //画面下部からの間隔設定
    }
  }
});

トグルアイコンとプレビューなしで全画面でAlliウィンドウをロードする

場合によっては、Alliをトグルアイコンとプレビューなしでロードする必要がありますが、フルスクリーンでフルUIを使用する必要があります。たとえば、モバイルブラウザのような小さな画面で使用する場合。これには、popupModeとランチャーを使用できます。

Alli.initialize({
  popupMode: true,
  launcher: false
});

popupModeがtrueの場合、AlliはフルスクリーンでフルUIをロードします。
ランチャーがfalseの場合、Alliはトグルアイコンをロードしません。

ユーザーを特定する

AlliはCookieを利用し、ユーザーIDでは識別できないサイト訪問者を識別します。ユーザーがCookieを消去した場合は履歴が失われます。

ウェブサイトにログインしているユーザーが特定できている場合、このユーザーが誰であるかをAlliに伝えることができます。また、ログインしていないユーザーの一時IDを設定することもできます。

例：ユーザーID”USER-123”

Alli.setUser({
  id: "USER-123"
});

ユーザーに関する詳細情報がある場合は、setUser（）関数で送信できます。
送信された情報は変数に保存されます。

Alli.setUser({
  id: "USER-123",
  email: "user123@gmail.com",
});

SDKの配置

Alli SDKは特定のキャンペーンチャットフローを任意のWEBサイト（アプリ）に実装する事ができます。
例えば、LPではプロダクトの紹介やユーザーニーズを確認する為のキャンペーンを配置。カートのページでは追加注文を頂く為のおススメ商品の紹介する為のキャンペーンを配置する事ができます。

静的な配置

プレイスメントを作成したら、Alli Dashboardにて、そのプレイスメントのキャンペーンチャットフローを変更できます。プレイスメント活用の利点は、いつでも好きな場所に、表示したいキャンペーンを設定できることです。

例：プレイスメント＝shopping　

if (window.Alli) {
    window.Alli.setPlacement("shopping");    
}

動的な配置

Alli SDKはURLを自動的に送信するため、キャンペーン設定で動的プレースメントのURLパターンが利用できます。この場合、次のような呼び出しを行います。

if (window.Alli) {
    window.Alli.setPlacement();    
}

たとえば、「/ download」のURLでキャンペーンを開始する場合は、ダッシュボードの「contains download」を使用してプレースメントを設定できます。 SPA（シングルページアプリ）はダイナミックプレースメントでは機能しないことに注意してください。

変数に値を割り当てる

会話の開始時に特定の値を変数に割り当てるには以下を参照ください。

window.Alli.event({
    variables: [{
    	"name": "VARIABLE_NAME",
    	"value":"VARIABLE_VALUE"
  }]
});

尚、利用する変数を事前にAlliダッシュボード > プロジェクト設定 > 変数にて、登録する必要があります。

サポートしているブラウザ

・Chrome（バージョン64以降）
・FireFox（バージョン60以降）
・Opera（バージョン50以降）
・Safari（10以降）
・Internet Explorer 11
・Microsoft Edge（バージョン40以降）