> For the complete documentation index, see [llms.txt](https://docs.wicle.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wicle.io/other/opt-in.md).

# オプトインの設定

Wicleのオプトインモードを有効にし、サイトやCMPで管理する同意状態に応じてAPIで計測を開始・停止する実装方法と注意点を説明します。

ユーザーが同意するまで計測を開始しないよう、Wicleの計測タグを制御します。サイト側で同意画面と同意状態を管理し、Wicleへ計測の開始・停止を伝えます。

## CMP(Consent Management Platform) による制御 <a href="#cmp-control" id="cmp-control"></a>

CMP（同意管理ツール）を使う場合も、ツールを導入するだけでWicleと自動連携するわけではありません。ツールの設定方法に従い、同意・拒否の結果を下記のAPIに連携してください。

連携方法が不明な場合は、利用しているCMPと実現したい制御を添えて[サポート窓口](https://docs.wicle.io/other/support/contact.md)へお問い合わせください。

## 実装による制御 <a href="#implementation-control" id="implementation-control"></a>

### タグ設定の変更 <a href="#tag-setting" id="tag-setting"></a>

設定を変更するには、組織のOwner権限が必要です。先に、下記の[アプリケーション実装](#application-implementation)を行い、テスト環境のプロジェクトなどで同意・拒否に応じた動作を確認してください。

1. サイドメニューの`プロジェクト / 組織設定`を開き、対象のプロジェクトを選択します。
2. `プロジェクト設定`の`計測タグ`で、`高度な設定`を開きます。
3. `オプトインモード`の`有効にする`を選択します。
4. 確認画面の内容を読み、`有効にする`を選択します。

<figure><img src="https://1516189518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhDtk9aBzYOvC8RRWtKCd%2Fuploads%2FBwo76wFQRw8XgvvYXB7Z%2Fimage.png?alt=media&amp;token=e7e2bfc2-a51d-47e8-869d-bed2d5bb42d4" alt="オプトインモードの旧設定画面"><figcaption><p>旧画面の参考例です。現在は「高度な設定」から有効化します。</p></figcaption></figure>

{% hint style="warning" %}
有効化すると、ユーザーの同意を伝えるまで計測は開始されません。同意を伝える実装がない状態で有効化すると、同意済みのユーザーも計測されなくなります。
{% endhint %}

### アプリケーション実装 <a href="#application-implementation" id="application-implementation"></a>

Wicleの計測タグを設置し、タグ内で`krt`が定義された後に、同意状態に応じて次のAPIを呼び出します。

| API           | 呼び出すタイミング                          | 動作          |
| ------------- | ---------------------------------- | ----------- |
| `krt.allow()` | ユーザーが同意したとき、または同意済みのユーザーがページを開いたとき | 以後の計測を開始します |
| `krt.deny()`  | 計測を開始したユーザーが同意を撤回したとき              | 以後の計測を停止します |

オプトインモードでは、同意していないページ表示時は`krt.allow()`を呼び出さなければ計測されません。拒否を記録するためだけに、毎回`krt.deny()`を呼び出す必要はありません。

{% hint style="danger" %}
これらのAPIは、同意状態を次のページ表示まで保持しません。同意状態はサイト側やCMPで保存し、計測タグを設置した各ページで、同意済みなら`krt.allow()`を呼び出してください。
{% endhint %}

計測開始前の拒否、同意後の計測開始、次のページへの同意状態の引き継ぎ、同意撤回後の停止を確認してください。送信内容の確認には[Chrome拡張機能](https://docs.wicle.io/chrome-extension/event-viewer.md)を使えます。
