发起数据导出

Start a new export 发起数据导出

Exports 接口允许向列表通过建立任务导出（异步）收件人列表或收件人细分. 一个CSV文件将作为返回结果.

通过在POST请求中包含不同的参数，你可以选择哪些属性字段会被导出（系统默认或自定义的). 执行一个GET请求可以对导出任务的状态进行轮询（如，导出过程是否还在进行中或已完成), 如若完成则该GET请求将返回一个URL，该URL即导出结果文件可供下载的地址.

请求数据格式

创建导出任务请求中的Data元素部分.
Data子元素:
元素/属性 类型 描述
Type string 导出类型. 必填. 合法值有:

    • List列表 – 导出收件人列表
    • Segment细分 – 导出收件人细分
ListId integer 将被导出的收件人列表ID 如果 Type=List 则必填，否则可忽略
SegmentId integer 将被导出的收件人细分ID 如果 Type=Segment 则必填，否则可忽略
Fields complex Field元素集合. 列出可能被导出的系统默认属性字段 (如. Email, Firstname, Vendor 等). 至少其中一个系统默认的属性字段应该被选择。所有合法的系统默认属性字段见下
Properties complex Property元素集合 . 列出可能被导出的自定义属性字段。自定义属性字段之间用ID区分，见示例请求
Field子元素:
元素/属性 类型 描述
(Field element content) string 系统默认属性字段名称.
Property子元素:
元素/属性 类型 描述
(Property element content) int 自定义属性字段ID

系统默认属性字段:

名称 描述
Id 收件人ID
FirstName 收件人名字
LastName 收件人姓氏
Email 收件人email
EmailMd5 收件人email的MD格式
EmailSha256 收件人email的SHA256格式
CustomSubscriberId 收件人标识ID
IP 收件人加入列表中时的IP地址
Vendor 收件人来源
TrackingCode 收件人加入列表中时追踪代码
GeoCountry 收件人上次动作/行为 IP地址所对应的国家
GeoState 收件人上次动作/行为 IP地址所对应的省市自治区
GeoCity 收件人上次动作/行为 IP地址所对应的城市
GeoZipCode 收件人上次动作/行为 IP地址所对应的邮编
LastActivity 收件人上次动作/行为 发生的时间 (点击, 打开, 进入个人中心等等)
LastMessage 上次发送给收件人消息的时间
LastEmail 上次发送给收件人消息的日期
LastOpenEmail 收件人上次打开邮件的时间
LastClickEmail 收件人上次点击邮件某一链接
SubscriptionDate 收件人被添加至列表的日期(如果导出的类型是收件人细分，那么此处就是收件人被加入后台数据库的时间).
开通短信/彩信业务后可导出以下字段:
名称 描述
Phone 收件人的电话号码
LastSmsMms 上次发送短信/彩信至收件人的日期
LastClickSmsMms 收件人上次点击短信/彩信的日期

应答

接口的返回值为导出的任务ID, ID可以用来通过GET方式获取导出进度状态
应答Data元素:
元素/属性 类型 描述
(Data element content) int  建立导出任务的ID

示例

列表发起一次导出任务（只含有默认属性字段）
请求:
POST https://api.esv2.com/v2/Api/Exports HTTP/1.1 

Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 411 
<ApiRequest xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xs=”http://www.w3.org/2001/XMLSchema”>
  <ApiKey>test_api_key1</ApiKey>
  <Data>
    <Type>List</Type>
    <ListId>11</ListId>
    <Fields>
      <Field>Email</Field>
      <Field>FirstName</Field>
      <Field>LastName</Field>
    </Fields>
    <FileFormat>Csv</FileFormat>
  </Data>
</ApiRequest>
列表发起一次导出任务（含有自定义属性字段）
请求中:
POST https://api.esv2.com/v2/Api/Exports HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 411 
<ApiRequest xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xs=”http://www.w3.org/2001/XMLSchema”>
  <ApiKey>test_api_key1</ApiKey>
  <Data>
    <Type>Segment</Type>
    <SegmentId>93</SegmentId>
    <Fields>
      <Field>Email</Field>
      <Field>FirstName</Field>
      <Field>LastName</Field>
    </Fields>
    <Properties>
      <Property>5</Property>
      <Property>12</Property>
    </Properties>
  </Data>
</ApiRequest>
应答:
HTTP/1.1 201 Created 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 3.0 
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Mon, 25 Nov 2013 16:40:14 GMT 
Content-Length: 147 
 
<ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
  <Data>12</Data>
</ApiResponse>