ユーザープロファイルデータ

データはユーザーのプロファイルに保存でき、その後システム全体で利用できます。これらの属性には、セマンティックユーザー属性を含めることができます。

ユーザープロファイルデータに対する操作は、userDataOps メッセージタイプを使用します。

操作

operations パラメーターは、操作の配列を受け取ります。これらは以下のタイプになります。

• set - プロファイル属性を指定された値に設定します
• setOnce - プロファイル属性が現在存在しない場合に、指定された値に設定します
• unset - プロファイル属性を削除します
• increment - プロファイル属性を、指定された整数値だけ増加させます

一度に必要な数の操作を送信でき、それらは複数のタイプであっても構いません。

有効期限

set と setOnce の両方で、expiresOn プロパティを供給できます。これは、ミリ秒単位のUTCのエポックタイムの整数である必要があります。

設定

プロファイルに属性を設定するために使用します。

例

この例では、favoriteColor 属性を red に設定します。このプロパティは2024年の初め頃に有効期限が切れます。

{
  "type": "userDataOps",
  // 操作
  "operations": [{
    "type": "set",
    "key": "favoriteColor",
    "value": "red",
    "expiresOn": 1704139200000
  }],
  // 一般的なメッセージプロパティ
  "writeKey": "<WRITE_KEY>",
  "messageId": "213d7f53-ffac-4a58-a20b-5d609455d64c",
  "timestamp": "2022-11-15T04:31:44Z",
  "userId": "5.wBOQ7hKNVgIUcJn5IbX.1670273082",
  "sessionId": "28eef5c8-1098-4f76-abe9-58a921cabfaf",
  "pageId": "eca34e0f-4802-4fa4-8db1-11c727839dbd"
  "context": {
    "page": {
      "url": "https://www.weather-station.com/",
      "path": "/",
      "referrer": "",
      "title": "Weather Station - Get Weather"
    },
  }
}

一度だけ設定

プロファイルにまだ設定されていない場合にのみ、属性を設定するために使用します。

例

この例は、set 例の後に実行された場合、値が既に設定されているため、プロファイル属性を変更しません。

{
  "type": "userDataOps",
  // 操作
  "operations": [{
    "type": "setOnce",
    "key": "favoriteColor",
    "value": "green"
  }],
  // 一般的なメッセージプロパティ
  "writeKey": "<WRITE_KEY>",
  "messageId": "213d7f53-ffac-4a58-a20b-5d609455d64c",
  "timestamp": "2022-11-15T04:31:44Z",
  "userId": "5.wBOQ7hKNVgIUcJn5IbX.1670273082",
  "sessionId": "28eef5c8-1098-4f76-abe9-58a921cabfaf",
  "pageId": "eca34e0f-4802-4fa4-8db1-11c727839dbd"
  "context": {
    "page": {
      "url": "https://www.weather-station.com/",
      "path": "/",
      "referrer": "",
      "title": "Weather Station - Get Weather"
    },
  }
}

解除

プロファイルから属性を削除するために使用します。

例

この例では、favoriteColor 属性が削除されます。

{
  "type": "userDataOps",
  // 操作
  "operations": [{
    "type": "unset",
    "key": "favoriteColor"
  }],
  // 一般的なメッセージプロパティ
  "writeKey": "<WRITE_KEY>",
  "messageId": "213d7f53-ffac-4a58-a20b-5d609455d64c",
  "timestamp": "2022-11-15T04:31:44Z",
  "userId": "5.wBOQ7hKNVgIUcJn5IbX.1670273082",
  "sessionId": "28eef5c8-1098-4f76-abe9-58a921cabfaf",
  "pageId": "eca34e0f-4802-4fa4-8db1-11c727839dbd"
  "context": {
    "page": {
      "url": "https://www.weather-station.com/",
      "path": "/",
      "referrer": "",
      "title": "Weather Station - Get Weather"
    },
  }
}

インクリメント

プロファイル属性の値を増加させるために使用します。

警告

指定された名前の属性が既に存在し、それが整数でない場合、値は 1 に設定されます。これは、値が実際の値 1 ではなく、文字列 "1" であっても同様です。また、10.5 のような浮動小数点値も、最初のインクリメント呼び出しで 1 にリセットされます。

例

この例では、numberOfLoginAttempts 属性が 1 だけ増加します。

{
  "type": "userDataOps",
  // 操作
  "operations": [{
    "type": "increment",
    "key": "numberOfLoginAttempts",
    "value": 1
  }],
  // 一般的なメッセージプロパティ
  "writeKey": "<WRITE_KEY>",
  "messageId": "213d7f53-ffac-4a58-a20b-5d609455d64c",
  "timestamp": "2022-11-15T04:31:44Z",
  "userId": "5.wBOQ7hKNVgIUcJn5IbX.1670273082",
  "sessionId": "28eef5c8-1098-4f76-abe9-58a921cabfaf",
  "pageId": "eca34e0f-4802-4fa4-8db1-11c727839dbd"
  "context": {
    "page": {
      "url": "https://www.weather-station.com/",
      "path": "/",
      "referrer": "",
      "title": "Weather Station - Get Weather"
    },
  }
}