kradwhite/mytarget-api-client

MyTarget api client

0.1.15 2022-08-23 03:03 UTC

Requires

• php: >=7.1
• ext-json: *
• guzzlehttp/guzzle: ^7.4.5
• kradwhite/mytarget-oauth2: ^0.2.12

Requires (Dev)

• codeception/codeception: ^5.0.2
• codeception/module-asserts: ^2.0.1

BSD-3-Clause

• kradwhite

• api
• client
• myTarget
• kradwhite

README

Простой и удобный PHP-клиент для MyTarget Api.

Требования

• PHP 7.0 и выше

Установка

В файле composer.json:

{
    ...
    "require": {
        ...
        "kradwhite/mytarget-api-client": "*"
    }
    ...
}

Использование

Оглавление

1. Получение токена
2. Инициализация клиента
3. Конфигурация клиента
4. Примеры запросов
5. Полезная информация

Получение токена

use kradwhite\myTarget\oauth2\Oauth2;

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

Для получения информации по другим видам токенов можно познакомится в kradwhite\mytarget-oauth2

Инициализация клиента

use kradwhite\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,
    // по умолчанию kradwhite\myTarget\transport\Transport. Имя класса реализующего
    // интерфейс kradwhite\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'
);

Полезная информация

• В классе kradwhite\myTarget\api\Client перед каждым методом в комментариях имеется ссылка на оффициальную страницу в документации myTarget по запрашиваемому ресурсу.
• Имена методов клиента для получения ресурсов совпадают с именами ресурсов из официальной документации.