Een gegevensset inschakelen voor Profile en Identity Service gebruiken, API's

Deze zelfstudie behandelt het proces waarbij een gegevensset wordt ingeschakeld voor gebruik in Real-Time Customer Profile en Identity Service, onderverdeeld in 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. Voordat u met deze zelfstudie begint, raadpleegt u de documentatie voor deze verwante onderwerpen Platform diensten:

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 conventies die worden gebruikt in documentatie voor voorbeeld-API-aanroepen raadpleegt u de sectie over voorbeeld-API-aanroepen lezen in de Experience Platform gids voor probleemoplossing.

Waarden verzamelen voor vereiste koppen

Om vraag te maken aan Platform API's, moet u eerst de verificatiezelfstudie. Het voltooien van de zelfstudie over verificatie biedt de waarden voor elk van de vereiste kopteksten in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:

Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra Content-Type header. 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 verzoeken aan Platform API's vereisen een x-sandbox-name header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt. Voor meer informatie over sandboxen in Platform, zie de overzichtsdocumentatie van sandbox.

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, volg de stappen voor het vormen van een bestaande dataset gevonden verderop in dit document.

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

API-indeling

POST /dataSets

Verzoek

Door unifiedProfile en unifiedIdentity krachtens tags in de aanvraaginstantie zal de gegevensset onmiddellijk worden ingeschakeld voor Profile en Identity Service, respectievelijk. De waarden van deze tags moeten een array zijn die de tekenreeks bevat "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"]
    }
  }'

Antwoord

Een succesvolle reactie toont een serie die identiteitskaart van de pas gecreëerde dataset in de vorm van bevat "@/dataSets/{DATASET_ID}". Nadat u een gegevensset hebt gemaakt en ingeschakeld, gaat u verder met de stappen voor gegevens uploaden.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Een bestaande gegevensset configureren configure-an-existing-dataset

De volgende stappen behandelen hoe te om een eerder gecreeerde dataset voor toe te laten Real-Time Customer Profile en Identity Service. Als u reeds een profiel-Toegelaten dataset hebt gecreeerd, gelieve te werk te gaan aan de stappen voor opnemen, gegevens.

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

Met de Catalog API, kunt u een bestaande dataset inspecteren om te bepalen of het voor gebruik binnen wordt toegelaten Real-Time Customer Profile en Identity Service. De volgende vraag wint de details van een dataset door identiteitskaart terug

API-indeling

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}'

Antwoord

{
    "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 tags eigenschap, kunt u zien dat unifiedProfile en unifiedIdentity zijn beide aanwezig met de waarde enabled:true. Daarom Real-Time Customer Profile en Identity Service zijn ingeschakeld voor deze gegevensset.

De gegevensset inschakelen enable-the-dataset

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

API-indeling

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 verzoekende instantie omvat een path tot twee typen tags, unifiedProfile en unifiedIdentity. De value van elk zijn arrays die de tekenreeks bevatten enabled:true.

Antwoord

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 unifiedProfile en unifiedIdentity Er zijn nu codes 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

Beide Real-Time Customer Profile en Identity Service verbruikt XDM gegevens aangezien het in een dataset wordt opgenomen. Raadpleeg de zelfstudie voor instructies over het uploaden van gegevens naar een gegevensset. maken van een gegevensset met behulp van API's. Wanneer u plant welke gegevens u naar uw Profile- toegelaten dataset, overweeg de volgende beste praktijken:

Gegevens bevestigen die worden ingevoerd door Real-Time Customer Profile 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 Real-Time Customer Profile Toegang API, kunt u partijgegevens terugwinnen aangezien het in een dataset wordt geladen. Als u geen van de entiteiten kunt terugwinnen u verwacht, kan uw dataset niet worden toegelaten 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 over het gebruik van de Real-Time Customer Profile API voor toegang Profile gegevens, raadpleeg de eindgebruikershandleiding voor entiteiten, ook wel bekend als "Profile Access" API.

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 toegang tot identiteitsgegevens, gelieve te beginnen door gelezen Overzicht van identiteitsservice.