adsensor/adsensor-api-php-sdk

Adsensor 广告系统 API - PHP SDK

v1.2 2018-03-06 14:13 UTC

This package is not auto-updated.

Last update: 2024-09-22 08:58:05 UTC


README

通过这个库,您可以使用 adsensor 广告系统

安装

安装此扩展的首选方式是通过 composer

运行

php composer.phar require --prefer-dist adsensor/adsensor-api-php-sdk "dev-master"

或添加

"adsensor/adsensor-api-php-sdk": "dev-master"

到您的 composer.json 文件的 require 部分。

配置应用程序

为配置 API 添加以下代码

use Adsensor\API\AdMedia;
use Adsensor\API\AdsensorAPI;
use Adsensor\API\Campaign;
use Adsensor\API\TelegramAd;

$token = 'KEY-XXXX';
AdsensorAPI::init($token);

使用方法

获取用户信息并测试 API

$user = AdsensorAPI::me();
if($user !== null) {
    echo '<pre>';
    print_r($user);
    echo '</pre>';
}

获取所有类别的列表

// create a new campaign
$campaign = new Campaign();
$categories = $campaign->getCategories();

echo '<pre>';
print_r($categories);
echo '</pre>';

创建活动

// create a new campaign
$campaign = new Campaign(null, [
    Campaign::NAME => 'campaign name',
    Campaign::TYPE => Campaign::TYPE_ENGAGE, // campaign KPI Range : TYPE_ENGAGE - TYPE_VIRAL - TYPE_BRANDING
    Campaign::CATEGORY => [1, 2, 3] // categories ID
]);

if( $campaign->validate() && $campaign->create() )
{
    // campaign created ...
    $campaign_id = $campaign->{Campaign::ID}; // access campaign ID
}

上传活动文件

$media = new AdMedia();
$file_path = __DIR__ . '/image.jpg'; // file directory

if( $media->create($file_path) )
{
    // new media created successfully
    $media_id = $media->{AdMedia::ID}; // access media ID
}

创建新的 Telegram 广告

$campaign_id = ''; // insert campaign ID here
$media_id = ''; // insert media ID here
$telegramAd = new TelegramAd(null, $campaign_id);

$telegramAd->setData([
    TelegramAd::BUDGET  => 3000000, // budget (Rial)
    TelegramAd::TEXT    => 'test content...', // text of ad
    TelegramAd::MEDIA   => $media_id // fetch media by ID 
]);

if($telegramAd->validate() && $telegramAd->create())
{
    // telegram ad created successfully
    $telegramAd_id = $telegramAd->{TelegramAd::ID}; // access Ad by ID
    
    // pay & active telegram ad
    if( $telegramAd->active() ) {
        // Telegram ad activated successfully
    }
}

通过 ID 获取活动数据

$campaign_id = ''; // insert campaign ID here
$campaignInfo = new Campaign($campaign_id);

echo '<pre>';
print_r($campaignInfo->read());
echo '</pre>';

您的活动列表

$campains = new Campaign();

echo '<pre>';
print_r($campains->all());
echo '</pre>';

通过 ID 获取 Instagram 广告数据

$instagram_ad_id = ''; // insert Instagram AD ID here
$adInfo = new InstagramAd($instagram_ad_id);

echo '<pre>';
print_r($adInfo->read());
echo '</pre>';