Schema Registry API指南

Schema Registry用於存取Adobe Experience Platform中的結構描述資料庫，提供可存取所有可用資料庫資源的使用者介面和RESTful API。

Schema Registry API提供數個端點，可讓您以程式設計方式管理Platform中可供您使用的所有結構描述和相關的Experience Data Model (XDM)資源。 這包括Adobe、Experience Platform個合作夥伴以及您使用之應用程式的廠商所定義的專案。

這些端點概述如下。 如需詳細資訊，請瀏覽個別端點指南，並參閱快速入門手冊，以取得必要標頭、讀取範例API呼叫等重要資訊。

若要檢視所有可用的端點和CRUD作業，請造訪結構描述登入API參考。

結構描述

XDM結構描述會呈現並驗證擷取至Platform的資料結構和格式。 結構描述由一個類別和零個或多個結構描述欄位群組組成。 您可以使用/schemas端點建立、檢視、編輯和刪除結構描述。 若要瞭解如何使用此端點，請參閱結構描述端點指南。

如需如何在Schema Registry API中手動建立完整結構描述的逐步指南，包括建立和新增欄位群組和資料型別，請參閱API結構描述建立教學課程。

如果您正在內嵌CSV資料，請參閱CSV到結構描述轉換一節。

行為

行為會定義結構描述之資料的性質。 每個XDM類別都必須參考特定行為，採用該類別的所有結構描述都會繼承。 請參閱行為端點指南，瞭解如何檢視API中的可用行為。

類別

類別會定義所有以該類別為基礎的結構描述都必須包含的通用屬性的基底結構，並決定哪些欄位群組適合用於這些結構描述。 每個類別都必須與現有行為相關聯。 如需在API中使用類別的詳細資訊，請參閱類別端點指南。

欄位群組

欄位群組是可重複使用的元件，可定義代表特定概念的一或多個欄位，例如個人、郵寄地址或網頁瀏覽器環境。 視欄位群組代表的資料行為（記錄或時間序列）而定，這些欄位群組旨在包含在實施相容類別的結構描述中。 請參閱欄位群組端點指南，瞭解如何在API中使用欄位群組。

資料類型

資料型別在類別或欄位群組中作為參考型別欄位使用，其使用方式與基本常值欄位相同，主要區別在於資料型別可以定義多個子欄位。 雖然資料型別與欄位群組類似，因為其允許一致地使用多欄位結構，但資料型別較靈活，因為它們可以包含在架構結構中的任意位置，而欄位群組只能新增到根層級。 如需在API中使用資料型別的詳細資訊，請參閱資料型別端點指南。

描述項

描述項是指派給結構描述內特定欄位的一組中繼資料，提供各種內容詳細資訊，包括這些欄位（以及結構描述本身）如何與其他結構描述相關。 每個結構描述可以套用一個或多個描述項實體，並且有幾種不同的描述項型別可用於不同的目的。 請參閱描述項端點指南，以取得在API中使用描述項的詳細資訊，以及不同描述項型別及其使用案例的概觀。

聯合

雖然Platform可讓您針對特定使用案例來撰寫結構描述，但也允許您為屬於特定類別的結構描述撰寫「聯合」。 聯合結構描述會將共用相同類別的所有結構描述的欄位彙總到單一表示中。 藉由啟用結構描述以搭配即時客戶設定檔使用，該結構描述會成為其特定類別的聯集。 因此，聯合結構描述不能直接編輯，並且只能受到在設定檔中包含或排除使用結構描述的影響。

若要瞭解如何在結構描述登入API中檢視聯合，請參閱聯合端點指南。

CSV到結構描述轉換 csv-to-schema

您可以使用CSV檔案作為範本自動產生XDM結構描述，允許您建立範本以大量匯入結構描述欄位，並削減手動API或UI工作。

如需詳細資訊，請參閱CSV至結構描述轉換端點指南。

轉存 export

結構描述登入API可讓您在沙箱和組織之間傳輸和共用XDM資源。 對於任何結構、欄位群組或資料型別，您可以產生包含資源結構和任何相依資源的匯出裝載。 然後，此裝載可用於將資源匯入目的地沙箱和組織。

如需如何為現有XDM資源建立匯出裝載的詳細資訊，請參閱匯出端點指南。

讀入

如果您使用匯出或CSV至結構描述轉換端點來建立匯出裝載，您可以將該裝載傳送至目標組織和沙箱，以匯入指定的資源。

請參閱匯入端點指南，以取得有關如何從匯出裝載產生XDM資源的詳細資訊。

樣本資料

您可以在「結構描述資料庫」內產生任何指定結構的範例資料。 接著，傳回的回應物件即可作為資料擷取的來源使用。

如需有關使用此端點的詳細資訊，請參閱範例資料端點指南。

稽核記錄

「結構描述登入」會維護不同更新之間對資源（類別、欄位群組、資料型別或結構描述）發生的所有變更記錄。 您可以在此端點的GET要求路徑中提供特定資源的$id或meta:altId，以擷取其記錄。

請參閱稽核記錄端點指南，以取得有關使用此端點的詳細資訊。

後續步驟

若要開始使用Schema Registry API進行呼叫，請閱讀快速入門手冊，然後選取其中一個端點指南，以瞭解如何使用特定端點。