メタデータ

ユーザーのカスタマイズデータを保存できるように、メタデータ（metadata）のフィールドを提供しています。

メタデータ（Metadata）は、は最大10個の項目により構成されたリストで、それぞれの項目が以下のフォーマットに従います。

{
  "name": "sample_name",
  "type": "string",
  "value": "sample_string"
}

nameフィールドは以下の予約値（id、instanceId、model、collection、key、createdAt、updatedAt、expiresAt）以外、自由に設定できますが、重複することはできません。サービスがデータ型を理解できるように、typeフィールドを指定する必要があります。現在、string（文字列）、integer (32ビット符号付き整数)、boolean（ブーリアン型）、float（単精度浮動小数点数）の4つのデータ型を提供しています。入力値は、そのデータ型に従う必要があります。そうしないと、エラーが発生します。文字列型に長さ制限はありませんが、文字列が5MBを超えるとHTTPコード413が返されます。

メタデータのフィールドはインデックス化されていないため、リストまたは検索APIで事前フィルタリング条件として使用することはできません。

❗️
更新時の注意事項
更新時には、必ず既存のすべてのメタデータのフィールドを含めてください。そうしないと、データが失われる恐れがあります。

metadataの柔軟性の故、一つの全体としてしか扱うことができません。つまり、顔データを更新しようとするときは、metadata のすべてのフィールドを含む必要があります。例えば、顔データに既に4つの項目があり、ageの項目だけを"28"に更新したい場合、「正しい更新本体」の内容でリクエストしなければなりません。「間違った更新本文」の内容を使用すると、ageの項目のみが保持され、他のすべてのフィールドが失われます。

"metadata": [
   {
     "name": "name",
     "type": "string",
     "value": "John"
   },
   {
     "name": "age",
     "type": "integer",
     "value": 27
   },
   {
     "name": "male",
     "type": "boolean",
     "value": true
   },
   {
     "name": "point",
     "type": "float",
     "value": 10.5
   }
]

"metadata": [
   {
     "name": "name",
     "type": "string",
     "value": "John"
   },
   {
     "name": "age",
     "type": "integer",
     "value": 28
   },
   {
     "name": "male",
     "type": "boolean",
     "value": true
   },
   {
     "name": "point",
     "type": "float",
     "value": 10.5
   }
]

"metadata": [
   {
     "name": "age",
     "type": "integer",
     "value": 28
   }
]