靜態清單
Marketo提供了一組REST API,可用於對靜態清單執行CRUD操作。 這些API遵循資產API的標準介面模式,提供查詢、建立、更新和刪除選項。
查詢
查詢靜態清單會依循的標準查詢型別(識別碼、名稱和瀏覽)。
依Id
依ID的查詢,以單一靜態清單id作為路徑引數,並傳回單一靜態清單記錄。
GET /rest/asset/v1/staticList/{id}.json
{
"success": true,
"errors": [],
"requestId": "843c#1641f969e96",
"result": [
{
"id": 1021,
"name": "Foundation Seed List",
"createdAt": "2017-07-27T01:38:33Z+0000",
"updatedAt": "2017-07-27T01:39:26Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1021A1"
}
]
}
依名稱
依名稱查詢以靜態清單name作為引數,並傳回單一靜態清單記錄。 會針對執行個體中的所有靜態清單名稱執行完全相符的字串,並傳回符合該名稱的靜態清單結果。
GET /rest/asset/v1/staticList/byName.json?name=Foundation Seed List
{
"success": true,
"errors": [],
"requestId": "28ab#1641fa246b9",
"result": [
{
"id": 1021,
"name": "Foundation Seed List",
"createdAt": "2017-07-27T01:38:33Z+0000",
"updatedAt": "2017-07-27T01:39:26Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1021A1"
}
]
}
瀏覽
靜態清單也可以以批次擷取。 folder引數可用來指定要在其中執行查詢的父資料夾,並將其格式化為包含ID和型別的JSON物件。 如同其他大量資產擷取端點,offset和maxReturn是可用於分頁的選用引數。 earliestUpdatedAt和latestUpdatedAt引數可讓您設定低日期時間與高日期時間浮水印,以傳回在指定範圍內建立或更新之靜態清單。 日期時間值必須是有效的ISO-8601字串,而且不應該包含毫秒
GET /rest/asset/v1/staticLists.json?folder={"id":13,"type":"Folder"}
{
"success": true,
"errors": [],
"requestId": "2dc0#1641f846633",
"result": [
{
"id": 1021,
"name": "Foundation Seed List",
"createdAt": "2017-07-27T01:38:33Z+0000",
"updatedAt": "2017-07-27T01:39:26Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1021A1"
},
{
"id": 1022,
"name": "Blacklist Seed List",
"createdAt": "2017-07-27T23:19:33Z+0000",
"updatedAt": "2017-07-27T23:21:29Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1022A1"
},
{
"id": 1023,
"name": "Possible Duplicates Seed List",
"createdAt": "2017-07-28T00:10:02Z+0000",
"updatedAt": "2017-07-28T00:11:22Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1023A1"
}
]
}
建立和更新
建立靜態清單是使用application/x-www-form-urlencoded POST執行,其中包含兩個必要的引數。 folder引數是用來指定要在其中建立靜態清單的父資料夾,且會格式化為包含ID和型別的JSON物件。 name引數是用來命名靜態清單,而且必須是唯一的。 可選擇使用description引數描述靜態清單。
POST /rest/asset/v1/staticLists.json
Content-Type: application/x-www-form-urlencoded
folder={"id":1034,"type":"Program"}&name=My Static List
{
"success": true,
"errors": [],
"requestId": "1269d#164209d6e1e",
"result": [
{
"id": 1027,
"name": "My Static List",
"createdAt": "2018-06-21T04:32:25Z+0000",
"updatedAt": "2018-06-21T04:32:25Z+0000",
"folder": {
"id": 1034,
"type": "Program"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1027A1"
}
]
}
靜態清單的更新是透過具有兩個選擇性引數的個別端點所進行。 description引數可用來更新靜態清單描述。 name引數可用來更新靜態清單名稱,而且必須是唯一的。
POST /rest/asset/v1/staticList/{id}.json
Content-Type: application/x-www-form-urlencoded
description=This is a static list used for testing
{
"success": true,
"errors": [],
"requestId": "f84f#16420b4c746",
"result": [
{
"id": 1027,
"name": "My Static List",
"description": "This is a static list used for testing",
"createdAt": "2018-06-21T04:32:26Z+0000",
"updatedAt": "2018-06-21T04:57:55Z+0000",
"folder": {
"id": 1034,
"type": "Program"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1027A1"
}
]
}
刪除
刪除靜態清單會以單一靜態清單id作為路徑引數。 無法刪除匯入或匯出操作正在使用的靜態清單,或其他資產正在使用的靜態清單。
POST /rest/asset/v1/staticList/{id}/delete.json
{
"success": true,
"errors": [],
"requestId": "2c79#16420ded0e9",
"result": [
{
"id": 1027
}
]
}
清單成員資格
清單成員資格端點提供新增、移除和查詢靜態清單成員的功能。 此外,您可以查詢靜態清單成員資格。
新增至清單
新增至清單端點用於將一或多個成員新增至清單。 端點採用必要的listId路徑引數,以及一或多個包含潛在客戶ID的ID查詢引數(允許的最大值為300)。
回應包含result陣列,由JSON物件組成,要求中指定的每個潛在客戶ID都具有狀態。
POST /rest/v1/lists/{listId}/leads.json?id=318594&id=318595
{
"requestId": "6860#1706170ba29",
"result": [
{
"id": 318594,
"status": "added"
},
{
"id": 318595,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}
從清單中移除
已從清單中移除從清單端點移除一或多個成員。 端點採用必要的listId路徑引數,以及一或多個包含潛在客戶ID的id查詢引數(允許的最大值為300)。
回應包含result陣列,由JSON物件組成,要求中指定的每個潛在客戶ID都具有狀態。
DELETE /rest/v1/lists/{listId}/leads.json?id=318603&id=318595&id=999999
{
"requestId": "9e79#17061689ac3",
"result": [
{
"id": 318603,
"status": "removed"
},
{
"id": 318595,
"status": "removed"
},
{
"id": 999999,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}
查詢清單
依清單ID取得銷售機會端點用於擷取清單的成員。 端點採用必要的listId路徑引數,並允許多個可選的查詢引數來指定篩選條件。
batchSize引數是用來指定單一呼叫中要傳回的潛在客戶記錄數目(預設值及上限為300)。
nextPageToken引數是用來分頁大型結果集。 此引數不會在第一次呼叫中傳遞,但只會在分頁的後續呼叫中傳遞。
fields引數包含回應中要傳回的欄位名稱清單(以逗號分隔)。 若此請求中未包含欄位引數,則會傳回下列預設欄位: email、updatedAt、createdAt、lastName、firstName和id。
回應包含result陣列,由JSON物件組成,其中包含要求中指定的潛在客戶欄位。
GET /rest/v1/lists/{listId}/leads.json?batchSize=3
{
"requestId": "ddae#170615ba0cc",
"result": [
{
"id": 318594,
"firstName": "Hanna",
"lastName": "Crawford",
"email": "208161Robert.L.Deacon@pookmail.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
},
{
"id": 318595,
"firstName": "Bertha",
"lastName": "Fulton",
"email": "208160Tyrone.V.Dyer@trashymail.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
},
{
"id": 318596,
"firstName": "Faith",
"lastName": "England",
"email": "208159Rex.M.Bailey@dodgit.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
}
],
"success": true,
"nextPageToken": "PS5VL5WD4UOWGOUCJR6VY7JQO24LC2U5DRBU4WO4RQMPHDHTK2T3BEZOR75VLQXYB3245WW2GMDSK==="
}
依銷售機會Id查詢清單成員資格
清單端點的成員用於檢視一個或多個潛在客戶是否為清單的成員。 端點採用必要的listId路徑引數,以及一或多個包含潛在客戶ID的id查詢引數(允許的最大值為300)。
回應包含result陣列,由JSON物件組成,要求中指定的每個潛在客戶ID都具有狀態。
GET /rest/v1/lists/{listId}/leads/ismember.json?id=309901&id=318603&id=999999
{
"requestId": "693a#17061475cf9",
"result": [
{
"id": 309901,
"status": "memberof"
},
{
"id": 318603,
"status": "notmemberof"
},
{
"id": 999999,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}