查询
查询机会的模式与潜在客户API的模式非常相似，添加了限制：filterType参数接受searchableFields数组或相应描述调用（即dedupeFields）中列出的字段。 请注意，如果您使用的是自定义机会字段，那么searchableFields数组中只会列出类型为String或Integer的自定义机会字段。
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的列表时，如果请求了特定字段但未返回，则该值默认为null。
创建和更新
机会会密切遵循潜在客户API模式，但有一些限制。 action可用的值为： createOnly、createOrUpdate和updateOnly。 使用createOnly或createOrUpdate模式时，每个记录中必须包含externalOpportunityId字段。 对于updateOnly模式，可以使用marketoGUID或externalOpportunityId。 如果未指定，则该模式默认为createOrUpdate。
潜在客户API中的lookupField参数不可用，将被dedupeBy参数取代，该参数仅在操作为updateOnly时有效。 dedupeBy可用的值是“dedupeFields”或“idField”，这两个值分别在describe调用中指定为externalOpportunityId和marketoGUID。 如果未指定dedupeBy ，则默认为dedupeFields模式。 “name”字段不能为空。
一次最多可以提交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名称和数据类型。 这些属性统称为元数据。
以下端点允许您查询公司对象上的字段。 这些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
}