+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Magento 2

< Alle Themen

 

Einleitung

Das Modul synchronisiert Kundendaten, Bestelldaten und Warenkorbinformationen zwischen Magento und Maileon. Magento ist das primäre System, was bedeutet, dass die Kundeninformationen in Magento als die wichtigsten Informationen betrachtet werden und Änderungen an diesen Daten mit Magento synchronisiert werden. Umgekehrt werden nur bestimmte Informationen synchronisiert: die DOI-Bestätigung und die Abbestellung. Für Bestelldetails und Warenkorbabbrüche werden diese Informationen als Transaktionen (Events) an Maileon gesendet und können entweder zur Datenanalyse mittels Kontaktfilter oder zur Aktivierung eines Trigger-Mailings verwendet werden. Alle Funktionen können über ein Konfigurationspanel in Magento eingestellt werden.
 

Benutzung des Plugins

Installation

Der erste Schritt besteht darin, das Maileon-Verzeichnis in das /app/code-Verzeichnis der Magento-Installation zu kopieren. Falls das app-Verzeichnis nicht bereits ein Unterverzeichnis code enthält, legen Sie es bitte an. Danach muss das Modul mit den folgenden Schritten aktiviert werden:

– Prüfen Sie über die Kommandozeile, ob das Modul von Magento erkannt wird. Geben Sie den folgenden Befehl ein:

php bin/magento module:status

Dies sollte zu der folgenden Antwort führen:

List of disabled modules:
Xqueue_Maileon

Dies bedeutet, dass das System das Synchronisationsmodul erkannt hat, es aber noch nicht aktiviert ist.

– Geben Sie den folgenden Befehl ein, um das Modul zu aktivieren:

php bin/magento module:enable Xqueue_Maileon

Wenn dies erfolgreich war, wird die folgende Meldung angezeigt:

The following modules has been enabled: – Xqueue_Maileon

– Danach muss Magento seine Datenbank überprüfen und aktualisieren. Geben Sie den folgenden Befehl ein:

php bin/magento setup:upgrade

Wenn alles gut gegangen ist, können Sie zur Magento-Verwaltungsoberfläche wechseln. Die Plugin-Einstellungen sind im folgenden Menü verfügbar:

Stores -> Configuration -> Maileon

– Ein benutzerdefiniertes Feld zum Kontakt hinzufügen: magento_storeview_id
– Fügen Sie ein benutzerdefiniertes Feld zum Kontakt hinzu: magento_source Kann Newsletter, order_confirmation und abandoned_cart sein
 

Konfiguration in Magento

Die Konfiguration ist unter “Stores” → “Konfiguration” zu finden und kann seit Version 1.8 auch auf Storeview-Ebene eingestellt werden. Das bedeutet, dass Sie für jeden Storeview einen eigenen API-Schlüssel wählen können, um verschiedene Maileon-Accounts zu verwenden oder Sie können verschiedene DOI-Mail-Schlüssel wählen, um DOIs z.B. in verschiedenen Sprachen zu versenden.
 

Abbildung 1: Plugin Settings

General Settings
 

Abbildung 2: General Settings

– Maileon Api Schlüssel: Der API-Schlüssel, der mit dem Maileon-Konto verbunden ist, das Sie verwenden möchten.
– CURL-Debug-Daten drucken: Wenn Sie diese Option aktivieren, werden die Antworten der Maileon-API protokolliert. Nützlich für die Fehlersuche.

Subscriber Settings
 

Abbildung 3: Subscriber Settings

– Aktiv: Dies aktiviert das Newsletter-Abonnentenmodul. Dieses Modul synchronisiert neue Abonnements mit Maileon.
– Erlaubnis: Die Berechtigungsstufe, die für neue Maileon-Abonnenten festgelegt werden soll.
o Keine: Keine Berechtigung. Dies ist höchstwahrscheinlich erforderlich, z.B. in Deutschland.
o Single Opt-in: Die Zustimmung wird nur einmal erteilt, z.B. durch Eingabe der E-Mail-Adresse im Anmeldeformular. Dies garantiert nicht, dass der Abonnent tatsächlich mit dem Inhaber des E-Mail-Kontos identisch ist.
o Confirmed Opt-in: Eine Bestätigungsmail über die Anmeldung wird an die angegebene E-Mail-Adresse geschickt, enthält aber keinen Bestätigungslink. Diese Methode wird häufig von Spammern missbraucht. Der Empfänger muss seine Zustimmung aktiv widerrufen, um keine Werbe-E-Mails zu erhalten. Diese Methode ist in Deutschland nicht wirklich legal und sollte nicht verwendet werden.
o Double Opt-in: Setzen Sie Double-Opt-in in Maileon, z.B. wenn eine solche Erlaubnis bereits extern eingeholt wurde.
o Double Opt-in Plus: Double-opt-in inklusive Zustimmung zum Single-User-Tracking.
o DOI-Prozess: Eine Bestätigungs-E-Mail mit einem “Bestätigungslink” wird an die angegebene E-Mail-Adresse gesendet. Erst wenn der Empfänger diesen Link anklickt, wird das Abonnement gültig. So wird sichergestellt, dass der Empfänger mit dem Inhaber der Mailbox identisch ist und wirklich Ihre Mailings erhalten möchte (der Empfänger kann den Bestätigungslink nicht anklicken, ohne sich in seiner Mailbox angemeldet zu haben). Double Opt-in ist die einzige Abonnementmethode, die wir empfehlen können. Bitte beachten Sie, dass XQ nur allgemeine Informationen, aber keine offizielle Rechtsberatung anbieten kann. Bitte wenden Sie sich bei rechtlichen Fragen zu diesem Thema an Ihren Anwalt.
– DOI+ Prozess: Erfordert die Option “DOI-Prozess”. Eine DOI+-Genehmigung wird registriert, nachdem der Nutzer auf den DOI-Bestätigungslink in der DOI-Mail geklickt hat.
Bitte beachten Sie: Nur wenn Ihre Kontakte dem Single User Tracking zugestimmt haben, können Sie aussagekräftige Response-Analysen erhalten und entsprechend reagieren. Da nur das Double-Opt-In-Verfahren rechtssicher ist (für Anbieter mit Sitz in Deutschland), können wir Ihnen nur die Erlaubnismethode “Double-Opt-In mit Zustimmung zum Single-User-Tracking” empfehlen.
– Doi Mailing ID: Wenn die obige Berechtigung auf DOI oder DOI-Plus gesetzt ist, wird dem Newsletter-Abonnenten ein Bestätigungsmailing über Maileon zugesandt. In diesem Feld kann eingestellt werden, welches DOI-Mailing von Maileon verschickt werden soll. Wenn Sie das Feld leer lassen, wird die Standard-DOI-Bestätigung verschickt. (Ein Standard DOI Bestätigungsmailing muss in Maileon eingestellt sein, damit dies funktioniert).
– Abmelde-Haken-Token: Dieses Token wird verwendet, um Maileon-Abonnenten zurück zu Magento zu synchronisieren. Dieses Feld muss eine eindeutige Zeichenfolge sein. (Denken Sie an ein Passwort.) Die Einrichtung des Hooks wird später detailliert beschrieben.
– Doi Hook Token: Dieses Token wird verwendet, um Maileon DOI-Bestätigungen zurück zu Magento zu synchronisieren. Wenn es gesetzt ist, wird der Magento-Abonnentenstatus mit dem Maileon-Abonnentenstatus jedes Kunden übereinstimmen. Dieses Feld muss eine eindeutige Zeichenfolge sein. (Denken Sie an ein Passwort.) Das Hook-Setup wird später detailliert beschrieben.
– Bei storeview sollten alle E-Mails abbestellt werden: Seit Magento 2.4 kann eine E-Mail mehrfach bei Magento registriert werden (einmal pro Storeview). Wenn Maileon die Abmeldungen an Magento zurückmeldet, wird die Storeview-ID mitgegeben, aber wenn diese Daten gelöscht werden oder nicht in der Webhook-Konfiguration eingetragen sind, weiß Magento nicht, aus welcher Storeview der Kontakt abgemeldet werden soll. Diese Option ermöglicht es, alle Kontakte mit einer bestimmten E-Mail-Adresse (aus allen Storeviews) abzumelden, wenn dies nicht eindeutig ist oder wenn dies erforderlich ist (z.B. aus gesetzlichen Gründen).
– Bestätigungsanforderung per E-Mail deaktivieren: Wird verwendet, um die in Magento DOI integrierte Bestätigungs-E-Mail zu deaktivieren.
– Erfolgs-E-Mail deaktivieren: Wird verwendet, um die eingebaute Magento DOI-Erfolgs-E-Mail zu deaktivieren.
– E-Mail zur Abmeldung deaktivieren: Wird verwendet, um die in Magento integrierte E-Mail zur Abmeldung zu deaktivieren.

Order Settings
 

Abbildung 4: Order Confirmation Mail Settings

– Aktiv: Dies aktiviert das Modul für die Bestellbestätigung. Dieses Modul synchronisiert Bestellungsereignisse mit Maileon. Jede Bestellung erzeugt zwei Arten von Transaktionen: magento_orders und magento_orders_extended. Die Transaktion magento_orders enthält ein Ereignis für jede Bestellung. Die Transaktion magento_orders_extended enthält ein Ereignis pro Position in der Bestellung. Diese Ereignisse haben die folgenden Eigenschaften:
 

Abbildung 5: Maileon Order-Confirmation-Transactiontype
 

Abbildung 6: Extended Maileon Order-Confirmation-Transactiontype

– Fallback-Erlaubnis: Maileon legt für jede Transaktion einen Kontakt an, um später z.B. den Zugang zu Online-Versionen des Newsletters zu ermöglichen. Oft gibt es die Möglichkeit, den Newsletter während eines Bestellvorgangs zu abonnieren. Wenn in diesem Fall DOI oder DOI+ als Newsletter-Berechtigung ausgewählt wird, erhält der Kunde auch eine DOI-Mail. Wenn der Nutzer keine Mail abrufen möchte, besteht auch die Möglichkeit, diesen Kontakten eine bestimmte Berechtigung, z.B. SOI, zu erteilen, so dass sie Mails mit Inhalten von besonderem Interesse erhalten, da sie echte Kunden mit geschäftlichem Interesse sind.

Abandoned Cart Settings
 

Abbildung 7: Shopping Cart Abandonnment Mail Settings

– Aktiv: Aktiviert das Modul für den Abbruch von Einkaufswagen. Dieses Modul synchronisiert die Ereignisse für abgebrochene Warenkörbe mit Maileon.
– Fallback-Berechtigung: Die Berechtigung, die ein Kontakt erhält, wenn er zu Maileon hinzugefügt wird. In den meisten Fällen sollte dies auf none gesetzt werden.
– # Of Hours Before Sending Reminder: Dies ist die Anzahl der Stunden, nachdem ein offener Warenkorb als verlassen gilt.
– Schatten-E-Mail: Diese E-Mail-Adresse erhält ebenfalls eine Kopie der E-Mail zum Verlassen des Warenkorbs.
– E-Mail überschreiben: Wenn dieses Feld aktiviert ist, erhalten Kunden keine E-Mails zum Verlassen des Warenkorbs. Stattdessen werden sie an diese Adresse gesendet.

 

Abbildung 8: Transactiontype for Cart Abandonnments

 

Benutzerdefinierte Formulare konfigurieren

Um andere Standard- oder benutzerdefinierte Daten an Maileon zu übermitteln, muss das folgende Schema verwendet werden:
– Standardfelder: Die Standardfelder müssen das Präfix standard_ verwenden, gefolgt von der genauen Bezeichnung und dem korrekten Format, das auf http://dev.maileon.com/api/rest-api-1-0/contacts/standard-contact-fields/ dokumentiert ist. Beispiel: standard_FIRSTNAME
– Benutzerdefinierte Felder: Wenn benutzerdefinierte Felder übermittelt werden sollen, müssen sie das Präfix custom_ haben. Die Kapizalisierung muss genau wie in Maileon angegeben respektiert werden.
Beispiel: custom_MySpecialField

 

Verbesserung der Transaktionsdaten

In einigen Fällen ist es erforderlich, benutzerdefinierte Datentransaktionen hinzuzufügen. Wenn Sie z.B. ein Plugin verwenden, das es erlaubt, Produkte mit Namen, eigenen Bildern usw. zu versehen, und das Bild in der Bestellbestätigungsmail angezeigt werden soll, müssen Sie diese URL an Maileon übergeben. In diesem Fall bietet das Plugin eine einfache Möglichkeit, Daten zu den Transaktionen hinzuzufügen, indem die Klasse “Maileon\SyncPlugin\Helper\External\Data” von einem externen Plugin überschrieben wird.
Um die Entwicklung zu erleichtern, stellen wir ein Test-Plugin zur Verfügung, das ein minimalistisches Setup zeigt. In di.xml wird die Klasse mit einer eigenen Implementierung überschrieben:

Bei der Untersuchung der Klasse “Maileon\TestPlugin\Helper\External\Data”, die vom Testpaket bereitgestellt wird und auch frei benannt werden kann, gibt es verschiedene Methoden, die verwendet werden können.

1. Diese Methode fügt Attribute zu einem einzelnen Produkt innerhalb einer Bestellung hinzu. Basierend auf dem Produkt kann z.B. eine URL eines benutzerdefinierten Bildes abgerufen und in dem Array zurückgegeben werden: getCustomProductAttributes($product)
2. Diese Methode fügt direkt Attribute zu einer Bestellung hinzu. Da wir direkt mit einer Transaktion arbeiten, stellen Sie sicher, dass Sie als Schlüssel einen der gültigen Schlüssel aus der Definition des Transaktionstyps verwenden:
getCustomOrderTransactionAttributes($transaction_content)
3. Diese Methode fügt direkt Attribute zu Einzelposten-Transaktionen hinzu. Da wir direkt mit einer Transaktion arbeiten, stellen Sie sicher, dass Sie als Schlüssel einen der gültigen Schlüssel aus der Definition der Transaktionsart verwenden:
getCustomOrderExtendedTransactionAttributes($transaction_ext_content)
4. Diese Methode fügt Attribute zu einem einzelnen Produkt innerhalb einer Kartenabbruchtransaktion hinzu. Basierend auf dem Produkt kann z.B. eine URL eines benutzerdefinierten Bildes abgerufen und in dem Array zurückgegeben werden:
getCustomAbandonedCartProductAttributes($product)
5. Diese Methode fügt direkt Attribute zu einer Warenkorbabbruchtransaktion hinzu. Da wir direkt mit einer Transaktion arbeiten, stellen Sie sicher, dass Sie als Schlüssel einen der gültigen Schlüssel verwenden, die in der Definition des Transaktionstyps angegeben sind:
getCustomAbandonedCartTransactionAttributes($transaction_content)

Die Daten können z.B. hinzugefügt werden, indem sie in eines der freien generischen Stringfelder geschrieben werden:
$result[‘generic.string_1’] = “dies ist eine zusätzliche Information”;
Dieser Wert kann dann in einem Mailing verwendet werden, um ihn zu drucken, als Link oder als Bild-URL zu verwenden.
Die Installation des Plugins erfolgt wie erwartet über den Composer. Der erste Schritt ist das Kopieren des “Maileon”-Verzeichnisses des Test-Plugins in das /app/code-Verzeichnis der Magento-Installation. Falls das app-Verzeichnis nicht bereits ein Unterverzeichnis code enthält, legen Sie dieses bitte an. Danach muss das Modul mit den folgenden Schritten aktiviert werden:

– Prüfen Sie über die Kommandozeile, ob das Modul von Magento erkannt wird. Geben Sie den folgenden Befehl ein:

php bin/magento module:status

Dies sollte zu der folgenden Antwort führen:

List of disabled modules:
Maileon_TestPlugin

Dies bedeutet, dass das System das Synchronisationsmodul erkannt hat, es aber noch nicht aktiviert ist.

– Geben Sie den folgenden Befehl ein, um das Modul zu aktivieren:

php bin/magento module:enable Maileon_TestPlugin

Wenn dies erfolgreich war, wird die folgende Meldung angezeigt:

The following modules has been enabled:
– Malieon_TestPlugin

Danach muss Magento seine Datenbank überprüfen und aktualisieren. Geben Sie den folgenden Befehl ein:

php bin/magento setup:upgrade

Wenn alles wie erwartet installiert wurde, sollten beim nächsten Mal, wenn z. B. eine Bestellung ausgelöst wird, einige zusätzliche Daten angehängt werden.

 

Abbildung 9: Additional information attached to a transaction

 

Webhook-Einstellungen in Maileon

Geänderte Parameter in Version 1.8: Seit Magento 2.4 kann für jede Storeview eine E-Mail als Newsletter-Abonnent hinzugefügt werden, so dass die E-Mail mehrfach im Magento-Newsletter-Modul vorhanden sein kann. Ab Version 1.8 des Plugins erfolgt die Konfiguration auf Storeview-Ebene, d.h. eine E-Mail kann je nach Herkunft zu verschiedenen Maileon-Newsletter-Konten hinzugefügt werden. Wenn Maileon also eine DOI-Bestätigung oder eine Abmeldung zurückmeldet, muss es den richtigen Storeview für einen bestimmten Kontakt identifizieren. Dies geschieht durch Hinzufügen eines neuen Parameters “storeview_id”.

Abmelde-Webhook-Einrichtung

Der Abmelde-Webhook wird verwendet, um Maileon-Abonnenten zurück zu Magento zu synchronisieren. Um diesen in Maileon einzurichten, müssen Sie zu Einstellungen/Webhooks navigieren. Klicken Sie in diesem Bereich auf Neuen Webhook erstellen. Wählen Sie Abmeldung aus dem Ereignis-Dropdown. Geben Sie für die HTTP-Post-URL Folgendes ein (ersetzen Sie dabei Ihre eigene Domain):

http:///maileon_webhook
z.B.: http://maileonmagento.com/maileon_webhook

Fügen Sie die folgenden URL-Parameter hinzu:
email -> Wert des Kontaktfeldes -> E-Mail Adresse
token -> benutzerdefinierter Wert ->
storeview_id -> Wert des Kontaktfeldes -> magento_storeview_id

Das Token muss mit dem Wert übereinstimmen, der in den Magento-Einstellungen für das Unsubscribe Hook Token angegeben ist.
 

Abbildung 10: Webhook Settings for Unsubscriptions

Bitte beachten Sie: Um nun das Kontaktfeld “magento_storeview_id” im Falle einer Abmeldung zu anonymisieren, ist es erforderlich, Maileon entsprechend zu konfigurieren.

DOI-Bestätigungs-Webhook einrichten
Der DOI-Bestätigungs-Webhook wird verwendet, um DOI-Bestätigungen von Maileon zurück zu Magento zu synchronisieren. Um dies in Maileon einzurichten, müssen Sie zu Einstellungen/Webhooks navigieren. In diesem Panel klicken Sie auf Create new webhook. Wählen Sie DOI Confirmation aus dem Event-Dropdown. Geben Sie für die HTTP-Post-URL Folgendes ein (ersetzen Sie dabei Ihre eigene Domain):

http:///maileon_webhook
z. B.: http://maileonmagento.com/maileon_webhook

Fügen Sie die folgenden URL-Parameter hinzu:
email -> Wert des Kontaktfeldes -> E-Mail Adresse
token -> benutzerdefinierter Wert ->
doi -> benutzerdefinierter Wert -> 1
Das Token muss mit dem Wert übereinstimmen, der in den Magento-Einstellungen für das DOI-Haken-Token angegeben ist.
 

Abbildung 11: Webhook Settings for DOI-Confirmations

Inhaltsverzeichnis

Bleiben Sie Up-to-Date und profitieren Sie von spannenden News und Aktionen.

Maileon ist ein Produkt der XQueue GmbH