balerka/yandex-metrika-offline-conversion-php

Yandex Metrika Offline Conversion PHP APIv2

1.0.0 2024-03-18 11:14 UTC

Requires

• php: ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6|^7

MIT

• Artem Iksanov, Balerka

README

PHP >=8.0

Клиент для управления офлайн-данными Яндекс.Метрики используя API

Внимание! API находится в стадии разработки.

Installation

Для того чтобы подключить библиотеку в свой проект, можно воспользоваться composer

composer require balerka/yandex-metrika-offline-conversion-php

Usage

Пример загрузки офлайн-конверсий

При добавлении конверсии используется метод:

addConversion(
	$clid, 				// идентификатор посетителя сайта
	$target,  			// идентификатор цели
	$dateTime = null, 	// дата и время конверсии в формате unix timestamp (по умолчанию - текущее)
	$price = null, 		// цена (не обязательно)
	$currency = null 	// валюта (не обязательно)
);

use Balerka\YandexMetrikaOfflineConversion\tokenSession;

$oauthToken = 'dsERGE4564GBFDG34t3GDEREBbrgbdfbg4564DG3'; // OAuth-токен
$counterId = 123456; // идентификатор счетчика
$client_id_type = Syntax::CLIENT_ID_TYPE_CLIENT; // или USER / YCLID

$metrikaOffline = new tokenSession($oauthToken);
$metrikaConversionUpload = $metrikaOffline->params($counterId, $client_id_type));
$metrikaConversionUpload->comment('Комментарий к загрузке'); // Опционально

$metrikaConversionUpload->addConversion('133591247640966458', 'GOAL1', '1481718166'); // Добавляем конверсию
$metrikaConversionUpload->addConversion('579124169844706072', 'GOAL3', '1481718116', '678.90', 'RUB'); // Добавляем ещё конверсию
/* ... и далее добавляем необходимое количество конверсий ... */

$uploadResult = $metrikaConversionUpload->send(); // Отправляем данные. $uploadResult содержит информацию о передаче, в соответствии с объектом "uploading"