Campañas inteligentes
Referencia de extremo de campañas inteligentes (recurso)
Referencia de extremo de campañas (posibles clientes)
Marketo ofrece un conjunto de API de REST para realizar operaciones en campañas inteligentes. Estas API siguen el patrón de interfaz estándar para las API de recursos que proporcionan opciones de consulta, creación, clonación y eliminación. Además, puede administrar la ejecución de campañas inteligentes programando campañas por lotes o solicitando campañas de déclencheur.
Consulta
La consulta de campañas inteligentes sigue los tipos de consulta estándar para los recursos de por id, por nombre y exploración.
Por ID
El extremo Get Smart Campaign by ID toma una sola campaña inteligente id como parámetro de ruta y devuelve un único registro de campaña inteligente.
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"
}
]
}
Con este extremo, siempre habrá un único registro en la primera posición de la matriz result.
Por nombre
El extremo Get Smart Campaign by Name toma una sola campaña inteligente name como parámetro y devuelve un único registro de campaña inteligente.
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"
}
]
}
Con este extremo, siempre habrá un único registro en la primera posición de la matriz result.
Examinar
El extremo Get Smart Campaigns funciona como otros extremos de exploración de Asset API y permite que varios parámetros de consulta opcionales especifiquen criterios de filtrado.
Los parámetros earliestUpdatedAt y latestUpdatedAt aceptan datetimes en formato ISO-8601 (sin milisegundos). Si se establecen ambos, firstUpdatedAt debe preceder a latestUpdatedAt.
El parámetro folder especifica la carpeta principal bajo la que examinar. El formato es un bloque JSON que contiene los atributos id y type.
El parámetro maxReturn es un entero que especifica el número máximo de entradas que se van a devolver. El valor predeterminado es 20. El máximo es 200.
El parámetro offset es un entero que especifica dónde comenzar a recuperar entradas. Se puede usar junto con maxReturn. El valor predeterminado es 0.
El parámetro isActive es un booleano que especifica que se devuelvan solamente las campañas de Déclencheur activas.
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"
}
]
}
Con este extremo, habrá uno o más registros en la matriz result.
Crear
El extremo Create Smart Campaign se ejecuta con un POST application/x-www-form-urlencoded con dos parámetros obligatorios. El parámetro name especifica el nombre de la campaña inteligente que se creará. El parámetro folder especifica la carpeta principal en la que se crea la campaña inteligente. El formato es un bloque JSON que contiene los atributos id y type.
Opcionalmente, puede describir la campaña inteligente utilizando el parámetro description (máximo 2000 caracteres).
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"
}
]
}
Actualización
El extremo Update Smart Campaign se ejecuta con un POST application/x-www-form-urlencoded. Toma una sola campaña inteligente id como parámetro de ruta. Puede usar el parámetro name para actualizar el nombre de la campaña inteligente, o el parámetro description para actualizar la descripción de la campaña inteligente.
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"
}
]
}
Clonar
El extremo Clone Smart Campaign se ejecuta con un POST application/x-www-form-urlencoded con tres parámetros obligatorios. Se necesita un parámetro id que especifica la campaña inteligente que se va a clonar, un parámetro name que especifica el nombre de la nueva campaña inteligente y un parámetro folder para especificar la carpeta principal en la que se crea la nueva campaña inteligente. El formato es un bloque JSON que contiene los atributos id y type.
Opcionalmente, puede describir la campaña inteligente utilizando el parámetro description (máximo 2000 caracteres).
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"
}
]
}
Eliminar
El extremo Delete Smart Campaign toma una sola campaña inteligente id como parámetro de ruta.
POST /rest/asset/v1/smartCampaign/{id}/delete.json
{
"success": true,
"errors": [],
"requestId": "d757#16c934216ac",
"warnings": [],
"result": [
{
"id": 1077
}
]
}
Lote
Las campañas inteligentes por lotes se inician en un momento específico y afectan a un conjunto específico de posibles clientes a la vez.
Programación
Use el extremo Programar campaña para programar una campaña por lotes para que se ejecute de inmediato o en una fecha futura. La campaña id es un parámetro de ruta de acceso obligatorio. Los parámetros opcionales son tokens, runAt y cloneToProgram, que se pasan en el cuerpo de la solicitud como application/json.
El parámetro de matriz de tokens es una matriz de Mis tokens que anula los tokens de programa existentes. Después de ejecutar la campaña, los tokens se descartan. Cada elemento de matriz de token contiene pares de nombre/valor. El nombre del token debe tener el formato "{{my.name}}".
El parámetro runAt de fecha y hora especifica cuándo ejecutar la campaña. Si no se especifica, la campaña se ejecutará 5 minutos después de llamar al extremo. El valor datetime no puede ser superior a dos años en el futuro.
Las campañas programadas a través de esta API siempre esperan un mínimo de cinco minutos antes de ejecutarse.
El parámetro de cadena cloneToProgram contiene el nombre de un programa resultante. Cuando se configura, esto hace que la campaña, el programa principal y todos sus recursos se creen con el nuevo nombre resultante. El programa principal se clona y la campaña recién creada se programa. El programa resultante se crea debajo del elemento principal. Los programas con fragmentos, notificaciones push, mensajes en la aplicación, listas estáticas, informes y recursos sociales no se pueden clonar de esta manera. Cuando se utiliza, este punto de conexión está limitado a 20 llamadas al día. El extremo clone program es la alternativa recomendada.
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
}
Desencadenante
Las campañas inteligentes de déclencheur afectan a una persona a la vez en función de un evento activado.
Solicitud
Use el extremo Request Campaign para pasar un conjunto de posibles clientes a una campaña de déclencheur para que se ejecute en el flujo de la campaña. La campaña debe tener un déclencheur "Campaña solicitada" con "API de servicio web" como origen.
Este extremo requiere una campaña id como parámetro de ruta de acceso y un parámetro de matriz de enteros leads que contenga identificadores de posibles clientes Se permite un máximo de 100 posibles clientes por llamada.
Opcionalmente, el parámetro de matriz tokens se puede usar para anular Mis tokens locales del programa principal de la campaña. tokens acepta un máximo de 100 token. Cada elemento de matriz tokens contiene un par nombre/valor. El nombre del token debe tener el formato "{{my.name}}". Si usas Agregar un token de sistema como un enlace en un correo electrónico para agregar el token de sistema "viewAsWebpageLink", no puedes anularlo usando tokens. En su lugar, use Agregar una vista como vínculo de página web a un correo electrónico, lo que le permite invalidar "viewAsWebPageLink" mediante tokens.
Los parámetros leads y tokens se pasan en el cuerpo de la solicitud como application/json.
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
}
Activar
El punto de conexión Activar campaña inteligente es sencillo. Se requiere un parámetro de ruta de acceso id. Para que la activación se realice correctamente, debe cumplirse lo siguiente en la campaña:
- Se debe desactivar
- Debe tener al menos un déclencheur y un paso de flujo
- Debe tener déclencheur, filtros y pasos de flujo libres de errores
POST /rest/asset/v1/smartCampaign/{id}/activate.json
{
"success": true,
"errors": [],
"requestId": "a33a#161d9c0dcf3",
"result": [
{
"id": 1069
}
]
}
Desactivar
Desactivar campaña inteligente es sencillo. Se requiere un parámetro de ruta de acceso id. Para que la desactivación se realice correctamente, debe activarse la campaña.
POST /rest/asset/v1/smartCampaign/{id}/deactivate.json
{
"success": true,
"errors": [],
"requestId": "6228#161d9c29fbf",
"result": [
{
"id": 1069
}
]
}