ルックアップテーブルAPI

地域

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

リクエストはhttps://amplitude.com（デフォルト）またはhttps://analytics.eu.amplitude.com（EU）に送信されます。https://analytics.amplitude.comのホスト名はアナリティクスウェブアプリ（ブラウザーUI）です。RESTリクエストにはanalytics.amplitude.comではなく、この表に記載されているホストを使用してください。

考慮事項

CSVファイルは、次の要件を満たしている必要があります。

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

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

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

パラメータ

リクエスト

curl -L -X POST 'https://amplitude.com/api/2/lookup_table/:name' \
        -u API_KEY:SECRET_KEY \
        -F 'file=@"/path/to/file.csv"' \

レスポンス

{
  "name": "skuToMetadata",
  "column_headers": ["Product Category", "Product Name"],
  "created_at": "2021-07-15T21:04:23.000593",
  "created_by": "rest",
  "last_modified_at": "2021-07-16T19:14:11.627477",
  "last_modified_by": "rest"
}

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

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

パラメータ

リクエスト

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

レスポンス

{
  "name": "skuToMetadata",
  "column_headers": ["Product Category", "Product Name"],
  "created_at": "2021-07-15T21:04:23.000593",
  "created_by": "rest",
  "last_modified_at": "2021-07-16T19:14:11.627477",
  "last_modified_by": "rest"
}

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

ルックアップテーブルの列とデータを更新します。

パラメータ

リクエスト

curl -L -X PATCH 'https://amplitude.com/api/2/lookup_table/:name' \
        -u API_KEY:SECRET_KEY
        -F 'file=@"/path/to/file.csv"' \

レスポンス

{
  "name": "skuToMetadata",
  "column_headers": ["Product Category", "Product Name"],
  "created_at": "2021-07-15T21:04:23.000593",
  "created_by": "rest",
  "last_modified_at": "2021-07-16T19:14:11.627477",
  "last_modified_by": "rest"
}

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

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

パラメータ

リクエスト

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

レスポンス

{
  "name": "skuToMetadata",
  "success": true
}

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

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

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

レスポンス

{
  "data": [
    {
      "name": "isbnToMetadata",
      "column_headers": ["Genres", "Authors"],
      "created_at": "2021-07-15T21:04:23.000593",
      "created_by": "rest",
      "last_modified_at": "2021-07-16T19:14:11.627477",
      "last_modified_by": "rest"
    },
    {
      "name": "skuToMetadata",
      "column_headers": ["Product Category", "Product Name"],
      "created_at": "2021-07-16T19:28:18.070073",
      "created_by": "rest",
      "last_modified_at": "2021-07-16T19:28:18.070073",
      "last_modified_by": "rest"
    }
  ]
}