API-guide för Schema Registry

Schema Registry används för att komma åt schemabiblioteket i Adobe Experience Platform, med ett användargränssnitt och RESTful API från vilket alla tillgängliga biblioteksresurser är tillgängliga.

API:t för schemaregister innehåller flera slutpunkter som gör att du kan hantera alla scheman och relaterade XDM-resurser (Experience Data Model) som är tillgängliga inom plattformen. Detta omfattar de som definieras av Adobe, Experience Platform partners och leverantörer vars program du använder.

Dessa slutpunkter beskrivs nedan. Besök de enskilda slutpunktsguiderna för mer information och se kom igång-guiden för viktig information om obligatoriska huvuden, läsning av exempel-API-anrop med mera.

Om du vill visa alla tillgängliga slutpunkter och CRUD-åtgärder går du till API-referens för schemaregister.

Scheman

XDM-scheman representerar och validerar strukturen och formatet för data som hämtas till Platform. Ett schema består av en klass och noll eller flera schemafältgrupper. Du kan skapa, visa, redigera och ta bort scheman med slutpunkten /schemas. Mer information om hur du använder den här slutpunkten finns i schemas slutpunktshandbok.

En steg-för-steg-guide om hur du skapar ett fullständigt schema manuellt i API:t för schemaregister, inklusive hur du skapar och lägger till fältgrupper och datatyper, finns i självstudiekursen för att skapa API-schema.

Om du importerar CSV-data läser du avsnittet CSV till schemakonvertering.

Beteenden

Beteenden definierar den typ av data som ett schema beskriver. Varje XDM-klass måste referera till ett specifikt beteende, som alla scheman som använder den klassen ärver. Se beteendeslutpunktsguiden för att lära dig hur du visar tillgängliga beteenden i API:t.

Klasser

En klass definierar den grundläggande strukturen för gemensamma egenskaper som alla scheman baserade på den klassen måste innehålla, och fastställer vilka fältgrupper som kan användas i dessa scheman. Alla klasser måste kopplas till ett befintligt beteende. Mer information om hur du arbetar med klasser i API finns i klassernas slutpunktshandbok .

Fältgrupper

Fältgrupper är återanvändbara komponenter som definierar ett eller flera fält som representerar ett visst koncept, till exempel en enskild person, en postadress eller en webbläsarmiljö. Fältgrupper är avsedda att ingå som en del av ett schema som implementerar en kompatibel klass, beroende på beteendet för de data de representerar (post- eller tidsserie). Läs slutpunktshandboken för fältgrupper om du vill lära dig hur du arbetar med fältgrupper i API:t.

Datatyper

Datatyper används som referenstypfält i klasser eller fältgrupper på samma sätt som grundläggande litteralfält, med den största skillnaden är att datatyper kan definiera flera underfält. Även om datatyperna liknar fältgrupper på så sätt att de medger konsekvent användning av en struktur med flera fält, är datatyperna mer flexibla eftersom de kan inkluderas var som helst i schemastrukturen medan fältgrupper bara kan läggas till på rotnivån. Mer information om hur du arbetar med datatyper i API finns i datatypsslutpunktshandboken.

Beskrivningar

Beskrivare är uppsättningar metadata som tilldelas till specifika fält i ett schema, och ger olika sammanhangsberoende detaljer, inklusive hur dessa fält (och själva schemat) är relaterade till andra scheman. Varje schema kan ha en eller flera beskrivningsentiteter tillämpade och det finns flera olika beskrivningstyper som kan användas i olika syften. Mer information om hur du arbetar med beskrivningar i API:t finns i deskriptors-slutpunktshandboken och en översikt över de olika beskrivningstyperna och deras användningsfall.

Unions

Med Platform kan du skapa scheman för särskilda användningsfall, men du kan också skapa en"union" av scheman som tillhör en viss klass. Ett unionsschema samlar fälten för alla scheman som delar samma klass i en enda representation. Genom att aktivera ett schema för användning med Kundprofil för realtid, inkluderas det schemat i unionen för sin särskilda klass. Det innebär att det inte går att redigera fackscheman direkt och att de bara kan påverkas om du inkluderar eller utesluter scheman för användning i profilen.

Mer information om hur du visar föreningar i API:t för schematabellen finns i slutpunktshandboken för föreningar.

CSV till schemakonvertering csv-to-schema

Du kan automatiskt generera ett XDM-schema med en CSV-fil som mall, vilket gör att du kan skapa mallar för att importera schemafält gruppvis och skära ned på manuellt API- eller gränssnittsarbete.

Mer information finns i CSV-guiden för schemakonvertering.

Exportera export

Med API:t för schemaregister kan du överföra och dela XDM-resurser mellan sandlådor och organisationer. För alla scheman, fältgrupper och datatyper kan du generera en exportnyttolast som innehåller resursstrukturen och eventuella beroende resurser. Denna nyttolast kan sedan användas för att importera resursen till en målsandlåda och en målorganisation.

Mer information om hur du skapar en exportnyttolast för en befintlig XDM-resurs finns i exportslutpunktshandboken.

Import

Om du använder export eller CSV för schemakonvertering-slutpunkter för att skapa en exportnyttolast kan du skicka den nyttolasten till en målorganisation och sandlåda för att importera de angivna resurserna.

Mer information om hur du genererar XDM-resurser från exportnyttolaster finns i importguiden.

Exempeldata

Du kan generera exempeldata för ett angivet schema i schemabiblioteket. Svarsobjektet som returneras kan sedan användas som källa för dataöverföring.

Mer information om hur du använder den här slutpunkten finns i exempelguiden för dataslut.

Granskningslogg

Schemaregistret innehåller en logg över alla ändringar som har gjorts för en resurs (klass, fältgrupp, datatyp eller schema) mellan olika uppdateringar. Du kan hämta loggen för en viss resurs genom att ange dess $id eller meta:altId i sökvägen för en GET-begäran till den här slutpunkten.

Mer information om hur du använder den här slutpunkten finns i slutpunktshandboken för granskningsloggen.

Nästa steg

Om du vill börja ringa anrop med API:t för schemaregister läser du kom igång-guiden och väljer sedan en av slutpunktshandböckerna för att lära dig hur du använder specifika slutpunkter.