Handboek Schema Register API-handleiding
Dit document bevat aanvullende informatie over het werken met de Schema Registry API.
Query-parameters gebruiken query
Schema Registry steunt het gebruik van vraagparameters aan pagina en filterresultaten wanneer het vermelden van middelen.
&) worden gescheiden.Paginering paging
De gemeenschappelijkste vraagparameters voor het pagineren omvatten:
orderbyorderby=title sorteert de resultaten op titel in oplopende volgorde (A-Z). Wanneer u een - vóór de parameterwaarde ( orderby=-title ) toevoegt, worden items op titel gesorteerd in aflopende volgorde (Z-A).limitorderby samen met een parameter wordt gebruikt, beperkt limit het maximumaantal items dat voor een bepaalde aanvraag moet worden geretourneerd. Deze parameter kan niet worden gebruikt zonder dat er een parameter orderby aanwezig is.de
limit parameter specificeert een positief geheel (tussen 0 en 500) als a wenk over het maximumaantal punten dat zou moeten zijn teruggekeerd. limit=5 retourneert bijvoorbeeld slechts vijf bronnen in de lijst. Deze waarde wordt echter niet strikt nageleefd. De werkelijke responsgrootte kan kleiner of groter zijn, zoals wordt beperkt door de noodzaak om de betrouwbare werking van de parameter start te bieden, als er een wordt opgegeven.startorderby , geeft start aan waar de lijst met items in de subset moet beginnen. Deze parameter kan niet worden gebruikt zonder dat er een parameter orderby aanwezig is. Deze waarde kan worden verkregen uit het _page.next -kenmerk van een lijstreactie en worden gebruikt om de volgende pagina met resultaten te openen. Als de waarde _page.next null is, is er geen extra pagina beschikbaar.typisch, wordt deze parameter weggelaten om de eerste pagina van resultaten te verkrijgen. Vervolgens moet
start worden ingesteld op de maximumwaarde van de primaire sorteereigenschap van het orderby -veld dat in de vorige pagina is ontvangen. De API-reactie retourneert vervolgens items die beginnen met items met een primaire sorteereigenschap van orderby strikt groter dan (voor oplopend) of strikt kleiner dan (voor aflopend) de opgegeven waarde.Bijvoorbeeld, als de
orderby parameter aan orderby=name,firstname wordt geplaatst, zou de start parameter een waarde voor het name bezit bevatten. In dit geval, als u de volgende 20 ingangen van een middel onmiddellijk na de naam "Miller"wilde tonen, zou u gebruiken: ?orderby=name,firstname&start=Miller&limit=20.Filteren filtering
U kunt resultaten filteren met de parameter property , die wordt gebruikt om een specifieke operator toe te passen op een bepaalde JSON-eigenschap binnen de opgehaalde bronnen. Tot de ondersteunde operatoren behoren:
==property=title==test!=property=title!=test<property=version<5>property=version>5<=property=version<=5>=property=version>=5property=titleproperty gebruiken om schemagebiedgroepen door hun compatibele klasse te filtreren. property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile retourneert bijvoorbeeld alleen veldgroepen die compatibel zijn met de klasse XDM Individual Profile .Compatibiliteitsmodus compatibility
Experience Data Model (XDM) is een openbaar gedocumenteerde specificatie, die door Adobe wordt gedreven om de interoperabiliteit, de expressiviteit, en de macht van digitale ervaringen te verbeteren. De Adobe handhaaft de broncode en formele definities XDM in een open bronproject op GitHub. Deze definities worden geschreven in de Standaardaantekening XDM, gebruikend JSON-LD (de Nota van de Objecten van JavaScript voor Gekoppelde Gegevens) en Schema JSON als grammatica voor het bepalen van schema's XDM.
Wanneer u formele XDM-definities bekijkt in de openbare opslagplaats, ziet u dat standaard XDM verschilt van wat u in Adobe Experience Platform ziet. Wat u ziet in Experience Platform , wordt Compatibiliteitsmodus genoemd en biedt een eenvoudige toewijzing tussen standaard-XDM en de manier waarop deze wordt gebruikt binnen Platform .
Hoe de Wijze van de Verenigbaarheid werkt
De Wijze van de verenigbaarheid staat het model XDM JSON-LD toe om met bestaande gegevensinfrastructuur te werken door waarden binnen standaardXDM te veranderen terwijl het houden van de semantiek het zelfde. Er wordt een geneste JSON-structuur gebruikt, waarbij schema's in een boomachtige indeling worden weergegeven.
Het belangrijkste verschil tussen de standaard-XDM en de compatibiliteitsmodus is de verwijdering van het voorvoegsel "xdm:" voor veldnamen.
Hieronder volgt een vergelijking naast elkaar van verjaardagsgerelateerde velden (met verwijderde "beschrijving"-kenmerken) in zowel standaard XDM- als compatibiliteitsmodus. De velden Compatibiliteitsmodus bevatten een verwijzing naar het XDM-veld en het gegevenstype ervan in de kenmerken "meta:xdmField" en "meta:xdmType".
Waarom is de Wijze van de Verenigbaarheid noodzakelijk?
Adobe Experience Platform is ontworpen om met meerdere oplossingen en services te werken, elk met hun eigen technische uitdagingen en beperkingen (bijvoorbeeld hoe bepaalde technologieën speciale tekens verwerken). Om deze beperkingen te verhelpen, werd de compatibiliteitsmodus ontwikkeld.
De meeste Experience Platform -services, inclusief Catalog , Data Lake en Real-Time Customer Profile use Compatibility Mode , vervangen door standaard-XDM. De Schema Registry API gebruikt ook Compatibility Mode en de voorbeelden in dit document worden allemaal weergegeven met Compatibility Mode .
Het is de moeite waard om te weten dat een afbeelding plaatsvindt tussen standaard XDM en de manier waarop het in Experience Platform wordt uitgevoerd, maar het zou niet uw gebruik van Platform diensten moeten beïnvloeden.
Het opensource-project is beschikbaar voor u, maar als u communiceert met bronnen via de Schema Registry , bieden de API-voorbeelden in dit document de beste praktijken die u moet kennen en volgen.