Lookup Table API 2

地域

ベースURLは、プロジェクトのデータのレジデンシーによって異なります。このページ内のすべての例では、プロジェクトがAmplitudeのEUデータセンターを利用している場合を除き、デフォルトのベースURLを使用してください。EUデータセンターを利用している場合は、この表に記載されているEU用のベースURLを使用してください。

このAPIは、data-api.amplitude.com（デフォルト）またはdata-api.eu.amplitude.com（EU）を使用します。イベント取り込みではapi2.amplitude.comまたはapi.amplitude.comを使用します。実験管理ではexperiment.amplitude.comを使用します。https://analytics.amplitude.comホスト名は、このAPIエンドポイントではなく、アナリティクスウェブアプリ（ブラウザーUI）です。

データのレジデンシー	ベースURL
デフォルト	`https://data-api.amplitude.com`
欧州連合	`https://data-api.eu.amplitude.com`

CSVファイルの要件

CSVファイルは次の要件に従う必要があります。

ファイルの最大サイズは100MBです。ファイルの行数は1,000,000行を超えることはできません。
最初の行には、列名またはヘッダーを含める必要があります。
最初の列はマッピングプロパティ値に対応している必要があり、_一意_の値を含んでいる必要があります。ルックアップテーブルは完全な一致を検索します。また、_大文字と小文字_を区別します。
各列はコンマで区切ります。
改行を使用して行を区切ります。
フィールド値にカンマや引用符が含まれている場合は、値を二重引用符で囲みます。最初の二重引用符は列データの開始を示し、最後の二重引用符は列データの終了を示します。値に二重引用符付きの文字列が含まれている場合、Amplitudeはそれらの引用符を2つの二重引用符""に置き換えます。

ルックアップテーブルの作成

ルックアップテーブルオブジェクトを作成するには、既存のプロパティを新たに作成するプロパティにマッピングするCSVをアップロードします。multipart/form-dataコンテンツタイプを指定してリクエストを送信します。

パラメータ

名前	概要
`name`	必須です。タイプ：`string`。テーブルの名前。
`file`	必須です。タイプ：`file`。マッピングをCSVで表現しています。
`key`	必須です。タイプ：`string`。ルックアップテーブルのキーとして使用するCSV形式の列です。
`property`	必須です。タイプ：`JSON`。CSVのキー列にマップするAmplitudeのプロパティ。
`property.value`	必須です。タイプ：`string`。Amplitudeのプロパティ名。
`property.type`	必須です。タイプ：`string`。Amplitudeのプロパティのタイプ。
`property.groupType`	オプションです。タイプ：`string`。プロパティがグループプロパティである場合にのみ必要です。

リクエスト例

curl

curl -L -X POST 'https://data-api.amplitude.com/api/3/lookup_table' \
        -u API_KEY:SECRET_KEY \
        -F 'file=@"/path/to/file.csv";type=text/csv' \
        -F 'name=":name"' \
        -F 'key=":key"' \
        -F 'property="{\"value\": \":propertyName\", \"type\": \":propertyType\", \"groupType\":  \":propertyGroupType\"}";type=application/json'

レスポンス

json

{
  "appId": "<projectId>",
  "name": "example-lookup",
  "columnHeaders": ["Language"],
  "createdAt": 1715912516,
  "createdBy": "api",
  "lastModifiedAt": 1715912516,
  "lastModifiedBy": "api",
  "isDeleted": false,
  "isConfigured": true,
  "keyColumnHeader": "SKU",
  "keyProperty": {
    "type": "event",
    "value": "example",
    "groupType": "User"
  },
  "fileName": "lookup-table-example.csv",
  "rowCount": 3,
  "sizeBytes": 0
}

ルックアップテーブルを取得する

ルックアップテーブルをその名前で取得します。

パラメータ

名前	概要
`name`	必須です。タイプ：`string`。テーブルの名前。

リクエスト例

curl -L -X GET 'https://data-api.amplitude.com/api/3/lookup_table/:name' \
        -u API_KEY:SECRET_KEY

レスポンス

json

{
  "appId": "<projectId>",
  "name": "example-lookup",
  "columnHeaders": ["Language"],
  "createdAt": 1715912516,
  "createdBy": "api",
  "lastModifiedAt": 1715912516,
  "lastModifiedBy": "api",
  "isDeleted": false,
  "isConfigured": true,
  "keyColumnHeader": "SKU",
  "keyProperty": {
    "type": "event",
    "value": "example",
    "groupType": "User"
  },
  "fileName": "lookup-table-example.csv",
  "rowCount": 3,
  "sizeBytes": 5
}

CSVをダウンロードする

ルックアップテーブルオブジェクトをCSV形式でダウンロードします。増分変更があればすべて、ダウンロードされたファイルに適用されています。

パラメータ

名前	概要
`name`	必須です。タイプ：`string`。テーブルの名前。

リクエスト例

curl -L -X GET 'https://data-api.amplitude.com/api/3/lookup_table/:name/csv' \
        -u API_KEY:SECRET_KEY

ルックアップテーブルを上書きする

すでにAmplitudeにアップロードされているCSVを置き換えるCSVをアップロードすることで、ルックアップテーブルオブジェクトを上書きできます。multipart/form-dataコンテンツタイプを指定してリクエストを送信します。

パラメータ

名前	概要
`name`	必須です。タイプ：`string`。テーブルの名前。
`file`	オプションです。タイプ：`file`。マッピングをCSVで表現しています。
`property`	オプションです。タイプ：`JSON`。CSVのキー列にマップするAmplitudeのプロパティ。
`property.value`	オプションです。タイプ：`string`。Amplitudeのプロパティ名。
`property.type`	オプションです。タイプ：`string`。Amplitudeのプロパティのタイプ。
`property.groupType`	オプションです。タイプ：`string`。プロパティがグループプロパティである場合にのみ必要です。

リクエスト例

curl -L -X PUT 'https://data-api.amplitude.com/api/3/lookup_table/:name' \
        -u API_KEY:SECRET_KEY \
        -F 'file=@"/path/to/file.csv";type=text/csv' \
        -F 'property="{\"value\": \":propertyName\", \"type\": \":propertyType\", \"groupType\":  \":propertyGroupType\"}";type=application/json'

レスポンス

json

{
  "appId": "<projectId>",
  "name": "example-lookup",
  "columnHeaders": ["Language"],
  "createdAt": 1715912516,
  "createdBy": "api",
  "lastModifiedAt": 1715912516,
  "lastModifiedBy": "api",
  "isDeleted": false,
  "isConfigured": true,
  "keyColumnHeader": "SKU",
  "keyProperty": {
    "type": "event",
    "value": "example",
    "groupType": "User"
  },
  "fileName": "lookup-table-example.csv",
  "rowCount": 3,
  "sizeBytes": 0
}

ルックアップテーブルの更新

ルックアップテーブルの列とデータを更新します。CSVファイルを提供した場合、Amplitudeはそのファイルを既存のCSVとマージします。これにより、完全な置換ではなく、CSVの増分更新に対応します。

パラメータ

名前	概要
`name`	タイプ：`string`。テーブルの名前。
`file`	タイプ：`file`。マッピングをCSVで表現しています。
`property`	タイプ：`JSON`。CSVのキー列にマップするAmplitudeのプロパティ。
`property.value`	タイプ：`string`。Amplitudeのプロパティ名。
`property.type`	タイプ：`string`。Amplitudeのプロパティのタイプ。
`property.groupType`	タイプ：`string`。プロパティがグループプロパティである場合にのみ必要です。

リクエスト例

curl -L -X PATCH 'https://data-api.amplitude.com/api/3/lookup_table/:name' \
        -u API_KEY:SECRET_KEY
        -F 'file=@"/path/to/file.csv";type=text/csv' \
        -F 'property="{\"value\": \":propertyName\", \"type\": \":propertyType\", \"groupType\":  \":propertyGroupType\"}";type=application/json'

レスポンス

json

{
  "appId": "<projectId>",
  "name": "example-lookup",
  "columnHeaders": ["Language"],
  "createdAt": 1715912516,
  "createdBy": "api",
  "lastModifiedAt": 1715912516,
  "lastModifiedBy": "api",
  "isDeleted": false,
  "isConfigured": true,
  "keyColumnHeader": "SKU",
  "keyProperty": {
    "type": "event",
    "value": "example",
    "groupType": "User"
  },
  "fileName": "lookup-table-example.csv",
  "rowCount": 3,
  "sizeBytes": 0
}

ルックアップテーブルの削除

ルックアップテーブルを削除します。

パラメータ

名前	概要
`name`	必須です。タイプ：`string`。テーブルの名前。

リクエスト例

curl -L -X DELETE 'https://data-api.amplitude.com/api/3/lookup_table/:name' \
        -u API_KEY:SECRET_KEY

レスポンス

json

{
  "message": "Lookup table <:name> deleted successfully",
  "success": true
}

すべてのルックアップテーブルを表示

プロジェクトのすべてのルックアップテーブルを一覧表示します。

リクエスト例

curl -L -X GET 'https://data-api.amplitude.com/api/3/lookup_table' \
        -u API_KEY:SECRET_KEY

レスポンス

json

[
  {
    "appId": "<projectId>",
    "name": "example-lookup",
    "columnHeaders": ["Language"],
    "createdAt": 1715912516,
    "createdBy": "api",
    "lastModifiedAt": 1715912516,
    "lastModifiedBy": "api",
    "isDeleted": false,
    "isConfigured": true,
    "keyColumnHeader": "SKU",
    "keyProperty": {
      "type": "event",
      "value": "example",
      "groupType": "User"
    },
    "fileName": "lookup-table-example.csv",
    "rowCount": 3,
    "sizeBytes": 5
  },
  {
    "appId": "<projectId>",
    "name": "example-lookup-2",
    "columnHeaders": ["Language"],
    "createdAt": 1715912516,
    "createdBy": "api",
    "lastModifiedAt": 1715912516,
    "lastModifiedBy": "api",
    "isDeleted": false,
    "isConfigured": true,
    "keyColumnHeader": "SKU",
    "keyProperty": {
      "type": "event",
      "value": "example",
      "groupType": "User"
    },
    "fileName": "lookup-table-example.csv",
    "rowCount": 50,
    "sizeBytes": 10
  }
]

エラーコード

すべてのルックアップテーブルAPIには、これらの共通エラーコードがあります。

構造

名前	概要
`statusCode`	エラーのHTTPステータスコード。400、409、413
`message`	エラーを説明する人間が読めるメッセージ
`errorCode`	静的エラーコード文字列
`extraParams`	各エラーには、エラーの正確な原因をより正確に特定するのに役立つ追加のパラメータがレスポンスに含まれている場合があります

種類

コード	概要
`LOOKUP_TABLE_INVALID_FILE_COUNT`	単一のルックアップテーブルに対して複数のファイルをアップロードしようとしました。
`LOOKUP_TABLE_INVALID_FILE_SIZE`	100MBを超えるファイルを使用してルックアップテーブルを作成または編集しました。
`LOOKUP_TABLE_INVALID_FILE_TYPE`	CSV形式ではないファイルを使用してルックアップテーブルを作成または編集しました。
`LOOKUP_TABLE_INVALID_KEY_COLUMN`	テーブルのヘッダーに存在しない「キー」入力を使用してルックアップテーブルを作成しました。
`LOOKUP_TABLE_INVALID_VALUE_COLUMN`	アップロードされたファイル内のセルが1,024文字を超えています。
`LOOKUP_TABLE_INVALID_KEY_PROPERTY`	指定されたキープロパティはAmplitudeに存在しません。
`LOOKUP_TABLE_INVALID_NUMBER_OF_ROWS`	100万行を超えるファイルを使用してルックアップテーブルを作成/編集しました。
`LOOKUP_TABLE_KEY_COLUMN_DUPLICATE_VALUES`	指定されたキーカラムに重複した値があります。
`LOOKUP_TABLE_INVALID_TABLE_NAME`	指定された名前は無効です。
`LOOKUP_TABLE_MALFORMED_CSV`	提供されたCSVは正しく処理されていません。詳細については、エラーメッセージを参照してください。
`LOOKUP_TABLE_INVALID_INPUT`	フィールドへの入力が期待値と一致しません。詳細については、エラーメッセージを参照してください。
`LOOKUP_TABLE_ALREADY_EXISTS`	指定されたプロジェクトにすでに存在するテーブルを作成しました。
`LOOKUP_TABLE_DOES_NOT_EXIST`	存在しないテーブルのロードまたは編集を試みました。
`LOOKUP_TABLE_INVALID_COLUMN_HEADERS`	ファイル内のカラムヘッダーが正しく処理されていません。

これは役に立ちましたか？