README

功能

身份验证重试系统
内联代码文档
将报告结果保存到文件

安装

Criteo MAPI 包可以通过 Composer 安装

composer require jpikowski/criteo-mapi-php-client:"^1.0"

安装后，请确保通过自动加载器包含您的依赖项

require_once __DIR__ . 'vendor/autoload.php';

基本代码示例

初始化

require_once __DIR__ . 'vendor/autoload.php'; //Composer Dependencies

$criteo = new Criteo_MAPI( 'username', 'password' );

基本请求

API 请求的结果以结果关联数组的形式返回。

$criteo->getCampaignsByAdvertiser( '12345' );

身份验证重试

从/oauth2/token端点检索的 OAuth2 令牌有效期为 5 分钟。

初始化后的第一次请求，MAPI 客户端将根据提供的用户名和密码请求身份验证令牌并继续请求。

第一次请求（无存储身份验证）

对于后续请求，存储的令牌可能因长时间运行的过程而无效。MAPI 客户端将自动检测需要刷新令牌，并重试一次由于 401 未授权 错误而失败的请求。

带有过期或无效令牌的请求

其他功能

将报告保存到文件

对于报告 API 调用，可以提供一个文件路径以可选地将结果保存到本地路径。

	$query = [
		'reportType' => 'CampaignPerformance',
		'advertiserIds' => '12345',
		'startDate' => '2019-01-15',
		'endDate' => '2019-01-16',
		'dimensions' => [
			'CampaignId',
			'AdvertiserId',
			'Day'
		],
		'metrics' => [
			'Clicks',
			'Displays'
		],
		'format' => 'csv',
		'currency' => 'USD',
		'timezone' => 'PST'
	];

$criteo->getStats($query, './reports/results.csv');

进一步文档

MAPI 文档（Criteo 帮助中心）

MAPI 规范和测试工具（Swagger）

许可

MIT

jpikowski / criteo-mapi-php-client

维护者

详细信息