Uniepunten

Unions (of samenvoegingsweergaven) zijn door het systeem gegenereerde, alleen-lezen schema's die de velden samenvoegen van alle schema's die dezelfde klasse delen (XDM ExperienceEvent of XDM Individual Profile ) en die zijn ingeschakeld voor Real-Time Customer Profile .

Dit document behandelt essentiële concepten voor het werken met vakbonden in de API van de Registratie van het Schema, met inbegrip van steekproefvraag voor diverse verrichtingen. Voor meer algemene informatie over unies in XDM, zie de sectie over unies in de grondbeginselen van schemacompositie.

Unieschemavelden

Schema Registry bevat automatisch drie belangrijke velden binnen een samenvoegingsschema: identityMap , timeSeriesEvents en segmentMembership .

Identiteitskaart

Het schema van de unie identityMap is een vertegenwoordiging van de bekende identiteiten binnen de bijbehorende verslagschema's van de unie. In het identiteitsoverzicht worden identiteiten gescheiden in verschillende arrays die door naamruimte worden gebruikt. Elke vermelde identiteit is zelf een object dat een unieke id -waarde bevat. Zie de documentatie van de Dienst van de Identiteitvoor meer informatie.

Gebeurtenissen uit de tijdreeks

De array timeSeriesEvents is een lijst met tijdreeksgebeurtenissen die betrekking hebben op de recordschema's die aan de union zijn gekoppeld. Wanneer profielgegevens naar datasets worden geëxporteerd, wordt deze array opgenomen voor elke record. Dit is handig voor verschillende gebruiksgevallen, zoals het leren van machines waarbij modellen naast de recordkenmerken ook de gehele gedragsgeschiedenis van een profiel nodig hebben.

Segmentlidmaatschapstoewijzing

In de segmentMembership -kaart worden de resultaten opgeslagen van de evaluatie van een segmentdefinitie. Wanneer de segmentbanen met succes gebruikend de Segmentatie APIin werking worden gesteld, wordt de kaart bijgewerkt. segmentMembership slaat ook vooraf beoordeelde soorten publiek op die in Platform worden opgenomen, waardoor integratie met andere oplossingen zoals Adobe Audience Manager mogelijk wordt. Zie het leerprogramma op creërend publiek gebruikend APIsvoor meer informatie.

Een lijst met vakbonden ophalen list

Wanneer u de tag union instelt op een schema, voegt Schema Registry automatisch het schema toe aan de union voor de klasse waarop het schema is gebaseerd. Als er voor de betreffende klasse geen vakbond bestaat, wordt automatisch een nieuwe vakbond gemaakt. $id voor de union is gelijkaardig aan de norm $id van andere Schema Registry middelen, met het enige verschil dat door twee onderstrepingstekens en het woord "union" (__union) wordt toegevoegd.

U kunt een lijst met beschikbare samenvoegingen weergeven door een aanvraag voor GET in te dienen bij het eindpunt van /tenant/unions .

API formaat

GET /tenant/unions

Verzoek

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

De antwoordindeling is afhankelijk van de header Accept die in de aanvraag wordt verzonden. De volgende Accept kopteksten zijn beschikbaar voor samenvoegingen:

Reactie

Een geslaagde reactie retourneert HTTP-status 200 (OK) en een results -array in de hoofdtekst van de reactie. Als vakbonden zijn gedefinieerd, worden de gegevens voor elke samenvoeging als objecten in de array gegeven. Als er geen samenvoegingen zijn gedefinieerd, wordt de HTTP-status 200 (OK) nog steeds geretourneerd, maar is de array results leeg.

{
    "results": [
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile__union",
            "meta:altId": "_xdm.context.profile__union",
            "version": "1"
        },
        {
            "title": "Property",
            "$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590__union",
            "meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590__union",
            "version": "1"
        }
    ]
}

Vereniging opzoeken lookup

U kunt een specifieke samenvoeging bekijken door een verzoek van de GET uit te voeren die $id omvat en, afhankelijk van de Accept- kopbal, sommige of alle details van de unie.

API formaat

GET /tenant/unions/{UNION_ID}
GET /tenant/schemas/{UNION_ID}

Verzoek

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions/https%3A%2F%2Fns.adobe.com%2Fxdm%2Fcontext%2Fprofile__union \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed+json; version=1'

Voor opzoekverzoeken naar een Vereniging moet een version worden opgenomen in de koptekst Accepteren.

De volgende Accept-koppen zijn beschikbaar voor samenvoegschema-lookups:

Reactie

Een geslaagde reactie retourneert de samenvoegweergave van alle schema's waarmee de klasse wordt geïmplementeerd waarvan $id is opgegeven in het aanvraagpad.

De responsindeling is afhankelijk van de Accept-header die in de aanvraag wordt verzonden. Experimenteer met verschillende kopteksten voor Accepteren om de reacties te vergelijken en te bepalen welke koptekst het beste is voor uw gebruik.

{
    "type": "object",
    "description": "Union view of all schemas that extend https://ns.adobe.com/xdm/context/profile",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/477bb01d7125b015b4feba7bccc2e599"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"
        }
    ],
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/profile",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/xdm/common/extensible",
        "https://ns.adobe.com/xdm/common/auditable",
        "https://ns.adobe.com/xdm/context/profile-person-details",
        "https://ns.adobe.com/{TENANT_ID}/mixins/477bb01d7125b015b4feba7bccc2e599",
        "https://ns.adobe.com/xdm/context/profile-personal-details"
    ],
    "title": "Union object for https://ns.adobe.com/xdm/context/profile",
    "$id": "https://ns.adobe.com/xdm/context/profile__union",
    "meta:containerId": "tenant",
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:altId": "_xdm.context.profile__union",
    "version": "1.0",
    "meta:resourceType": "unions",
    "meta:registryMetadata": {}
}

Een schema voor samenvoeging inschakelen enable

Als u een schema voor de klasse wilt opnemen in de samenvoeging, moet u een tag union toevoegen aan het kenmerk meta:immutableTags van het schema. U kunt dit bereiken door een PATCH-verzoek in te dienen om een meta:immutableTags -array met een enkele tekenreekswaarde van union aan het desbetreffende schema toe te voegen. Zie de gids van het schemaeindpuntvoor een gedetailleerd voorbeeld.

Schema's weergeven in een union list-schemas

Om te zien welke schema's deel van een specifieke vereniging uitmaken, kunt u een verzoek van de GET tot het /tenant/schemas eindpunt uitvoeren. Met de query-parameter property kunt u de reactie alleen configureren voor retourschema's die een meta:immutableTags field en een meta:class bevatten die gelijk zijn aan de klasse waartoe u toegang hebt.

API Formaat

GET /tenant/schemas?property=meta:immutableTags==union&property=meta:class=={CLASS_ID}

Verzoek

Met het volgende verzoek wordt een lijst opgehaald van alle schema's die deel uitmaken van de union voor de XDM Individual Profile -klasse.

curl -X GET \
  'https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile' \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

De antwoordindeling is afhankelijk van de header Accept die in de aanvraag wordt verzonden. De volgende Accept kopteksten zijn beschikbaar voor aanbiedingsschema's:

Reactie

Een succesvolle reactie keert een gefilterde lijst van schema's terug, die slechts die bevatten die tot de gespecificeerde klasse behoren die voor vakbondslidmaatschap zijn toegelaten. Herinner dat wanneer het gebruiken van veelvoudige vraagparameters, EN verhouding wordt verondersteld.

{
    "results": [
        {
            "title": "Schema 1",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/142afb78d8b368a5ba97a6cc8fc7e033",
            "meta:altId": "_{TENANT_ID}.schemas.142afb78d8b368a5ba97a6cc8fc7e033",
            "version": "1.2"
        },
        {
            "title": "Schema 2",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/e7297a6ddfc7812ab3a7b504a1ab98da",
            "meta:altId": "_{TENANT_ID}.schemas.e7297a6ddfc7812ab3a7b504a1ab98da",
            "version": "1.5"
        },
        {
            "title": "Schema 3",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/50f960bb810e99a21737254866a477bf",
            "meta:altId": "_{TENANT_ID}.schemas.50f960bb810e99a21737254866a477bf",
            "version": "1.2"
        },
        {
            "title": "Schema 4",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/a39655ca8ea3d5c1f36a463b45fccca8",
            "meta:altId": "_{TENANT_ID}.schemas.a39655ca8ea3d5c1f36a463b45fccca8",
            "version": "1.1"
        },
        {
            "title": "Schema 5",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/c063fac45c6d6285ef33b0e2af09f633",
            "meta:altId": "_{TENANT_ID}.schemas.c063fac45c6d6285ef33b0e2af09f633",
            "version": "1.2"
        },
        {
            "title": "Schema 6",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/dfebb19b93827b70bbad006137812537",
            "meta:altId": "_{TENANT_ID}.schemas.dfebb19b93827b70bbad006137812537",
            "version": "1.7"
        }
    ],
    "_links": {
        "global_schemas": {
            "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile"
        }
    }
}