回答表示後の処理の実行¶
設定タグの completedHook に関数を記述すると、AI の回答の表示が完了した時点で、その関数を実行できます。関数は回答の参照先のページの URL を受け取ります。
| 項目 | 内容 |
|---|---|
| 対象者 | タグを設置する方(エンジニア、制作会社) |
| ページの概要 | 回答の表示が完了した時点で、アクセス解析への送信など、サイトの処理を実行できます |
| 前提条件 | タグの設置の手順で、AI の回答が表示されていること |
completedHook が呼び出されるタイミング¶
completedHook の関数は回答と参照リンクを表示し終えた後に 1 回呼び出されます。useStream: true を書いて回答を少しずつ表示する場合も、回答を最後まで表示した後に 1 回呼び出されます。
| 表示の状態 | completedHook の関数 |
|---|---|
| 回答を表示し終えたとき | 呼び出されます |
| URL に検索キーワードがないとき | 呼び出されません |
回答を取得できなかったとき(exceptionBodyText の固定メッセージが出るとき) |
呼び出されません |
| サービスを利用できないとき(契約が終了しているとき、今月のリクエスト数が上限に達しているとき) | 呼び出されません |
completedHook の記述方法¶
タグの設置で書いた設定タグに completedHook を足し、値に関数を記述します。次の例は、参照先の URL をブラウザのコンソールに出力します。[ ] の部分はタグの設置 › 設定タグの必須 4 項目で説明している値です。
<script>
window.aisConf = window.aisConf || [];
window.aisConf.push({
uid: "[サービスの ID]",
promptId: "[プロンプトの ID]",
insertSelector: "[表示領域を置く要素の CSS セレクタ]",
inputSelector: "[検索ボックスの CSS セレクタ]",
completedHook: function (params) {
try {
var urls = params.searchResult.references.map(function (reference) {
return reference.url;
});
console.log("AI SEARCH の回答を表示しました", urls);
} catch (error) {
console.error(error);
}
},
});
</script>
- 値は関数で記述します。関数以外の値(関数の名前の文字列など)を記述すると、ブラウザのコンソールに
Invalid value for completedHookが表示され、表示領域は表示されません - 関数の中の処理は
try...catchで囲みます。関数内で発生したエラーを捕捉せずに関数の外へ伝播させると、回答の代わりにexceptionBodyTextの固定メッセージが表示されます。useStream: trueを書いた場合は、段階的に表示した回答が最後に消え、固定メッセージに置き換わります。exceptionBodyTextを書いていない場合は、本文が空になります。このとき、コンソールにメッセージは表示されません asyncの関数や Promise の中で起きたエラーでは、回答の表示は変わりません。非同期処理のエラーは関数の中のawaitとtry...catch、または Promise の.catchで捕捉します
関数が受け取る引数¶
関数は、次の形式のオブジェクトを 1 つ受け取ります。
{
searchResult: {
references: [
{ url: "https://example.com/price.html" },
{ url: "https://example.com/faq.html" },
],
},
}
| 値 | 型 | 内容 |
|---|---|---|
searchResult.references |
配列 | 回答の参照先のページの一覧 |
searchResult.references[].url |
文字列 | 参照先のページの URL |
referencesは表示される参照リンクと同じとは限りません。表示される参照リンクは、回答内で番号が示されたページのみを、URL ごとに 1 つに集約したものです。referencesには回答の中で番号を示していないページの URL が入ることや、同じ URL が 2 回以上入ることがあります- 回答の文章と検索キーワードは受け取れません
設定例¶
Google タグマネージャーへのイベント送信¶
回答の表示が終わったときに、Google タグマネージャーのデータレイヤーにイベントを送ります。[イベントの名前] は Google タグマネージャーのトリガーに設定するイベントの名前に書き換えてください。
<script>
window.aisConf = window.aisConf || [];
window.aisConf.push({
uid: "[サービスの ID]",
promptId: "[プロンプトの ID]",
insertSelector: "[表示領域を置く要素の CSS セレクタ]",
inputSelector: "[検索ボックスの CSS セレクタ]",
completedHook: function (params) {
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: "[イベントの名前]",
});
} catch (error) {
console.error(error);
}
},
});
</script>
回答表示後のサイト要素の表示¶
回答の表示が終わったときに、hidden 属性で非表示にしておいたサイトの要素(問い合わせの案内など)を表示します。[表示する要素の CSS セレクタ] は表示したい要素に合うセレクタに書き換えます。
<script>
window.aisConf = window.aisConf || [];
window.aisConf.push({
uid: "[サービスの ID]",
promptId: "[プロンプトの ID]",
insertSelector: "[表示領域を置く要素の CSS セレクタ]",
inputSelector: "[検索ボックスの CSS セレクタ]",
completedHook: function (params) {
try {
var element = document.querySelector("[表示する要素の CSS セレクタ]");
if (element) {
element.hidden = false;
}
} catch (error) {
console.error(error);
}
},
});
</script>
関数内での検索キーワードの取得¶
関数は検索キーワードを受け取らないため、AI SEARCH と同じ規則で、検索結果ページの URL からキーワードを取得します。"q" は、設定タグに queryParamName を書いた場合はその名前に書き換えます。
<script>
window.aisConf = window.aisConf || [];
window.aisConf.push({
uid: "[サービスの ID]",
promptId: "[プロンプトの ID]",
insertSelector: "[表示領域を置く要素の CSS セレクタ]",
inputSelector: "[検索ボックスの CSS セレクタ]",
completedHook: function (params) {
try {
var name = "q";
var keyword = new URLSearchParams(window.location.search).get(name);
if (keyword === null) {
var hash = window.location.hash;
var index = hash.indexOf("?");
keyword = index < 0 ? "" : new URLSearchParams(hash.slice(index)).get(name) || "";
}
console.log("AI SEARCH の検索キーワード", keyword);
} catch (error) {
console.error(error);
}
},
});
</script>
URL の ? から # の前までにパラメータがない場合だけ、# 以降の ? より後ろの部分を取得します。取得の規則は「検索キーワードの URL パラメータが q 以外の場合 › URL の # 以降にキーワードがある場合」を参照してください。
確認方法¶
- completedHook の記述方法の例の設定タグを書き、検索結果ページを、検索キーワードを付けて開きます(例:
https://example.com/search?q=[サイトの内容に関わるキーワード]) - 回答の表示が完了した後に、ブラウザの開発者ツールのコンソールに
AI SEARCH の回答を表示しましたと参照先の URL が表示されることを確認します - 関数をサイトの処理に書き換え、同じ手順で処理が実行されることを確認します
completedHook を足した後に、回答の代わりに exceptionBodyText の固定メッセージが表示されるようになった場合は、関数の中でエラーが起きています。関数内の処理を try...catch で囲み、catch でコンソールに出力したエラーを確認して修正します。
設定上の制限と回避方法¶
| 制限事項 | 回避方法 |
|---|---|
| 関数で回答の文章や検索キーワードを受け取ること | 検索キーワードは関数の中で検索結果ページの URL から取ります。取り方は「関数内での検索キーワードの取得」を参照してください |
| 回答を取得できなかった場合や、サービスを利用できないときに関数を実行すること | 問合せ窓口にご相談ください |