Schema Registry API指南

Schema Registry用于访问Adobe Experience Platform中的架构库,提供可从中访问所有可用库资源的用户界面和RESTful API。

架构注册表API提供了多个端点,允许您以编程方式管理Platform中可用的所有架构和相关的Experience Data Model(XDM)资源。 这包括由Adobe、Experience Platform合作伙伴以及您使用其应用程序的供应商定义的应用程序。

下面概述了这些端点。 有关详细信息,请访问各个端点指南,并参阅快速入门指南 ,以了解有关所需标头、读取示例API调用等的重要信息。

重要

XDM使用JSON模式格式来描述和验证摄取的客户体验数据的结构。 在使用架构注册表API之前,强烈建议您查看官方JSON架构文档,以更好地了解此基础技术。

要查看所有可用的端点和CRUD操作,请访问架构注册表API引用

架构

XDM架构表示并验证摄取到平台中的数据的结构和格式。 架构由类和零个或多个架构字段组组成。 您可以使用/schemas端点创建、查看、编辑和删除架构。 要了解如何使用此端点,请参阅架构端点指南

有关如何在架构注册表API中创建完整架构(包括创建和添加字段组和数据类型)的分步指南,请参阅API架构创建教程

行为

行为定义模式描述的数据的性质。 每个XDM类必须引用特定行为,采用该类的所有架构都将继承该特定行为。 请参阅行为端点指南 ,了解如何查看API中的可用行为。

类定义基于该类的所有架构必须包含的通用属性的基本结构,并确定哪些字段组有资格在这些架构中使用。 每个类都必须与现有行为相关联。 有关在API中使用类的详细信息,请参阅类端点指南

字段组

字段组是可重用的组件,用于定义一个或多个表示特定概念的字段,例如个人、邮寄地址或Web浏览器环境。 字段组将作为实现兼容类的架构的一部分包含在内,具体取决于它们表示的数据(记录或时间序列)的行为。 请参阅字段组端点指南 ,了解如何在API中使用字段组。

数据类型

数据类型在类或字段组中用作引用类型字段,其方式与基本文字字段相同,关键区别在于数据类型可以定义多个子字段。 虽然与中的字段组类似,它们允许一致地使用多字段结构,但数据类型更加灵活,因为它们可以包含在架构结构中的任意位置,而字段组只能在根级别添加。 有关在API中处理数据类型的更多信息,请参阅数据类型端点指南

描述符

描述符是分配给架构内特定字段的元数据集,提供了各种上下文详细信息,包括这些字段(以及架构本身)如何与其他架构相关联。 每个架构可以应用一个或多个描述符实体,并且有多个不同的描述符类型可用于不同的目的。 有关在API中使用描述符的更多信息,请参阅描述符端点指南 ,以及不同描述符类型及其用例的概述。

工会

虽然平台允许您为特定用例编写架构,但它还允许您编写属于特定类的架构的“并集”。 并集架构将共享同一类的所有架构的字段聚合为单个表示形式。 通过启用用于实时客户资料的架构,该架构将包含在其特定类的并集中。 因此,合并架构不能直接编辑,并且只能通过包含或排除架构以在配置文件中使用而受到影响。

要了解如何在架构注册表API中查看联合,请参阅联合端点指南

导出/导入

架构注册表API允许您在沙箱和IMS组织之间传输和共享XDM资源。 对于任何架构、字段组或数据类型,您可以生成包含资源结构和任何相关资源的导出有效负荷。 然后,可以使用此有效负载将资源导入目标沙箱和IMS组织。

有关如何使用这些端点的更多信息,请参阅导出/导入端点指南

示例数据

您可以在架构库中为任何指定的架构生成示例数据。 然后,返回的响应对象可用作数据摄取的源。

有关此端点的使用的更多信息,请参阅示例数据端点指南

审核日志

架构注册表维护一个日志,其中包含不同更新之间对资源(类、字段组、数据类型或架构)所做的所有更改。 您可以通过在到此端点的GET请求路径中提供特定资源的$idmeta:altId来检索该特定资源的日志。

有关此端点的使用的详细信息,请参阅审核日志端点指南

后续步骤

要开始使用架构注册表API进行调用,请阅读快速入门指南,然后选择其中一个端点指南,以了解如何使用特定端点。

在此页面上