(Beta) Aktivieren von Zielgruppensegmenten für Batch-Ziele über die Ad-hoc-Aktivierungs-API

WICHTIG

Die ad-hoc activation API in Platform befindet sich derzeit in der Betaphase. Dokumentation und Funktionalität können sich ändern.

Übersicht

Mit der Ad-hoc-Aktivierungs-API können Marketing-Experten Zielgruppensegmente schnell und effizient für Situationen aktivieren, in denen eine sofortige Aktivierung erforderlich ist.

Das folgende Diagramm zeigt den End-to-End-Workflow zum Aktivieren von Segmenten über die Ad-hoc-Aktivierungs-API, einschließlich der Segmentierungsaufträge, die alle 24 Stunden in Platform stattfinden.

Ad-hoc-Aktivierung

HINWEIS

Die Ad-hoc-Zielgruppenaktivierung wird nur von Batch-dateibasierte Ziele.

Anwendungsfälle

Flash-Verkäufe oder -Promotions

Ein Online-Händler bereitet einen begrenzten Flash-Verkauf vor und möchte Kunden kurzfristig benachrichtigen. Über die Ad-hoc-Aktivierungs-API der Experience Platform kann das Marketing-Team bei Bedarf Segmente exportieren und Werbe-E-Mails schnell an den Kundenstamm senden.

Aktuelle Veranstaltungen oder aktuelle Nachrichten

Ein Hotel erwartet ein schlechtes Wetter an den folgenden Tagen, und das Team möchte die ankommenden Gäste schnell informieren, damit sie entsprechend planen können. Das Marketing-Team kann die Ad-hoc-Aktivierungs-API der Experience Platform verwenden, um Segmente bei Bedarf zu exportieren und die Gäste zu benachrichtigen.

Integrationstests

IT-Manager können die Ad-hoc-Aktivierungs-API der Experience Platform verwenden, um Segmente bei Bedarf zu exportieren, sodass sie ihre benutzerdefinierte Integration mit Adobe Experience Platform testen und sicherstellen können, dass alles ordnungsgemäß funktioniert.

Schutzschilde

Beachten Sie bei der Verwendung der Ad-hoc-Aktivierungs-API die folgenden Limits.

  • Derzeit kann jeder Ad-hoc-Aktivierungsauftrag bis zu 20 Segmente aktivieren. Der Versuch, mehr als 20 Segmente pro Auftrag zu aktivieren, führt dazu, dass der Auftrag fehlschlägt. Dieses Verhalten kann sich in zukünftigen Versionen ändern.
  • Ad-hoc-Aktivierungsvorgänge können nicht parallel zu geplanten Aktivitäten ausgeführt werden Segmentexportaufträge. Bevor Sie einen Ad-hoc-Aktivierungsauftrag ausführen, stellen Sie sicher, dass der geplante Segmentexportauftrag abgeschlossen ist. Siehe Ziel-Datenfluss-Überwachung Informationen zur Überwachung des Status der Aktivierungsflüsse. Wenn Ihr Aktivierungsdataflow beispielsweise eine Verarbeitung -Status, warten Sie, bis sie abgeschlossen ist, bevor Sie den Ad-hoc-Aktivierungsauftrag ausführen.
  • Führen Sie nicht mehr als einen gleichzeitigen Ad-hoc-Aktivierungsauftrag pro Segment aus.

Überlegungen zur Segmentierung

Adobe Experience Platform führt geplante Segmentierungsaufträge einmal alle 24 Stunden aus. Die Ad-hoc-Aktivierungs-API wird basierend auf den neuesten Segmentierungsergebnissen ausgeführt.

Schritt 1: Voraussetzungen

Bevor Sie die Adobe Experience Platform-APIs aufrufen können, stellen Sie sicher, dass Sie die folgenden Voraussetzungen erfüllen:

  • Sie verfügen über ein IMS-Organisationskonto mit Zugriff auf Adobe Experience Platform.
  • Ihr Experience Platform-Konto verfügt über die developer und user Rollen, die für das Adobe Experience Platform API-Produktprofil aktiviert sind. Wenden Sie sich an Admin Console Administrator, um diese Rollen für Ihr Konto zu aktivieren.
  • Du hast einen Adobe ID. Wenn Sie keine Adobe ID haben, navigieren Sie zum Adobe Developer Console und erstellen Sie ein neues Konto.

Schritt 2: Sammeln von Anmeldeinformationen

Um Platform-APIs aufrufen zu können, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Im Rahmen des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Kopfzeilen 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}

Ressourcen in Experience Platform lassen sich in spezifischen virtuellen Sandboxes isolieren. Bei Anfragen an Platform-APIs können Sie den Namen und die Kennung der Sandbox angeben, in der der Vorgang ausgeführt werden soll. Dies sind optionale Parameter.

  • x-sandbox-name: {SANDBOX_NAME}
HINWEIS

Weitere Informationen zu Sandboxes in Experience Platform finden Sie in der Sandbox-Übersichtsdokumentation.

Bei allen Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Medientyp-Kopfzeile erforderlich:

  • Content-Type: application/json

Schritt 3: Erstellen eines Aktivierungsflusses in der Platform-Benutzeroberfläche

Bevor Sie Segmente über die Ad-hoc-Aktivierungs-API aktivieren können, muss zunächst ein Aktivierungsfluss in der Platform-Benutzeroberfläche für das ausgewählte Ziel konfiguriert werden.

Dazu gehören der Einstieg in den Aktivierungs-Workflow, die Auswahl Ihrer Segmente, die Konfiguration eines Zeitplans und die Aktivierung dieser Segmente.

Detaillierte Anweisungen zum Konfigurieren eines Aktivierungsflusses für Batch-Ziele finden Sie im folgenden Tutorial: Aktivieren von Zielgruppendaten für Batch-Profil-Export-Ziele.

Schritt 4: Abrufen der neuesten Segmentexportauftrag-ID

Nachdem Sie einen Aktivierungsfluss für Ihr Batch-Ziel konfiguriert haben, werden geplante Segmentierungsaufträge automatisch alle 24 Stunden ausgeführt.

Bevor Sie den Ad-hoc-Aktivierungsauftrag ausführen können, müssen Sie die ID des aktuellen Segmentexportauftrags abrufen. Sie müssen diese ID in der Ad-hoc-Aktivierungsanfrage übergeben.

Befolgen Sie die beschriebenen Anweisungen. here , um eine Liste aller Segmentexportaufträge abzurufen.

Suchen Sie in der Antwort nach dem ersten Datensatz, der die unten stehende Schemaeigenschaft enthält.

"schema":{
   "name":"_xdm.context.profile"
}

Die Segmentexportauftrag-ID befindet sich im id -Eigenschaft, wie unten dargestellt.

Segmentexportauftrag-ID

Schritt 5: Ausführen des Ad-hoc-Aktivierungsauftrags

Adobe Experience Platform führt geplante Segmentierungsaufträge einmal alle 24 Stunden aus. Die Ad-hoc-Aktivierungs-API wird basierend auf den neuesten Segmentierungsergebnissen ausgeführt.

Bevor Sie einen Ad-hoc-Aktivierungsauftrag ausführen, stellen Sie sicher, dass der geplante Segmentexportauftrag für Ihre Segmente abgeschlossen ist. Siehe Ziel-Datenfluss-Überwachung Informationen zur Überwachung des Status der Aktivierungsflüsse. Wenn Ihr Aktivierungsdataflow beispielsweise eine Verarbeitung -Status, warten Sie, bis sie abgeschlossen ist, bevor Sie den Ad-hoc-Aktivierungsauftrag ausführen.

Nach Abschluss des Segmentexportauftrags können Sie die Aktivierung Trigger haben.

HINWEIS

Derzeit kann jeder Ad-hoc-Aktivierungsauftrag bis zu 20 Segmente aktivieren. Der Versuch, mehr als 20 Segmente pro Auftrag zu aktivieren, führt dazu, dass der Auftrag fehlschlägt. Dieses Verhalten kann sich in zukünftigen Versionen ändern.

Anfrage

curl -X POST https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -d '
{
   "activationInfo":{
      "destinationId1":[
         "segmentId1",
         "segmentId2"
      ],
      "destinationId2":[
         "segmentId2",
         "segmentId3"
      ]
   },
   "exportIds":[
      "exportId1"
   ]
}
Eigenschaft Beschreibung
  • destinationId1
  • destinationId2
Die IDs der Zielinstanzen, für die Sie Segmente aktivieren möchten.
  • segmentId1
  • segmentId2
  • segmentId3
Die IDs der Segmente, die Sie für das ausgewählte Ziel aktivieren möchten.
  • exportId1
Die in der Antwort der Segmentexport Auftrag. Siehe Schritt 4: Abrufen der neuesten Segmentexportauftrag-ID für Anweisungen zum Auffinden dieser ID.

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 zurück.

{
   "order":[
      {
         "segment":"db8961e9-d52f-45bc-b3fb-76d0382a6851",
         "order":"ef2dcbd6-36fc-49a3-afed-d7b8e8f724eb",
         "statusURL":"https://platform.adobe.io/data/foundation/flowservice/runs/88d6da63-dc97-460e-b781-fc795a7386d9"
      }
   ]
}
Eigenschaft Beschreibung
segment Die ID des aktivierten Segments.
order Die ID des Ziels, für das das Segment aktiviert wurde.
statusURL Die Status-URL des Aktivierungsflusses. Sie können den Flussfortschritt mithilfe der Flussdienst-API.

Umgang mit API-Fehlern

Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen der Experience Platform API-Fehlermeldung. Siehe API-Statuscodes und Fehler in der Anfragekopfzeile im Handbuch zur Fehlerbehebung bei Platform.

Auf dieser Seite