/
Push Notifications (OneSignal) für Shopware 6

Push Notifications (OneSignal) für Shopware 6

Please click here for the English documentation.

Vorwort

Wir freuen uns, dass Sie sich für unser Plugin Push Notifications (OneSignal) entschieden haben.

Das Plugin bietet Ihnen die Möglichkeit, Push Notifications basierend auf dem kostenlosen Service von OneSignal in Ihren Shop zu integrieren und dies unabhängig voneinander für jeden Haupt- oder Subshop mit eigenständiger Domain.

Sprachshops mit virtueller URL bieten Push Notifications über die Domain des Hauptshops. Die Spracheinstellung des Shops wird OneSignal als Tag zur Verfügung gestellt, so dass eine Segmentierung der Benutzer nach Spracheinstellung möglich ist. Eine detaillierte Plugin Konfiguration ermöglich es Ihnen, Design und Texte von Anmeldeglocke und Dialogen für jeden Shop explizit anzupassen.

Sollten Sie Vorschläge zur Weiterentwicklung des Plugins haben oder individuelle Anpassungen wünschen, zögern Sie nicht, uns zu kontaktieren. Registrieren Sie sich hierzu unter https://www.synergy-networks.de/konto#show-registration und erstellen ein Ticket für unser Entwicklerteam. Wir setzen uns anschließend umgehend mit Ihnen in Verbindung.

Eine Schritt-für-Schritt-Anleitung, wie Sie ein Ticket bei SYNERGY NETWORKS erstellen können finden Sie in hier https://synergy-networks.atlassian.net/wiki/spaces/DOK/pages/2579431426.

Anleitung

Wie Sie unser Plugin Push Notifications (One Signal) nach Ihren Anforderungen anpassen, zeigen wir Ihnen Schritt für Schritt in dieser Dokumentation.

Inhaltsverzeichnis

1. Systemvoraussetzungen

Bitte beachten Sie, dass die OneSignal Implementierung unseres Plugins die vollständige Unterstützung des HTTPS-Protokolls durch Ihren Shop voraussetzt!

2. Installation und Update

2.1 Plugin testen/ mieten

Sie haben die Möglichkeit, das Plugin vor der Miete ausgiebig zu testen. Wir stellen Ihnen einen Shopware-Demoshop zur Verfügung, um das Plugin im Backend und im Frontend zu testen.

Nach Abschluss der Bestellung der Mietversion im Shopware-Store befinden sich Downloads und Lizenzen in der Lizenz-Verwaltung Ihres Shopware-Accounts.

2.2 Plugin installieren/updaten

Zur Installation des Plugins:

  • öffnen Sie Erweiterungen > Meine Erweiterungen in der Shopware-Administration,

  • installieren bzw. updaten Sie das Plugin,

  • falls nicht bereits geschehen, aktivieren Sie das Plugin.

3. OneSignal Account

Zum Verwalten und Versenden der Push Notifications wird der kostenlose Push Notification Service von OneSignal verwendet. Erstellen Sie dazu bitte unter nachfolgender URL einen Account bei OneSignal: OneSignal Registrierung

3.1 Anmelden

Klicken Sie in der Navigation der Seite auf LOG IN und nutzen Sie eine der im Dialog aufgeführten Optionen zur Erstellung Ihres OneSignal Accounts.

Push Notifications_One Signal Log in.png

3.2 One Signal App

3.2.1 OneSignal App erstellen

Push Notifications_One Signal new App.png

Nach der Anmeldung bei OneSignal wird Ihnen ein Dialogfeld angezeigt, um Sie durch die ersten Schritte der Einrichtung zu führen. Wählen Sie auf der letzten Seite des Dialogs „New App/Website“ (1). 

Push Notifications_One Signal Account1.png

Geben Sie einen Namen (1) für Ihre neue OneSignal App ein. Tragen Sie den Firmennamen (2) ein.

Eine OneSignal App verwaltet Push Notifications für jeweils eine Domain (Dies entspricht einem Haupt- oder Subshop). Idealerweise verwenden Sie hier die Domain des betreffenden Shops, z.B. mein-shop.de.

Wählen Sie die Einstellung „Web" (3) aus.

3.2.2 Web Configuration

Push Notifications_One Signal Account2.png

Wählen Sie hier Custom Code (1) aus. Tragen Sie den Shopnamen (2) ein. Geben Sie die URL (3) des Shops ein, für den Sie die OneSignal App einrichten. Optional kann ein eigenes Benachrichtigungs-Icon per Upload oder URL (4) hinterlegt werden. Speichern (5) Sie Ihre Einstellungen ab.

Hinweis: Bitte beachten Sie bei der Einrichtung, dass wir Ihnen an dieser Stelle dringend empfehlen, Ihre Seite auf https umzustellen, falls dies nicht bereits geschehen ist.

3.2.3 APP-ID und Safari-Web-ID

Push Notifications_One Signal Account3.png

 

Nach dem Speichern öffnet sich eine weitere Seite der Web Configuration. Kopieren Sie (unter dem Punkt Add Code to Site) nun die APP-ID (1) und hinterlegen diese in der Plugin-Konfiguration in Ihrer Shopware-Administration. Kopieren Sie die Safari-Web-ID (2) und hinterlegen diese in der Plugin-Konfiguration in Ihrer Shopware-Administration.

Grundsätzlich können Sie Ihre OneSignal Apps immer über das Side-Menü unter dem Punkt „All Apps" verwalten. Hier lassen sich Apps anlegen, löschen oder bearbeiten.

3.2.4 API-Schlüssel

Push Notifications_One Signal Account4.png

Um den API-Schlüssel zu erstellen, gehen Sie in die Einstellung Settings (1) und wählen die Einstellung Keys & IDs (2) aus.

 

Push Notifications_One Signal Account5.png

Wählen Sie nun die Einstellung Add Key (1).

 

Push Notifications_One Signal Account6.png

Tragen Sie in das Eingabefeld einen Namen (1) ein und erzeugen Sie den API-Schlüssel (2).

 

Push Notifications_One Signal Account7.png

Kopieren Sie den API-Schlüssel (1) und hinterlegen diesen in der Plugin-Konfiguration in Ihrer Shopware-Administration.

4. Konfiguration des Plugins

Die Plugin-Konfiguration in Ihrer Shopware-Administration ist spezifisch für jeden Shop und untergliedert sich in mehrere Abschnitte. Im Folgenden werden die Einstellungen der einzelnen Abschnitte näher erklärt.

4.1 Grundeinstellungen

In den Grundeinstellungen wird die Verbindung zum OneSignal Notification Service konfiguriert. Tragen Sie hier die App ID ein, die Ihnen beim Erstellen der OneSignal App für diese Domain ausgegeben wurde, weiterhin Namen und Kurznamen Ihrer Seite bzw. Ihres Unternehmens. Sie müssen den API-Schlüssel schreiben, um Ihre Anmeldeinformationen zu validieren/überprüfen.

Push Notifications_One Signal_Pluginkonfiguration.png

(1) Tragen Sie hier Ihre APP-ID ein, die Ihnen beim Erstellen der OneSignal App (siehe 2.2.4) für diese Domain ausgegeben wurde.

(2) Tragen Sie hier den Namen Ihres Unternehmens oder Ihrer Seite ein.

(3) Tragen Sie hier den Kurznamen Ihres Unternehmens oder Ihrer Seite ein. 

(4) Tragen Sie hier die Safari-Web-ID ein, die Ihnen beim Erstellen der OneSignal App (siehe 2.2.4) für diese Domain ausgegeben wurde.

(5) Tragen Sie hier den API-Schlüssel ein, die Ihnen beim Erstellen der OneSignal App (siehe 2.2.5) für diese Domain ausgegeben wurde.

(6) Validieren Sie die Anmeldeinformationen.

Hinweis: Bitte beachten Sie, dass bei der Konfiguration eines Sprachshops (Shop mit virtueller URL wie z.B. https://mein-shop.de/en) die Konfiguration der Verbindungsdaten mit dem Hauptshop identisch sein muss!

4.2 Cookie-Einstellungen

 

Hinweis: Zur Anzeige im Frontend müssen die notwendigen Cookies vom Nutzer/ Kunden akzeptiert werden. Nutzen Sie in Ihrem Shop den Standard-Cookie-Hinweises von Shopware: Entweder „Alle Cookies akzeptieren“ oder in der Konfiguration der Cookie-Voreinstellung > Komfortfunktion > One Signal: Push-Benachrichtigung akzeptieren.

Push Notifications_One Signal Komfortfunktion.png

 

Push Notifications_One Signal_Cookie-Einstellungen.png

(1) Auswahl, um innerhalb der Komfortfunktion des Standard-Cookie-Hinweises von Shopware das Auswahlfeld für die Cookie-Einstellungen anzuzeigen oder nicht.

(2) Falls Sie Usercentrics für das Cookie-Management auf Ihrer Website verwenden, aktivieren Sie es bitte.

(3) Bitte geben Sie den Titel des Cookies an, das Sie in Usercentrics für OneSignal erstellt haben.

4.3 Einstellungen

4.3.1 Anmeldeglocke Einstellungen

Push Notifications_One Signal Anmeldeglocke Einstellung.png

Die Einstellungen für die Anmeldeglocke sind selbsterklärend. Die Eingabe der Werte für die Abstände sind in CSS-konformen Größen möglich (px, %, em usw.). Der Abstand links bzw. rechts wird nur beachtet, wenn die Anmeldeglocke auch links bzw. rechts positioniert ist.

4.3.2 Anmeldeglocke Texte

Push Notifications_One Signal Anmeldeglocke Texte.png

Die Texte für die Anmeldeglocke sind bereits mit Standardwerten vorbelegt. Sie können diese Texte Ihren Bedürfnissen entsprechend anpassen und sollten dies für fremdsprachige Subshops auch unbedingt tun. 

4.3.3 Anmeldeglocke Farben

Push Notifications_One Signal Anmeldeglocke Farbe.png

Um die Anmeldeglocke an das Design Ihres Shops anzupassen, können Sie alle relevanten Farbwerte der Anmeldeglocke selbst spezifizieren. Sie können Farben in Form von Hex-Werten, RGB-Angaben oder als String eingeben.

4.3.4 Willkommensnachricht Texte

Push Notifications_One Signal Anmeldeglocke Willkommensnachricht.png

Hier konfigurieren Sie Titel und Nachricht der ersten Push Notification, die der Kunde erhält, nachdem er sich für die Push Notifications angemeldet hat.

4.3.5 Slide Prompt Einstellungen

In dieser Einstellung können Sie die Einwilligungsbenachrichtigung in der Shopansicht konfigurieren.

Push Notifications_One Signal_Slide Prompt Shopansicht.png
Push Notifications_One Signal_Slide Prompt EInstellung.png

(1) Verzögerung der Eingabeaufforderung
Gibt an, ab welchem Seitenaufruf, die Eingabeaufforderung angezeigt/ geladen wird. 

(2) Delay Time
Gibt die Zeit (in Sekunden) an, die vergeht, bis die Eingabeaufforderung eingeblendet wird.

(3) Aktionsnachricht
Tragen Sie hier Ihre Benachrichtigungsmitteilung ein. Im Standard ist Wir möchten Ihnen Benachrichtigungen über die neuesten Nachrichten und Updates anzeigen gesetzt.

(4) Schaltfläche Akzeptieren
Tragen Sie hier den Namen der Schaltfläche ein. Im Standard ist Akzeptieren gesetzt.

(5) Schaltfläche Abrechen
Tragen Sie hier den Namen der Schaltfläche ein. Im Standard ist Abrechen gesetzt.

5. Verfügbare Shopware Tags


Zusätzlich zu den von OneSignal angebotenen allgemeinen Tags, stellt das Plugin weitere Tags zur Verfügung, die Sie im OneSignal Dashboard verwenden können, um Segmente zu
erstellen. Diese Segmente verwenden Tag-Filter, um Benutzergruppen zu definieren, denen sie Push Notifications senden können.

TagsTA

Filterwerte

user_id

  • nicht vorbelegt

user_type

Kürzel der Kundengruppe

salutation

mr, ms

firstname

  • nicht vorbelegt

lastname

  • nicht vorbelegt

realname

Vorname Nachname

birthdate

yyyy-MM-dd (Bsp: 1965-05-02)

gender

mr, ms, company (Rechnungsadresse)

postcode

Postleitzahl der Rechnungsadresse

region

Ort (Rechnungsadresse)

birthyear

yyyy

user_type_firstlogin

yyyyMMdd (Bsp: 20161105)

user_type_lastlogindate

yyyyMMdd

user_type_lastlogintime

hhmmss (Bsp: 163422)

user_type_newsletter

0, 1

user_type_shop

Name des Shops

6. Changelog

Version 3.3.0

Für Safari-Nutzer wurde eine Verbesserung bezüglich des Problems mit dem Abonnieren vorgenommen.

Version 3.2.0

Eine Integration für das Cookie-Management mit Usercentrics wurde implementiert.

Version 3.1.0

Eine Integration für das Cookie-Management mit Usercentrics wurde implementiert.

Version 3.0.0

Kompatibilität mit Shopware 6.6

Version 2.1.0

Aktualisiert gemäß Onesignal v11.0

Version 2.0.0

Kompatibilität mit Shopware 6.5

Version 1.0.7

Kompatibilität mit Shopware 6.4.15.0. Jetzt direkt kompatibel mit minor Updates.

Version 1.0.6

Kompatibilität mit Shopware 6.4.14.0

Version 1.0.5

Kompatibilität mit Shopware 6.4.13.0

Version 1.0.4

Kompatibilität mit Shopware 6.4.12.0

Version 1.0.3

Kompatibilität mit Shopware 6.4.11.1

Version 1.0.2

Neue Konfiguration zum Ändern der Cookie-Gruppe des Plugins entsprechend der Verkaufskanälen hinzugefügt.

Version 1.0.1

Der API-Test-Button ist jetzt mit neuen Versionen kompatibel. Funktion zum Zusammenführen von Cookies überarbeitet.

Version 1.0.0

Initiale Veröffentlichung

Foreword

We are pleased that you have chosen our plugin Push Notifications (OneSignal).

The plugin allows you to integrate push notifications based on the free service from OneSignal into your shop, independently for each main or subshop with its own domain.

Language shops with a virtual URL provide push notifications through the domain of the main shop. The language setting of the shop is provided to OneSignal as a tag, allowing for user segmentation based on language setting. A detailed plugin configuration allows you to explicitly customize the design and texts of the signup bell and dialogs for each shop.

If you have suggestions for the further development of the plugin or wish for individual customizations, please do not hesitate to contact us. To register, please go to https://www.synergy-networks.de/konto#show-registration and create a ticket for our development team. We will then get in touch with you promptly.

A step-by-step guide on how to create a ticket with SYNERGY NETWORKS can be found here https://synergy-networks.atlassian.net/wiki/spaces/DOK/pages/2579431426.

Instructions

We will show you step by step how to customize our plugin Push Notifications (OneSignal) according to your requirements in this documentation.

Table of Contents

1. System Requirements

Please note that the OneSignal implementation of our plugin requires full support of the HTTPS protocol by your shop!

2. Installation and Update

2.1 Testing/Renting the Plugin

You have the option to extensively test the plugin before renting it. We provide you with a Shopware demo shop to test the plugin in the backend and frontend.

After completing the order for the rental version in the Shopware store, downloads and licenses will be available in the license management of your Shopware account.

2.2 Installing/Updating the Plugin

To install the plugin:

  • open Extensions > My Extensions in the Shopware administration,

  • install or update the plugin,

  • if not already done, activate the plugin.

3. OneSignal Account

The free push notification service from OneSignal is used to manage and send push notifications. Please create an account with OneSignal at the following URL: OneSignal Registration

3.1 Logging In

Click on LOG IN in the navigation of the page and use one of the options listed in the dialog to create your OneSignal account.

3.2 OneSignal App

3.2.1 Creating a OneSignal App

After logging in to OneSignal, a dialog box will appear to guide you through the initial setup steps. On the last page of the dialog, select “New App/Website” (1).

Enter a Name (1) for your new OneSignal app. Enter the Company Name (2).

A OneSignal app manages push notifications for each domain (this corresponds to a main or subshop). Ideally, you should use the domain of the respective shop, e.g., mein-shop.de.

Select the setting “Web" (3).

3.2.2 Web Configuration

Here, select Custom Code (1). Enter the Shop Name (2). Provide the URL (3) of the shop for which you are setting up the OneSignal app. Optionally, you can upload or provide a URL for a custom Notification Icon (4). Save (5) your settings.

Note: Please be aware during setup that we strongly recommend switching your site to https if this has not already been done.

3.2.3 APP-ID and Safari Web ID

After saving, another page of the Web Configuration will open. Copy the APP-ID (1) (under the point Add Code to Site) and enter it in the plugin configuration in your Shopware administration. Copy the Safari Web ID (2) and enter it in the plugin configuration in your Shopware administration.

In principle, you can always manage your OneSignal apps via the side menu under the point “All Apps”. Here you can create, delete, or edit apps.

3.2.4 API Key

To create the API key, go to the Settings (1) and select the Keys & IDs (2) setting.

Now select the Add Key (1) setting.

Enter a Name (1) in the input field and generate the API Key (2).

Copy the API Key (1) and enter it in the plugin configuration in your Shopware administration.

4. Plugin Configuration

The plugin configuration in your Shopware administration is specific to each shop and is divided into several sections. The settings of the individual sections are explained in more detail below.

4.1 Basic Settings

In the basic settings, the connection to the OneSignal Notification Service is configured. Enter the App ID that was issued to you when creating the OneSignal app for this domain, as well as the name and short name of your page or company. You must enter the API key to validate/check your credentials.

(1) Enter your APP-ID here, which was issued to you when creating the OneSignal app (see 2.2.4) for this domain.

(2) Enter the name of your company or your page here.

(3) Enter the short name of your company or your page here.

(4) Enter the Safari Web ID that was issued to you when creating the OneSignal app (see 2.2.4) for this domain.

(5) Enter the API key that was issued to you when creating the OneSignal app (see 2.2.5) for this domain.

(6) Validate the credentials.

Note: Please note that when configuring a language shop (shop with a virtual URL like https://mein-shop.de/en), the configuration of the connection data must be identical to that of the main shop!

4.2 Cookie Settings

Note: To display in the frontend, the necessary cookies must be accepted by the user/customer. Use the standard cookie notice from Shopware in your shop: Either "Accept all cookies" or in the configuration of the cookie pre-setting > Comfort function > One Signal: Accept push notifications.

(1) Selection to show or not show the selection field for cookie settings within the comfort function of the standard cookie notice from Shopware.

(2) If you use Usercentrics for cookie management on your website, please enable it.

(3) Please specify the title of the cookie that you have created in Usercentrics for OneSignal.

4.3 Settings

4.3.1 Signup Bell Settings

The settings for the signup bell are self-explanatory. The input of values for the margins is possible in CSS-compliant sizes (px, %, em, etc.). The margin left or right is only considered if the signup bell is also positioned left or right.

4.3.2 Signup Bell Texts

The texts for the signup bell are already pre-filled with standard values. You can customize these texts according to your needs and should definitely do so for foreign language subshops.

4.3.3 Signup Bell Colors

To adapt the signup bell to the design of your shop, you can specify all relevant color values of the signup bell yourself. You can enter colors in the form of hex values, RGB specifications, or as strings.

4.3.4 Welcome Message Texts

Here you configure the title and message of the first push notification that the customer receives after signing up for push notifications.

4.3.5 Slide Prompt Settings

In this setting, you can configure the consent notification in the shop view.

(1) Delay of the prompt
Indicates after which page view the prompt will be displayed/loaded.

(2) Delay Time
Indicates the time (in seconds) that elapses before the prompt is displayed.

(3) Action Message
Enter your notification message here. The default is set to We would like to show you notifications about the latest news and updates.

(4) Accept Button
Enter the name of the button here. The default is set to Accept.

(5) Cancel Button
Enter the name of the button here. The default is set to Cancel.

5. Available Shopware Tags

In addition to the general tags offered by OneSignal, the plugin provides additional tags that you can use in the OneSignal dashboard to create segments. These segments use tag filters to define user groups to which they can send push notifications.

TagsTA

Filter Values

TagsTA

Filter Values

user_id

not pre-filled

user_type

abbreviation of the customer group

salutation

mr, ms

firstname

not pre-filled

lastname

not pre-filled

realname

first name last name

birthdate

yyyy-MM-dd (e.g., 1965-05-02)

gender

mr, ms, company (billing address)

postcode

postal code of the billing address

region

city (billing address)

birthyear

yyyy

user_type_firstlogin

yyyyMMdd (e.g., 20161105)

user_type_lastlogindate

yyyyMMdd

user_type_lastlogintime

hhmmss (e.g., 163422)

user_type_newsletter

0, 1

user_type_shop

name of the shop

6. Changelog

Version 3.3.0

An improvement regarding the subscription issue for Safari users has been made.

Version 3.2.0

An integration for cookie management with Usercentrics has been implemented.

Version 3.1.0

An integration for cookie management with Usercentrics has been implemented.

Version 3.0.0

Compatibility with Shopware 6.6

Version 2.1.0

Updated according to Onesignal v11.0

Version 2.0.0

Compatibility with Shopware 6.5

Version 1.0.7

Compatibility with Shopware 6.4.15.0. Now directly compatible with minor updates.

Version 1.0.6

Compatibility with Shopware 6.4.14.0

Version 1.0.5

Compatibility with Shopware 6.4.13.0

Version 1.0.4

Compatibility with Shopware 6.4.12.0

Version 1.0.3

Compatibility with Shopware 6.4.11.1

Version 1.0.2

New configuration added to change the cookie group of the plugin according to the sales channels.

Version 1.0.1

The API test button is now compatible with new versions. Function for merging cookies revised.

Version 1.0.0

Initial release

Related content