この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

開発 API のコードサンプル

リリース API がリリースのカスタマイズにどのように役立つかをテストおよびプレビューします。

チャットウィンドウ

このコードサンプルでは、次のリリース API メソッドを使用するチャットウィンドウが作成されます。
  • startChat
  • showWhenOnline
  • showWhenOffline
  • addCustomDetail
  • setName
  • map
  • setChatWindowWidth
  • setChatWindowHeight
  • doKnowledgeSearch

リリース API を介して追加された詳細は、訪問者に関連付けられます。チャットが起動すると、Chasitor が最初の訪問者に関連付けられます。その後要求が出されると、新しい Chasitor として同じ訪問者に関連付けられます。作成した詳細を関連付ける Chasitor を 1 つのみにするには、代わりに事前チャット API を使用する必要があります。

警告

このコードでは、コンソールを使用するエージェントに次のビューが表示されます。
コンソールの Live Agent

setName (1) に基づいて、コンソールに顧客の名前 (この例では Jane Doe) が表示されます。addCustomDetail.doKnowledgeSearch をコールすると、ナレッジウィジェット (2) に検索が自動的に表示されます。

エージェントがチャットを受信すると、設定されたカスタム詳細がフロート表示ウィンドウに表示されます。
カスタム詳細がフロート表示される受信チャット。

省略可能な Cookie

同意管理を使用して、省略可能な Cookie を選択したり、オプトアウトしたりする機能をユーザに提供できます。ユーザがオプトインを選択した場合、省略可能な Cookie を追跡するために、liveagent.init() の 4 番目のパラメータに true を渡すことができます。ユーザがオプトインを選択しない場合で、オプトアウトを選択するときには false を渡します。4 番目のパラメータを省略した場合は、true を渡した場合と同じになります。

省略可能な Cookie からオプトアウトできる機能は、リリース API のバージョン 52.0 以降でサポートされています。

メモ

ユーザがオプトアウトした場合は、liveagent.disableOptionalCookies() を呼び出すこともできます。これにより、省略可能な Cookie の追跡が削除および停止されます。これは、値が true の liveagent.init() よりも優先順位が高いことを除けば、liveagent.init()false を渡すことと同じ処理になります。たとえば、先に liveagent.disableOptionalCookies() を呼び出し、次に liveagent.init() に true を渡した場合、省略可能な Cookie は無効のままです。liveagent.init() とは異なり、liveagent.disableOptionalCookies() は、ページが読み込まれた後にいつでもコールできます。

ユーザがオプトアウトした後に、省略可能な Cookie に再度オプトインした場合、次のページの読み込みで liveagent.init()true を渡します。