Datensatz für Profilaktualisierungen mithilfe von APIs aktivieren

In diesem Tutorial wird die Aktivierung eines Datensatzes mit "upsert"-Funktionen beschrieben, um Aktualisierungen an Echtzeit-Kundenprofildaten vorzunehmen. Dies umfasst die Schritte zum Erstellen eines neuen Datensatzes und zum Konfigurieren eines vorhandenen Datensatzes.

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:

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 Profilaktualisierungen aktiviert ist

Beim Erstellen eines neuen Datensatzes können Sie diesen Datensatz für Profil aktivieren und zum Zeitpunkt der Erstellung Aktualisierungsfunktionen aktivieren.

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 Profil und Updates aktiviert ist, verwenden Sie eine POST-Anfrage an den Endpunkt /dataSets .

API-Format

POST /dataSets

Anfrage

Wenn Sie unifiedProfile unter tags in den Anfrageinhalt aufnehmen, wird der Datensatz bei der Erstellung für Profile aktiviert. Innerhalb des unifiedProfile-Arrays wird durch Hinzufügen von isUpsert:true die Möglichkeit hinzugefügt, dass der Datensatz Aktualisierungen unterstützt.

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",
            "isUpsert: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.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

Vorhandenen Datensatz konfigurieren

Die folgenden Schritte beschreiben, wie Sie einen vorhandenen Datensatz mit aktiviertem Profil für die Aktualisierungsfunktion ("upsert") konfigurieren.

HINWEIS

Um einen vorhandenen Datensatz mit aktiviertem Profil für "upsert"zu konfigurieren, müssen Sie zunächst den Datensatz für Profil deaktivieren und ihn dann neben dem Tag isUpsert erneut aktivieren. Wenn der vorhandene Datensatz nicht für Profil aktiviert ist, können Sie direkt mit den Schritten für Aktivieren des Datensatzes für Profil und Aktualisieren fortfahren. Wenn Sie sich nicht sicher sind, zeigen Ihnen die folgenden Schritte, wie Sie überprüfen können, ob der Datensatz bereits aktiviert ist.

Überprüfen Sie, ob der Datensatz für Profil 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 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": "{DATASET_NAME}",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ]
        },
        "lastBatchId": "{BATCH_ID}",
        "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": "{VIEW_ID}",
        "status": "enabled",
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "{SCHEMA}",
        "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 mit dem Wert enabled:true vorhanden ist. Daher ist Real-time Customer Profile für diesen Datensatz aktiviert.

Datensatz für Profil deaktivieren

Um einen für Profile aktivierten Datensatz für Aktualisierungen zu konfigurieren, müssen Sie zunächst das Tag unifiedProfile deaktivieren und ihn dann neben dem Tag isUpsert erneut aktivieren. Dies geschieht mit zwei PATCH-Anfragen, einmal zur Deaktivierung und einmal zur erneuten Aktivierung.

WARNUNG

Daten, die während der Deaktivierung in den Datensatz aufgenommen werden, werden nicht in den Profilspeicher aufgenommen. Es wird empfohlen, die Aufnahme von Daten in den Datensatz zu vermeiden, bis er für Profil wieder aktiviert wurde.

API-Format

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

Anfrage

Der erste PATCH-Anfrageinhalt enthält ein path zu unifiedProfile, das value auf enabled:false setzt, um das Tag zu deaktivieren.

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": "replace", "path": "/tags/unifiedProfile", "value": ["enabled:false"] },
      ]'


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. Das Tag unifiedProfile wurde jetzt deaktiviert.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Datensatz für Profil aktivieren und aktualisieren

Ein vorhandener Datensatz kann mit einer einzigen PATCH-Anfrage für Profil- und Attributaktualisierungen aktiviert werden.

API-Format

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

Anfrage

Der Anfrageinhalt enthält ein path zu unifiedProfile , mit dem die value eingestellt wird, um die enabled - und isUpsert -Tags einzuschließen, die beide auf true gesetzt sind.

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","isUpsert:true"] },
      ]'


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. Das Tag unifiedProfile wurde jetzt für Attributaktualisierungen aktiviert und konfiguriert.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Nächste Schritte

Ihr Profil und Ihr hochaktivierter Datensatz können jetzt von Batch- und Streaming-Aufnahme-Workflows verwendet werden, um Aktualisierungen an Profildaten vorzunehmen. Um mehr über die Aufnahme von Daten in Adobe Experience Platform zu erfahren, lesen Sie zunächst die Übersicht über die Datenerfassung.

Auf dieser Seite