API でのデータセットの作成

Catalog API を使用してデータセットを作成するには、データセットの基となる Experience Data Model (XDM) スキーマの $id 値を把握しておく必要があります。 スキーマ ID を取得したら、Catalog API の /datasets エンドポイントにPOSTリクエストを送信して、データセットを作成できます。

メモ

このドキュメントでは、Catalog でのデータセットオブジェクトの作成方法についてのみ説明します。 データセットの作成、設定、監視の手順について詳しくは、次のチュートリアルを参照してください。

API 形式

POST /dataSets

リクエスト

次のリクエストは、以前に定義されたスキーマを参照するデータセットを作成します。

curl -X POST \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?requestDataSource=true' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name":"LoyaltyMembersDataset",
    "schemaRef": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/719c4e19184402c27595e65b931a142b",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    }
}'
プロパティ 説明
name 作成するデータセットの名前。
schemaRef.id データセットの基になる XDM スキーマの URI $id 値。
schemaRef.contentType スキーマの形式とバージョンを示します。 詳しくは、XDM API ガイドのスキーマのバージョン管理の節を参照してください。
メモ

この例では、containerFormat プロパティに Apache Parquet ファイル形式を使用しています。 JSON ファイル形式の使用例については、『バッチ取得開発者ガイド』を参照してください。

応答

成功した応答は、HTTP Status 201(作成済み)と、新しく作成されたデータセットの ID を "@/datasets/{DATASET_ID}" 形式で含む配列で構成される応答オブジェクトを返します。データセット ID は、API 呼び出しでデータセットを参照するために使用される、読み取り専用のシステム生成文字列です。

[
    "@/dataSets/5c8c3c555033b814b69f947f"
]

このページ