Get DataFields（データフィールドの取得）

日本語版はAIによる翻訳です。正確な情報については英語版をご参照ください。

送信したパラメーターに一致する各データフィールドのIDと型を返します。返された dataFieldId は、トリートメントの配信条件（eligibility rules）などでデータフィールドを参照する際に使用します。

POST https://apis.auxia.io/v1/GetDataFields

x-api-key ヘッダーに Treatment Management のAPIキーが必要です。読み取り専用のAPIのため、安全にリトライできます。

リクエストボディ

フィールド	型	説明
`projectId`	string	必須。 AuxiaのプロジェクトID。
`dataFieldParams`	DataFieldParams の配列	必須。取得するデータフィールド。1件以上指定してください。

DataFieldParams

各項目は1つのデータフィールドを表します。以下のフィールドのうち、いずれか1つだけを指定してください。

フィールド	型	説明
`userAttributeDataFieldParams`	object	ユーザー属性。下記「ユーザー属性」を参照してください。
`treatmentDataFieldParams`	object	トリートメントのインタラクションの件数または日時。下記「トリートメントのインタラクション」を参照してください。
`eventDataFieldParams`	object	イベントの件数または日時。下記「イベント」を参照してください。

ユーザー属性

フィールド	型	説明
`propertyName`	string	必須。ユーザー属性の名前（例：`loyalty_tier`）。

トリートメントのインタラクション

フィールド	型	説明
`treatmentInteractionType`	enum	必須。 `SENT`、`VIEWED`、`CLICKED`、`SNOOZED`、`DISMISSED`、`CTA_COMPLETED`、`SWIPE` のいずれか。
`treatmentId`、`surfaceId`、`surfaceName`、`treatmentTypeId`	string	任意。いずれか1つまで指定でき、そのトリートメント、サーフェス、またはトリートメントタイプのインタラクションのみを集計します。いずれも指定しない場合、プロジェクト内のすべてのトリートメントのインタラクションを集計します。
下記「集計方法」のいずれか1つ	object	必須。いずれか1つだけを指定してください。
`isDistinctInteraction`	boolean	任意。`true` の場合、ユーザーごとに1回として集計します。`dailyCountAggregation` と組み合わせた場合のみ有効です。デフォルトは `false` です。

イベント

フィールド	型	説明
`eventSchemaName`	string	必須。イベント名（例：`Stream Finished`）。
`propertyValueByPropertyName`	map	任意。プロパティが指定した値に一致するイベントのみを集計します。各値には `longValue`、`doubleValue`、`stringValue`、`booleanValue`、`timestampValue` のいずれか1つを指定します。
下記「集計方法」のいずれか1つ	object	必須。いずれか1つだけを指定してください。

集計方法

フィールド	説明
`dailyCountAggregation`	直近の一定期間における発生回数。`windowName` は必須で、`LAST_1D`、`LAST_7D`、`LAST_14D`、`LAST_28D`、`LAST_56D` のいずれかを指定します。指定しない項目はどのデータフィールドにも一致しません。
`firstTimestampAggregation`	最初に発生した日時。空のオブジェクト `{}` を指定します。
`latestTimestampAggregation`	最後に発生した日時。`{}` を指定します。
`daysSinceFirstTimestampAggregation`	最初の発生からの経過日数。`{}` を指定します。
`daysSinceLastTimestampAggregation`	最後の発生からの経過日数。`{}` を指定します。

レスポンス

フィールド	型	説明
`dataFields`	オブジェクトの配列	`dataFieldParams` の各項目に対応するエントリ。リクエストと同じ順序で返されます。

dataFields の各エントリは次のとおりです。

フィールド	型	説明
`dataFieldId`	string	データフィールドのID。64ビット整数を文字列として返します。
`dataFieldType`	string	`INTEGER`、`DOUBLE`、`STRING`、`BOOLEAN`、`TIMESTAMP_SECONDS`、`INTEGER_LIST`、`DOUBLE_LIST`、`STRING_LIST` のいずれか。
`dataFieldParams`	object	このエントリが一致したリクエストの項目（送信した内容のまま）。

例

Request

curl --request POST 'https://apis.auxia.io/v1/GetDataFields' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: API_KEY' \
  --data '{
    "projectId": "PROJECT_ID",
    "dataFieldParams": [
      {
        "userAttributeDataFieldParams": {
          "propertyName": "loyalty_tier"
        }
      },
      {
        "treatmentDataFieldParams": {
          "treatmentInteractionType": "VIEWED",
          "surfaceName": "HOME_SCREEN",
          "dailyCountAggregation": { "windowName": "LAST_7D" }
        }
      }
    ]
  }'

Response (200)

{
  "dataFields": [
    {
      "dataFieldId": "8821",
      "dataFieldParams": {
        "userAttributeDataFieldParams": { "propertyName": "loyalty_tier" }
      },
      "dataFieldType": "STRING"
    },
    {
      "dataFieldId": "8822",
      "dataFieldParams": {
        "treatmentDataFieldParams": {
          "treatmentInteractionType": "VIEWED",
          "surfaceName": "HOME_SCREEN",
          "dailyCountAggregation": { "windowName": "LAST_7D" }
        }
      },
      "dataFieldType": "INTEGER"
    }
  ]
}

エラー

エラーは標準のエラーレスポンスの形式で返されます。message ではなく、HTTPステータスで判定してください。

ステータス	発生条件
400	`projectId` が数値でない、`dataFieldParams` が空である、3種類のパラメーターのいずれも指定されていない項目がある、必須フィールドが欠落している、または `dailyCountAggregation` 以外で `isDistinctInteraction` が指定されている。
403	APIキーがない、無効である、またはこのプロジェクトのTreatment Managementのキーではない。
404	`dataFieldParams` の項目のうち少なくとも1つが、プロジェクト内のどのデータフィールドにも一致しない、または複数のデータフィールドに一致する。例：まだ登録されていないユーザー属性、存在しない `surfaceName`。

404 の場合、リクエスト全体が失敗します。存在するデータフィールドも含めて何も返されず、message には最初に一致しなかった項目のみが示されます。存在するデータフィールドと、存在しない項目の一覧を取得するには、allowMissing（下記）を設定してください。

`allowMissing` による部分的な結果の取得

allowMissing を true に設定すると、一部の項目が一致しない場合でも、存在するデータフィールドと、一致しなかった項目の一覧を取得できます。

フィールド	型	説明
`allowMissing`（リクエスト）	boolean	任意。デフォルトは `false`。`true` の場合、どのデータフィールドにも一致しない項目は、リクエストを `404` で失敗させる代わりに `missing` で返されます。
`missing`（レスポンス）	DataFieldParams の配列	`dataFieldParams` のうち、どのデータフィールドにも一致しなかった項目（送信した内容のまま）。`allowMissing` が `true` の場合のみ返されます。

allowMissing を true に設定した場合は、次のようになります。

一部またはすべての項目が一致しない場合でも、レスポンスは 200 になります。
dataFields には一致した項目のみが含まれます。各エントリとリクエストの対応は、位置ではなく dataFieldParams で照合してください。
複数のデータフィールドに一致する項目がある場合は、引き続き 404 でリクエストが失敗します。
400 および 403 のエラーは変わりません。

Request body

{
  "projectId": "PROJECT_ID",
  "allowMissing": true,
  "dataFieldParams": [
    { "userAttributeDataFieldParams": { "propertyName": "loyalty_tier" } },
    { "userAttributeDataFieldParams": { "propertyName": "spring_campaign_list" } }
  ]
}

Response (200)

{
  "dataFields": [
    {
      "dataFieldId": "8821",
      "dataFieldParams": {
        "userAttributeDataFieldParams": { "propertyName": "loyalty_tier" }
      },
      "dataFieldType": "STRING"
    }
  ],
  "missing": [
    { "userAttributeDataFieldParams": { "propertyName": "spring_campaign_list" } }
  ]
}

​リクエストボディ

​DataFieldParams

​ユーザー属性

​トリートメントのインタラクション

​イベント

​集計方法

​レスポンス

​例

​エラー

​allowMissing による部分的な結果の取得

リクエストボディ

DataFieldParams

ユーザー属性

トリートメントのインタラクション

イベント

集計方法

レスポンス

例

エラー

`allowMissing` による部分的な結果の取得