Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- de:dataexchange:import_which_properties_has_batchprocess [2022/04/27 17:28] – [Anforderungsliste für einen automatischen Import] fw
+++ de:dataexchange:import_which_properties_has_batchprocess [2025/04/02 16:37] (aktuell) – fw
@@ Zeile 72: / Zeile 72: @@
 |**Feldname**|**Feldtyp**|**Standard**|**Beschreibung/Befüllung**|
 |b2b_user_id|int(8)|0|interne Mandanten-ID: [xxxxx]|
-|id|int(9)| |interne Kunden-ID. Wird automatisch durch System befüllt.|
+|id|int(12)| |interne Kunden-ID. Wird automatisch durch System befüllt.|
 |mail|varchar(255)| | |
 |nick|varchar(255)| | |
@@ Zeile 88: / Zeile 88: @@
 |reg_datetime|datetime|0000-00-00 00:00:00|Registrierungszeitpunkt|
 |reg_ip|varchar(255)| |Registrierungs-IP|
-|tsCreated|timestamp|0000-00-00 00:00:00|Timestamp der Erstellung des Datensatzes. Wird automatisch durch System befüllt.|
+|tsCreated|datetime|0000-00-00 00:00:00|Zeitpunkt der Erstellung des Datensatzes. Wird automatisch durch System befüllt.|
 |tsLastUpdate|timestamp|on update CURRENT_TIMESTAMP|Timestamp der letzten Änderung des Datensatzes. Wird automatisch durch System befüllt.|
 |agr|tinyint(3)|0|Werbe-Einverständnis (1=erteilt)|
@@ Zeile 114: / Zeile 114: @@
 |**Feldname**|**Feldtyp**|**Standard**|**Beschreibung/Befüllung**|
 |b2b_user_id|int(8)|0|interne Mandanten-ID: [xxxx]|
-|id|int(9)| |interne Kunden-ID|
+|id|int(12)| |interne Kunden-ID|
 |mail|varchar(255)| | |
 |nick|varchar(255)| | |
@@ Zeile 142: / Zeile 142: @@
 Voraussetzung ist die Konfiguration eines automatischen Import-Prozesses durch den promio.net Support.
-Hierzu werden zwei Dateien in einem ZIP-File bereitgestellt:
+Hierzu werden die zwei Dateien //user.csv// und //action.json// in einem ZIP-File bereitgestellt. \\
+Das ZIP-File muss mit dem vereinbarten Namensschema im SFTP-Ordner /upload/auto für die automatische Verarbeitung bereitgestellt werden.
 ==== user.csv ====
@@ Zeile 154: / Zeile 155: @@
-==== action.xml ====
+==== action.json ====
-Enthält den SOAP-API-Call, der nach dem automatischen Import ausgeführt werden soll.
+Enthält Kampagnen- und Zielgruppeninformationen im JSON-Format. \\
-%CHECKSUM%, %REQUEST_ID% und %TARGETGROUP_ID% müssen genau so im File enthalten bleiben; diese Platzahlter werden nach dem Import automatisch ersetzt.
+Diese werden nach dem automatischen Import für die Ausführung von REST API Calls genutzt.
-Die anderen Werte müssen korrekt ausgefüllt sein.
-Dabei muss insbesondere darauf geachtet werden, dass alle Texte vollständig Html-Entities nutzen.
+=== Maximalausprägung mit allen notwendigen und optionalen Angaben ===
-<code>
+<code JavaScript>
- < => &lt;
+{
- > => &gt;
+ "clientId": 10105,
-etc.
+ "campaign": {
+   "name": "Meine Kampagne",
+   "code": "ABC-123-DEF",
+   "clientId": 12125,
+   "newsletterId": 82384
+ },
+ "message": {
+     "templateId": 2861485,
+     "format": "html",
+     "name": "Mein Creative",
+     "sendFromId": 12944,
+     "sendFromName": "promio.net Newsletter",
+     "locale": "de_DE",
+     "creative": {
+       "content": "<html>\n <head>\n   <title>My first message</title>\n </head>\n <body>\n   <p>Hello World!</p>\n </body>\n</html>\n",
+       "subject": "Meine Betreffzeile"
+     },
+     "text": {
+       "content": "Hello World.\n"
+     }
+ },
+ "targetGroup": {
+   "filter": {
+     "includes": [
+
+     ],
+     "excludes": [
+       {
+         "type": "list",
+         "id": 100898
+       }
+     ]
+   },
+   "limit": {
+     "amount": 50000,
+     "type": "mostActive"
+   }
+ },
+ "delivery": {
+   "schedule": {
+     "scheduledForDeliveryAt": "2025-03-01 12:00"
+   },
+   "start": {
+     "mailsPerHourLimit": 5000,
+     "resetStatistics": true,
+     "refreshAutoTargetGroup": true
+   },
+   "sendTest": {
+     "recipients": [
+       {
+         "custId": "abc-1234",
+         "mail": "max.mustermann@musterdomain.de",
+         "lastName": "Mustermann",
+         "firstName": "Manfred",
+         "gender": 1,
+         "street": "Musterstraße 4",
+         "city": "Musterstadt",
+         "countryCode": "DE",
+         "postcode": "12345",
+         "birthday": "1986-02-12",
+         "phoneNumber": 4912345678
+       }
+     ]
+   }
+ }
+}
 </code>
-<code xml>
+=== Pflichtangaben und Hinweise ===
-<?xml version="1.0" encoding="UTF-8"?>
-<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://api.promio-mail.com/1.4/soap/"
-                   xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
-                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
-    <SOAP-ENV:Body>
-        <ns1:createDelivery>
-            <authentification xsi:type="ns1:authentification">
-                <checksum xsi:type="xsd:string">%CHECKSUM%</checksum>
-                <requestId xsi:type="xsd:string">%REQUEST_ID%</requestId>
-                <requestIdBlockedMinutes xsi:type="xsd:integer">0</requestIdBlockedMinutes>
-            </authentification>
-            <delivery xsi:type="ns1:delivery">
-                <format xsi:type="ns1:contentType">html</format>
-                <clientId xsi:type="xsd:integer">$CLIENTID$</clientId>
-                <deliveryReceiver xsi:type="ns1:deliveryReceiver">
-                    <targetGroupAndSendFromId xsi:type="ns1:targetGroupAndSendFromId">
-                        <targetGroupId xsi:type="xsd:integer">%TARGETGROUP_ID%</targetGroupId>
-                        <sendFromId xsi:type="xsd:integer">$SEND_FROM_ID$</sendFromId>
-                    </targetGroupAndSendFromId>
-                </deliveryReceiver>
-                <deliverySendTime xsi:type="ns1:deliverySendTime">
-                    <sendDelayMinutes xsi:type="xsd:integer">$SEND_DELAY_MINUTES$</sendDelayMinutes>
-                </deliverySendTime>
-                <sendTestMail xsi:type="xsd:boolean">false</sendTestMail>
-                <delivery xsi:type="xsd:boolean">false</delivery>
-                <subject xsi:type="xsd:string">Betreffzeile</subject>
-                <description xsi:type="xsd:string">Testcampaign</description>
-                <campaignCode xsi:type="xsd:string">test</campaignCode>
-                <contentHtml xsi:type="xsd:string">
-                    &lt;h1&gt;Content&lt;/h2&gt;&lt;p&gt; some escaped HTML &lt;/p&gt;
-                </contentHtml>
-                <contentText xsi:type="xsd:string">Content text as text/plain</contentText>
-            </delivery>
-        </ns1:createDelivery>
-    </SOAP-ENV:Body>
-</SOAP-ENV:Envelope>
-</code>
+  * //clientId//:
+    * wird benötigt. ID des Mandanten eintragen.
+  * //campaign//:
+    * Pflichtfeld, Pflichtfeld innerhalb: //name//
+    * Doku: [[https://api.promio-connect.com/docs/3.1/#tag/campaign-write/operation/createCampaign|REST API - create campaign]]
+  * //message//:
+    * Pflichtfeld
+    * wenn //templateId// vorhanden ist
+      * Creative wird aus einem Template gebaut
+      * Pflichtfeld: //name//
+    * wenn //templateId// fehlt
+      * Pflichtfeld: //name//
+      * Doku: [[https://api.promio-connect.com/docs/3.1/#tag/Create-or-update-messages/operation/createMessage|REST API - create message]]
+    * //creative//:
+      * Verpflichtend bei Creatives, die nicht durch ein Template erzeugt werden
+      * Pflichtfelder: //content//, //subject//
+    * //text//:
+      * optional. Nur notwendig bei abweichendem Text-Part. Ohne Angabe von //text// wird der Text-Part automatisch aus dem HTML der Multipart E-Mail erzeugt.
+  * //targetGroup//
+      * optional. Nur notwendig, um //filter// und //limit// einstellen zu können.
+      * Die ZielgruppenId wird automatisch zugewiesen.
+      * Doku: [[https://api.promio-connect.com/docs/3.1/#tag/Target-message-audience/operation/assignTargetGroupToMessage|REST API - assign target group]]
+  * //delivery//
+      * optional. Nur notwendig, wenn der Versand terminiert und gestartet werden soll.
+      * Einstellmöglichkeiten zum Versand
+      * //schedule//
+        * Terminierung des Versands
+        * Pflichtfeld: //scheduledForDeliveryAt//
+        * Doku: [[https://api.promio-connect.com/docs/3.1/#tag/Manage-campaign-delivery/operation/scheduleCampaign|REST API - schedule delivery]]
+      * //start//
+        * nur, wenn //start// gesetzt ist, wird der Versand auch gestartet.
+        * keine Pflichtfelder
+        * Doku: [[https://api.promio-connect.com/docs/3.1/#tag/Manage-campaign-delivery/operation/sendCampaign|REST API - start delivery]]
+      * //sendTest//
+        * optional. Start eines Testversands.
+        * Doku: [[https://api.promio-connect.com/docs/3.1/#tag/Testing-messages/operation/sendTestMail|REST API - send test mail]]
-Dieses ZIP-File muss mit dem vereinbarten Namensschema im SFTP-Ordner /upload/auto für die automatische Verarbeitung bereitgestellt werden.
+**Wichtig:** \\
+Der Quelltext in //creative// und //text// muss für json "vorbereitet sein".
+Auf folgender (externer) Webseite stehen Angaben, wie maskiert werden muss, sowie eine Möglichkeit, Quelltext automatisch maskieren zu lassen: https://www.freeformatter.com/json-escape.html
+=== Beispiele ===
+Beispiel für die Erstellung eines Creatives via HTML-Quellcode (incl. Versandstart):
+<code JavaScript>
+{
+ "clientId": 10105,
+  "campaign": {
+    "name": "Meine Kampagne"
+  },
+  "message": {
+    "format": "html",
+    "name": "Mein Creative",
+    "sendFromId": 12944,
+    "sendFromName": "promio.net Newsletter",
+    "creative": {
+      "content": "<html>\n  <head>\n    <title>My first message</title>\n </head>\n <body>\n   <p>Hello World!</p>\n </body>\n</html>\n",
+      "subject": "Meine Betreffzeile"
+    }
+  },
+  "delivery": {
+    "schedule": {
+      "scheduledForDeliveryAt": "2025-03-01 12:00"
+    },
+    "start": {
+    }
+  }
+}
+</code>
+Beispiel für die Erstellung eines Creatives via Template (ohne Versandstart):
+<code JavaScript>
+{
+ "clientId": 10105,
+  "campaign": {
+    "name": "Meine Kampagne"
+  },
+  "message": {
+    "name": "Mein Creative",
+    "templateId": 2861485
+  }
+}
+</code>
-{{tag>Import Batch Prozess automatisch Satzbeschreibung Spezifikation Nomenklatur}}
+{{tag>Importe Batch automatische_Prozesse Satzbeschreibungen Spezifikationen Nomenklatur }}

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge