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): Experience Platform用于组织客户体验数据的标准化框架。
  • 批量摄取: Experience Platform如何从数据文件(如CSV和Parquet)摄取和存储数据。
  • 流式引入: Experience Platform如何从客户端和服务器端设备实时引入和存储数据。

以下部分提供了您需要了解或拥有的其他信息,以便成功调用Catalog Service API。

正在读取示例 API 调用

本指南提供了示例 API 调用来演示如何格式化请求。 这些包括路径、必需的标头和格式正确的请求负载。 还提供了在 API 响应中返回的示例 JSON。 有关示例 API 调用的文档中所用惯例的信息,请参阅故障排除指南中的如何读取示例 API 调用 Experience Platform。

收集所需标头的值

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

  • 授权:持有人{ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Experience Platform中的所有资源都被隔离到特定的虚拟沙盒中。 对Experience Platform API的所有请求都需要一个标头,用于指定将在其中执行操作的沙盒的名称:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
有关Experience Platform中沙盒的更多信息,请参阅沙盒概述文档

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

  • Content-Type: application/json

Catalog API调用的最佳实践

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

您可以在请求路径中包含特定对象的ID来查看它们,或者使用查询参数(如propertieslimit)来筛选响应。 过滤器可作为标头和查询参数传递,以作为查询参数传递的过滤器优先。 有关详细信息,请参阅有关筛选目录数据的文档。

由于某些查询可能会对API施加大量负载,因此已在Catalog个查询上实施全局限制,以进一步支持最佳实践。

后续步骤

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

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

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

recommendation-more-help
experience-platform-help-catalog