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 Platform. Dit omvat die door Adobe, Experience Platform partners, en verkopers worden bepaald waarvan toepassingen u 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.

Om alle beschikbare eindpunten en verrichtingen te bekijken CRUD, bezoek de Verwijzing van de Registratie API van het Schema.

Schema's

De schema's XDM vertegenwoordigen en bevestigen de structuur en het formaat van gegevens die in Platform worden opgenomen. 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.

Beschrijvers

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

Terwijl Platform u toestaat om schema's voor bepaalde gebruiksgevallen samen te stellen, staat het u ook toe om een "unie"van schema's samen te stellen die tot een specifieke 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 csv-to-schema

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.

Exporteren export

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.

Importeren

Als u de uitvoerof CSV aan schemaconversieeindpunten gebruikt om een de uitvoerlading tot stand te brengen, kunt u die nuttige lading naar een doelorganisatie en zandbak verzenden om de gespecificeerde middelen in te voeren.

Zie de invoereindpuntgidsvoor meer informatie over hoe te om middelen XDM van de uitvoerladingen te produceren.

Voorbeeldgegevens

U kunt voorbeeldgegevens genereren voor elk opgegeven schema in de Schemabibliotheek. Het geretourneerde reactieobject kan vervolgens worden gebruikt als bron voor gegevensinvoer.

Zie de gids van het de eindpunt van steekproefgegevensvoor meer informatie over het gebruik van dit eindpunt.

Controlelogboek

De Registratie van het Schema handhaaft een logboek van alle veranderingen die aan een middel (klasse, gebiedsgroep, gegevenstype, of schema) tussen verschillende updates zijn voorgekomen. U kunt het logboek voor een bepaalde bron terugwinnen door zijn $id of meta:altId in de weg van een verzoek van de GET aan dit eindpunt te verstrekken.

Zie de gids van het de eindpuntgids van het controlelogboekvoor meer informatie over het gebruik van dit eindpunt.

Volgende stappen

Begin makend vraag gebruikend de Registratie API van het Schema, lees begonnen gidsdan één van de eindpuntgidsen om te leren hoe te om specifieke eindpunten te gebruiken.