自定义对象

最近更新： 2024年8月26日

创建对象：

  • 管理员

自定义对象终结点引用 Marketo允许用户定义与Marketo标准对象（潜在客户、公司）或其他Marketo自定义对象相关的Marketo自定义对象。  Marketo自定义对象可以使用此处所述的Marketo UI创建，也可以使用如下所述的自定义对象元数据API创建。

访问自定义对象元数据API需要适当的Marketo订阅类型。  有关详细信息，请咨询您的CSM。

列表

除了可用于潜在客户数据库对象的标准描述、查询、更新和删除调用之外，自定义对象还有列表调用可用。  调用此端点将返回一个响应，其中包含目标实例中可用的自定义对象列表，以及有关这些对象的其他元数据。

GET /rest/v1/customobjects.json

{
   "requestId":"185d6#14b51985ff0",
   "success":true,
   "result":[
      {
         "name":"Car",
         "displayName":"Car",
         "description":"Car owner",
         "createdAt":"2015-02-03T22:36:23Z",
         "updatedAt":"2015-02-03T22:36:24Z",
         "idField":"marketoGUID",
         "dedupeFields":["vin"],
         "searchableFields":[
            ["vin"],
            ["marketoGUID"],
            ["siebelId"]
         ],
         "relationships":[
            {
               "field":"siebelId",
               "type":"parent",
               "relatedTo":{
                  "name":"Lead",
                  "field":"siebelId"
               }
            }
         ]
      }
   ]
}

响应将给出每个对象上存在的关系的列表。  关系将具有field成员，指示保存链接值的对象上的字段；一个type成员，指示关系是到父类型对象还是子类型对象；一个relatedTo对象，指示相关对象的名称，以及该对象上的链接字段。

描述

自定义对象的describe调用遵循与Opportunities和Companies相同的模式，在响应中添加relationships数组并在URI中添加apiName路径参数，该参数采用要描述的自定义对象类型的API名称。  与列表调用类似，这将列出可用于此自定义对象类型的所有关系。

GET /rest/v1/customobjects/{apiName}/describe.json

{
   "requestId":"185d6#14b51985ff0",
   "success":true,
   "result":[
      {
         "name":"Car",
         "displayName":"Car",
         "description":"Car owner",
         "createdAt":"2015-02-03T22:36:23Z",
         "updatedAt":"2015-02-03T22:36:24Z",
         "idField":"marketoGUID",
         "dedupeFields":["vin"],
         "searchableFields":[
            ["vin"],
            ["marketoGUID"],
            ["siebelId"]
         ],
         "relationships":[
            {
               "field":"siebelId",
               "type":"parent",
               "object":{
                  "name":"Lead",
                  "field":"siebelId"
               }
            }
         ],
         "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":"vin",
               "displayName":"VIN",
               "description":"Vehicle Identification Number",
               "dataType":"string",
               "length":36,
               "updateable":false
            },
            {
               "name":"siebelId",
               "displayName":"External Id",
               "description":"External Id",
               "dataType":"string",
               "length":36,
               "updateable":true
            },
            {
               "name":"make",
               "displayName":"Make",
               "dataType":"string",
               "length":36,
               "updateable":true
            },
            {
               "name":"model",
               "displayName":"Model",
               "description":"Vehicle Model",
               "dataType":"string",
               "length":255,
               "updateable":true
            },
            {
               "name":"year",
               "displayName":"Year",
               "dataType":"integer",
               "updateable":true
            },
            {
               "name":"color",
               "displayName":"Color",
               "description":"Vehicle color",
               "dataType":"String",
               "length": 255,
               "updateable":true
            }
         ]
      }
   ]
}

查询

查询自定义对象与其他Lead Database API略有不同，它采用apiName路径参数，如描述。  对于普通的filterType参数，查询是简单的GET，例如对其他类型记录的查询，并且需要filterType和filterValues。  它将选择性地接受**fields**、batchSize和nextPageToken参数。  在请求字段列表时，如果请求的是特定字段但未返回，则该值默认为空。

GET /rest/v1/customobjects/{apiName}.json?filterType=idField&filterValues=dff23271-f996-47d7-984f-f2676861b5fa,dff23271-f996-47d7-984f-f2676861b5fb

{
   "requestId":"e42b#14272d07d78",
   "success":true,
   "result":[
      {
         "seq":0,
         "marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fa",
         "vin":"19UYA31581L000000",
         "createdAt":"2015-02-23T18:21:53Z",
         "updatedAt":"2015-02-23T18:23:41Z"
      },
      {
         "seq":1,
         "marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fb",
         "vin":"29UYA31581L000000",
         "createdAt":"2015-02-23T18:21:53Z",
         "updatedAt":"2015-02-23T18:23:41Z"
      },
   ]
}

或者，在使用复合键进行查询时，API的行为类似于Opportunity Roles API，接受具有JSON主体的POST。  JSON正文可以具有与GET查询相同的成员，但filterValues除外。  有一个input数组而不是筛选器值，该数组采用包含为对象类型的每个dedupeFields命名成员的对象。

POST /rest/v1/customobjects/{apiName}.json?_method=GET

{
   "filterType":"dedupeFields",
   "fields":[
      "marketoGuid",
      "Bedrooms",
      "yearBuilt"
   ],
   "input":[
      {
         "mlsNum":"1962352",
         "houseOwnerId":"42645756"
      },
      {
         "mlsNum":"2962352",
         "houseOwnerId":"52645756"
      },
      {
         "mlsNum":"3962352",
         "houseOwnerId":"62645756"
      }
   ]
}

{
   "requestId":"e42b#14272d07d78",
   "success":true,
   "result":[
      {
         "seq":0,
         "marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fa",
         "Bedrooms":3,
         "yearBuilt":1948,
         "createdAt":"2015-02-23T18:21:53Z",
         "updatedAt":"2015-02-23T18:23:41Z"
      },
      {
         "seq":1,
         "marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fb",
         "Bedrooms":4,
         "yearBuilt":1956,
         "createdAt":"2015-02-23T18:21:53Z",
         "updatedAt":"2015-02-23T18:23:41Z"
      },
      {
         "seq":2,
         "marketoGUID":"dff23271-f996-47d7-984f-f2676861b5fc",
         "Bedrooms":3,
         "yearBuilt":2001,
         "createdAt":"2015-02-23T18:21:53Z",
         "updatedAt":"2015-02-23T18:23:41Z"
      }
   ]
}

创建和更新

使用同步自定义对象端点创建或更新自定义对象，您可以使用action参数指定操作。  在一次调用中最多可以创建或更新300条记录。  input数组中使用的值主要基于Describe Custom Objects端点返回的信息。 在示例car对象中，只有一个重复数据删除字段vin。  要在使用dedupeFields模式时更新或创建记录，输入数组中的每条记录需要至少包含一个vin字段。

POST /rest/v1/customobjects/{apiName}.json

{
   "action":"updateOnly",
   "dedupeBy":"dedupeFields",
   "input":[
      {
         "vin":"19UYA31581L000000",
         "siebelId":"f2676861b5fb",
         "make":"BMW",
         "model":"3-Series 330i",
         "year":2003
      },
      {
         "vin":"29UYA31581L000000",
         "siebelId":"f2676861b5fc",
         "make":"BMW",
         "model":"3-Series 330i",
         "year":2003
      },
      {
         "vin":"39UYA31581L000000",
         "siebelId":"f2676861b5fd",
         "make":"BMW",
         "model":"3-Series 330i",
         "year":2003
      }
   ]
}

{
   "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"
      },
      {
         "seq":2,
         "status": "skipped"
         "reasons":[
            {
               "code":"1004",
               "message":"Lead not found"
            }
         ]
      }
   ]
}

通过idField模式执行更新时，idField将始终为marketoGUID，因此每个记录将始终需要marketoGUID字段。  请记住，idField仅对updateOnly操作类型有效，因为此字段始终由系统管理。  您的响应将包括结果数组中每个单独记录的​ 状态，以及一个marketoGUID或reasons数组，具体取决于单个记录的操作是否成功。