Specifieke velden aan een schema toevoegen met de API voor het schemaregister

Laatst bijgewerkt: 16 juli 2024
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar

De schema's van het Gegevensmodel van de ervaring (XDM) zijn samengesteld uit een basisklasse, met extra gebieden inbegrepen door het gebruik van standaardgebiedsgroepen die door Adobe en de groepen van het douanegebied worden bepaald door uw organisatie.

Wanneer u een schema samenstelt, wilt u wellicht bepaalde velden uit een bepaalde veldgroep gebruiken, terwijl u andere wilt uitsluiten van dezelfde groep die u niet nodig hebt. Deze zelfstudie laat zien hoe u afzonderlijke velden van een veldgroep kunt toevoegen aan een schema met behulp van de API voor schemaregistratie.

NOTE
Voor informatie over hoe te om individuele schemagebieden in Adobe Experience Platform toe te voegen en te verwijderen UI, zie de gids op op gebied-gebaseerde werkschema's(momenteel in bèta).

Vereisten

Dit leerprogramma impliceert het maken van vraag aan de Registratie API van het Schema. Alvorens te beginnen, te herzien gelieve de ontwikkelaarsgidsvoor belangrijke informatie die u moet kennen om met succes vraag aan API, met inbegrip van uw {TENANT_ID}, het concept containers, en de vereiste kopballen te maken om verzoeken te doen.

Het veld meta:refProperty

Voor elk schema wordt naar de klasse- en veldgroepen die de structuur ervan vormen verwezen onder de array allOf . Elke component wordt vertegenwoordigd als een object dat een eigenschap $ref bevat die naar de URI van de component $id verwijst.

De volgende JSON vertegenwoordigt een vereenvoudigd schema dat één enkele klasse (experienceevent) en gebiedsgroep (experienceevent-all) gebruikt:

{
  "title": "My Sample Schema",
  "description": "My Sample Description",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all"
    }
  ]
}

Voor elk object in de array allOf dat verwijst naar een veldgroep, kunt u een verwant meta:refProperty -veld toevoegen om op te geven welke velden in de groep moeten worden opgenomen in het schema.

NOTE
Elk veld wordt opgegeven met een JSON-aanwijzertekenreeks die het pad vertegenwoordigt naar het veld binnen de desbetreffende veldgroep. De tekenreeks moet beginnen met een slash (/) en mag geen naamruimten van het type properties bevatten. Bijvoorbeeld: /_experience/campaign/message/id .

Wanneer meta:refProperty wordt opgenomen als een tekenreeks, kan het verwijzen naar één veld in een groep. Andere velden van dezelfde groep kunnen worden opgenomen door dezelfde $ref -waarde te gebruiken in een ander object met een andere meta:refProperty -waarde.

{
  "title": "My Sample Schema",
  "description": "An example schema that uses the XDM ExperienceEvent class.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": "/_experience/campaign/message/id"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": "/_experience/campaign/message/size"
    }
  ]
}

U kunt meta:refProperty ook als een array opgeven, zodat u meerdere velden kunt opgeven die vanuit een bepaalde groep in één allOf -lijstitem moeten worden opgenomen:

{
  "title": "My Sample Schema",
  "description": "An example schema that uses the XDM ExperienceEvent class.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": [
        "/_experience/campaign/message/id",
        "/_experience/campaign/message/size",
        "/_experience/campaign/message/variant"
      ]
    }
  ]
}