Catalog Service API指南
Catalog Service 是Adobe Experience Platform中数据位置和族系的记录系统。 Catalog 充当元数据存储或“目录”，您可以在其中查找有关您的数据的信息 Experience Platform，无需访问数据本身。 请参阅 Catalog 概述 以了解更多信息。
本开发人员指南提供了帮助您开始使用 Catalog API 的步骤。然后，该指南提供了使用执行关键操作的API调用示例 Catalog.
先决条件
Catalog 跟踪中多种资源和操作的元数据 Experience Platform. 本开发人员指南要求您实际了解各种 Experience Platform 创建和管理这些资源所涉及的服务：
- Experience Data Model (XDM)：Platform 用于组织客户体验数据的标准化框架。
- 批量摄取：方法 Experience Platform 从数据文件（如CSV和Parquet）摄取和存储数据。
- 流式摄取：方法 Experience Platform 实时从客户端和服务器端设备摄取和存储数据。
以下部分提供了您需要了解或掌握的其他信息，以便成功调用 Catalog Service API。
正在读取示例 API 调用
本指南提供了示例 API 调用来演示如何格式化请求。这些包括路径、必需的标头和格式正确的请求负载。还提供了在 API 响应中返回的示例 JSON。有关示例 API 调用的文档中使用的惯例信息，请参阅 故障排除指南中的如何读取示例 API 调用Experience Platform。
收集所需标头的值
为调用 Platform API，您必须先完成身份验证教程。完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值，如下所示：
- 授权：持有者
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
中的所有资源 Experience Platform 被隔离到特定的虚拟沙盒中。 所有请求 Platform API需要一个标头，该标头应指定将在其中执行操作的沙盒的名称：
- x-sandbox-name:
{SANDBOX_NAME}
包含负载 (POST、PUT、PATCH) 的所有请求都需要额外的标头：
- Content-Type： application/json
的最佳实践 Catalog API调用
执行GET请求时 Catalog API中，最佳实践是在请求中包含查询参数，以便仅返回所需的对象和属性。 未过滤的请求可能会导致响应有效负载的大小超过3GB，这会降低整体性能。
您可以通过在请求路径中包含特定对象的ID来查看这些对象，也可以使用查询参数，例如 properties 和 limit 以筛选响应。 过滤器可作为标头和查询参数传递，以作为查询参数传递的过滤器优先。 查看文档 筛选目录数据 以了解更多信息。
由于某些查询可能会对API施加大量负载，因此已对实施全局限制 Catalog ，以进一步支持最佳实践。
后续步骤
本文档介绍了调用 Catalog API 所需的必备知识。您现在可以继续进行本开发人员指南中提供的示例调用，并按照其说明进行操作。
本指南中的大多数示例都使用 /dataSets 端点，但原则可以应用于中的其他端点 Catalog (例如 /batches)。 请参阅 目录服务API参考 以获取每个端点可用的所有调用和操作的完整列表。
有关分步工作流，它演示了 Catalog API与数据摄取有关，请参阅关于的教程 创建数据集.