ドキュメントExperience Platformカタログおよびデータセットガイド

List Catalog objects

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 開発者

1 回の API 呼び出しで、特定のタイプの使用可能なすべてのオブジェクトのリストを取得できます。ベストプラクティスは、応答のサイズを制限するフィルターを含めることです。

API 形式

GET /{OBJECT_TYPE}
GET /{OBJECT_TYPE}?{FILTER}={VALUE}&{FILTER_2}={VALUE}
パラメーター
説明
{OBJECT_TYPE}

リストされるオブジェク Catalog のタイプ。 有効なオブジェクトは次のとおりです。

  • batches
  • dataSets
  • dataSetFiles
{FILTER}
応答で返された結果をフィルターするために使用されるクエリパラメーター。複数のパラメーターはアンパサンド（&）で区切られます。詳しくは、カタログデータのフィルタリングに関するガイドを参照してください。

リクエスト

以下のリクエスト例では、データセットのリストを取得し、応答を 5 つの結果に減らす limit フィルターと、各データセットに対して表示されるプロパティを制限する properties フィルターを使用しています。

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets?limit=5&properties=name,description,files' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、Catalog オブジェクトのリストがキーと値のペアの形式で返され、リクエストで提供されるクエリパラメーターでフィルタリングされます。 キーと値のペアごとに、キーは、対象となる Catalog オブジェクトの一意の ID を表します。さらに詳しくは、別の呼び出しで使用して その特定のオブジェクトを表示できます。

NOTE
返されたオブジェクトに、properties クエリで示されるリクエストされたプロパティが 1 つ以上含まれていない場合、次の Sample Dataset 3 と Sample Dataset 4 に示すように、応答は、含まれているリクエストされたプロパティのみを返します。
{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset 1",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    },
    "5bb276b03a14440000971552": {
        "name": "Sample Dataset 2",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bb276b03a14440000971552"
    },
    "5bceaa4c26c115000039b24b": {
        "name": "Sample Dataset 3"
    },
    "5bda3a4228babc0000126377": {
        "name": "Sample Dataset 4",
        "files": "@/dataSetFiles?dataSetId=5bda3a4228babc0000126377"
    },
    "5bde21511dd27b0000d24e95": {
        "name": "Sample Dataset 5",
        "description": "Description of dataset.",
        "files": "@/dataSetFiles?dataSetId=5bde21511dd27b0000d24e95"
    }
}
recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676