埋め込みタグの基本仕様

キッキジの音声プレーヤーは、<script> タグを 1 行貼るだけで任意のサイトに埋め込めます。本ページでは CMS 共通の仕様(タグ構造・属性・配置場所の指針)をまとめます。
各 CMS 別の貼り付け手順は 連携ガイド一覧 から参照してください。

1. 埋め込みタグの 2 種類

キッキジには用途に応じた 2 種類の埋め込みタグがあります。

種類スクリプト用途
単一記事タグ embed.js 記事ページの本文を音声化し、その記事ページ自身に音声プレーヤーを表示
プレイリストタグ playlist-embed.js 管理画面で作成したプレイリスト(複数音声)をまとめて配信

2. 単一記事タグ(embed.js)

最小構成

この 1 行を記事ページ内(音声プレーヤーを表示したい位置)に貼ると、現在開いているページの URL を音声化します。

<script src="https://kikkiji.net/scripts/embed.js"></script>

フル構成(属性指定)

対象 URL や言語、テーマを明示的に指定する場合は data-* 属性を追加します。

<script src="https://kikkiji.net/scripts/embed.js"
  data-url="https://example.com/article/123"      <!-- 音声化する記事URL(省略時は現在のページURL) -->
  data-lang="ja-JP"                              <!-- 出力言語 BCP-47 タグ。空=自動判定 -->
  data-theme="light"                             <!-- light | dark -->
  data-mode="auto"                               <!-- 取得方式(通常は auto のまま) -->
></script>

属性一覧

属性必須デフォルト説明
data-url現在のページ URL音声化する記事の URL。記事ページに貼る場合は省略可
data-lang自動判定ja-JP / en-US 等。指定言語と原文が異なる場合は翻訳されます
data-themelightプレーヤーの配色(light / dark
data-targetスクリプト位置プレーヤーを描画する要素の CSS セレクタ。指定するとその要素内に挿入
data-modeauto取得方式。通常は変更不要
data-voice-setting-id特定のボイス設定を強制する場合に指定

3. プレイリストタグ(playlist-embed.js)

管理画面で作成したプレイリストの ID を data-playlist-id に指定します。プレイリスト ID は管理画面の「プレイリスト」詳細画面の「埋め込みスクリプトをコピー」から取得できます。

最小構成

<script src="https://kikkiji.net/scripts/playlist-embed.js" data-playlist-id="YOUR_PLAYLIST_ID"></script>

属性一覧

属性必須説明
data-playlist-id必須プレイリスト ID。管理画面でコピー
data-themelight / dark
data-target描画先のセレクタ

4. 配置場所の指針

5. 埋め込み前のチェックリスト

タグを貼る前に、管理画面で以下を済ませておく必要があります。

  1. 許可ドメインに自分のサイトを登録
    管理画面 > 組織設定 > 許可ドメイン から、埋め込み先のドメイン(例:example.com)を追加します。許可されていないドメインからリクエストがあると 403 エラーになります。
  2. (プレイリスト埋め込みのみ)プレイリストを作成
    管理画面 > プレイリスト から作成し、「埋め込みスクリプトをコピー」でタグを取得します。
許可ドメインを登録しないと動きません。 「タグを貼ったのにプレーヤーが出ない/403 が出る」場合、まず許可ドメイン設定を確認してください。

次にやること

お使いの CMS 別の貼り付け手順を参照してください。