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

Catalog オブジェクトを検索する

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

作成対象：

  • 開発者

特定の Catalog オブジェクトの一意の ID がわかっている場合は、GETリクエストを実行してそのオブジェクトの詳細を表示できます。

NOTE
特定のオブジェクトを表示する場合でも、 プロパティでフィルタリングして、目的のプロパティのみを返すことがベストプラクティスです。

API 形式

GET /{OBJECT_TYPE}/{OBJECT_ID}
GET /{OBJECT_TYPE}/{OBJECT_ID}?properties={PROPERTY_1},{PROPERTY_2},{PROPERTY_3}
パラメーター
説明
{OBJECT_TYPE}

取得 Catalog るオブジェクトのタイプ。 有効なオブジェクトは次のとおりです。

  • batches
  • dataSets
  • dataSetFiles
{OBJECT_ID}
取得する特定のオブジェクトの識別子。

リクエスト

次のリクエストでは、ID でデータセットを取得し、その name、description、tags および files のプロパティを返しています。

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a?properties=name,description,tags,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}'

応答

正常な応答は、指定されたデータセッを返します。本文にはリクエストされた properties のみが含まれます。

{
    "5ba9452f7de80400007fc52a": {
        "name": "Sample Dataset",
        "description": "Sample dataset containing important data.",
        "tags": {
            "adobe/pqs/table": [
                "sample_dataset"
            ]
        },
        "files": "@/dataSetFiles?dataSetId=5ba9452f7de80400007fc52a"
    }
}
NOTE
値の先頭にが付くプロパティは @ 相互に関連するオブジェクトを表します。 これらのオブジェクトの詳細を表示する手順については、付録の「相互関連オブジェクトの表示」の節を参照してください。
recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676