# スクリプトタグAPI
ショップページにスクリプトタグを挿入するAPIです。
スクリプトタグAPIを用いると、指定された対象のページ(例えばショップページ)に、指定されたスクリプトURLとIntegrity属性を持つ以下のスクリプトタグを埋め込むことができます。
<script src="{{スクリプトURL}}" integrity="{{Integrity属性}}">
- 埋め込まれるスクリプトの正確性を保証するためにIntegrity属性を持つスクリプトタグを埋め込みます。スクリプトの登録や、登録済みスクリプトの変更の際には適切なIntegrityパラメータを指定する必要があります。
- 登録・更新時にカラーミーショップAPIが指定されたスクリプトURLにアクセスしてスクリプトを取得します。スクリプトが取得できない場合は登録できないため、スクリプトはインターネット上に公開されている必要があります。
スクリプトタグAPIのリクエストやレスポンスに関する仕様につきましては 「スクリプトタグ」 (opens new window) をご覧ください。
# スクリプトタグの挿入箇所について
スクリプトタグはショップページおよび注文完了ページに挿入することができます。スクリプトタグの作成時に指定する display_scope
パラメータを使用して挿入するページを設定できます。
# スクリプトタグを挿入できる箇所
- トップ
- 商品一覧
- 商品詳細
- 商品検索結果
- 特定商取引
- プライバシーポリシー
- フリーページ
- カートの購入完了ページ
# スクリプトタグを挿入できない箇所
- 会員登録画面
- 会員ログイン画面
- 会員ログイン後のマイページ
- カートフォームページ
# スクリプトタグ用カラーミーオブジェクト
ページに関する情報を格納したグローバルオブジェクトを提供しています。
スクリプトタグAPIによって挿入されるJavaScriptで参照できます。
詳細なドキュメントは 「スクリプトタグ用カラーミーショップオブジェクト」 をご覧ください。
# アンインストール時の動作
スクリプトタグAPIで挿入されたスクリプトタグは、アプリがアンインストールされると自動で削除されます。