# カスタムイベント

## カスタムイベントでできること <a href="#what-you-can-do" id="what-you-can-do"></a>

カスタムイベントでは、 [auto-event](https://docs.wicle.io/data-setting/event-tracking/auto-event "mention")とは逆に、任意のタイミングで任意のデータをイベントとして送信することが可能になります。

## 設定・実装方法 <a href="#setup-and-implementation" id="setup-and-implementation"></a>

<figure><img src="https://1516189518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhDtk9aBzYOvC8RRWtKCd%2Fuploads%2FEdF5lzaI3xBsz5QAYLFX%2Fimage.png?alt=media&#x26;token=19c3ab54-f8f6-485e-9043-234da96c50ba" alt=""><figcaption></figcaption></figure>

イベントの定義情報を設定画面から入力し保存することで、送信されたイベントデータが管理画面上での閲覧・検索が可能になります。データの送信自体は設定を行っていなくても可能です。

{% hint style="info" %}
カスタムイベントの作成数はプランにより上限があります。詳しくは[料金ページ](https://wicle.io/plan)をご確認ください。

* Freeプラン: 10個
* Growthプラン: 30個
* Customプラン: カスタム
  {% endhint %}

### クライアントサイドでの実装方法 <a href="#block-7928913db673463faea6dab1f8695aa2" id="block-7928913db673463faea6dab1f8695aa2"></a>

カスタムイベント設定画面でイベントやフィールドを定義すると、実行コードのサンプルが表示されます。

このコードを元に必要なタイミングで送信したい値をセットし実行される様に実装を行ってください。

[event-viewer](https://docs.wicle.io/chrome-extension/event-viewer "mention") で、実装後の確認を行うこともできます。

<figure><img src="https://1516189518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhDtk9aBzYOvC8RRWtKCd%2Fuploads%2FuUqvN3uXLR8WSAGEP7Zy%2Fimage.png?alt=media&#x26;token=98b3459f-eb53-49de-8888-13793663f215" alt=""><figcaption><p>画像内のコードはサンプルです。実際はご自身の管理画面内で表示されたものをご利用ください</p></figcaption></figure>

### サーバーサイドでの実装方法 <a href="#server-side-implementation" id="server-side-implementation"></a>

{% hint style="info" %}
WebAPIをご利用頂くには弊社側での設定とアクセストークンの受け渡し等が必要になります。現時点ではご連絡を頂き個別ご案内させて頂くフローになっておりますので、ご利用されたい場合はチャットやメールでご連絡ください。
{% endhint %}

## コンバージョンの設定 <a href="#conversion-setting" id="conversion-setting"></a>

カスタムイベントの作成・編集画面で、中間コンバージョンまたは最終コンバージョンとして設定できます。コンバージョンに設定したイベントは[CVダッシュボード](https://docs.wicle.io/analytics/dashboard#conversion)/[CV到達経路分析](https://docs.wicle.io/analytics/dashboard/cv-path)で利用されます。

## その他の設定 <a href="#other-settings" id="other-settings"></a>

### フォルダ管理 <a href="#folder-management" id="folder-management"></a>

カスタムイベントをフォルダで整理できます。イベント数が多い場合に活用してください。

## おすすめの設定例 <a href="#recommended-examples" id="recommended-examples"></a>

| 表示名   | イベント名    | 補足                          | フィールド表示名       | フィールドのキー        | フィールドのデータ型 | 補足                                 |
| ----- | -------- | --------------------------- | -------------- | --------------- | ---------- | ---------------------------------- |
| 会員登録  | signup   | 会員登録完了時に送信するイベントです。         |                |                 |            |                                    |
| ログイン  | login    | ログイン状態が変わるタイミングで送信するイベントです。 | ログインステータス      | status          | boolean    | ログイン時にtrueを、ログアウト時にfalseを送信してください。 |
| カート   | cart     | カート操作時に送信するイベントです。          | 価格             | price           | number     |                                    |
|       |          |                             | 商品ID           | item\_id        | string     |                                    |
|       |          |                             | 商品名            | name            | string     |                                    |
|       |          |                             | 商品カテゴリ         | item\_category  | string     |                                    |
| 購入    | buy      | 購入時に送信するイベントです。             | 購入金額           | revenue         | number     |                                    |
|       |          |                             | 商品数            | item\_count     | number     |                                    |
|       |          |                             | ユーザーの累計購入回数    | buy\_total      | number     |                                    |
|       |          |                             | ユーザーの累計購入金額    | buy\_pay\_total | number     |                                    |
|       |          |                             | 注文ID           | transaction\_id | string     |                                    |
| お気に入り | favorite | お気に入り追加時に送信するイベントです。        | お気に入りしたもののID   | item\_id        |            |                                    |
|       |          |                             | お気に入りしたものの名前   | name            |            |                                    |
|       |          |                             | お気に入りしたもののカテゴリ | item\_category  |            |                                    |
| 検索    | search   | 検索時に送信するイベントです。             | 検索キーワード        | keyword         |            | <p><br></p>                        |

## 各画面での利用/確認方法 <a href="#block-bc055e0b0a9345ebb580d02346b1ed76" id="block-bc055e0b0a9345ebb580d02346b1ed76"></a>

<table><thead><tr><th width="180">画面</th><th width="188">利用箇所</th><th></th></tr></thead><tbody><tr><td>ユーザー</td><td>検索条件</td><td>検索フォーム内の<code>ユーザーディメンション（コードレス/カスタムイベント）</code>にて発生回数を条件に設定できます</td></tr><tr><td></td><td>ユーザーリスト</td><td>カスタムイベントごとの発生回数を表示できます</td></tr><tr><td>イベント</td><td>検索条件</td><td>検索フォーム内の<code>カスタムイベント</code>にて特定のイベント・フィールド・値などを条件に設定できます</td></tr><tr><td></td><td>ファセット</td><td>検索結果のファセットにて特定のフィールドの内訳が確認できます</td></tr><tr><td>ライフサイクル</td><td>ライフサイクル条件</td><td>・エントリー条件<br>・活性化済みの条件<br>・ファンの条件</td></tr><tr><td>キー行動</td><td>キー行動の条件</td><td>カスタムイベントを条件として設定できます</td></tr><tr><td>ファネル</td><td>ステップの条件</td><td>検索フォーム内の<code>カスタムイベント</code>にて特定のイベント・フィールド・値などを条件に設定できます</td></tr><tr><td></td><td>ファセット</td><td>検索結果のファセットにて特定のフィールドの内訳が確認できます</td></tr><tr><td>n1ユーザー</td><td>イベントタイムライン</td><td>ここのイベントデータにある「イベントデータを表示」から送信されたイベントの詳細を詳細を確認できます</td></tr><tr><td>セグメント</td><td>検索条件</td><td>カスタムイベントの発生回数をセグメントの条件に設定できます</td></tr><tr><td>CVダッシュボード</td><td>コンバージョン</td><td>中間コンバージョン/最終コンバージョンに設定したカスタムイベントをCVとして確認できます</td></tr><tr><td>CV到達経路分析</td><td>コンバージョン</td><td>中間コンバージョン/最終コンバージョンに設定したカスタムイベントをCVとして確認できます</td></tr><tr><td>カスタムダッシュボード</td><td>チャート</td><td>カスタムイベントのチャートをダッシュボードに追加できます</td></tr></tbody></table>
