ご利用マニュアル
shutto翻訳が提供する各種API及び活用方法
shutto翻訳の言語情報や翻訳先言語指定、言語切替タイミングの取得をするAPIのご紹介となります。
これらを用いてサイト内のご希望の動作にもご活用いただける場合がございますので、活用例もご参考ください。
1．shutto翻訳の言語取得API
shutto翻訳による表示言語を取得するAPIです。
取得するタイミングはユーザーのブラウザ上で翻訳対象ページの読み込みが終わった時点（※3）以降のご希望のタイミングとなります。
<script>
__stt.get('lang', function(lang) {
// 任意の動作スクリプト
});
</script>
※1 shutto翻訳の導入タグよりも後に記述してください。
※2 ご希望の動作に活用されたい場合は上記スクリプト内の＜任意の動作スクリプト＞箇所へ記述してください。
※3 翻訳対象ページの読み込みが終わった時点の表示言語優先順位は以下となります。
1）URLで指定している表示言語（URLクエリパラメータで?stt_lang=enのように指定がある場合）
2）cookieに記録された表示言語（言語切替バーでの言語切替え発生以降からcookieが生成されます）
3）shutto翻訳の初回表示言語設定による表示言語
※4 このAPIは１ページ内に複数設置可能ですが、取得できる言語情報は該当のAPIが発火したタイミングの言語情報となります。
活用例
- shutto翻訳から他の翻訳サービスのページへ遷移するときに引き継ぐ言語情報を取得したい場合
- サイト側でユーザーが切替えた言語に合わせた表示変更を設定するために言語情報を取得したい場合
など
２．shutto翻訳の言語指定API
shutto翻訳によって切替える表示言語を意図的に指定するAPIです。
※1 shutto翻訳の導入タグよりも後に記述してください。<script>__stt.set('lang', 'en');</script>
※2 上記は翻訳先言語を直接「英語（’en’）」に設定する場合の記述となります。
そのほかの言語コードはこちらをご参照ください。
※3 上記スクリプト内「英語（’en’）」の箇所は任意で定義した変数（値は言語コード）を用いてカスタマイズいただく事も可能です。
活用例
- 他の翻訳サービスを導入したサイトからshutto翻訳導入したサイトへ遷移する際に言語情報を指定したい場合
- 意図的に表示言語を指定したい場合
など
３．shutto翻訳の言語切替タイミング取得API
shutto翻訳においてデフォルト言語切替バーまたはカスタム言語切替バーを利用して言語が切替られたタイミングを取得するAPIです。
<script>
__stt.on('selectLang', function(event) {
// 任意の動作スクリプト
});
</script>
※1 shutto翻訳の導入タグよりも後に記述してください。
※2 初回表示言語設定による自動切替えのタイミングは取得できません。
※3 任意の動作に活用されたい場合は上記スクリプト内＜任意の動作スクリプト＞箇所へ記述ください。
※4 上記スクリプト内の(event)とある部分のデータに言語情報（項目名：「event.lang」）が格納されるため、以下のように選択された言語情報も取得できます。（「
※4 上記スクリプト内の(event)とある部分のデータに言語情報（項目名：「event.lang」）が格納されるため、以下のように選択された言語情報も取得できます。（「
currentLang」の部分は任意の変数名） <script>
__stt.on('selectLang', function(event) {
var currentLang = event.lang
// 任意のスクリプト
});
</script>活用例
- shutto翻訳で言語切替えが発生したタイミングで中間ページを表示させたい場合
- shutto翻訳で言語切替えが発生したタイミングでTOPページに遷移させたい場合
など