Datensatz für Profile und Identity Service mithilfe von APIs aktivieren

In diesem Tutorial wird der Prozess zum Aktivieren eines Datensatzes für die Verwendung in Real-time Customer Profile und Identity Service beschrieben, der in die folgenden Schritte unterteilt wird:

  1. Aktivieren Sie einen Datensatz zur Verwendung in Real-time Customer Profile mithilfe einer von zwei Optionen:
  2. Daten in den Datensatz aufnehmen
  3. Datenaufnahme nach Echtzeit-Kundenprofil bestätigen
  4. Datenerfassung durch Identity Service bestätigen

Erste Schritte

Dieses Tutorial setzt Grundkenntnisse verschiedener Adobe Experience Platform-Dienste voraus, die mit der Verwaltung von profilaktivierten Datensätzen verbunden sind. Bevor Sie mit diesem Tutorial beginnen, lesen Sie bitte die Dokumentation für diese zugehörigen DNL Platform-Dienste:

  • Real-time Customer Profile: Bietet ein einheitliches Echtzeit-Kundenprofil, das auf aggregierten Daten aus verschiedenen Quellen basiert.
  • Identity Service: Ermöglicht Real-time Customer Profile die Überbrückung von Identitäten aus unterschiedlichen Datenquellen, in die Platformaufgenommen wird.
  • Catalog Service: Eine RESTful-API, mit der Sie Datensätze erstellen und für Real-time Customer Profile Identity Serviceund konfigurieren können.
  • Experience Data Model (XDM): Das standardisierte Framework, mit dem Platform Kundenerlebnisdaten organisiert.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um die Platform-APIs erfolgreich aufrufen zu können.

Lesen von Beispiel-API-Aufrufen

In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform

Sammeln von Werten für erforderliche Kopfzeilen

Um Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

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

Für alle Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Content-Type -Kopfzeile erforderlich. Der richtige Wert für diese Kopfzeile wird bei Bedarf in den Beispielanfragen angezeigt.

Alle Ressourcen in Experience Platform sind auf bestimmte virtuelle Sandboxes beschränkt. Für alle Anfragen an Platform-APIs ist eine x-sandbox-name-Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll. Weitere Informationen zu Sandboxes in Platform finden Sie in der Sandbox-Übersichtsdokumentation.

Erstellen eines Datensatzes, der für Profil und Identität aktiviert ist

Sie können einen Datensatz für Echtzeit-Kundenprofil und Identity Service sofort nach der Erstellung oder zu einem beliebigen Zeitpunkt nach der Erstellung des Datensatzes aktivieren. Wenn Sie einen bereits erstellten Datensatz aktivieren möchten, führen Sie die Schritte für Konfigurieren eines vorhandenen Datensatzes aus, die weiter unten in diesem Dokument zu finden sind.

HINWEIS

Um einen neuen Datensatz mit aktiviertem Profil zu erstellen, müssen Sie die ID eines vorhandenen XDM-Schemas kennen, das für Profil aktiviert ist. Informationen zum Nachschlagen oder Erstellen eines Profilaktivierten Schemas finden Sie im Tutorial zum Erstellen eines Schemas mit der Schema Registry-API🔗.

Um einen Datensatz zu erstellen, der für Profile aktiviert ist, können Sie eine POST-Anfrage an den Endpunkt /dataSets senden.

API-Format

POST /dataSets

Anfrage

Durch die Einbeziehung von unifiedProfile und unifiedIdentity unter tags in den Anfrageinhalt wird der Datensatz sofort für Profile bzw. Identity Service aktiviert. Die Werte dieser Tags müssen ein Array sein, das die Zeichenfolge "enabled:true" enthält.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "fields":[],
    "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"]
    }
  }'
Eigenschaft Beschreibung
schemaRef.id Die ID des Profile-aktivierten Schemas, auf dem der Datensatz basieren soll.
{TENANT_ID} Der Namespace innerhalb von Schema Registry , der Ressourcen enthält, die zu Ihrer IMS-Organisation gehören. Weitere Informationen finden Sie im Abschnitt TENANT_ID des Schema Registry-Entwicklerhandbuchs.

Antwort

Eine erfolgreiche Antwort zeigt ein Array mit der Kennung des neu erstellten Datensatzes in der Form "@/dataSets/{DATASET_ID}" an. Nachdem Sie einen Datensatz erfolgreich erstellt und aktiviert haben, fahren Sie mit den Schritten für Hochladen von Daten fort.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

Vorhandenen Datensatz konfigurieren

Die folgenden Schritte beschreiben, wie Sie einen zuvor erstellten Datensatz für Real-time Customer Profile und Identity Service aktivieren. Wenn Sie bereits einen Datensatz mit aktiviertem Profil erstellt haben, fahren Sie mit den Schritten für Erfassen von Daten fort.

Überprüfen, ob der Datensatz aktiviert ist

Mithilfe der Catalog-API können Sie einen vorhandenen Datensatz überprüfen, um festzustellen, ob er für die Verwendung in Real-time Customer Profile und Identity Service aktiviert ist. Der folgende Aufruf ruft die Details eines Datensatzes nach Kennung ab.

API-Format

GET /dataSets/{DATASET_ID}
Parameter Beschreibung
{DATASET_ID} Die ID eines Datensatzes, den Sie überprüfen möchten.

Anfrage

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Unter der Eigenschaft tags können Sie sehen, dass unifiedProfile und unifiedIdentity beide mit dem Wert enabled:true vorhanden sind. Daher sind Real-time Customer Profile und Identity Service für diesen Datensatz aktiviert.

Datensatz aktivieren

Wenn der vorhandene Datensatz für Profile oder Identity Service nicht aktiviert wurde, können Sie ihn aktivieren, indem Sie eine PATCH-Anfrage mit der Datensatz-ID ausführen.

API-Format

PATCH /dataSets/{DATASET_ID}
Parameter Beschreibung
{DATASET_ID} Die ID eines Datensatzes, den Sie aktualisieren möchten.

Anfrage

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/tags/unifiedProfile", "value": ["enabled:true"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] } 
      ]'

Der Anfrageinhalt enthält path bis zu zwei Arten von Tags, unifiedProfile und unifiedIdentity. Die value von jedem sind Arrays, die die Zeichenfolge enabled:true enthalten.


AntwortEine erfolgreiche PATCH-Anfrage gibt den HTTP-Status 200 (OK) und ein Array mit der Kennung des aktualisierten Datensatzes zurück. Diese ID sollte mit der in der PATCH-Anfrage gesendeten ID übereinstimmen. Die Tags unifiedProfile und unifiedIdentity wurden hinzugefügt und der Datensatz ist für die Verwendung durch Profil- und Identitätsdienste aktiviert.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Daten in den Datensatz aufnehmen

Sowohl Real-time Customer Profile als auch Identity Service verwenden XDM-Daten, während sie in einen Datensatz aufgenommen werden. Anweisungen zum Hochladen von Daten in einen Datensatz finden Sie im Tutorial zum Erstellen eines Datensatzes mithilfe von APIs🔗. Beachten Sie bei der Planung der an Ihren Profile-aktivierten Datensatz zu sendenden Daten die folgenden Best Practices:

  • Schließen Sie alle Daten ein, die Sie als Segmentierungskriterien verwenden möchten.
  • Fügen Sie so viele Identifikatoren ein, wie Sie aus Ihren Profildaten erkennen können, um Ihr Identitätsdiagramm zu maximieren. Dadurch kann Identity Service Identitäten besser über Datensätze hinweg zuordnen.

Datenerfassung bestätigen mit Real-time Customer Profile

Beim erstmaligen Hochladen von Daten in einen neuen Datensatz oder im Rahmen eines Prozesses mit einem neuen ETL oder einer neuen Datenquelle wird empfohlen, die Daten sorgfältig zu überprüfen, um sicherzustellen, dass sie erwartungsgemäß hochgeladen wurden. Mit der Zugriffs-API Real-time Customer Profile können Sie Batch-Daten abrufen, während sie in einen Datensatz geladen werden. Wenn Sie keine der erwarteten Entitäten abrufen können, ist Ihr Datensatz möglicherweise nicht für Real-time Customer Profile aktiviert. Nachdem Sie bestätigt haben, dass Ihr Datensatz aktiviert wurde, stellen Sie sicher, dass Ihr Quelldatenformat und Ihre Identifikatoren Ihre Erwartungen unterstützen. Detaillierte Anweisungen zur Verwendung der Real-time Customer Profile-API für den Zugriff auf Profile-Daten finden Sie im Entitäts-Endpunkthandbuch, auch als "Profile Access"-API bezeichnet.

Datenerfassung durch Identity Service bestätigen

Jedes erfasste Datenfragment, das mehr als eine Identität enthält, erstellt einen Link in Ihrem privaten Identitätsdiagramm. Weitere Informationen zu Identitätsdiagrammen und zum Zugriff auf Identitätsdaten finden Sie in der Übersicht über den Identitätsdienst.

Auf dieser Seite