批量潜在客户提取

最近更新： 2024年7月20日
  • 主题：

创建对象：

  • 管理员

批量潜在客户提取终结点引用

REST API的“批量潜在客户提取”集提供了一个编程接口，用于从Marketo中检索大量潜在客户/人员记录。 此外，它可用于根据记录的创建日期、最近更新、静态列表成员资格或智能列表成员资格增量检索潜在客户。 推荐的界面，用于需要在Marketo与一个或多个外部系统之间持续交换数据的用例，用于ETL、数据仓库存储和存档目的。

权限

Bulk Lead Extract API要求拥有的API用户具有只读潜在客户或读写潜在客户权限中的一个或两个角色。

过滤器

潜在客户支持各种筛选器选项。 某些筛选器（包括updatedAt、smartListName和smartListId）需要额外的基础结构组件，这些组件尚未推广到所有订阅。 每个导出作业只能指定一个过滤器类型。

筛选器类型数据类型备注
createdat日期范围接受具有成员startAt和endAt的JSON对象。 startAt接受表示低水位线的日期时间，endAt接受表示高水位线的日期时间。 范围必须为31天或更少。 日期时间应采用ISO-8601格式，不带毫秒。 具有此筛选器类型的作业将返回在日期范围内创建的所有可访问记录。
更新时间*日期范围接受具有成员startAt和endAt的JSON对象。 startAt接受表示低水位线的日期时间，endAt接受表示高水位线的日期时间。 范围必须为31天或更少。 日期时间应采用ISO-8601格式，不带毫秒。 注意：此过滤器不筛选可见的“updatedAt”字段，该字段仅反映对标准字段的更新。 它根据最近一次字段更新商机记录的时间进行筛选。使用此筛选类型的作业将返回日期范围内最近更新的所有可访问记录。
staticListName字符串接受静态列表的名称。 具有此筛选器类型的作业将返回所有可访问的记录，这些记录是作业开始处理时静态列表的成员。 使用“获取列表”端点检索静态列表名称。
staticListId整数接受静态列表的id。 具有此筛选器类型的作业将返回所有可访问的记录，这些记录是作业开始处理时静态列表的成员。 使用Get Lists端点检索静态列表ID。
smartListName*字符串接受智能列表的名称。 具有此筛选器类型的作业将返回在作业开始处理时作为智能列表成员的所有可访问记录。 使用获取智能列表端点检索智能列表名称。
smartListId*整数接受智能列表的id。 具有此筛选器类型的作业将返回在作业开始处理时作为智能列表成员的所有可访问记录。 使用获取智能列表端点检索智能列表ID。

过滤器类型不适用于某些订阅。 如果您的订阅不可用，则在调用“创建导出潜在客户作业”终结点（“1035，目标订阅不受支持的过滤器类型”）时会收到一个错误。 客户可以联系Marketo支持部门以在其订阅中启用此功能。

选项

创建导出潜在客户作业端点提供了多个格式选项，使用户能够在导出的文件中包括特定字段，能够重命名这些字段的列标题，以及导出文件的格式。

参数数据类型必需备注
字段数组[字符串]是字段参数接受字符串的JSON数组。 每个字符串必须是Marketo潜在客户字段的REST API名称。 列出的字段包含在导出的文件中。 除非用columnHeader覆盖，否则每个字段的列标题将是每个字段的REST API名称。 注意：启用Adobe Experience Cloud Audience Sharing功能后，将进行Cookie同步过程以将Adobe Experience Cloud ID (ECID)与Marketo潜在客户关联。 您可以指定“ecid”字段以将ECID包含在导出文件中。
columnHeaderName对象否包含字段和列标题名称的键值对的JSON对象。 键必须是导出作业中包含的字段的名称。 这是可以通过调用Describe Lead检索的字段的API名称。 值是该字段的导出列标题的名称。
格式字符串否接受以下内容之一：CSV、TSV、SSV。 如果设置，导出的文件将分别呈现为逗号分隔的值、制表符分隔的值或空格分隔的值文件。 如果未设置，则默认为CSV。