kradwhite / mytarget-api-client
MyTarget API 客户端
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
README
一个简单易用的PHP客户端,用于MyTarget API。
要求
- PHP 7.0及以上版本
安装
在文件composer.json
{ ... "require": { ... "kradwhite/mytarget-api-client": "*" } ... }
使用
目录
获取令牌
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官方文档链接。
- 客户端方法名称与官方文档中的资源名称相同。