pardot-api-client 0.0.1

特性

• 支持Python 2和3

• 支持API版本3

• 支持所有API实体：账户、活动、自定义字段、自定义重定向、动态内容、电子邮件、电子邮件点击、表单、已识别公司、生命周期历史、生命周期阶段、列表、列表成员、机会、个人资料、个人资料标准、潜在客户、潜在客户账户、标签、标签对象、用户、访问、访问者、访问者活动、访问者页面浏览、访问者引用

• 支持大多数API操作：查询、分配、取消分配、创建、读取、更新、Upsert、删除

• 支持取消设置字段值

• 隐式处理API会话超时

• 透明的API错误反馈

• 可选的请求重试，具有指数退避

计划中的特性

• 支持API版本4

• 支持API批处理操作：batchCreate、batchUpdate、batchUpsert

• 支持结果集操作，例如指定字段、限制、偏移、排序_by、排序_order

• 隐式结果分页

• 隐式分块处理批处理操作

安装

$ pip install pardot-api-client

使用方法

1. 通过遵循http://developer.pardot.com/#authentication中的说明从Pardot获取API认证凭据 - 您需要以下内容：电子邮件、密码、用户密钥

2. 查看支持的Pardot API文档http://developer.pardot.com/#official-pardot-api-documentation

3. 使用Python API客户端与API交互

   >>> from pardot.client import APIClient
   >>> client = APIClient(
   ...     'pardot-email',
   ...     'pardot-password',
   ...     'pardot-user_key')
   ...
   >>> # read
   >>> r = client.prospect.read('someone@example.com')
   >>> print(r)
   >>> # update
   >>> r = client.prospect.update('someone@example.com', first_name='John')
   >>> print(r)
   >>> # query
   >>> for r in client.prospect.query(new=True):
   ...    print(r)
   ...

参数与关键字参数

为了使客户端的API简单，它会对资源操作调用中传入的标识符进行有根据的猜测。

要使此功能正常工作，所有必需的参数（除user_key和api_key外，这两个参数将自动添加）都必须作为位置参数传递，任何可选参数都必须作为关键字参数传递。

例如，API文档指出，“prospect”资源上的“assign”操作可以使用“email”或“id”作为标识符，并必须提供以下参数之一：“user_email”、“user_id”或“group_id”。以下任何形式都可以从客户端进行此调用

>>> # identify by email
>>> client.prospect.update('someone@example.com', user_email='someone-else@example.com')
>>> client.prospect.update('someone@example.com', user_id=2544897)
>>> client.prospect.update('someone@example.com', group_id=5499876)
>>> # identify by id
>>> client.prospect.update(7142577, user_email='someone-else@example.com')
>>> client.prospect.update(7142577, user_id=2544897)
>>> client.prospect.update(7142577, group_id=5499876)