Schema Registry API-handleiding
Schema Registry wordt gebruikt om toegang te krijgen tot de Schemabibliotheek binnen Adobe Experience Platform, die een gebruikersinterface en RESTful API verstrekt waarvan alle beschikbare bibliotheekmiddelen toegankelijk zijn.
De API van de Registratie van het Schema verstrekt verscheidene eindpunten die u toestaan om alle schema's en verwante middelen van het Gegevensmodel van de Ervaring programmatically te beheren (XDM) beschikbaar aan u binnen Experience Platform. Dit zijn onder andere de gedefinieerde toepassingen door Adobe, Experience Platform partners en leveranciers van wie u de toepassingen gebruikt.
Deze eindpunten worden hieronder beschreven. Gelieve te bezoeken de individuele eindpuntgidsen voor details en te verwijzen naar begonnen gidsvoor belangrijke informatie over vereiste kopballen, lezend steekproefAPI vraag, en meer.
IMPORTANTOm alle beschikbare eindpunten en verrichtingen te bekijken CRUD, bezoek de Verwijzing van de Registratie API van het Schema.
Schema's
XDM-schema's vertegenwoordigen en valideren de structuur en indeling van gegevens die in Experience Platform worden ingevoerd. Een schema bestaat uit een klasse en nul of meer groepen schemavelden. U kunt schema's maken, weergeven, bewerken en verwijderen met behulp van het /schemas -eindpunt. Leren hoe te om dit eindpunt te gebruiken, zie de gids van het schemaeindpunt.
Voor een geleidelijke gids op hoe te om een volledig schema in de Registratie API van het Schema manueel tot stand te brengen, met inbegrip van het creëren van en het toevoegen van gebiedsgroepen en gegevenstypes, zie de API schemaverwezenlijking leerprogramma.
Als u CSV- gegevens opneemt, zie de sectie op CSV aan schemaomzetting.
Gedrag
Gedragingen bepalen de aard van gegevens die een schema beschrijft. Elke klasse XDM moet naar een specifiek gedrag verwijzen, dat alle schema's die die klasse gebruiken zullen erven. Zie de gids van het gedragseindpuntleren hoe te om beschikbaar gedrag in API te bekijken.
Klassen
Een klasse definieert de basisstructuur van gemeenschappelijke eigenschappen die alle schema's die op die klasse zijn gebaseerd, moeten bevatten en bepaalt welke veldgroepen in aanmerking komen voor gebruik in die schema's. Elke klasse moet aan een bestaand gedrag worden geassocieerd. Zie de gids van het klassen eindpuntvoor details bij het werken met klassen in API.
Veldgroepen
Veldgroepen zijn herbruikbare componenten die een of meer velden definiëren die een bepaald concept vertegenwoordigen, zoals een individuele persoon, een mailingadres of een webbrowseromgeving. Veldgroepen moeten worden opgenomen als onderdeel van een schema dat een compatibele klasse implementeert, afhankelijk van het gedrag van de gegevens die ze vertegenwoordigen (record- of tijdreeks). Zie de gids van het de gebiedsgroepen eindpuntleren hoe te met gebiedsgroepen in API te werken.
Datatypen
Gegevenstypen worden op dezelfde manier als letterlijke basisvelden gebruikt als referentietypen in klassen of veldgroepen. Het belangrijkste verschil is dat gegevenstypen meerdere subvelden kunnen definiëren. Hoewel gelijkaardig aan gebiedsgroepen in zoverre zij voor het verenigbare gebruik van een multi-gebiedstructuur toestaan, zijn de gegevenstypes flexibeler omdat zij overal in de schemastructuur kunnen worden omvat terwijl de gebiedsgroepen slechts op het wortelniveau kunnen worden toegevoegd. Zie de gids van het gegevenstypeseindpuntvoor meer informatie bij het werken met gegevenstypes in API.
NOTEBeschrijvers
Descriptors zijn reeksen meta-gegevens die aan specifieke gebieden binnen een schema worden toegewezen, die diverse contextuele details verstrekken met inbegrip van hoe die gebieden (en het schema zelf) met andere schema's verwant zijn. Op elk schema kunnen een of meer descriptorentiteiten zijn toegepast en er zijn verschillende descriptortypen voor verschillende doeleinden. Zie de gids van het didentrekkereindpunt van beschrijversvoor meer informatie bij het werken met beschrijvers in API, en een overzicht van de verschillende beschrijvingstypes en hun gebruiksgevallen.
Unies
Hoewel u met Experience Platform schema's kunt samenstellen voor bepaalde gebruiksgevallen, kunt u ook een 'samenvoeging' van schema's samenstellen die tot een bepaalde klasse behoren. Een samenvoegingsschema voegt de gebieden van alle schema's samen die de zelfde klasse in één enkele vertegenwoordiging delen. Door een schema voor gebruik met in real time het Profiel van de Klanttoe te laten, wordt dat schema inbegrepen in de unie voor zijn bijzondere klasse. Als zodanig kunnen unieschema's niet rechtstreeks worden bewerkt en alleen worden beïnvloed door het opnemen of uitsluiten van schema's voor gebruik in profiel.
Leren hoe te om vakbonden in de Registratie API van het Schema te bekijken, zie de gids van het vakbondseindpunt.
CSV naar schemaomzetting
U kunt automatisch een XDM-schema genereren door een CSV-bestand als sjabloon te gebruiken, zodat u sjablonen kunt maken voor het bulksgewijs importeren van schemavelden en kunt knippen op handmatig API- of UI-werk.
Zie CSV aan de gids van het schemaomzettingseindpuntvoor meer informatie.
NOTEExporteren
Met de API voor het schemaregister kunt u XDM-bronnen overbrengen en delen tussen sandboxen en organisaties. Voor om het even welk schema, gebiedsgroep, of gegevenstype, kunt u een de uitvoerlading produceren die de structuur van het middel en om het even welke afhankelijke middelen bevat. Deze nuttige lading kan dan worden gebruikt om het middel in een bestemmingszandbak en organisatie in te voeren.
Zie de gids van het uitvoereindpuntvoor meer informatie over hoe te om een de uitvoerlading voor een bestaand middel tot stand te brengen XDM.