Transaktionsnachrichten senden (API)
Ziel
Transaktionsnachrichten mit der Mapp Engage-API senden
Hintergrundinformation
Eine Transaktionsnachricht enthält eine eindeutige ID für jeden Kontakt. Diese ID wird als Transaktionsnachrichten-ID (TMID) bezeichnet. Mit dieser ID können Sie jede Nachricht einzeln verfolgen und feststellen, ob der Kontakt die Nachricht erhält und öffnet.
Die hier verwendete API-Methode lautet messageSendTransactional.
Diese Anordnung setzt voraus, dass Ihr externes Tool eine eindeutige ID für jede Nachricht erstellt. Diese Anordnung setzt außerdem voraus, dass Ihr Tool diese ID im API-Aufruf als Parameter an Mapp Engage sendet.
Wenn Ihr externes Tool diese ID nicht generiert, kann Mapp Engage eindeutige IDs für Sie generieren. Verwenden Sie die API-Methode messageSendSingle statt messageSendTransactional. Stellen Sie den Transaktionsnachrichtenmodus in den Verteilereinstellungen auf An. Verwenden Sie den Dialog Personalisierung, um ein Muster zu erstellen, das eine eindeutige TMID für jeden Versand generiert.
Beispiel
u=<%${user['PK']}%>m=<%${message['PK']}%>t=<%${ecx:formatDate(ecm:addInterval(date.today, '-0d'), 'yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\'', ecm:timeZone('UTC'), '', false)}%> |
Wenn von Mapp Engage die Einzelnachrichten versendet werden, weist das System jeder Nachricht eine eindeutige TMID zu. Für weitere Informationen siehe Eine TMID zu Nachrichten hinzufügen.
Wenn Mapp Engage eine Transaktionsnachricht an einen Kontakt sendet, der nicht zum Verteiler gehört, fügt Mapp Engage den Kontakt zum Verteiler hinzu.
Vorgehen
Dieser Vorgang hat fünf Schritte.
- Erstellen Sie ein API-Benutzerkonto.
- Erstellen Sie einen Verteiler für den Versand von Transaktionsnachrichten.
- Richten Sie die Transaktionsnachricht als versandfertige Nachricht ein.
- Richten Sie die API-Lösung ein.
- Verfolgen Sie die Transaktionsnachrichten.
A) API-Benutzerkonto erstellen
- Klicken Sie in der Hauptnavigation auf Benutzerverwaltung > Systemanwender > Systemanwender.
- Klicken Sie auf die Schaltfläche Neu.
⇒ Der Dialog Neuer Systembenutzer wird geöffnet.
Weitere Informationen zum Erstellen von API-Benutzerkonten finden Sie unter Tabelle.
B) Verteiler für den Versand von Transaktionsnachrichten erstellen
Richten Sie einen neuen Verteiler ein, um Empfänger von Transaktionsnachrichten zu verwalten. Dieser Verteiler dient als Container und trennt die Empfänger von Transaktionsnachrichten von anderen Benutzern im System.
Wenn Mapp Engage eine Transaktionsnachricht an einen Kontakt sendet, der nicht zum Verteiler gehört, fügt Mapp Engage den Kontakt zum Verteiler hinzu.
Oft haben die Empfänger einer Transaktionsnachricht den Anmeldevorgang für Ihren Newsletter noch nicht abgeschlossen. Verwalten Sie diese Adressen separat, um zu verhindern, dass diese Adressen versehentlich Marketingangebote erhalten, mit denen sie nicht einverstanden sind.
- Klicken Sie im Menü Hauptnavigation auf Zielgruppe >Verteiler.
⇒ Der Dialog Übersicht Verteiler wird geöffnet. - Klicken Sie auf Erstellen.
⇒ Der Dialog Details des Verteilers wird geöffnet. - Geben Sie im Eingabefeld Name einen Namen ein, der diesen Verteiler von anderen Verteilern unterscheidet, die bereits im System gespeichert sind. Geben Sie im Eingabefeld E-Mail die E-Mail-Adresse ein, die für den Versand der Transaktionsnachricht verwendet werden soll.
- Klicken Sie auf Erstellen.
⇒ Ein Dialog mit dem Register Allgemeine Einstellungen wird geöffnet - Öffnen Sie das Register Versandeinstellungen, und scrollen Sie zum BereichTransaktionsnachrichten herunter.
- Stellen Sie den Transaktionsnachrichtenmodus in den Verteilereinstellungen auf Aus. Durch diese Einstellung wird Mapp Engage angewiesen, keine zusätzliche TMID für jeden Versand zu generieren.
C) Transaktionsnachricht als versandfertige Nachricht einrichten
Erstellen Sie eine versandfertige Nachricht, die Sie als Vorlage für eine Transaktionsnachricht verwenden können.
Weitere Informationen zur Erstellung neuer Nachrichten finden Sie unter Eine E-Mail-Nachricht erstellen.
Der Beispiel-HTML-Code enthält Platzhalter für ein Standardattribut, ein angepasstes Attribut und einen Parameter zum Einfügen von Daten aus dem verbundenen System.
<html>
<body>
<p>Hi <%${user['FirstName']}%>,</p><!--Standard attribute placeholders insert data stored in the user profile in Mapp Engage.-->
<p>The item you requested has been ordered for delivery to our <%user.CustomAttribute['Local store purchase']%> store:</p><!--Custom attribute placeholders insert data stored in custom attributes.-->
<p><%parameter.productName%></p><!--This placeholder inserts data from the connected system. The property reference should match the column name in the external data set.-->
<p>We will send you notification when the item is available for pickup.</p> <p>Best Regards,</p>
</body>
</html>
- Klicken Sie in der Hauptnavigation auf + Erstellen und Neue Nachricht.
- Geben Sie im Eingabefeld Name der Nachricht einen Namen für die Nachricht ein, zum Beispiel Vorlage für Transaktionsnachricht.
Klicken Sie auf Erstellen. - Kopieren Sie die Beispiel-HTML, und fügen Sie diesen Code in den Inhaltsbereich ein.
- Klicken Sie auf die Schaltfläche Zum Versand.
- Wählen Sie im Listenfeld Verteiler den Verteiler aus, der im vorherigen Vorgang erstellt wurde.
- Wählen Sie im Feld Nachricht wird die Option Als versandfertige Nachricht gespeichert aus.
- Klicken Sie auf Nachricht überprüfen
⇒ Die Nachricht wird im Dialog Übersicht Versandfertige Nachrichten erstellt und angezeigt.
D) API-Lösung einrichten
Transaktionsereignisse, die einen Nachrichtenversand auslösen, müssen über die API zu Mapp Engage gesendet werden. Die API-Lösung kann so eingerichtet werden, dass sie eine der folgenden Aktionen durchführt:
In Mapp Engage nach dem Empfängerkonto suchen oder ein neues erstellen
Das Anwenderprofil aktualisieren
Den Nachrichteninhalt einschließlich Anhängen senden
Daten bereitstellen, die zum Verfolgen der Transaktion in Mapp Engage verwendet werden.
Die Transaktionsnachricht senden
Den Nachrichteninhalt übermitteln
Diese Anordnung gilt nur für API 2.0. Einige Systeme mit Standardintegrationen verwenden eine ältere Version der API (zum Beispiel Magento oder Demandware). Diese Integrationen haben unterschiedliche Konfigurationen für Transaktionsnachrichten.
API 1.0 verwendet den SOAP-Aufruf sendParametrizedSingleMessageToUser. Sie können die TMID von einem externen System als einen der Parameter übertragen. In diesem Fall müssen Sie im Bereich Transaktionsnachrichten im Register Versandeinstellungen einen Platzhalter zu den Verteilereinstellungen hinzufügen. Der Platzhalter ist wie folgt aufgebaut: <%parameter.YourParameterName%>.
E) Transaktionsnachrichten verfolgen
Mapp Engage bietet folgende Möglichkeiten zur Verfolgung von Transaktionsnachrichten.
Im Dialog Nachrichtenhistorie können Sie anzeigen, ob ein einzelner Kontakt eine Transaktionsnachricht empfangen und geöffnet hat. Für weitere Informationen siehe Nachrichtenhistorie des Empfängers (Dialog).
Im Bereich Statistik können Sie eine Zusammenfassung der Statistiken für alle Aussendungen der versandfertigen Nachricht ansehen. Für weitere Informationen siehe Single Message Statistics Overview (window).
Exportieren Sie Daten zu Transaktionsnachrichten mit einem Rohdatenexport. Für weitere Informationen siehe Rohdatenexporte. Sie können diese Daten zur weiteren Analyse in Ihr CRM- oder BI-Tool hochladen.
Rufen Sie Daten aus der Mapp Engage-Ergebniswarteschlange ab. Nutzen Sie dazu den API-Aufruf asyncPoll (siehe http://developers.mapp.com/#poll). Ein Mapp-Administrator muss festlegen, wie Rückläuferdaten in die Rückläuferwarteschlange für Ihr Mapp Engage-System eingegeben werden. Diese Option ist für selbstständige Mapp Engage-Systeme nicht standardmäßig aktiviert. Für integrierte CIM/Mapp Engage-Systeme ist diese Option standardmäßig aktiviert.