Intelligente Kampagnen
Endpunkt-Referenz für intelligente Kampagnen (Asset)
Referenz zum Kampagnen-Endpunkt (Leads)
Verwenden Sie die REST-APIs für intelligente Kampagnen, um intelligente Kampagnen abzufragen, zu erstellen, zu klonen und zu löschen. Sie können auch Batch-Kampagnen planen, Trigger-Kampagnen anfordern und die Kampagnenaktivierung verwalten.
Abfrage
Abfragen von SmartKampagnen (), nach Name oder durch Browsen.
Nach ID
Der Endpunkt Smart-Kampagne nach ID abrufen nimmt eine einzelne Smart-Kampagnen-id als Pfadparameter und gibt einen einzelnen Smart-Kampagnen-Datensatz zurück.
GET /rest/asset/v1/smartCampaign/{id}.json
{
"success": true,
"errors": [],
"requestId": "7883#169838a32f0",
"warnings": [],
"result": [
{
"id": 1001,
"name": "Process Bounced Emails",
"description": "System smart campaign for processing bounced email events",
"createdAt": "2016-09-10T23:16:19Z+0000",
"updatedAt": "2016-09-10T23:16:19Z+0000",
"status": "Never Run",
"type": "batch",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": false,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 1001,
"flowId": 1001,
"computedUrl": "https://app-sjqe.marketo.com/#SC1001A1"
}
]
}
Der Endpunkt gibt einen Datensatz an der ersten Position des result-Arrays zurück.
Nach Name
Der Endpunkt Smart-Kampagne nach Namen abrufen nimmt eine einzelne Smart-Kampagnen-name als Parameter und gibt einen einzelnen Smart-Kampagnen-Datensatz zurück.
GET /rest/asset/v1/smartCampaign/byName.json?name=Test Trigger Campaign
{
"success": true,
"errors": [],
"requestId": "14494#16c886ffa44",
"warnings": [],
"result": [
{
"id": 1069,
"name": "Test Trigger Campaign",
"description": "",
"createdAt": "2018-02-16T01:34:39Z+0000",
"updatedAt": "2019-08-13T00:45:21Z+0000",
"folder": {
"id": 327,
"type": "Folder"
},
"status": "Inactive",
"type": "trigger",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": false,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 2747,
"flowId": 1088,
"computedUrl": "https://app-sjqe.marketo.com/#SC1069A1"
}
]
}
Der Endpunkt gibt einen Datensatz an der ersten Position des result-Arrays zurück.
Durchsuchen
Der Endpunkt Smart-Kampagnen abrufen unterstützt optionale Abfrageparameter für Filterung und Paginierung.
Die Parameter earliestUpdatedAt und latestUpdatedAt akzeptieren datetimes im ISO-8601-Format (ohne Millisekunden). Wenn beide festgelegt sind, muss „frühestensUpdatedAt“ dem „latestUpdatedAt“ vorangehen.
Der Parameter folder gibt den zu durchsuchenden übergeordneten Ordner an. Übergeben Sie sie als JSON-Objekt, das id und type enthält.
Die maxReturn Ganzzahl gibt die maximale Anzahl von Einträgen an. Der Standardwert ist 20, der Maximalwert 200.
Die offset Ganzzahl gibt an, wo mit dem Abrufen von Einträgen begonnen werden soll. Verwenden Sie es mit maxReturn. Der Standardwert ist 0.
Legen Sie den isActive booleschen Parameter fest, sodass nur aktive Trigger-Kampagnen zurückgegeben werden.
GET /rest/asset/v1/smartCampaigns.json?earliestUpdatedAt=2016-09-10T23:15:00-00:00&latestUpdatedAt=2016-09-10T23:17:00-00:00
{
"success": true,
"errors": [],
"requestId": "626#16983a92965",
"warnings": [],
"result": [
{
"id": 1001,
"name": "Process Bounced Emails",
"description": "System smart campaign for processing bounced email events",
"createdAt": "2016-09-10T23:16:19Z+0000",
"updatedAt": "2016-09-10T23:16:19Z+0000",
"status": "Never Run",
"type": "batch",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": false,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 1001,
"flowId": 1001,
"computedUrl": "https://app-sjqe.marketo.com/#SC1001A1"
},
{
"id": 1002,
"name": "Process Unsubscribes",
"description": "System smart campaign for processing unsubscribe events",
"createdAt": "2016-09-10T23:16:19Z+0000",
"updatedAt": "2016-09-10T23:16:19Z+0000",
"status": "Never Run",
"type": "batch",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": false,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 1002,
"flowId": 1002,
"computedUrl": "https://app-sjqe.marketo.com/#SC1002A1"
}
]
}
Der Endpunkt gibt einen oder mehrere Datensätze im result-Array zurück.
Erstellen
Senden Sie eine application/x-www-form-urlencoded POST-Anfrage an den Endpunkt Smart-Kampagne erstellen. Die Parameter name und folder sind erforderlich. Übergeben Sie folder als JSON-Objekt, das id und type enthält.
Optional können Sie die Smart-Kampagne mit dem description Parameter (maximal 2.000 Zeichen) beschreiben.
POST /rest/asset/v1/smartCampaigns.json
Content-Type: application/x-www-form-urlencoded
name=Smart Campaign 02&folder={"type": "folder","id": 640}&description=This is a smart campaign creation test.
{
"success": true,
"errors": [],
"requestId": "25bc#16c9138f148",
"warnings": [],
"result": [
{
"id": 1076,
"name": "Smart Campaign 02",
"description": "This is a smart campaign creation test.",
"createdAt": "2019-08-14T17:42:04Z+0000",
"updatedAt": "2019-08-14T17:42:04Z+0000",
"folder": {
"id": 640,
"type": "Folder"
},
"status": "Never Run",
"type": "batch",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": true,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 5132,
"flowId": 1095,
"computedUrl": "https://app-sjqe.marketo.com/#SC1076A1"
}
]
}
Update
Senden Sie eine application/x-www-form-urlencoded POST-Anfrage an den Endpunkt Smart-Kampagne aktualisieren. Der Parameter für den Smart-Campaign-id ist erforderlich. Verwenden Sie name, um den Namen zu ändern, oder description, um die Beschreibung zu ändern.
POST /rest/asset/v1/smartCampaign/{id}.json
Content-Type: application/x-www-form-urlencoded
name=Smart Campaign 02 Update&description=This is a smart campaign update test.
{
"success": true,
"errors": [],
"requestId": "14b6a#16c924b992f",
"warnings": [],
"result": [
{
"id": 1076,
"name": "Smart Campaign 02 Update",
"description": "This is a smart campaign update test.",
"createdAt": "2019-08-14T17:42:04Z+0000",
"updatedAt": "2019-08-14T22:42:04Z+0000",
"folder": {
"id": 640,
"type": "Folder"
},
"status": "Never Run",
"type": "batch",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": true,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 5132,
"flowId": 1095,
"computedUrl": "https://app-sjqe.marketo.com/#SC1076A1"
}
]
}
Klonen
Senden Sie eine application/x-www-form-urlencoded POST-Anfrage an den Endpunkt Klonen der SmartKampagne). Die Parameter id, name und folder sind erforderlich. Sie geben die Quellkampagne, den neuen Kampagnennamen und den übergeordneten Ordner an. Übergeben Sie folder als JSON-Objekt, das id und type enthält.
Optional können Sie die Smart-Kampagne mit dem description Parameter (maximal 2.000 Zeichen) beschreiben.
POST /rest/asset/v1/smartCampaign/{id}/clone.json
Content-Type: application/x-www-form-urlencoded
name=Test Trigger Campaign Clone&folder={"type": "folder","id": 640}&description=This is a smart campaign clone test.
{
"success": true,
"errors": [],
"requestId": "681d#16c9339499b",
"warnings": [],
"result": [
{
"id": 1077,
"name": "Test Trigger Campaign Clone",
"description": "This is a smart campaign clone test.",
"createdAt": "2019-08-15T03:01:41Z+0000",
"updatedAt": "2019-08-15T03:01:41Z+0000",
"folder": {
"id": 640,
"type": "Folder"
},
"status": "Inactive",
"type": "trigger",
"isSystem": false,
"isActive": false,
"isRequestable": false,
"isCommunicationLimitEnabled": false,
"recurrence": {
"weekdayOnly": false
},
"qualificationRuleType": "once",
"workspace": "Default",
"smartListId": 5135,
"flowId": 1096,
"computedUrl": "https://app-sjqe.marketo.com/#SC1077A1"
}
]
}
Löschen
Der Endpunkt Smart-Kampagne löschen akzeptiert eine einzelne Smart-Kampagnen-id als Pfadparameter.
POST /rest/asset/v1/smartCampaign/{id}/delete.json
{
"success": true,
"errors": [],
"requestId": "d757#16c934216ac",
"warnings": [],
"result": [
{
"id": 1077
}
]
}
Batch
Batch-Kampagnen werden zu einem bestimmten Zeitpunkt ausgeführt und verarbeiten gemeinsam einen definierten Satz von Leads.
Zeitplan
Verwenden Kampagne planen um eine Batch-Kampagne zu planen. Der Kampagnenparameter id Pfad ist erforderlich. Übergeben Sie die optionalen tokens-, runAt- und cloneToProgram-Parameter im Textkörper der JSON-Anfrage.
Das tokens-Array überschreibt die vorhandenen Programm-My-Token für diese Ausführung. Marketo verwirft die Überschreibungen nach der Ausführung der Kampagne. Jedes Element enthält ein Name/Wert-Paar, und der Token-Name muss das {{my.name}} Format verwenden.
Der runAt Datums-/Uhrzeitparameter gibt an, wann die Kampagne ausgeführt werden soll. Wenn dies ausgelassen wird, wird die Kampagne fünf Minuten nach der Anfrage ausgeführt. Der Wert darf in Zukunft nicht mehr als zwei Jahre betragen.
Über diese API geplante Kampagnen warten immer mindestens fünf Minuten, bevor sie ausgeführt werden.
Der cloneToProgram Zeichenfolgenparameter enthält den Namen eines resultierenden Programms. Wenn dieser Wert festgelegt ist, werden die Kampagne, das übergeordnete Programm und alle zugehörigen Assets mit dem resultierenden neuen Namen erstellt. Das übergeordnete Programm wird geklont und die neu erstellte Kampagne wird geplant. Das resultierende Programm wird unter dem übergeordneten Element erstellt. Programme mit Snippets, Push-Benachrichtigungen, In-App-Nachrichten, statischen Listen, Berichten und Social-Media-Assets können auf diese Weise nicht geklont werden. Bei Verwendung ist dieser Endpunkt auf 20 Aufrufe pro Tag beschränkt. Der Klonprogramm-Endpunkt ist die empfohlene Alternative.
POST /rest/v1/campaigns/{id}/schedule.json
{
"input":
{
"runAt": "2018-03-28T18:05:00+0000",
"tokens": [
{
"name": "{{my.message}}",
"value": "Updated message"
},
{
"name": "{{my.other token}}",
"value": "Value for other token"
}
]
}
}
{
"requestId": "52b#161d90e1743",
"result": [
{
"id": 3713
}
],
"success": true
}
Auslöser
Trigger-Smart-Kampagnen verarbeiten jeweils nur eine Person als Reaktion auf ein Ereignis.
Anfrage
Verwenden Kampagne anfragen um Leads durch den Fluss einer Trigger-Kampagne zu leiten. Die Kampagne muss einen angeforderten Campaign-Trigger mit der Web-Service-API als Quelle verwenden.
Der Pfadparameter der id und ein leads ganzzahliges Array von Lead-IDs sind erforderlich. Jeder Aufruf akzeptiert maximal 100 Leads.
Optional kann der Parameter „Array tokens" verwendet werden, um „Meine Token lokal“ für das übergeordnete Programm der Kampagne zu überschreiben. tokens akzeptiert maximal 100 Token. Jedes tokens Array-Element enthält ein Name/Wert-Paar. Der Name des Tokens muss als “{{my.name}}” formatiert sein. Wenn Sie den Ansatz Hinzufügen eines System-Tokens als Link in einer E-Mail verwenden, um das System-Token „viewAsWebpageLink“ hinzuzufügen, können Sie es nicht mit tokens überschreiben. Verwenden Sie stattdessen Ansatz „Ansicht als Webseitenlink zu E-Mail hinzufügen mit dem Sie „viewAsWebPageLink“ mit tokens überschreiben können.
Übergeben Sie die leads und tokens Parameter im Text der JSON-Anfrage.
POST /rest/v1/campaigns/{id}/trigger.json
{
"input":
{
"leads" : [
{
"id" : 318592
},
{
"id" : 318593
}
],
"tokens" : [
{
"name": "{{my.message}}",
"value": "Updated message"
},
{
"name": "{{my.other token}}",
"value": "Value for other token"
}
]
}
}
{
"requestId": "9e01#161d922f1aa",
"result": [
{
"id": 3712
}
],
"success": true
}
Aktivieren
Der Activate Smart Campaign-Endpunkt ist einfach. Ein id ist erforderlich. Damit die Aktivierung erfolgreich ist, muss für die Kampagne Folgendes zutreffen:
- Die Kampagne ist deaktiviert.
- Die Kampagne weist mindestens einen Trigger und einen Flussschritt auf.
- Die Kampagne verfügt über fehlerfreie Trigger, Filter und Flussschritte.
POST /rest/asset/v1/smartCampaign/{id}/activate.json
{
"success": true,
"errors": [],
"requestId": "a33a#161d9c0dcf3",
"result": [
{
"id": 1069
}
]
}
Deaktivieren
Die Smart-Kampagne deaktivieren ist unkompliziert. Ein id ist erforderlich. Damit die Deaktivierung erfolgreich ist, muss die Kampagne aktiviert werden.
POST /rest/asset/v1/smartCampaign/{id}/deactivate.json
{
"success": true,
"errors": [],
"requestId": "6228#161d9c29fbf",
"result": [
{
"id": 1069
}
]
}