スマートリスト
Marketo は、スマートリストで操作を実行する一連の REST API を備えています。これらの API は、クエリ、削除、複製のオプションを提供するアセット API の標準インターフェイスパターンに従います。
メモ：これらの API は、ユーザが作成したスマートリストに対してのみサポートされます。ビルトイン／システムのスマートリストには使用できません。
クエリ
スマートリストのクエリは、ID 別、名前別および参照のアセットに対する標準のクエリタイプに従います。
ID 別
ID によるクエリ実行は、単一のスマートリスト id をパスパラメーターとして受け取り、単一のスマートリストレコードを返します。オプションで、includeRules ブール値パラメーターを渡して、応答にスマートリストルールを含めることができます。
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
}
]
}
]
}
}
]
}
スマートキャンペーン ID 別
スマートキャンペーン ID によるクエリ実行は、単一のスマートキャンペーン id をパスパラメーターとして受け取り、単一のスマートリストレコードを返します。オプションで、includeRules ブール値パラメーターを渡して、応答にスマートリストルールを含めることができます。
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"
}
]
}
プログラム ID 別
プログラム ID によるクエリ実行は、単一のメールプログラム id をパスパラメーターとして受け取り、単一のスマートリストレコードを返します。オプションで、includeRules ブール値パラメーターを渡して、応答にスマートリストルールを含めることができます。
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"
}
]
}
名前別
名前によるクエリ実行は、スマートリスト name をパラメーターとして受け取り、単一のスマートリストレコードを返します。インスタンス内のすべてのスマートリスト名に対して正確な文字列一致が実行され、その名前に一致するスマートリストの結果が返されます。
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"
}
]
}
参照
スマートリストは、バッチで取得することもできます。folder パラメーターは、クエリが実行される親フォルダーを指定するために使用されます。これは、id と type を含む JSON オブジェクトとして書式設定されます。他の一括アセット取得エンドポイントと同様に、 offset と maxReturn はページングに使用できるオプションパラメーターです。オプションの earliestUpdatedAt および latestUpdatedAt 日時パラメーターを使用すると、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"
}
]
}
複製
スマートリストの複製は、application/x-www-form-urlencoded POST で実行されます。複製するスマートリストは、id パスパラメーターで指定されます。folder パラメーターは、スマートリストが作成される親フォルダーを指定するために使用され、ID とタイプを含む JSON オブジェクトとして書式設定されます。親フォルダーは、プログラムフォルダーまたはスマートリストフォルダーのいずれかである必要があります。name パラメーターは、新しいスマートリストに名前を付けるために使用され、一意である必要があります。オプションで、description パラメーターを使用してスマートリストを説明することもできます。
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"
}
]
}
削除
スマートリストの削除では、パスパラメーターとして単一のスマートリスト id を受け取ります。
POST /rest/asset/v1/smartList/{id}/delete.json
{
"success": true,
"errors": [],
"requestId": "8f5#16423dd0fbe",
"result": [
{
"id": 788645
}
]
}