Een gegevensset inschakelen voor Profile en Identity Service met behulp van API's

Deze zelfstudie behandelt het proces waarbij een gegevensset wordt ingeschakeld voor gebruik in Real-Time Customer Profile en Identity Service , en omvat de volgende stappen:

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:

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:

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 profiel en identiteit create-a-dataset-enabled-for-profile-and-identity

U kunt een dataset voor het Profiel en de Dienst van de Identiteit van de Klant in real time onmiddellijk op verwezenlijking of op om het even welk punt toelaten nadat de dataset is gecreeerd. Als u een dataset zou willen toelaten die reeds is gecreeerd, de stappen voor vormend een bestaande datasetvolgen die later in dit document wordt gevonden.

Om een dataset tot stand te brengen die voor Profiel wordt toegelaten, kunt u een verzoek van de POST aan het /dataSets eindpunt gebruiken.

API formaat

POST /dataSets

Verzoek

Door unifiedProfile en unifiedIdentity under tags op te nemen in de hoofdtekst van de aanvraag, wordt de gegevensset direct ingeschakeld voor respectievelijk Profile en Identity Service . De waarden van deze tags moeten een array zijn met de tekenreeks "enabled:true" .

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 '{
    "schemaRef": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags": {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'

Reactie

Een succesvol antwoord toont een serie die identiteitskaart van de pas gecreëerde dataset in de vorm van "@/dataSets/{DATASET_ID}" bevat. Zodra u met succes een dataset hebt gecreeerd en toegelaten, te werk gaan aan de stappen voor het uploaden gegevens.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Een bestaande gegevensset configureren configure-an-existing-dataset

In de volgende stappen wordt beschreven hoe u een eerder gemaakte dataset voor Real-Time Customer Profile en Identity Service kunt inschakelen. Als u reeds een profiel-Toegelaten dataset hebt gecreeerd, te werk gaan aan de stappen voor het nemen van gegevens.

Controleren of de gegevensset is ingeschakeld check-if-the-dataset-is-enabled

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

API formaat

GET /dataSets/{DATASET_ID}

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": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "@/xdms/context/experienceevent",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Onder de eigenschap tags ziet u dat unifiedProfile en unifiedIdentity beide aanwezig zijn met de waarde enabled:true . Daarom zijn Real-Time Customer Profile en Identity Service ingeschakeld voor deze gegevensset.

De gegevensset inschakelen enable-the-dataset

Als de bestaande dataset niet voor Profile of Identity Service is toegelaten, kunt u het toelaten door een verzoek van de PATCH te maken gebruikend dataset identiteitskaart

API formaat

PATCH /dataSets/{DATASET_ID}

Verzoek

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"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

De hoofdtekst van de aanvraag bevat een path naar twee typen tags, unifiedProfile en unifiedIdentity . De value van elk zijn arrays die de tekenreeks enabled:true bevatten.

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 toegevoegd en de gegevensset is ingeschakeld voor gebruik door de services Profiel en Identiteit.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Gegevens in de dataset opnemen ingest-data-into-the-dataset

Zowel Real-Time Customer Profile als Identity Service gebruiken XDM-gegevens terwijl deze in een gegevensset worden opgenomen. Voor instructies op hoe te om gegevens in een dataset te uploaden, verwijs naar het leerprogramma op creërend een dataset gebruikend APIs. Houd bij het plannen van de gegevens die u naar de Profile -gegevensset wilt verzenden rekening met de volgende aanbevolen procedures:

Gegevens die worden ingevoerd door Real-Time Customer Profile bevestigen confirm-data-ingest-by-real-time-customer-profile

Bij het voor het eerst uploaden van gegevens naar een nieuwe gegevensset of als onderdeel van een proces waarbij een nieuwe ETL of gegevensbron betrokken is, wordt aanbevolen de gegevens zorgvuldig te controleren om te controleren of deze op de verwachte wijze zijn geüpload. Met de API voor toegang van Real-Time Customer Profile kunt u batchgegevens ophalen terwijl deze in een gegevensset worden geladen. Als u geen van de entiteiten kunt ophalen die u verwacht, is het mogelijk dat de gegevensset niet is ingeschakeld voor Real-Time Customer Profile . Na het bevestigen dat uw dataset is toegelaten, zorg ervoor dat uw brongegevensformaat en herkenningstekens uw verwachtingen steunen. Voor gedetailleerde instructies op hoe te om Real-Time Customer Profile API te gebruiken om tot Profile gegevens toegang te hebben, gelieve te verwijzen naar de gids van het entiteitseindpunt, die ook als "Profile Access"API wordt bekend.

Gegevens die door Identity Service worden ingevoerd bevestigen confirm-data-ingest-by-identity-service

Elk opgenomen gegevensfragment dat meer dan één identiteit bevat, maakt een koppeling in uw persoonlijke identiteitsgrafiek. Voor meer informatie over identiteitsgrafieken en de gegevens van de toegangsidentiteit, gelieve te beginnen door het overzicht van de Dienst van de Identiteitte lezen.