mataluis2k/marketing-php

本包最新版本（dev-master）无许可证信息。

此包提供对多个Maropost服务的程序访问。

维护者

详细信息

github.com/mataluis2k/marketing-php

源代码

安装: 2

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 10

dev-master 2022-02-09 20:51 UTC

Requires

Requires (Dev)

Unknown License e5d15df2c9f583bdc33e16d98bd7807eddc5438d

This package is auto-updated.

Last update: 2024-09-10 02:19:53 UTC

README

摘要

此包提供对多个Maropost服务的程序访问。它包含在 Maropost.Api 命名空间内的八个服务。每个服务包含一个或多个执行对Maropost账户操作的函数。这些函数返回一个结果对象，指示成功/失败，任何抛出的异常以及结果数据。

安装

Composer

Composer 是 PEAR 的现代替代品，易于使用。由于此包遵循 PSR-4 规范，您可以使用 Composer 安装它。为此，只需将 maropost/api 添加到您项目 composer.json 文件中的 "require" 对象即可。

{
    "require": {
        "maropost/api": "*"
    }
}

从源安装

您也可以克隆 API 仓库，并使用 PSR-4 兼容的自动加载器来加载库。我们位于 ~/tests/index.php 的测试文件提供了一个如何做到这一点的示例。您需要查看我们的 composer.json 文件以了解依赖项（在 "requires" 下列出），并确保已安装。

用法

要使用服务，首先实例化它，提供您的 Maropost 账户 ID 和认证令牌。例如，要使用 Reports 服务获取您的报告列表，执行

$reports = new Maropost.Api.Reports($myAccountId, $myAuthToken);
$result = $reports.get();
if ($result.isSuccess) {
    $myReports = $result.getData();
}

结果对象包含三个字段

  • isSuccess（布尔值）
  • errorMessage（字符串）
  • exception（Exception）

如果 isSuccess 为 false，则 errorMessage 将包含信息，而 exception 可能 包含一个异常，具体取决于失败的原因。如果 exception 不是 null，则 isSuccess 总是 false。

该对象还包含一个函数，getData()，它包含操作本身提供的任何数据。某些操作，如 delete() 操作，可能不会提供任何数据。

特定 API

包含的具体 API 有

活动

实例化

new Maropost.Api.Campaigns($myAccountId, $myAuthToken)

可用方法

  • get(int $page)
    • 返回账户的活动列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • getCampaign(int $campaignId)
    • 返回指定的活动
    • $campaignId
  • getBounceReports(int $id, int $page)
    • 返回给定活动 ID 的弹跳报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • getClickReports(int $id, int $page, bool unique = null)
    • 返回给定活动 ID 的点击报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $unique：true = 获取唯一联系人。否则，false。
  • getComplaintReports(int $id, int $page)
    • 返回给定活动 ID 的投诉报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • getDeliveredReports(int $id, int $page)
    • 返回给定活动 ID 的投递报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • getHardBounceReports(int $id, int $page)
    • 返回给定活动 ID 的硬弹跳列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • getLinkReports(int $id, int $page, bool unique = null)
    • 返回给定活动 ID 的链接报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $unique：true = 获取唯一联系人。否则，false。
  • getOpenReports(int $id, int $page, bool unique = null)
    • 返回给定活动 ID 的打开报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $unique：true = 获取唯一联系人。否则，false。
  • getSoftBounceReports(int $id, int $page)
    • 返回给定活动 ID 的软弹跳报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
  • getUnsubscribeReports(int $id, int $page)
    • 返回指定活动ID的退订报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

A/B 测试活动

实例化

new Maropost.Api.AbTestCampaigns($myAccountId, $myAuthToken)

可用方法

  • createAbTest(string $name, string $fromEmail, string $replyTo, string $address, string $language, array $campaignGroupsAttributes, string commit, \DateTime $sendAt, int $brandId = null, array $suppressedListIds = [], array $suppressedSegmentIds = [], array $suppressedJourneyIds = [], int $emailPreviewLink = null, string $decidedBy = null, array $lists = [], array $cTags = [], array $segments = [])
    • $name：新活动的名称
    • $fromEmail：活动邮件的默认发件人电子邮件地址
    • $replyTo：活动邮件的默认回复电子邮件地址
    • $address：活动邮件中包含的默认物理地址
    • $language：ISO 639-1语言代码（例如，"en"）。2个字符。
    • $campaignGroupsAttributes：属性数组。每个属性本身是一个对象，具有以下属性（全部为字符串）
      • name：组名
      • content_id：内容ID
      • subject：邮件主题行
      • from_name：邮件的“发件人”名称
      • percentage：应使用这些设置的邮件百分比。
      • 预览头:
      • send_at：表示DateTime的字符串，格式为YYYY-MM-DD HH:mm:ss
    • $commit：允许的值：“保存为草稿”或“发送测试”或“安排”
    • $sendAt：表示AB活动的开始时间的DateTime对象
    • $brandId：字符串形式的品牌ID
    • $suppressedListIds：列表ID数组（字符串格式）
    • $suppressedSegmentIds：段ID数组（字符串格式）
    • $suppressedJourneyIds：旅程ID数组（字符串格式）
    • $emailPreviewLink：1（true）发送预览链接。否则0（false）。
    • $decidedBy：允许的值：（'TopChoice'用于最高选择）或（'Opens'用于最高的打开率）或（'Clicks'用于最高的点击率）或（'Manual'用于手动选择）或（'click_to_open'用于最高的点击-打开率）或（'conversions'用于最高的转化率）
    • $lists：目标列表ID数组（字符串格式）
    • $cTags：字符串格式的标签数组
    • $segments：目标段ID数组（字符串格式）

事务性活动

实例化

new Maropost.Api.TransactionalCampaigns($myAccountId, $myAuthToken)

可用方法

  • get(int $page)

    • 返回交易活动的列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • create(string $name, string $subject, string $preheader, string $fromName, string $fromEmail, string $replyTo, int $contentId, bool $emailPreviewLink, string $address, string $language, string... $ctags)

    • 创建一个交易活动
    • $name：活动名称
    • $subject：活动主题
    • $preheader：活动预览头
    • $fromName：邮件中的发件人姓名
    • $fromEmail：发件人电子邮件地址
    • $replyTo：回复电子邮件地址
    • $contentId
    • $emailPreviewLink
    • $address：物理地址
    • $language：ISO 639-1语言代码
    • ...$ctags：活动标签数组

  • sendEmail(int $campaignId, int $contentId = null, string $contentName = null, string $contentHtmlPart = null, string $contentTextPart = null, int $sendAtHour = null, int $sendAtMinute = null, bool $ignoreDnm = null, int $contactId = null, string $recipientEmail = null, string $recipientFirstName = null, string $recipientLastName = null, array $recipientCustomFields = null, string $bccEmail = null, string $fromName = null, string $fromEmail = null, string $subject = null, string $replyTo = null, string $senderAddress = null, array $tags = null, array $ctags = null )

    • 向收件人发送交易活动邮件。除非在函数参数中提供，否则将自动从交易活动中获取发件人信息。
    • $campaignId：必须在调用$svc->get()时已存在的活动。如果您没有，首先调用$svc->create()。
    • $contentId：如果提供，将用此内容替换交易活动的内 容。
    • $contentName：如果$contentId为null，将用此名称替换交易活动的内 容名称。
    • $contentHtmlPart：如果 $contentId 为 null，则事务性活动的内容 HTML 部分将被此 HTML 部分替换。
    • $contentTextPart：如果 $contentId 为 null，则事务性活动的文本内容部分将被此文本部分替换。
    • $sendAtHour：必须是 1-12。否则邮件将立即发出。如果小时小于当前小时，邮件将在第二天发出。
    • $sendAtMinute：必须是 0-60。否则将视为 0。如果小时和分钟相加小于当前时间，邮件将在第二天发出。
    • $ignoreDnm：如果为 true，则忽略收件人联系人的 Do Not Mail 列表。
    • $contactId：收件人联系 ID。
    • $recipientEmail：电子邮件地址。除非 $contactId 为 null，否则将被忽略。否则，它必须是一个有效的电子邮件地址，符合 FILTER_VALIDATE_EMAIL。
    • $recipientFirstName：收件人的名字。除非 $contactId 为 null，否则将被忽略。
    • $recipientLastName：收件人的姓氏。除非 $contactId 为 null，否则将被忽略。
    • $recipientCustomFields：收件人的自定义字段。除非 $contactId 为 null，否则将被忽略。是一个关联数组，其中项目键是自定义字段的名称，项目值是字段值。所有键必须是字符串。所有值都必须是非 null 的标量。
    • $bccEmail：BCC 收件人。只能传递单个电子邮件地址、空字符串或 null。如果提供，则必须是一个有效的电子邮件地址，符合 FILTER_VALIDATE_EMAIL。
    • $fromName：发件人姓名。如果 $fromEmail 已设置，则覆盖事务性活动的默认发件人姓名。否则将被忽略。
    • $fromEmail：发件人电子邮件地址。覆盖事务性活动的默认发件人电子邮件地址。
    • $subject：电子邮件的主题行。覆盖事务性活动的默认主题。
    • $replyTo：回复地址。覆盖事务性活动的默认回复地址。
    • $senderAddress：发件人的物理地址。覆盖事务性活动的默认发件人地址。
    • $tags：关联数组，其中项目键是内容中的标签名称，项目值是发送时标签的替换值。所有键必须是字符串。所有值都必须是非 null 的标量。
    • $ctags：活动标签。必须是一个标量值的简单数组。

联系人

实例化

new Maropost.Api.Contacts($myAccountId, $myAuthToken)

可用方法

  • getForEmail(string $email)

    • 根据电子邮件地址获取联系人
    • $email：联系人的电子邮件地址

  • getOpens(int $contactId, int $page)

    • 获取指定联系人的打开列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • getClicks(int $contactId, int $page)

    • 获取指定联系人的点击列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • getForList(int $listId, int $page)

    • 获取指定列表的联系人类别
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • getContactForList(int $listId, int $contactId)

    • 从指定列表中获取指定联系人
    • $listId
    • $contactId

  • public function updateForListAndContact( int $listId, int $contactId, string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = true, bool $subscribe = true )

    • 在列表中创建联系人。如果之前联系人是通过电子邮件匹配的，则更新。
    • $listId：更新中联系人所属列表的 ID
    • $contactId：正在更新的联系人的 ID
    • $email：要更新的联系人的电子邮件地址
    • $firstName：联系人的名字
    • $lastName：联系人的姓氏
    • $phone：联系人的电话号码
    • $fax：联系人的传真号码
    • $uid：联系人的 UID
    • $customField：以关联数组形式传递的自定义字段。键代表字段名称，值代表值。
    • $addTags：要添加到联系人的标签。简单的标签名称数组。
    • $removeTags：要从联系人中删除的标签。简单的标签名称数组。
    • $removeFromDNM：将此设置为true，以将联系人订阅到列表，并从DNM中删除。
    • $subscribe：将此设置为true以将联系人订阅到列表；否则为false。

  • createOrUpdateForList( int $listId, string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = true, bool $subscribe = true )

    • 在列表中创建联系人。如果通过电子邮件匹配先前的联系人，则更新。
    • $listId：要为联系人创建的列表的ID。
    • $email：要创建或更新的联系人的电子邮件地址。
    • $firstName：联系人的名字
    • $lastName：联系人的姓氏。
    • $phone：联系人的电话号码
    • $fax：联系人的传真号码
    • $uid：联系人的UID。
    • $customField：以关联数组形式传递的自定义字段。键代表字段名称，值代表值。
    • $addTags：要添加到联系人的标签。简单的标签名称数组（字符串）。
    • $removeTags：要从联系人中删除的标签。简单的标签名称数组（字符串）。
    • $removeFromDNM：将此设置为true以将联系人订阅到列表，并从DNM中删除。
    • $subscribe：将联系人订阅到列表为true；否则为false。

  • createOrUpdateContact( int $contactId, string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = true, bool $subscribe = true )

    • 创建不带列表的联系人。如果传递了已存在的电子邮件，则更新。
    • $contactId：联系人的ID。
    • $email：要创建或更新的联系人的电子邮件地址。
    • $firstName：联系人的名字
    • $lastName：联系人的姓氏。
    • $phone：联系人的电话号码
    • $fax：联系人的传真号码
    • $uid：联系人的UID。
    • $customField：以关联数组形式传递的自定义字段。键代表字段名称，值代表值。
    • $addTags：要添加到联系人的标签。简单的标签名称数组（字符串）。
    • $removeTags：要从联系人中删除的标签。简单的标签名称数组（字符串）。
    • $removeFromDNM：将此设置为true以将联系人订阅到列表，并从DNM中删除。

  • createOrUpdateForListsAndWorkflows( string $email, string $firstName = null, string $lastName = null, string $phone = null, string $fax = null, string $uid = null, array $customField = [], array $addTags = [], array $removeTags = [], bool $removeFromDNM = false, array $subscribeListIds = [], array $unsubscribeListIds = [], array $unsubscribeWorkflowIds = [], string $unsubscribeCampaign = null )

    • 创建或更新联系人
      • 可以订阅或取消订阅多个列表。
      • 可以取消订阅多个工作流程。
    • $email：要创建或更新的联系人的电子邮件地址。
    • $firstName：联系人的名字
    • $lastName：联系人的姓氏
    • $phone：联系人的电话号码
    • $fax：联系人的传真号码
    • $uid：联系人的 UID
    • $customField：以关联数组形式传递的自定义字段。键代表字段名称，值代表值。
    • $addTags：要添加到联系人的标签。简单的标签名称数组（字符串）。
    • $removeTags：要从联系人中删除的标签。简单的标签名称数组（字符串）。
    • $removeFromDNM：将此设置为true以将联系人订阅到列表，并从DNM中删除。
    • $subscribeListIds：要订阅联系人到的列表ID的简单数组。
    • $unsubscribeListIds：要从联系人取消订阅的列表ID的简单数组。
    • $unsubscribeWorkflowIds：要从联系人取消订阅的工作流程ID的简单数组。
    • $unsubscribeCampaign：要取消订阅联系人的活动ID。

  • deleteFromAllLists(string $email)

    • 从所有列表中删除指定的联系人。
    • $email：联系人的电子邮件地址

  • deleteFromLists(int $contactId, array $listIds = [])

    • 从指定的列表中删除指定的联系人。
    • $contactId：联系人的id。
    • $listIds：列表id的简单数组。

  • deleteContactForUid(string $uid)

    • 删除具有指定UID的联系人。

  • deleteListContact(int $listId, int $contactId)

    • 从指定的列表中删除指定的联系人。

  • unsubscribeAll(string $contactFieldValue, string $contactFieldName = 'email')

    • 取消具有指定字段名称/值的联系人的订阅。
    • $contactFieldValue：被取消订阅的联系人字段的值
    • $contactFieldName：正在检查值的字段名称。目前，接受的字段名称有：'email' 或 'uid'

旅程

实例化

new Maropost.Api.Journeys($myAccountId, $myAuthToken)

可用方法

  • get(int $page)

    • 获取旅程列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • getCampaigns(int $journeyId, int $page)

    • 获取指定旅程的所有活动列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • getContacts(int $journeyId, int $page)

    • 获取指定旅程的所有联系人列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • stopAll(int $contactId, string $recipientEmail, string $uid)

    • 停止所有旅程，根据匹配的参数进行过滤
    • $contactId：除非大于0，否则此过滤器被忽略
    • $recipientEmail：如果为null，则忽略此过滤器
    • $uid：如果为null，则忽略此过滤器

  • pauseJourneyForContact(int $journeyId, int $contactId)

    • 暂停指定联系人的指定旅程

  • pauseJourneyForUid(int $journeyId, string $uid)

    • 暂停具有指定UID的联系人指定的旅程

  • resetJourneyForContact(int $journeyId, int $contactId)

    • 重置指定联系人指定的活动。将联系人重置到旅程开始将导致发送与最初发送相同的旅程活动。

  • public function resetJourneyForUid(int $journeyId, string $uid)

    • 重置具有指定UID的活动/暂停的联系人。将联系人重置到旅程开始将导致发送与最初发送相同的旅程活动。

  • public function startJourneyForContact(int $journeyId, int $contactId)

    • 为暂停的联系人重新启动旅程。在旅程中添加新的联系人。重新触发完成旅程一次的联系人。（要重新触发，请确保“重新触发旅程”选项已启用。）

  • startJourneyForUid(int $journeyId, string $uid)

    • 为具有指定UID的暂停联系人重新启动旅程。在旅程中添加新的联系人。重新触发完成旅程一次的联系人。（要重新触发，请确保“重新触发旅程”选项已启用。）

产品和收入

实例化

new Maropost.Api.ProductAndRevenue($myAccountId, $myAuthToken)

可用方法

  • getOrder(int $id)

    • 获取指定订单

  • getOrderForOriginalOrderId(string $originalOrderId)

    • 获取指定订单

  • createOrder(bool $requireUnique, string $contactEmail, string $contactFirstName, string $contactLastName, string $orderDateTime, string $orderStatus, string $originalOrderId, array $orderItems, array $customFields = null, array $addTags = null, array $removeTags = null, string $uid = null, string $listIds = null, string $grandTotal = null, int $campaignId = null, string $couponCode = null)

    • 创建订单
    • $requireUnique：如果为true，则验证订单对于给定的联系人具有唯一的original_order_id。
    • $contactEmail
    • $contactFirstName
    • $contactLastName
    • $orderDateTime：使用格式：“YYYY-MM-DDTHH:MM:SS-05:00”
    • $orderStatus
    • $originalOrderId：设置original_order_id字段
    • $orderItems是一个包含 \mataluis2k\marapost\InputTypes\OrderItemInput 对象的数组。
    • $customFields关联数组，其中键（字符串）表示字段名称，值是字段值
    • $addTags要添加的标签的简单数组（标量值）
    • $removeTags要删除的标签的简单数组（标量值）
    • $uid
    • $listIdsCSV列表的ID（例如，“12,13”）
    • $grandTotal
    • $campaignId
    • $couponCode

  • updateOrderForOriginalOrderId(string $originalOrderId, string $orderDateTime, string $orderStatus, array $orderItems, int $campaignId = null, string $couponCode = null)

    • 如果由于部分退货或其他更新而更改了详细信息，则使用唯一的original_order_id更新现有电子商务订单。
    • $originalOrderId：与订单的original_order_id字段匹配
    • $orderDateTime：使用格式：YYYY-MM-DDTHH:MM:SS-05:00
    • $orderStatus
    • $orderItems：重新声明orderItems为OrderItemInput对象的数组。
    • $campaignId
    • $couponCode

  • updateOrderForOrderId(int $orderId, string $orderDateTime, string $orderStatus, array $orderItems, int $campaignId = null, string $couponCode = null)

    • 根据订单_id更新现有电子商务订单，如果由于部分退货或其他更新导致详细信息发生变化。
    • $orderId：与订单的Maropost order_id字段匹配
    • $orderDateTime：使用格式：YYYY-MM-DDTHH:MM:SS-05:00
    • $orderStatus
    • $orderItems：重新声明orderItems为OrderItemInput对象的数组。
    • $campaignId
    • $couponCode

  • deleteForOriginalOrderId(string $originalOrderId)

    • 如果订单被取消或退货，则删除整个电子商务订单
    • $originalOrderId：与订单的original_order_id字段匹配

  • deleteForOrderId(int $id)

    • 使用Maropost订单id，如果订单被取消或退货，则删除整个电子商务订单
    • $id：Maropost订单_id

  • deleteProductsForOriginalOrderId(string $originalOrderId, array $productIds)

    • 如果产品被取消或退货，则从整个电子商务订单中删除指定的产品
    • $originalOrderId：与订单的original_order_id字段匹配
    • $productIds：要从中删除的订单中的产品

  • deleteProductsForOrderId(int $id, array $productIds)

    • 如果产品被取消或退货，则从整个电子商务订单中删除指定的产品
    • $id：Maropost订单_id
    • $productIds：要从中删除的订单中的产品

关系表

实例化

与其他服务不同，此构造函数需要第三个参数：$tableName。例如

$svc = new Maropost.Api.RelationalTables($myAccountId, $myAuthToken, $tableName);

$tableName 设置了服务的操作应针对哪个关系表。要切换表，您不需要重新实例化服务。相反，您可以调用

$svc->_setTableName($newTableName);

您还可以调用 _getTableName() 以确定当前设置了哪个表。

可用函数

  • get()

    • 获取关系表的记录

  • show(int $id)

    • 从关系表中获取指定的记录
    • $id：要读取的现有记录的ID

  • create(KeyValue... $keyValues)

    • 向关系表添加记录
    • ...$keyValues：要创建的记录的多个Maropost.Api.InputTypes.KeyValue对象，每个对象包含两个字段
      • $key：表示字段名称的字符串
      • $value：表示字段新值的标量值。
        • 任何DateTime字符串都必须采用以下三种格式之一：“MM/DD/YYYY”，“YYYY-MM-DD”或“YYYY-MM-DDThh:mm:ssTZD”。
      • 注意：其中一个KeyValues必须代表唯一标识符。

  • update(KeyValue... $keyValues)

    • 更新关系表中的记录。
    • ...$keyValues：要更新的记录的多个Maropost.Api.InputTypes.KeyValue对象，每个对象包含两个字段
      • $key：表示字段名称的字符串
      • $value：表示字段新值的标量值。
        • 任何DateTime字符串都必须采用以下三种格式之一：“MM/DD/YYYY”，“YYYY-MM-DD”或“YYYY-MM-DDThh:mm:ssTZD”。
      • 注意：其中一个KeyValues必须代表唯一标识符。

  • upsert(KeyValue... $keyValues)

    • 在关系表中创建或更新记录。
    • ...$keyValues：要创建或更新的记录的多个Maropost.Api.InputTypes.KeyValue对象，每个对象包含两个字段
      • $key：表示字段名称的字符串
      • $value：表示字段新值的标量值。
        • 任何DateTime字符串都必须采用以下三种格式之一：“MM/DD/YYYY”，“YYYY-MM-DD”或“YYYY-MM-DDThh:mm:ssTZD”。
      • 注意：其中一个KeyValues必须代表唯一标识符。

  • delete(int $idFieldName, $idFieldValue)

    • 删除关系表中的给定记录
    • $idFieldName：表示唯一标识符的字段名称（例如，“id”，“email”）
    • $idFieldValue：标识字段值，用于删除记录。

报告

实例化

new Maropost.Api.Reports($myAccountId, $myAuthToken)

可用方法

  • get(int $page)

    • 返回报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。

  • getReport(int $id)

    • 获取报告列表
    • $id：报告ID

  • getOpens( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null )

    • 根据提供的筛选器和字段返回打开的报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $fields：获取这些联系人字段
    • $from：日期范围筛选的开始
    • $to：日期范围筛选的结束
    • $unique：当为true时，仅获取唯一的打开项
    • $email：按提供的联系人中的电子邮件筛选
    • $uid：按uid筛选
    • $per：确定每个请求接收的记录数

  • getClicks( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null )

    • 返回点击报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $fields：如果存在，则提取这些联系人字段
    • $from：特定日期范围筛选的开始
    • $to：日期范围筛选的结束
    • $unique：如果为 true，则获取唯一记录
    • $email：获取特定电子邮件的点击量
    • $uid：获取提供的 uid 的点击量
    • $per：获取指定数量的记录

  • getBounces( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, string $type = null, int $per = null )

    • 返回弹跳报告列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $fields：如果存在，则提取这些联系人字段
    • $from：特定日期范围筛选的开始
    • $to：日期范围筛选的结束
    • $unique：如果为 true，则获取唯一记录
    • $email：获取特定电子邮件的弹跳报告
    • $uid：获取提供的 uid 的弹跳报告
    • $per：获取指定数量的记录

  • getUnsubscribes( int $page, array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null )

    • 返回具有提供过滤约束的取消订阅列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $fields：如果存在，则提取这些联系人字段
    • $from：特定日期范围筛选的开始
    • $to：日期范围筛选的结束
    • $unique 如果为 true，则获取唯一记录
    • $email 获取特定电子邮件的取消订阅
    • $uid 获取提供的 uid 的取消订阅
    • $per 获取指定数量的记录

  • getComplaints( array $fields = [], string $from = null, string $to = null, bool $unique = null, string $email = null, string $uid = null, int $per = null )

    • 返回根据提供的参数过滤的投诉列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $fields：如果存在，则提取这些联系人字段
    • $from：特定日期范围筛选的开始
    • $to：日期范围筛选的结束
    • $unique：如果为 true，则获取唯一记录
    • $email：获取特定电子邮件的投诉
    • $uid：获取提供的 uid 的投诉
    • $per：获取指定数量的记录

  • getAbReports( string $name, int $page, string $from = null, string $to = null, int $per = null )

    • 返回 Ab 报告列表
    • $name：获取具有指定名称的 ab_reports
    • $page：页面号（>= 1）。每页最多返回 200 条记录。
    • $from：日期范围过滤的开始
    • $to：日期范围筛选的结束
    • $per：获取指定数量的报告

  • getJourneys(int $page)

    • 返回所有旅程列表
    • $page：页面号（>= 1）。每页最多返回 200 条记录。