機會
Marketo公開API以供讀取、寫入、建立和更新商機記錄。 在Marketo中，機會記錄會透過中繼機會角色物件連結至銷售線索和聯絡人記錄，因此機會可能會連結至許多個別銷售線索。 這兩種物件型別都會透過API公開，而且就像大多數Lead Database物件型別一樣，它們都有相對應的Describe呼叫，這會傳回有關物件型別的中繼資料。
針對已啟用SFDC Sync或Microsoft Dynamics Sync的訂閱，機會API為唯讀存取。
說明
說明Opportunity記錄會遵循潛在客戶資料庫物件的標準模式。
GET /rest/v1/opportunities/describe.json
{
"requestId":"185d6#14b51985ff0",
"success":true,
"result":[
{
"name":"opportunity",
"displayName":"Opportunity",
"createdAt":"2015-02-03T22:36:23Z",
"updatedAt":"2015-02-03T22:36:24Z",
"idField":"marketoGUID",
"dedupeFields":[
"externalOpportunityId"
],
"searchableFields":[
[
"externalOpportunityId"
],
[
"marketoGUID"
]
],
"fields":[
{
"name":"marketoGUID",
"displayName":"Marketo GUID",
"dataType":"string",
"length":36,
"updateable":false
},
{
"name":"createdAt",
"displayName":"Created At",
"dataType":"datetime",
"updateable":false
},
{
"name":"updatedAt",
"displayName":"Updated At",
"dataType":"datetime",
"updateable":false
},
{
"name":"externalOpportunityId",
"displayName":"External Opportunity Id",
"dataType":"string",
"length":50,
"updateable":false
}
]
}
]
}
此回應型別最重要的欄位是idField、dedupeFields和searchableFields。 idField會指出機會的主要索引鍵marketoGUID。 這是系統產生的唯一索引鍵，可用於讀取和更新操作，但不能用於插入，因為它由系統管理。 dedupeFields陣列指出哪些欄位是插入作業的有效金鑰；在機會的情況下，這只有externalOpportunityId。 searchableFields陣列提供您一組有效的欄位，可用於查詢、externalOpportunityId和marketoGUID。
查詢
查詢商機的模式非常遵循銷售機會API的模式，並新增限制，filterType引數接受searchableFields陣列或對應描述呼叫或dedupeFields中列出的欄位。 請注意，如果您使用自訂機會欄位，只有String或Integer型別的自訂機會欄位會列在searchableFields陣列中。
GET /rest/v1/opportunities.json?filterType=marketoGUID&filterValues=dff23271-f996-47d7-984f-f2676861b5fa&dff23271-f996-47d7-984f-f2676861b5fc,dff23271-f996-47d7-984f-f2676861b5fb
{
"requestId":"e42b#14272d07d78",
"success":true,
"result":[
{
"seq":0,
"marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fa ",
"externalOpportunityId":"19UYA31581L000000",
"name":"Chairs",
"description":"Chairs",
"amount":"1604.47",
"source":"Inbound Sales Call/Email"
},
{
"seq":1,
"marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fc ",
"externalOpportunityId":"29UYA31581L000000",
"name":"Big Dog Day Care-Phase12",
"description":"Big Dog Day Care-Phase12",
"amount":"1604.47",
"source":"Email"
}
]
}
您也可以包含選擇性查詢引數fields，以傳回其他機會欄位nextPageToken，以分頁處理大於批次大小batchSize的集合，預設值為，最大值為300。 請求fields的清單時，如果請求特定欄位但未傳回，則值會隱含為空值。
建立和更新
機會會密切遵循潛在客戶API模式，但有一些限制。 action可用的值為： createOnly、createOrUpdate和updateOnly。 使用createOnly或createOrUpdate模式時，externalOpportunityId欄位必須包含在每個記錄中。 對於updateOnly模式，可能會使用marketoGUID或externalOpportunityId。 如果未指定，模式會預設為createOrUpdate。
銷售機會API中的lookupField引數無法使用，且由dedupeBy引數取代，這只有在動作為updateOnly時有效。 dedupeBy可用的值是"dedupeFields"或"idField"，這兩個值分別由描述呼叫指定為externalOpportunityId和marketoGUID。 如果未指定dedupeBy，預設為dedupeFields模式。 'name'欄位不可為Null。
您一次最多可以提交300筆記錄。
POST /rest/v1/opportunities.json
{
"action":"createOrUpdate",
"dedupeBy":"dedupeFields",
"input":[
{
"externalOpportunityId":"19UYA31581L000000",
"name":"Chairs",
"description":"Chairs",
"amount":"1604.47",
"source":"Inbound Sales Call/Email"
},
{
"externalOpportunityId":"29UYA31581L000000",
"name":"Big Dog Day Care-Phase12",
"description":"Big Dog Day Care-Phase12",
"amount":"1604.47",
"source":"Email"
}
]
}
{
"requestId":"e42b#14272d07d78",
"success":true,
"result":[
{
"seq":0,
"status":"updated",
"marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fb"
},
{
"seq":1,
"status":"created",
"marketoGUID":"cff23271-f996-47d7-984f-f2676861b5fb"
}
]
}
API將回應每個記錄的marketoGUID，以及status欄位（表示每個記錄的個別成功或失敗），以及用於關聯提交記錄與回應順序的seq欄位。 欄位中的數字是請求中提交的記錄索引。
欄位
公司物件包含一組欄位。 每個欄位定義都由一組描述該欄位的屬性組成。 屬性的範例為顯示名稱、API名稱和dataType。 這些屬性統稱為中繼資料。
下列端點可讓您查詢公司物件上的欄位。 這些API要求擁有的API使用者必須擁有具有Read-Write Schema Standard Field或Read-Write Schema Custom Field許可權之一或兩者的角色。
查詢欄位
查詢機會欄位非常簡單。 您可以依API名稱查詢單一公司欄位，或查詢所有公司欄位集。
依名稱
依名稱取得機會欄位端點會擷取公司物件上單一欄位的中繼資料。 必要的fieldApiName路徑引數指定欄位的API名稱。 回應類似於Describe Opportunity端點，但包含其他中繼資料，例如isCustom屬性，其代表欄位是否為自訂欄位。
GET /rest/v1/opportunities/schema/fields/externalOpportunityId.json
{
"requestId": "12331#17e9779cb4b",
"result": [
{
"displayName": "SFDC Oppty Id",
"name": "externalOpportunityId",
"description": null,
"dataType": "string",
"length": 50,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
}
],
"success": true
}
瀏覽
取得機會欄位端點會擷取公司物件上所有欄位的中繼資料。 依預設，最多會傳回300筆記錄。 您可以使用batchSize查詢引數來減少此數目。 如果moreResult屬性為true，則表示有更多結果可用。 繼續呼叫此端點，直到moreResult屬性傳回false （表示沒有可用的結果）。 從此API傳回的nextPageToken應一律重複用於此呼叫的下一個反複專案。
GET /rest/v1/opportunities/schema/fields.json?batchSize=5
{
"requestId": "b4a#17e995b31da",
"result": [
{
"displayName": "SFDC Oppty Id",
"name": "externalOpportunityId",
"description": null,
"dataType": "string",
"length": 50,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Name",
"name": "name",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Description",
"name": "description",
"description": null,
"dataType": "string",
"length": 2000,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Type",
"name": "type",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Stage",
"name": "stage",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
}
],
"success": true,
"nextPageToken": "E5ZONGE4SAHALYYW6FS25KB5BM======",
"moreResult": true
}
刪除
您可以依重複資料刪除欄位或ID欄位來刪除商機。 使用deleteBy引數指定dedupeFields或idField的值。 如果未指定，預設值為dedupeFields。 要求內文包含要刪除的input機會陣列。 每個呼叫最多允許300個機會。
POST /rest/v1/opportunities/delete.json
{
"deleteBy":"dedupeFields",
"input":[
{
"externalOpportunityId":"19UYA31581L000000"
},
{
"externalOpportunityId":"29UYA31581L000000"
}
]
}
{
"requestId":"e42b#14272d07d78",
"success":true,
"result":[
{
"seq":0,
"marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fb",
"status":"deleted"
},
{
"seq":1,
"marketoGUID":"cff23271-f996-47d7-984f-f2676861b5fb",
"status":"deleted"
}
]
}
逾時
-
機會端點的逾時為30秒，除非以下說明
- 同步處理機會：60秒
- 刪除機會：60秒