Schema Registry API指南

的 Schema Registry 用於訪問Adobe Experience Platform內的架構庫,提供用戶介面和REST風格的API,從中可以訪問所有可用的庫資源。

架構註冊表API提供了幾個端點,允許您以寫程式方式管理平台內可用的所有架構和相關的經驗資料模型(XDM)資源。 這包括Adobe, Experience Platform 合作夥伴和您使用的應用程式的供應商。

下面概述了這些端點。 請訪問各個端點指南以瞭解詳細資訊,並參閱 入門指南 有關所需標頭、讀取示例API調用等的重要資訊。

重要

XDM使用JSON架構格式來描述和驗證所接收客戶體驗資料的結構。 在使用架構註冊表API之前,強烈建議您查看 正式JSON架構文檔 來更好地理解這個基礎技術。

要查看所有可用端點和CRUD操作,請訪問 架構註冊表API引用

方案

XDM模式表示並驗證了所接收資料的結構和格式。 架構由類和零個或多個架構欄位組組成。 可以使用 /schemas 端點。 要瞭解如何使用此終結點,請參閱 架構終結點指南

有關如何在架構註冊表API中建立完整架構(包括建立和添加欄位組和資料類型)的逐步指南,請參見 API架構建立教程

行為

行為定義模式描述的資料的性質。 每個XDM類必須引用特定行為,使用該類的所有架構都將繼承該行為。 查看 行為端點指南 瞭解如何查看API中的可用行為。

類別

類定義基於該類的所有方案必須包含的公共屬性的基本結構,並確定哪些欄位組適合在這些方案中使用。 每個類都必須與現有行為關聯。 查看 類終結點指南 的子菜單。

欄位群組

欄位組是可重用的元件,它定義了表示特定概念的一個或多個欄位,如個人、郵件地址或Web瀏覽器環境。 欄位組將作為實現相容類的架構的一部分被包括,具體取決於它們所代表的資料(記錄或時間序列)的行為。 查看 欄位組終結點指南 瞭解如何使用API中的欄位組。

資料類型

資料類型在類或欄位組中以與基本文本欄位相同的方式用作參考型別欄位,主要區別在於資料類型可以定義多個子欄位。 雖然與允許一致使用多欄位結構的欄位組類似,但資料類型更靈活,因為它們可以包含在架構結構中的任何位置,而欄位組只能在根級別添加。 查看 資料類型終結點指南 的子菜單。

描述符

描述符是指派給架構中特定欄位的元資料集,提供各種上下文詳細資訊,包括這些欄位(和架構本身)如何與其他架構相關聯。 每個架構可以應用一個或多個描述符實體,並且有多種不同的描述符類型以滿足不同的目的。 查看 描述符端點指南 有關在API中使用描述符的詳細資訊,以及不同描述符類型及其使用情形的概述。

工會

雖然平台允許您針對特定的使用情形編寫架構,但它也允許您編寫屬於特定類的架構的「聯合」。 聯合架構將共用同一類的所有架構的欄位聚合為單個表示。 通過啟用模式以與 即時客戶概要資訊,該架構將包含在其特定類的聯合中。 因此,聯合架構不能直接編輯,並且只能受包含或排除在配置檔案中使用的架構的影響。

要瞭解如何在架構註冊表API中查看聯合,請參見 聯合端點指南

CSV到架構轉換

您可以使用CSV檔案作為模板自動生成XDM架構,從而可以建立模板以批量導入架構欄位並減少手動API或UI工作。

查看 CSV到架構轉換終結點指南 的子菜單。

轉存

Schema Registry API允許您在沙箱和IMS組織之間傳輸和共用XDM資源。 對於任何架構、欄位組或資料類型,可以生成包含資源結構和任何從屬資源的導出負載。 然後,此負載可用於將資源導入目標沙箱和IMS組織。

查看 導出終結點指南 的子菜單。

讀入

如果使用 出口CSV到架構轉換 終結點建立導出負載,您可以將該負載發送到目標組織和沙盒以導入指定的資源。

查看 導入終結點指南 的子菜單。

示例資料

可以為架構庫中的任何指定架構生成示例資料。 然後,返回的響應對象可以用作資料接收源。

查看 示例資料端點指南 的子菜單。

審核日誌

架構註冊表維護不同更新之間對資源(類、欄位組、資料類型或架構)所做的所有更改的日誌。 您可以通過提供特定資源的日誌來檢索其日誌 $idmeta:altId 在GET請求到此終結點的路徑中。

查看 審計日誌終結點指南 的子菜單。

後續步驟

要開始使用架構註冊表API進行調用,請閱讀 入門指南 然後選擇其中一個端點參考線,以瞭解如何使用特定端點。

本頁內容