Handboek Schema Register API-handleiding
Dit document bevat aanvullende informatie over het werken met de Schema Registry API.
Query-parameters gebruiken query
De Schema Registry ondersteunt het gebruik van queryparameters voor pagina- en filterresultaten bij het weergeven van bronnen.
&).Paginering paging
De gemeenschappelijkste vraagparameters voor het pagineren omvatten:
orderbyorderby=title sorteert de resultaten op titel in oplopende volgorde (A-Z). Een - vóór de parameterwaarde (orderby=-title) sorteert objecten op titel in aflopende volgorde (Z-A).limitorderby parameter, limit beperkt het maximumaantal items dat voor een bepaald verzoek moet worden geretourneerd. Deze parameter kan niet worden gebruikt zonder orderby parameter aanwezig.De
limit parameter geeft een positief geheel getal aan (tussen 0 en 500) als hint over het maximumaantal objecten dat moet worden geretourneerd. Bijvoorbeeld: limit=5 retourneert slechts vijf bronnen in de lijst. Deze waarde wordt echter niet strikt nageleefd. De werkelijke responsgrootte kan kleiner of groter zijn, omdat de betrouwbare werking van de start parameter, als er een wordt opgegeven.startorderby parameter, start Hiermee geeft u aan waar de sublijst met items moet beginnen. Deze parameter kan niet worden gebruikt zonder orderby parameter aanwezig. Deze waarde kan worden verkregen via de _page.next kenmerk van een reactie in een lijst en gebruikt voor toegang tot de volgende pagina met resultaten. Als de _page.next De waarde is null en er is geen extra pagina beschikbaar.Deze parameter wordt meestal weggelaten om de eerste pagina met resultaten te verkrijgen. Daarna,
start moet worden ingesteld op de maximumwaarde van de primaire sorteereigenschap van de orderby veld ontvangen op de vorige pagina. 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 gespecificeerde waarde.Als de
orderby parameter is ingesteld op orderby=name,firstnamede start parameter zou een waarde voor de name eigenschap. 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 de resultaten filteren met de property parameter, die wordt gebruikt om een specifieke exploitant op een bepaalde bezit JSON binnen de teruggewonnen middelen toe te passen. Tot de ondersteunde operatoren behoren:
==property=title==test!=property=title!=test<property=version<5>property=version>5<=property=version<=5>=property=version>=5property=titleproperty parameter om schemagebiedgroepen door hun compatibele klasse te filtreren. Bijvoorbeeld: property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile Hiermee worden alleen veldgroepen geretourneerd die compatibel zijn met de XDM Individual Profile klasse.Compatibiliteitsmodus compatibility
Experience Data Model (XDM) is een openbaar gedocumenteerde specificatie, gedreven door Adobe om de interoperabiliteit, de expressiviteit, en de macht van digitale ervaringen te verbeteren. Adobe handhaaft de broncode en de formele definities XDM in een open-bronproject op GitHub. Deze definities worden geschreven in de Standaardaantekening XDM, gebruikend JSON-LD (de Nota van Objecten JavaScript voor Gekoppelde Gegevens) en Schema JSON als grammatica voor het bepalen van XDM schema's.
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 genoemd de Wijze van de Verenigbaarheid, en het verstrekt een eenvoudige afbeelding tussen standaard XDM en de manier het binnen wordt gebruikt 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.
Meeste Experience Platform diensten, waaronder Catalog, Data Lake, en Real-Time Customer Profile gebruiken Compatibility Mode in plaats van standaard-XDM. De Schema Registry API gebruikt ook Compatibility Modeen de voorbeelden in dit document worden allemaal weergegeven met Compatibility Mode.
Het is nuttig om te weten dat een afbeelding tussen standaard XDM en de manier plaatsvindt het binnen Experience Platform, maar het mag uw gebruik van Platform diensten.
Het open bronproject is beschikbaar aan u, maar wanneer het over het in wisselwerking staan met middelen door Schema RegistryDe API-voorbeelden in dit document bieden de aanbevolen procedures die u moet kennen en volgen.