Konfigurieren eines Datensatzes für Profile und Identity Service mithilfe von APIs

Dieses Lernprogramm beschreibt den Prozess der Aktivierung eines Datensatzes für die Verwendung in Real-time Customer Profile und Identity Service und unterteilt in die folgenden Schritte:

  1. Aktivieren Sie einen Datensatz zur Verwendung in Real-time Customer Profile, indem Sie eine der beiden Optionen verwenden:
  2. Daten in den Datensatz aufnehmen
  3. Datenerfassung nach Echtzeit-Kundendaten bestätigen
  4. Datenerfassung durch Identitätsdienst bestätigen

Erste Schritte

Dieses Lernprogramm erfordert ein Verständnis der verschiedenen Adobe Experience Platform-Dienste, die mit der Verwaltung von Profile-fähigen Datensätzen befasst sind. Bevor Sie mit diesem Tutorial beginnen, lesen Sie bitte die Dokumentation zu diesen verwandten Platform-Diensten:

  • Real-time Customer Profile: Bietet ein einheitliches, Echtzeit-Profil für Kunden, das auf aggregierten Daten aus mehreren Quellen basiert.
  • Identity Service: Ermöglicht Real-time Customer Profile die Überbrückung von Identitäten aus unterschiedlichen Datenquellen, in die Daten eingehen Platform.
  • Catalog Service: Eine RESTful-API, mit der Sie Datasets erstellen und konfigurieren können, für Real-time Customer Profile und Identity Service.
  • 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}

Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:

  • Content-Type: application/json

Alle Ressourcen in Experience Platform werden zu bestimmten virtuellen Sandboxen isoliert. Für alle Anforderungen an Platform-APIs ist ein Header erforderlich, der den Namen der Sandbox angibt, in der der Vorgang ausgeführt wird. Weitere Informationen zu Sandboxen in Platform finden Sie in der Sandbox-Übersichtsdokumentation.

  • x-sandbox-name: {SANDBOX_NAME}

Erstellen Sie einen Datensatz, der für Profile und Identity aktiviert ist.

Sie können einen Datensatz für Real-time Customer Profile und Identity Service unmittelbar nach der Erstellung oder zu einem beliebigen Zeitpunkt nach der Erstellung des Datensatzes aktivieren. Wenn Sie einen Datensatz aktivieren möchten, der bereits erstellt wurde, führen Sie die Schritte für Konfigurieren eines vorhandenen Datensatzes weiter unten in diesem Dokument aus. Um einen neuen Datensatz zu erstellen, müssen Sie die ID eines vorhandenen XDM-Schemas kennen, das für Echtzeit-Kundendaten-Profil aktiviert ist. Informationen zum Nachschlagen oder Erstellen eines Profil-aktivierten Schemas finden Sie im Lernprogramm zum Erstellen eines Schemas mit der Schema Registry API](…/…/xdm/tutorials/create-schema-api.md). [ Der folgende Aufruf der API Catalog aktiviert einen Datensatz für Profile und Identity Service.

API-Format

POST /dataSets

Anfrage

Durch die Aufnahme von unifiedProfile und unifiedIdentity unter tags in den Anforderungstext 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 '{
    "fileDescription" : {
    "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    },
    "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 basiert.
{TENANT_ID} Der Namensraum 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 ID des neu erstellten Datensatzes in Form von "@/dataSets/{DATASET_ID}". 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 Profil-aktivierten Datensatz erstellt haben, fahren Sie mit den Schritten für Erfassen von Daten fort.

Überprüfen Sie, ob der Datensatz aktiviert ist.

Mithilfe der API Catalog 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 ID 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",
        "fileDescription": {
            "persisted": true,
            "containerFormat": "parquet",
            "format": "parquet"
        },
        "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 nicht für Profile oder Identity Service aktiviert wurde, können Sie ihn aktivieren, indem Sie eine PATCH-Anforderung mit der DataSet-ID erstellen.

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' \
  -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 '{
    "tags" : {
        "unifiedProfile": ["enabled:true"],
        "unifiedIdentity": ["enabled:true"]
    }
  }'

Der Anforderungstext enthält die Eigenschaft tags, die zwei Untereigenschaften enthält: "unifiedProfile" und "unifiedIdentity". Die Werte dieser Untereigenschaften sind Arrays mit der Zeichenfolge "enabled:true".

Antwort
Eine erfolgreiche PATCH-Anforderung gibt HTTP-Status 200 (OK) und ein Array mit der ID 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 Dataset 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 Lernprogramm Erstellen eines Datensatzes mit APIs. Berücksichtigen Sie bei der Planung, welche Daten an Ihren Profile-aktivierten Datensatz gesendet werden sollen, die folgenden Best Practices:

  • Schließen Sie alle Daten ein, die Sie als Segmentkriterien für Audiencen verwenden möchten.
  • Schließen Sie so viele Bezeichner ein, wie Sie aus Ihren Profil-Daten erkennen können, um Ihr Identitätsdiagramm zu maximieren. Auf diese Weise können Identitäten zwischen Datensätzen effektiver verknüpft werden.Identity Service

Datenerfassung bestätigen durch Real-time Customer Profile

Beim erstmaligen Hochladen von Daten in einen neuen Datensatz oder im Rahmen eines Prozesses mit einer neuen ETL oder 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 Stapeldaten abrufen, während sie in ein Dataset 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. Ausführliche Anweisungen zum Verwenden der Real-time Customer Profile-API für den Zugriff auf Profile-Daten erhalten Sie im Entitäts-Endpunkthandbuch, auch als "Profile Access-API"bezeichnet.

Datenerfassung durch Identitätsdienst bestätigen

Jedes ingetierte 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 erhalten Sie zunächst im Übersicht über den Identitätsdienst.

Auf dieser Seite

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now