biplane/yandex-direct

PHP library for Yandex.Direct API

Friday, June 8, 2018
by yethee
Repository
7 Watchers
13 Stars
23,028 Installations

PHP
1 Dependents
0 Suggesters
5 Forks
0 Open issues
25 Versions
8 % Grown

The README.md

Yandex.Direct API PHP Client

, _(*1)

Библиотека для работы с API Директа., _(*2)

Формат взаимодействия: SOAP, _(*3)

NOTE: Библиотека совместима только с 64-битной версией PHP., _(*4)

Установка

Проще всего установить с помощью менеджера пакетов - composer., _(*5)

$ composer require biplane/yandex-direct

Дополнительно для работы с сервисом Reports

Для работы с сервисом Reports нужен HTTP-клиент, совместимый с PSR-18. В зависимостях не указана какая-то конкретная реализация. Вместо этого используется php-http/discovery для поиска подходящей реализации среди установленных пакетов, как стратегия по умолчанию., _(*6)

Примеры использования

Получение данных по объявлениям

Данный пример отражает взаимодействие с сервисом Ads для получения списка объявлений., _(*7)

<?php

use Biplane\YandexDirect\ApiServiceFactory;
use Biplane\YandexDirect\Api\V5\Ads;
use Biplane\YandexDirect\Api\V5\Contract;
use Biplane\YandexDirect\ConfigBuilder;

$serviceFactory = new ApiServiceFactory();

$config = ConfigBuilder::create()
    ->setAccessToken('<INSERT_ACCESS_TOKEN>')
    ->setClientLogin('agrom')
    ->setLocale('ru')
    ->getConfig();
$service = $serviceFactory->createService($config, Ads::class);

$campaignsIds = [123];

$criteria = Contract\AdsSelectionCriteria::create()
    ->setCampaignIds($campaignsIds)
    ->setStates([
        Contract\StateEnum::ON,
    ]);
$request = Contract\GetAdsRequest::create()
    ->setSelectionCriteria($criteria)
    ->setFieldNames([
        Contract\AdFieldEnum::AD_CATEGORIES,
        Contract\AdFieldEnum::AGE_LABEL,
        Contract\AdFieldEnum::AD_GROUP_ID,
        Contract\AdFieldEnum::ID,
        Contract\AdFieldEnum::STATUS,
    ]);

$response = $service->get($request);

foreach ($response->getAds() ?? [] as $item) {
    // Здесь $item будет являться экземпляром `Biplane\YandexDirect\Api\V5\Contract\AdGetItem`
    // Например, получение информации о возрастной метке:
    // $item->getAgeLabel();
}

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

В данном примере делается запрос на подготовку отчета, ожидаем его готовность, загружаем и сохраняем в файл., _(*8)


use Biplane\YandexDirect\Api\V5\Reports;
use Biplane\YandexDirect\ConfigBuilder;
use Biplane\YandexDirect\ReportServiceFactory;

$serviceFactory = new ReportServiceFactory();

$config = ConfigBuilder::create()
    ->setAccessToken('<INSERT_ACCESS_TOKEN>')
    ->setClientLogin('agrom')
    ->setLocale('ru')
    ->getConfig();
$service = $serviceFactory->createService($config);

$reportDefinition = Reports\ReportDefinition::create()
    ->setReportName('demo')
    ->setReportType(Reports\ReportTypeEnum::CAMPAIGN_PERFORMANCE_REPORT)
    ->setDateRangeType(Reports\DateRangeTypeEnum::LAST_7_DAYS)
    ->setFieldNames([
        Reports\FieldEnum::CAMPAIGN_ID,
        Reports\FieldEnum::CAMPAIGN_NAME,
        Reports\FieldEnum::IMPRESSIONS,
        Reports\FieldEnum::CLICKS,
        Reports\FieldEnum::COST,
    ])
    ->setIncludeVAT(false);

$request = Reports\ReportRequestBuilder::create()
    ->setReportDefinition($reportDefinition)
    ->returnMoneyInMicros(false)
    ->skipReportHeader(true)
    ->getReportRequest();

$result = $service->getReady($request);

$result->saveToFile('/path/to/file.tsv');

Логирование

Для логирования запросов к API можно реализовать интерфейс Biplane\YandexDirect\Log\SoapLogger. Либо использовать адаптер для psr/log:, _(*9)


use Biplane\YandexDirect\ApiServiceFactoryBuilder;
use Biplane\YandexDirect\Log\SoapLogger\PsrLogger;

$serviceFactory = ApiServiceFactoryBuilder::create()
    ->setLogger(new PsrLogger($psrLogger))
    ->getFactory();

// ...

В данной конфигурации все запросы к API будут записываться в журнал, но уровень логирования будет определяться ответом, успех или ошибка., _(*10)

Response	Log level
OK	`DEBUG`
Error	`ERROR`

Поддерживаемые сервисы API

Сервис	Документация
`V4\YandexAPIService`	API Live 4 doc
`V5\AdExtensions`	Doc
`V5\AdGroups`	Doc
`V5\AdImages`	Doc
`V5\Ads`	Doc
`V5\AgencyClients`	Doc
`V5\AudienceTargets`	Doc
`V5\BidModifiers`	Doc
`V5\Bids`	Doc
`V5\Campaigns`	Doc
`V5\Changes`	Doc
`V5\Clients`	Doc
`V5\Dictionaries`	Doc
`V5\DynamicTextAdTargets`	Doc
`V5\Feeds`	Doc
`V5\KeywordBids`	Doc
`V5\Keywords`	Doc
`V5\KeywordsResearch`	Doc
`V5\Leads`	Doc
`V5\NegativeKeywordSharedSets`	Doc
`V5\RetargetingLists`	Doc
`V5\Sitelinks`	Doc
`V5\SmartAdTargets`	Doc
`V5\Strategies`	Doc
`V5\TurboPages`	Doc
`V5\VCards`	Doc
`V5\Reports`	Doc

License

This package is licensed using the MIT License., _(*11)

The Versions

08/06 2018

dev-master

9999999-dev

PHP library for Yandex.Direct API

library yandex-direct

PHP library for Yandex.Direct API

biplane/yandex-direct

The README.md

Yandex.Direct API PHP Client

Установка

Дополнительно для работы с сервисом Reports

Примеры использования

Получение данных по объявлениям

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

Логирование

Поддерживаемые сервисы API

License

The Versions

dev-master

The Requires

The Development Requires

by Contributors

by Denis

4.5.0

The Requires

The Development Requires

by Contributors

by Denis

4.4.1

The Requires

The Development Requires

by Contributors

by Denis

4.4.0

The Requires

The Development Requires

by Contributors

by Denis

4.3.0

The Requires

The Development Requires

by Contributors

by Denis

4.2.0

The Requires

The Development Requires

by Contributors

by Denis

4.1.1

The Requires

The Development Requires

by Contributors

by Denis

4.1.0

The Requires

The Development Requires

by Contributors

by Denis

4.1.0-beta2

The Requires

The Development Requires

by Contributors

by Denis

4.1.0-beta1

The Requires

The Development Requires

by Contributors

by Denis

4.0.1

The Requires

The Development Requires

by Contributors

by Denis

4.0

The Requires

The Development Requires

by Contributors

by Denis

3.4.2

The Requires

The Development Requires

by Contributors

by Denis

3.4.1