ユーザープロパティ

Streams でのセグメンテーションや条件ロジックに使用できるユーザーレベルのプロパティを管理します。

プロパティはユーザーレベルで定義でき、後で Streams でのセグメンテーションや条件ロジックに使用できます。

ブラウザ経由の更新

ユーザープロパティは、Fanplayr の Data Layer 配列にコマンドをプッシュすることで、ブラウザから管理できます。以下の操作がサポートされています。

user.set

ユーザーレコードにプロパティを設定します。同じプロパティ名に既存の値がある場合は上書きされます。

使用法:

fanplayr_api.push({
  "_type": "user.set",
  "key": "email"
  "value": "user@domain.com",
  // オプション：プロパティを7日後に期限切れにする
  "maxAge": 7 * 60 * 60 * 24
});

引数	型	説明
key	文字列 (必須)	保存するプロパティの名前。
value	任意 (必須)	指定されたプロパティ名に保存する値。
maxAge	数値 (オプション)	プロパティを保存する最大期間を秒単位で指定します。

user.setOnce

ユーザーレコードにプロパティを設定します。ただし、プロパティがまだ存在しない場合に限ります。

使用法:

fanplayr_api.push({
  "_type": "user.setOnce",
  "key": "firstSeen"
  "value": new Date()
});

引数	型	説明
key	文字列 (必須)	保存するプロパティの名前。
value	任意 (必須)	指定されたプロパティ名に保存する値。
maxAge	数値 (オプション)	プロパティを保存する最大期間を秒単位で指定します。

user.increment

数値プロパティを増減させます。プロパティが存在しない場合は作成され、指定された値に設定されます。

使用法:

fanplayr_api.push({
  "_type": "user.increment",
  "key": "counter1"
  "value": 1
});

fanplayr_api.push({
  "_type": "user.increment",
  "key": "remainingCount"
  "value": -1
});

引数	型	説明
key	文字列 (必須)	保存するプロパティの名前。
value	数値 (オプション)	増減させる量。デフォルトは1です。
maxAge	数値 (オプション)	プロパティを保存する最大期間を秒単位で指定します。

user.unset

ユーザーレコードからプロパティを削除します。

使用法:

fanplayr_api.push({
  _type: 'user.unset',
  key: 'email'
});

引数	型	説明
key	文字列 (必須)	削除するプロパティの名前。

Streams 経由の更新

ユーザープロパティは、Streams の Update User Data アクションを介して更新することもできます。

Streamsの「ユーザーデータを更新」アクションインターフェース

制限事項

最大ストレージサイズ

各ユーザーに保存できる合計サイズは、約20KBが上限です。この制限を超えるユーザーデータの更新は無視され、保持されません。各プロパティの名前、値、有効期限情報は、この全体的な制限にカウントされます。