README

从 kradwhite/mytarget-api-client 分支

要求

• PHP 7.0 及以上

安装

通过 composer

composer require dugard/mytarget

使用

目录

1. 获取令牌
2. 初始化客户端
3. 客户端配置
4. 查询示例
5. 实用信息

获取令牌

use dugard\myTarget\oauth2\Oauth2;

$oauth = new Oauth2();
$token = $oauth->clientCredentialsGrant('client_id', 'client_secret')->request();
$access_token = $token['access_token'];

关于其他类型令牌的信息可以在 dugard\mytarget-oauth2 中了解

初始化客户端

use dugard\myTarget\api\Client;

$client = new Client($access_token);

客户端配置

$config = [
    // по умолчанию false. Если true, запросы будут отправляться к песочнице myTarget.
    'sandbox' => true,
    // по умолчанию true. Если true, ответом на запросы к myTarget будет ассоциативный массив,
    // в противно случае объект.
    'assoc' => false,
    // по умолчанию false. Включает опцию debug
    // http://docs.guzzlephp.org/en/stable/request-options.html#debug.
    'debug' => true,
    // по умолчанию 0. Установка опции timeout
    // http://docs.guzzlephp.org/en/stable/request-options.html#timeout.
    'timeout' => 0,
    // по умолчанию dugard\myTarget\transport\Transport. Имя класса реализующего
    // интерфейс dugard\mytarget\transport\TransportInterface.
    'transport' => Class::name,
];

// инициализация клиента с конфигурацией
$client = new Client($access_token, $config);

查询示例

// получение кампаний
$allCampaigns = $client->campaigns()->get();

// получение активных кампаний
$activedCampaigns = $client->campaigns()->get([
    '_status' => 'active',
    'sorting' => 'id'
]);

// создание ссылки
$newUrlId = $client->createUrl()->post([
    'url' => 'http://example.com/123456789?1=1'
]);

// редактирование рекламного объявления
$response = $client->banner()->post([
    'status' => 'blocked'
]);

// запрос статистика по кампании
$statistics = $client->statistics()->get(
    // название ресурса campaigns, banners или user
    'campaigns',
    // id ресурса, или несколько id через запятую
    '1234',
    // по умолчанию base, метрика
    'base',
    // по умолчанию summary, summary или days. Eсли days, нужно указать 
    // 2 следующих параметры в виде даты
    'day',
    // дата начала статистики
    '2019-10-08'
    // дата конца статистика
    '2019-11-01'
);

实用信息

• 在 dugard\myTarget\api\Client 类中，每个方法前面都有注释，其中包含指向 myTarget 文档中相应资源的官方页面的链接。
• 客户端方法名称与官方文档中资源名称相同。