README

Mailchimp Marketing — PHP

此分支是基于官方 Mailchimp Marketing API 的 PHP 客户端库，使其与 Drupal 9 兼容，直到此 pull request 解决。

安装

选项 1： 通过 Packagist 安装

composer require testudio/mailchimp-marketing

或将以下内容添加到 composer.json

{
  "require": {
    "testudio/mailchimp-marketing": "*"
  }
}

使用以下命令安装所有 composer 依赖项

composer install

选项 2： 手动安装

克隆存储库

git clone git@github.com:testudio/mailchimp-marketing-php.git

在客户端库项目根目录中，安装所有依赖项

composer install

手动将 vendor/autoload.php 包含到您的实现中

require_once('/path/to/MailchimpMarketing/vendor/autoload.php');

快速入门

请注意，此 SDK 需要 PHP 7.2 或更高版本。

require_once('/path/to/MailchimpMarketing/vendor/autoload.php');

$mailchimp = new MailchimpMarketing\ApiClient();

$mailchimp->setConfig([
  'apiKey' => 'YOUR_API_KEY',
  'server' => 'YOUR_SERVER_PREFIX'
]);

$response = $mailchimp->ping->get();
print_r($response);

身份验证方法

客户端库可以配置为使用 基本身份验证 或 OAuth2。

对于任何一种方法，都应传递一个服务器前缀，例如 us19，以便客户端确定适当的 URL。

基本身份验证

$mailchimp->setConfig([
  'apiKey' => 'YOUR_API_KEY',
  'server' => 'YOUR_SERVER_PREFIX'
]);

OAuth2

$mailchimp->setConfig([
  'accessToken' => 'YOUR_ACCESS_TOKEN',
  'server' => 'YOUR_SERVER_PREFIX'
]);

PRs 和 Issues

此存储库是从 https://github.com/mailchimp/mailchimp-client-lib-codegen 自动生成的 - 请在此处提交 PR 或 issues！

其他配置选项

APIClient 类允许您设置各种配置选项，如超时、主机、用户代理和调试输出。有关更多详细信息，请参阅 https://github.com/mailchimp/mailchimp-marketing-php/blob/master/lib/Configuration.php。

API 端点

所有 URI 都相对于 https://server.api.mailchimp.com/3.0

示例

lists.createSegment

// Create tag (static).
$segment = $mailchimp->lists->createSegment($list_id, '{"name":"Tag 1","static_segment":[]}');
// Create segment (dynamic tag).
$segment = $mailchimp->lists->createSegment($list_id, 
  '{"name":"Segment 2","options":{"match":"any","conditions":[]}}');

lists.deleteSegment

$segment_id = $segment->id;
$segment_list_id = $segment->list_id;

$mailchimp->lists->deleteSegment($segment_list_id, $segment_id);

lists.getAllLists

$response = $mailchimp->lists->getAllLists();
foreach ($response->lists as $list) {
  $list_id = $list->id;
  $list_name = $list->name;
  ...
}

lists.getList

$list_id = '7f4f516be';
$list = $mailchimp->lists->getList($list_id);
if ($list) {
  $list_id = $list->id;
  $list_name = $list->name;
  ...
}

lists.getListInterestCategories

$response = $mailchimp->lists->getListInterestCategories($list_id);
foreach ($response->categories as $category) {
  $category_id = $category->id;
  $category_title = $category->title;
  ...
}

lists.listSegments

$list_id = '7f4f516be';
// Load up to 10 tags.
$response = $mailchimp->lists->listSegments($list_id);
// Load up to 200 tags.
$response = $mailchimp->lists->listSegments($list_id, NULL, NULL, '200');
if ($response) {
  foreach ($response->segments as $segment) {
    $segment_id = $segment->id;
    $segment_name = $segment->name;
    $segment_member_count = $segment->member_count;
    $segment_list_id = $segment->list_id;
  }
}

其他库

Mailchimp Marketing 库以下列语言可用