Documentatie Experience Platform Handleiding voor catalogi en gegevenssets

Een dataset voor profielupdates inschakelen met behulp van API's

Laatst bijgewerkt: 16 juli 2024

Onderwerpen:
Catalogus

Gemaakt voor:

Ontwikkelaar

Deze zelfstudie behandelt het proces waarbij een dataset met "upsert"mogelijkheden wordt toegelaten om updates aan gegevens van het Profiel van de Klant in real time te maken. Dit omvat stappen voor het creëren van een nieuwe dataset en het vormen van een bestaande dataset.

NOTE

De workflow die in deze zelfstudie wordt beschreven, werkt alleen voor batchopname. Voor het stromen opnemen upserts, gelieve te verwijzen naar de gids bij verzendend gedeeltelijke rijupdates naar het Profiel van de Klant in real time gebruikend Prep van Gegevens.

Aan de slag

Deze zelfstudie vereist een goed begrip van verschillende Adobe Experience Platform-services die betrokken zijn bij het beheer van voor profielen geschikte gegevenssets. Lees vóór het starten van deze zelfstudie de documentatie voor deze verwante Platform services:

Real-Time Customer Profile: biedt een uniform, real-time consumentenprofiel dat is gebaseerd op geaggregeerde gegevens van meerdere bronnen.
Catalog Service: Een RESTful-API waarmee u gegevenssets kunt maken en configureren voor Real-Time Customer Profile en Identity Service .
Experience Data Model (XDM): Het gestandaardiseerde framework waarmee Platform gegevens voor de klantervaring indeelt.
Inname van de Partij: De Ingestie API van de Partij staat u toe om gegevens in Experience Platform als partijdossiers in te voeren.

De volgende secties verstrekken extra informatie die u zult moeten weten om met succes vraag aan Platform APIs te maken.

API-voorbeeldaanroepen lezen

Deze zelfstudie biedt voorbeeld-API-aanroepen om aan te tonen hoe uw verzoeken moeten worden opgemaakt. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te om voorbeeld API vraagin de Experience Platform het oplossen van problemengids te lezen.

Waarden verzamelen voor vereiste koppen

Om vraag aan Platform APIs te maken, moet u het authentificatieleerprogrammaeerst voltooien. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in alle API-aanroepen van Experience Platform , zoals hieronder wordt getoond:

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra Content-Type kopbal. De correcte waarde voor deze kopbal wordt getoond in de steekproefverzoeken waar nodig.

Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle aanvragen naar Platform API's vereisen een x-sandbox-name -header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt. Voor meer informatie over zandbakken in Platform, zie de documentatie van het zandbakoverzicht.

Een gegevensset maken die is ingeschakeld voor profielupdates

Wanneer het creëren van een nieuwe dataset, kunt u die dataset voor Profiel toelaten en updatemogelijkheden op het tijdstip van verwezenlijking toelaten.

NOTE

Om een nieuwe profiel-Toegelaten dataset tot stand te brengen, moet u identiteitskaart van een bestaand schema kennen XDM dat voor Profiel wordt toegelaten. Voor informatie over hoe te omhoog kijken of een profiel-Toegelaten schema tot stand brengen, zie het leerprogramma op creërend een schema gebruikend de Registratie API van het Schema.

Om een dataset tot stand te brengen die voor Profiel en updates wordt toegelaten, gebruik een verzoek van de POST aan het /dataSets eindpunt.

API formaat

POST /dataSets

Verzoek

Door zowel de unifiedIdentity als de unifiedProfile under tags in de hoofdtekst van de aanvraag op te nemen, wordt de gegevensset ingeschakeld voor Profile bij het maken. Als u isUpsert:true toevoegt binnen de array unifiedProfile , kan de dataset updates ondersteunen.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/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}' \
  -d '{
        "name": "Sample dataset",
        "description: "A sample dataset with a sample description.",
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
            "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
        },
        "tags": {
            "unifiedIdentity": [
                "enabled: true"
            ],
            "unifiedProfile": [
                "enabled: true",
                "isUpsert: true"
            ]
        }
      }'

Eigenschap

Beschrijving

schemaRef.id

De id van het schema waarvoor Profile is ingeschakeld en waarop de gegevensset wordt gebaseerd.

{TENANT_ID}

De naamruimte in de Schema Registry die bronnen bevat die tot uw organisatie behoren. Zie TENANT_IDsectie van de Schema Registry ontwikkelaarsgids voor meer informatie.

Reactie

Een succesvol antwoord toont een serie die identiteitskaart van de pas gecreëerde dataset in de vorm van "@/dataSets/{DATASET_ID}" bevat.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Een bestaande gegevensset configureren

De volgende stappen behandelen hoe te om een bestaande profiel-Toegelaten dataset voor updatefunctionaliteit (upsert) te vormen.

NOTE

Om een bestaande profiel-Toegelaten dataset voor upsert te vormen, moet u eerst de dataset voor Profiel onbruikbaar maken en dan het naast de isUpsert markering re-toelaten. Als de bestaande dataset niet voor Profiel wordt toegelaten, kunt u rechtstreeks aan de stappen voor te werk gaan toelatend de dataset voor Profiel ente steunen. Als u onzeker bent, tonen de volgende stappen u hoe te om te controleren als de dataset reeds wordt toegelaten.

Controleren of de gegevensset is ingeschakeld voor profiel

Met de API van Catalog kunt u een bestaande dataset inspecteren om te bepalen of deze is ingeschakeld voor gebruik in Real-Time Customer Profile . De volgende vraag wint de details van een dataset door identiteitskaart terug

API formaat

GET /dataSets/{DATASET_ID}

Parameter

Beschrijving

{DATASET_ID}

De id van een gegevensset die u wilt inspecteren.

Verzoek

curl -X GET 'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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}'

Reactie

{
    "5b020a27e7040801dedbf46e": {
        "name": "{DATASET_NAME}",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ],
            "unifiedProfile": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "{VIEW_ID}",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "{SCHEMA}",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Onder de eigenschap tags ziet u dat unifiedProfile aanwezig is met de waarde enabled:true . Daarom is Real-Time Customer Profile ingeschakeld voor deze gegevensset.

De gegevensset voor profiel uitschakelen

Als u een voor profiel geschikte gegevensset wilt configureren voor updates, moet u eerst de tags unifiedProfile en unifiedIdentity uitschakelen en deze vervolgens weer inschakelen naast de tag isUpsert . Dit wordt gedaan gebruikend twee verzoeken van PATCH, één om onbruikbaar te maken en één om re-toe te laten.

WARNING

Gegevens die in de gegevensset worden opgenomen terwijl deze is uitgeschakeld, worden niet opgenomen in de profielopslag. U zou moeten vermijden het opnemen van gegevens in de dataset tot het voor Profiel opnieuw is toegelaten.

API formaat

PATCH /dataSets/{DATASET_ID}

Parameter

Beschrijving

{DATASET_ID}

De id van de gegevensset die u wilt bijwerken.

Verzoek

De eerste hoofdtekst van de PATCH-aanvraag bevat een lus path to unifiedProfile en een lus path to unifiedIdentity , waarbij de waarde value op enabled:false voor beide paden wordt ingesteld om de tags uit te schakelen.

curl -X PATCH https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+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}' \
  -d '[
        {
            "op": "replace",
            "path": "/tags/unifiedProfile",
            "value": ["enabled:false"]
        },
        {
            "op": "replace",
            "path": "/tags/unifiedIdentity",
            "value": ["enabled:false"]
        }
      ]'

Reactie

Een succesvol PATCH verzoek keert de Status 200 van HTTP (O.K.) en een serie terug die identiteitskaart van de bijgewerkte dataset bevatten. Deze id moet overeenkomen met de id die in de aanvraag voor PATCH is verzonden. De tags unifiedProfile en unifiedIdentity zijn nu uitgeschakeld.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

De dataset voor Profiel en Bijvoegen inschakelen

Een bestaande dataset kan voor de updates van het Profiel en van attributen worden toegelaten gebruikend één enkel verzoek van PATCH.

IMPORTANT

Wanneer het toelaten van uw dataset voor Profiel, gelieve te verzekeren het schema de dataset met wordt geassocieerd is ook profiel-toegelaten. Als het schema niet profiel-toegelaten is, zal de dataset niet als profiel-toegelaten binnen Platform UI verschijnen.

API formaat

PATCH /dataSets/{DATASET_ID}

Parameter

Beschrijving

{DATASET_ID}

De id van een gegevensset die u wilt bijwerken.

Verzoek

De hoofdtekst van de aanvraag bevat een path tot unifiedProfile instelling van value om de tags enabled en isUpsert op te nemen, beide ingesteld op true en een path tot unifiedIdentity instelling van value om de tag enabled op te nemen die is ingesteld op true .

curl -X PATCH https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+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}' \
  -d '[
        {
            "op": "add",
            "path": "/tags/unifiedProfile",
            "value": [
                "enabled:true",
                "isUpsert:true"
            ]
        },
        {
            "op": "add",
            "path": "/tags/unifiedIdentity",
            "value": [
                "enabled:true"
            ]
        }
      ]'

Reactie

Een succesvol PATCH verzoek keert de Status 200 van HTTP (O.K.) en een serie terug die identiteitskaart van de bijgewerkte dataset bevatten. Deze id moet overeenkomen met de id die in de aanvraag voor PATCH is verzonden. De tag unifiedProfile en de tag unifiedIdentity zijn nu ingeschakeld en geconfigureerd voor kenmerkupdates.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Volgende stappen

De gegevensset Profiel en Upsert-ingeschakeld kunnen nu worden gebruikt door workflows voor het invoeren van batches om updates van profielgegevens te maken. Om meer over het opnemen van gegevens in Adobe Experience Platform te leren, gelieve te beginnen door het overzicht van de gegevensinvoer te lezen.

recommendation-more-help