Listes intelligentes
Référence des points d’entrée des listes dynamiques
Marketo propose un ensemble d’API REST pour effectuer des opérations sur des listes intelligentes. Ces API suivent le modèle d’interface standard des API de ressources en fournissant des options de requête, de suppression et de clonage.
Remarque : ces API sont uniquement prises en charge pour les listes dynamiques créées par l’utilisateur. Ils ne peuvent pas être utilisés pour les listes dynamiques intégrées/système.
Requête
L’interrogation de listes dynamiques suit les types de requête standard pour les ressources de par id, par nom et parcourir.
Par Id
Requête par ID prend un seul id de liste dynamique comme paramètre de chemin d’accès et renvoie un seul enregistrement de liste dynamique. Vous pouvez éventuellement transmettre le paramètre booléen includeRules pour inclure des règles de liste dynamique dans la réponse.
GET /rest/asset/v1/smartList/{id}.json?includeRules=true
{
"success": true,
"errors": [],
"requestId": "6efc#16c8967a21f",
"warnings": [],
"result": [
{
"id": 4363,
"name": "Smart List Test 01",
"createdAt": "2019-06-03T23:01:13Z+0000",
"updatedAt": "2019-06-04T17:37:45Z+0000",
"url": "https://app-sjqe.marketo.com/#SL4363A1LA1",
"folder": {
"id": 1041,
"type": "Program"
},
"workspace": "Default",
"rules": {
"filterMatchType": "all",
"triggers": [],
"filters": [
{
"id": 459,
"name": "Visited Web Page",
"ruleTypeId": 1,
"ruleType": "Activity",
"operator": "occurs",
"conditions": [
{
"activityAttributeId": 1,
"activityAttributeName": "Web Page",
"operator": "is",
"values": [
"Program Test.Landing Page Test 01"
],
"isPrimary": true
},
{
"activityAttributeId": 6,
"activityAttributeName": "Browser",
"operator": "is",
"values": [
"Chrome"
],
"isPrimary": false
},
{
"activityAttributeId": -101,
"activityAttributeName": "Date of Activity",
"operator": "in past",
"values": [
"30 days"
],
"isPrimary": false
}
]
}
]
}
}
]
}
Par Identifiant De Campagne Dynamique
Requête par identifiant de campagne intelligente utilise un seul id de campagne intelligente comme paramètre de chemin d’accès et renvoie un seul enregistrement de liste dynamique. Vous pouvez éventuellement transmettre le paramètre booléen includeRules pour inclure des règles de liste dynamique dans la réponse.
GET /rest/asset/v1/smartCampaign/{smartCampaignId}/smartList.json
{
"success": true,
"errors": [],
"requestId": "6efc#16c8967a21f",
"warnings": [],
"result": [
{
"id": 4363,
"name": "Smart List Test 01",
"createdAt": "2019-06-03T23:01:13Z+0000",
"updatedAt": "2019-06-04T17:37:45Z+0000",
"url": "https://app-sjqe.marketo.com/#SL4363A1LA1",
"folder": {
"id": 1041,
"type": "Program"
},
"workspace": "Default"
}
]
}
Par ID de programme
Requête par ID de programme prend un seul id de programme d’e-mail comme paramètre de chemin d’accès et renvoie un seul enregistrement de liste dynamique. Vous pouvez éventuellement transmettre le paramètre booléen includeRules pour inclure des règles de liste dynamique dans la réponse.
GET /rest/asset/v1/program/{programId}/smartList.json
{
"success": true,
"errors": [],
"requestId": "6efc#16c8967a21f",
"warnings": [],
"result": [
{
"id": 4363,
"name": "Smart List Test 01",
"createdAt": "2019-06-03T23:01:13Z+0000",
"updatedAt": "2019-06-04T17:37:45Z+0000",
"url": "https://app-sjqe.marketo.com/#SL4363A1LA1",
"folder": {
"id": 1041,
"type": "Program"
},
"workspace": "Default"
}
]
}
Par nom
Requête par nom prend un name de liste dynamique en tant que paramètre et renvoie un seul enregistrement de liste dynamique. Une correspondance de chaîne exacte est effectuée par rapport à tous les noms de liste dynamique dans l’instance et renvoie un résultat pour la liste dynamique correspondant à ce nom.
GET /rest/asset/v1/smartList/byName.json?name=2018 Leads
{
"success": true,
"errors": [],
"requestId": "115d7#16423bc13b4",
"result": [
{
"id": 283988,
"name": "2018 Leads",
"createdAt": "2008-10-07T15:20:39Z+0000",
"updatedAt": "2010-04-13T15:34:32Z+0000",
"url": "https://app-abm.marketo.com/#SL283988A1",
"folder": {
"id": 31,
"type": "Folder"
},
"workspace": "Default"
}
]
}
Parcourir
Les listes dynamiques peuvent également être récupérées par lots. Le paramètre folder est utilisé pour spécifier le dossier parent sous lequel la requête est exécutée. Il est formaté en tant qu’objet JSON contenant id et type. Comme les autres points d’entrée de récupération de ressources en bloc, offset et maxReturn sont des paramètres facultatifs qui peuvent être utilisés pour la pagination. Les paramètres de date et d’heure facultatifs earliestUpdatedAt et latestUpdatedAt peuvent être utilisés pour filtrer les résultats par période UpdatedAt.
GET /rest/asset/v1/smartLists.json?folder={"id":31,"type":"Folder"}
{
"success": true,
"errors": [],
"requestId": "9aa4#16423c0e969",
"result": [
{
"id": 283988,
"name": "2018 Leads",
"createdAt": "2008-10-07T15:20:39Z+0000",
"updatedAt": "2010-04-13T15:34:32Z+0000",
"url": "https://app-abm.marketo.com/#SL283988A1",
"folder": {
"id": 31,
"type": "Folder"
},
"workspace": "Default"
},
{
"id": 299697,
"name": "Active Prospects",
"createdAt": "2008-10-17T02:09:49Z+0000",
"updatedAt": "2010-03-27T18:27:46Z+0000",
"url": "https://app-abm.marketo.com/#SL299697A1",
"folder": {
"id": 31,
"type": "Folder"
},
"workspace": "Default"
},
{
"id": 400517,
"name": "Leads by Score",
"createdAt": "2009-01-07T18:52:52Z+0000",
"updatedAt": "2010-04-13T15:36:09Z+0000",
"url": "https://app-abm.marketo.com/#SL400517A1",
"folder": {
"id": 31,
"type": "Folder"
},
"workspace": "Default"
}
]
}
Cloner
Le clonage d’une liste dynamique est exécuté avec une requête POST d’application/x-www-form-urlencoded. La liste dynamique à cloner est spécifiée dans le paramètre de chemin d’accès id. Le paramètre folder est utilisé pour spécifier le dossier parent sous lequel la liste dynamique sera créée et est formaté comme un objet JSON contenant l’ID et le type. Le dossier parent doit être un dossier de programme ou de liste dynamique. Le paramètre name est utilisé pour nommer la nouvelle liste dynamique et doit être unique. Le paramètre description peut éventuellement être utilisé pour décrire la liste dynamique.
POST /rest/asset/v1/smartList/{id}/clone.json
Content-Type: application/x-www-form-urlencoded
folder={"id":31,"type":"Folder"}&name=2018 Leads Qualified
{
"success": true,
"errors": [],
"requestId": "a672#16423d755ed",
"result": [
{
"id": 788645,
"name": "2018 Leads Qualified",
"createdAt": "2018-06-21T19:34:32Z+0000",
"updatedAt": "2018-06-21T19:34:32Z+0000",
"url": "https://app-abm.marketo.com/#SL788645A1",
"folder": {
"id": 31,
"type": "Folder"
},
"workspace": "Default"
}
]
}
Supprimer
La suppression d’une liste dynamique utilise un seul id de liste dynamique comme paramètre de chemin d’accès.
POST /rest/asset/v1/smartList/{id}/delete.json
{
"success": true,
"errors": [],
"requestId": "8f5#16423dd0fbe",
"result": [
{
"id": 788645
}
]
}