> 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/data-extension/user-profile.md).

# ユーザープロファイル

Wicleのユーザープロファイルのフィールド設定、IDと属性をコードで送信する方法、CSVで計測済みユーザーの属性を更新する手順を説明します。

## ユーザープロファイルでできること <a href="#what-you-can-do" id="what-you-can-do"></a>

会員ランクや契約プランなどの属性をユーザーごとに保存し、管理画面で閲覧・検索できます。同じユーザーのID（`user_id`）を送信すると、異なるデバイスのデータを同一ユーザーにまとめられます。

ユーザーの属性はユーザープロファイルで、購入完了などの行動と購入金額は[カスタムイベント](https://docs.wicle.io/data-extension/custom-event.md)で送信します。来訪回数など、Wicleがイベントから計算する値は[ユーザーディメンション](https://docs.wicle.io/data-setting/data-type.md#block-16d0b91f460540e5a5c31886911c676e)として扱われます。

ユーザープロファイルの更新方法には、サイトからコードで送信する方法と、CSVで計測済みのユーザーをまとめて更新する方法があります。

## カスタムフィールドの設定方法 <a href="#custom-field-settings" id="custom-field-settings"></a>

会員ランクなど独自の項目を使う場合は、送信やCSVインポートの前にカスタムフィールドを登録します。`user_id`や`name`など、後述のデフォルトフィールドは登録不要です。保存したカスタムフィールドのキーは変更できないため、送信データやCSVで使う名前を決めてから登録してください。

1. `データ設定`で、`ユーザープロファイル`の`フィールド設定`を開きます。
2. `フィールドを追加`を選択し、`表示名`・`キー`・`データ型`を入力します。表示名は管理画面で使う名前、キーは送信データやCSVの列名に使う識別子です。
3. `保存`を選択し、確認画面でも保存を確定します。

<figure><img src="https://1516189518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhDtk9aBzYOvC8RRWtKCd%2Fuploads%2F508RsMHUlD98CJOafZp3%2Fimage.png?alt=media&amp;token=0476beb1-5516-4480-a3c1-d47ce91a8139" alt="データ設定からユーザープロファイルを開くメニュー"><figcaption></figcaption></figure>

| データ型    | 設定する値                 | 例              |
| ------- | --------------------- | -------------- |
| String  | 文字列                   | 会員ランクや契約プランの名前 |
| Number  | 数値                    | 契約金額や保有ポイント    |
| Boolean | 真偽値（`true` / `false`） | 有料会員かどうか       |

表示名は1〜100文字、キーは1〜40文字です。キーには、次の制約があります。

* 使用できる文字は、半角英数字とアンダースコア（`_`）です。
* 先頭は英字またはアンダースコアにします。
* デフォルトフィールド、作成済みのユーザープロファイルのカスタムフィールド、グループプロファイルと同じキーは使えません。

カスタムフィールド数の標準の上限は、Freeプランが3個、Growthプランが10個、Customプランが20個です。個別の設定によって異なる場合があります。現在の上限は、[プロジェクトのリミット](https://docs.wicle.io/organization-project/project-setting/limitation.md)で確認してください。

{% hint style="info" %}
カスタムフィールドは、A/Bテストのディメンション条件でも使えます。施策の配信条件で参照中のフィールドは削除できません。詳しくは[A/Bテストの配信設定](https://docs.wicle.io/action/experiment/settings.md)をご覧ください。
{% endhint %}

デフォルトで使用できるフィールドは次のとおりです。

| キー               | 送信する内容                       |
| ---------------- | ---------------------------- |
| `user_id`        | ユーザーを一意に識別するID。送信時に必須です      |
| `name`           | ユーザーの表示名。Wicleの各画面でも使います     |
| `email`          | メールアドレス                      |
| `photo`          | プロフィール画像のURL。Wicleの各画面でも使います |
| `isInternalUser` | 社内ユーザーなら`true`、それ以外なら`false` |

## 実装方法 <a href="#implementation" id="implementation"></a>

[計測タグ](https://docs.wicle.io/initial-setting/tag.md)を設置したサイトに、ユーザープロファイルを送信する処理を組み込みます。設定画面のコードサンプルを実装担当者に渡し、送信するタイミングと値を指定してください。ログイン後や会員情報の更新時など、ユーザーのIDと属性が分かるタイミングで送信します。

### 送信するIDと属性 <a href="#precautions" id="precautions"></a>

* `user_id`は必須です。文字列（String型）で256文字以下にします。指定せずに送信するとエラーになります。
* 同じユーザーには同じID、異なるユーザーには異なるIDを使います。誤ったIDを送ると、別のユーザーのデータがまとめられる場合があります。
* ログイン前など、IDを特定できない場合は送信しません。空文字や全ユーザーに共通のIDを指定しないでください。

第3引数のオブジェクトに、`user_id`と更新したい属性を指定します。更新しないフィールドは省略してください。次はデフォルトフィールドを送信する例です。各値をサイト側のユーザー情報に置き換えます。

```javascript
window.krt('send', 'identify', {
  user_id: '<USER_ID>',
  name: '<NAME>',
  email: '<EMAIL>',
  photo: '<IMAGE_URL>',
  isInternalUser: false
});
```

`identify`による送信は、計測イベント数にカウントされません（課金対象外）。同一端末から同じ内容を再送信した場合は、送信が抑制されることがあります。

### タグ読み込み前のエラーを防ぐ <a href="#wait-for-krt" id="wait-for-krt"></a>

計測タグの初期化コードは、`window.krt`を定義し、外部スクリプトの読み込みが完了するまで呼び出しを保存します。初期化コードを送信処理より先に実行すれば、外部スクリプトの読み込み完了を待つ必要はありません。

初期化コードより先に送信処理を実行すると、`window.krt is not a function`のようなJavaScriptエラーが発生します。たとえば、ページ下部にタグを設置した場合や、GTMによるタグ配信より先に送信処理が動く場合です。

まず、初期化コードが送信処理より先に実行されるように設置してください。実行順を揃えられない場合は、次の例のように`window.krt`が定義されるまで待ちます。

```javascript
function whenKrtReady(callback) {
  if (typeof window.krt === 'function') return callback();
  var timer = setInterval(function () {
    if (typeof window.krt === 'function') {
      clearInterval(timer);
      callback();
    }
  }, 200);
}

whenKrtReady(function () {
  window.krt('send', 'identify', { user_id: '<USER_ID>', name: '<NAME>' });
});
```

{% hint style="info" %}
計測タグを `</head>` タグの直前など、できるだけ早い位置に設置することで、このエラーが発生しにくくなります。
{% endhint %}

### 実装後の確認方法 <a href="#verification" id="verification"></a>

サイト上で送信処理が動く操作を行い、[Chrome拡張のイベントビューア](https://docs.wicle.io/chrome-extension/event-viewer.md)でユーザープロファイルの送信内容を確認します。`user_id`が正しいか、更新したいフィールドに期待する値が入っているかを確認してください。

<figure><img src="https://1516189518-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhDtk9aBzYOvC8RRWtKCd%2Fuploads%2F2VYOxkpsPIVsXWsAP3aF%2Fimage.png?alt=media&amp;token=1f8d8b14-f32f-46bf-9360-aa5833650a6b" alt="Chrome拡張でユーザープロファイルの送信内容を確認する画面"><figcaption></figcaption></figure>

送信内容が表示されない場合は、処理が実行されているか、計測タグの初期化より先に呼び出していないかを確認します。値が異なる場合は、送信時に指定するIDや属性を確認してください。同じ内容の再送信は抑制される場合もあります。

管理画面への反映には[集計の時間](https://docs.wicle.io/data-setting/measured-data/renewal-period.md)がかかります。解決しない場合は、[サポート窓口](https://docs.wicle.io/other/support/contact.md)へお問い合わせください。

## データインポート <a href="#data-import" id="data-import"></a>

CSVファイルで、計測済みのユーザーの属性をまとめて更新できます。新しいユーザーを作成する機能ではありません。存在しない`user_id`の行は、更新されません。

カスタムフィールドを更新する場合は、先に[フィールド設定](#custom-field-settings)で登録してください。

### CSVファイル形式 <a href="#csv-format" id="csv-format"></a>

CSVファイルは30MB以下にします。ヘッダー行と`user_id`列が必須です。それ以外の列名には、更新したいフィールドのキーを指定します。

次の例を使う場合は、`int_field`をNumber、`string_field`をString、`boolean_field`をBooleanとして事前に登録します。`user1`・`user2`は、更新対象のユーザーIDに置き換えてください。

```csv
user_id,int_field,string_field,boolean_field
user1,123,ABC,true
user2,456,DEF,false
```

### 注意事項 <a href="#notes" id="notes"></a>

* `user_id`列がない場合、IDが空欄の場合、未登録のキーやデータ型に合わない値がある場合は、インポートを開始できません。
* Boolean型の列には、`true`または`false`を指定します。大文字・小文字は区別しません。
* 同じフィールドをCSVと`identify`の両方で更新すると、値が上書きされる場合があります。更新元を一方に揃えるか、両方から同じ内容を送信してください。

### インポートの手順 <a href="#import-steps" id="import-steps"></a>

1. `データ設定`で、`ユーザープロファイル`の`データインポート`を開きます。
2. `ファイルを選択`からCSVファイルを選びます。
3. `インポートを実行`を選択し、確認画面で`実行`を選択します。
4. しばらく待って画面を再読み込みし、`インポート履歴`のステータスが`成功`になったことを確認します。`現在のプロファイルデータを確認`から、更新内容も確認できます。
