Catalog Service API指南

Catalog Service 是Adobe Experience Platform中数据位置和谱系的记录系统。Catalog 充当元数据存储或“目录”,您可以在中查找有关数据的信息,而 Experience Platform无需访问数据本身。有关更多信息,请参阅Catalog 概述

本开发人员指南提供了帮助您开始使用Catalog API的步骤。 然后,该指南提供了使用Catalog执行键操作的示例API调用。

先决条件

Catalog 跟踪中多种资源和操作的元数 Experience Platform据。本开发人员指南要求您对创建和管理这些资源所涉及的各种Experience Platform服务有一定的了解:

  • Experience Data Model (XDM):用于组织客户体验数 Platform 据的标准化框架。
  • 批量摄取:如 Experience Platform 何从数据文件(如CSV和Parquet)中摄取和存储数据。
  • 流摄取:如何 Experience Platform 实时从客户端和服务器端设备摄取和存储数据。

以下各节提供了为成功调用Catalog Service API而需要了解或掌握的其他信息。

读取示例API调用

本指南提供了示例API调用,以演示如何设置请求的格式。 这包括路径、所需标头以及格式正确的请求负载。 还提供了API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅Experience Platform疑难解答指南中如何阅读示例API调用一节。

收集所需标题的值

要调用Platform API,您必须先完成身份验证教程。 完成身份验证教程可为所有Experience Platform API调用中每个所需标头的值,如下所示:

  • 授权:载体{ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有资源均与特定虚拟沙箱隔离。 对Platform API的所有请求都需要一个标头来指定操作将在其中进行的沙盒的名称:

  • x-sandbox-name: {SANDBOX_NAME}
注意

有关Platform中沙箱的更多信息,请参阅沙盒概述文档

所有包含有效负载(POST、PUT、PATCH)的请求都需要额外的标头:

  • Content-Type:application/json

Catalog API调用的最佳实践

在对Catalog API执行GET请求时,最佳做法是在请求中包含查询参数,以便仅返回所需的对象和属性。 未过滤的请求可能会导致响应负载的大小超过3GB,从而降低整体性能。

您可以通过在请求路径中包含特定对象的ID来查看特定对象,或使用查询参数(如propertieslimit)来筛选响应。 过滤器可以作为标题和查询参数进行传递,并且优先作为查询参数进行传递。 有关详细信息,请参阅filtering Catalog data上的文档。

由于某些查询可能会给API带来沉重负载,因此已对Catalog查询实施了全局限制,以进一步支持最佳实践。

后续步骤

本文档介绍了调用Catalog API所需的先决知识。 您现在可以继续阅读本开发人员指南中提供的示例调用并按照其说明进行操作。

本指南中的大多数示例都使用/dataSets端点,但该原则可以应用于Catalog内的其他端点(如/batches/accounts)。 有关每个端点可用的所有调用和操作的完整列表,请参阅目录服务API引用

有关演示Catalog API如何与数据摄取相关的分步工作流,请参阅创建数据集教程。

在此页面上