DataSet für Profile und Identity Service mit APIs konfigurieren

In diesem Lernprogramm wird der Prozess der Aktivierung eines Datensatzes zur Verwendung in Real-time Customer Profile und Identity Serviceunterteilt in die folgenden Schritte beschrieben:

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

Erste Schritte

This tutorial requires a working understanding of the various Adobe Experience Platform services involved in managing Profile-enabled datasets. Before beginning this tutorial, please review the documentation for these related Platform services:

  • 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

All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in. For more information on sandboxes in Platform, see the sandbox overview documentation.

  • x-sandbox-name: {SANDBOX_NAME}

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

Sie können einen Datensatz für Real-time Customer Profile und Identity Service sofort nach der Erstellung oder jederzeit nach Erstellung des Datensatzes aktivieren. Wenn Sie einen Datensatz aktivieren möchten, der bereits erstellt wurde, führen Sie die Schritte zum 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-Registrierungs-API. Der folgende Aufruf der Catalog API aktiviert einen Datensatz für Profile und Identity Service.

API-Format

POST /dataSets

Anfrage

Durch Aufnahme unifiedProfile und unifiedIdentity unter tags in den Anforderungstext wird der Datensatz sofort für Profile bzw. Identity Serviceaktiviert. Die Werte dieser Tags müssen ein Array sein, das die Zeichenfolge enthält "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: {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 Profileaktivierten Schemas, auf dem der Datensatz basiert.
{TENANT_ID} Der Namensraum innerhalb der Schema Registry , der Ressourcen Ihrer IMS-Organisation enthält. 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 zum Hochladen der Datenfort.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

Vorhandenen Datensatz konfigurieren

In den folgenden Schritten wird beschrieben, wie Sie einen zuvor erstellten Datensatz für Real-time Customer Profile und aktivieren Identity Service. Wenn Sie bereits einen Datensatz mit aktiviertem Profil erstellt haben, fahren Sie mit den Schritten zum Erfassen von Datenfort.

Ü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 und Real-time Customer Profile Identity Servicedie Verwendung 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 tags Eigenschaft können Sie sehen, dass unifiedProfile und unifiedIdentity beide vorhanden sind mit dem Wert enabled:true. Daher sind Real-time Customer Profile und Identity Service sind für diesen Datensatz aktiviert.

Datensatz aktivieren

Wenn der vorhandene Datensatz nicht aktiviert wurde Profile oder Identity Service, können Sie ihn aktivieren, indem Sie eine PATCH-Anforderung mit der DataSet-ID durchfü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' \
  -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 eine tags Eigenschaft, 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" Tags wurden jetzt hinzugefügt und der Datensatz 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 Lernprogramm zum Erstellen eines Datensatzes mit APIs. Berücksichtigen Sie bei der Planung, welche Daten an Ihren Profileaktivierten 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. Dadurch können Identitäten effektiver über Datensätze hinweg Identity Service zusammengeführt werden.

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. Using the Real-time Customer Profile Access API, you can retrieve batch data as it gets loaded into a dataset. If you are unable to retrieve any of the entities you expect, your dataset may not be enabled for Real-time Customer Profile. 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 finden Sie im Entitäts-Endpunkthandbuch, auch bekannt als "Profile Access API".

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 in der Übersicht über den Identitätsdienst.

Auf dieser Seite