README

概述

• 安装
• 活动
  • 创建活动
  • 更新活动
  • 切换活动状态
  • 活动统计
  • 活动投放统计
  • 定位
    • 年龄
    • 浏览器
    • 平台
    • 设备
    • 语言
    • 国家
    • 地区
    • 城市
• 广告
  • 创建广告（例如：预告片）
  • 更新广告（例如：预告片）
  • 启用/禁用存档广告
  • 更新广告状态
• 创意
  • 创意统计
• 图片
  • 上传图片
• 材料
  • 横幅尺寸
• 数据
  • 地理国家
  • 地理地区
• 示例
• 变更日志

安装

步骤 1

composer require kadam/php-sdk

步骤 2

变体 1

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

$appId = 10;
$secretKey = 'you_secret_key'; // or token if auth by bearer token

// initial with signature
$kadamApi = new \kadam\KadamApi($appId, $secretKey);

变体 2

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

$appId = 10;
$token = 'you_bearer_token';

// initial with bearer token
$kadamApi = new \kadam\KadamApi($appId, $token, \kadam\KadamApi::MODE_BEARER);

创建活动

/** @var \kadam\KadamApi $kadamApi */
$id = $kadamApi->createCampaign([
    'ad_format' => 10, // teaser
    'cost_type' => 0, // cpc
    'name' => 'Ads campaign',
    'linkUrl' => 'https://darkfriend.ru',
    'realUrl' => 'https://darkfriend.ru',
    'age' => '1,2,4',
    'gender' => 3,
    'tags' => ['key1', 'key2', 'key3'],
    'geoExclude' => 0,
    'langs' => [0,1,2,3,4,5,6,7,8,9,10],
    'cities' => [5819],
    'countries' => [
        187 => [
            'bid' => 0.2,
            'leadCost' => 0.8,
        ],
        83 => [
            'bid' => 0.5,
            'leadCost' => 1,
        ],
        20 => [
            'bid' => 0.5,
            'leadCost' => 1,
        ],
    ],
    'regions' => [50360],
//    'black_list' => ['123', '456'], // if need black list
//    'white_list' => ['321', '654'], // if need  white list
]);
var_dump($id);

更新活动

$campaignId = 1;
/** @var \kadam\KadamApi $kadamApi */
$id = $kadamApi->updateCampaign($campaignId, [
    'name' => 'Ads campaign update',
    'geoExclude' => 0,
    'langs' => [0,1,2,3,4,5,6,7,8,9,10],
    'cities' => [5819],
    'countries' => [
        187 => [
            'bid' => 0.2,
            'leadCost' => 0.8,
        ],
        83 => [
            'bid' => 0.5,
            'leadCost' => 1,
        ],
        20 => [
            'bid' => 0.5,
            'leadCost' => 1,
        ],
    ],
    'regions' => [50360],
//    'black_list' => ['123', '456'], // if need black list
//    'white_list' => ['321', '654'], // if need  white list
]);
var_dump($id);

活动统计

$campaignId = [1];
/** @var \kadam\KadamApi $kadamApi */
$stats = $kadamApi->getCampaignStats(
    $campaignId,
    ['date','campaign'],
    '2020-01-01',
    '2020-02-01'
);
var_dump($stats);

活动投放统计

$campaignId = [1];
/** @var \kadam\KadamApi $kadamApi */
$stats = $kadamApi->getCampaignPlacementStats(
    $campaignId,
    '2020-01-01',
    '2020-02-01'
);
var_dump($stats);

年龄目标

/** @var \kadam\KadamApi $kadamApi */
$ages = $kadamApi->getAgesTarget();
var_dump($ages);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"]=> int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

浏览器目标

/** @var \kadam\KadamApi $kadamApi */
$browsers = $kadamApi->getBrowsersTarget();
var_dump($browsers);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"]=> int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

平台目标

/** @var \kadam\KadamApi $kadamApi */
$platforms = $kadamApi->getPlatformsTarget();
var_dump($platforms);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"]=> int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

语言目标

/** @var \kadam\KadamApi $kadamApi */
$langs = $kadamApi->getLangsTarget();
var_dump($langs);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"]=> int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

设备目标

/** @var \kadam\KadamApi $kadamApi */
$devices = $kadamApi->getDevicesTarget();
var_dump($devices);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"] => int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

国家目标

/** @var \kadam\KadamApi $kadamApi */
$countries = $kadamApi->getCountriesTarget();
var_dump($countries);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"] => int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

地区目标

/** @var \kadam\KadamApi $kadamApi */
$regions = $kadamApi->getRegionsTarget();
var_dump($regions);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"] => int
      ["title"] => string
      ["countryId"] => int
      ["subdivisionId"] => int
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
      ["countryId"] => int
      ["subdivisionId"] => int
    }
    ....
  }
}

城市目标

/** @var \kadam\KadamApi $kadamApi */
$cities = $kadamApi->getCitiesTarget();
var_dump($cities);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"] => int
      ["title"] => string
      ["countryId"] => int
      ["subdivisionId"] => int
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
      ["countryId"] => int
      ["subdivisionId"] => int
    }
    ....
  }
}

创建预告片

$campaignId = 1;
$link = 'https://darkfriend.ru/img/darkfriend.jpg';

/** @var \kadam\KadamApi $kadamApi */
$id = $kadamApi->createMaterial($campaignId, 10, [
    'title' => 'Test teaser',
    'linkUrl' => 'https://darkfriend.ru', // schema and host as in campaign
    'linkMedia' => \file_get_contents($link),
//    'linkMediaRect' => $linkRect, // rectangle picture
    'bids' => [
        187 => [
            'bid' => 0.2,
        ],
        83 => [
            'bid' => 0.5,
        ],
    ],
//    'categories' => [1,2,3],
]);
var_dump($id);

更新预告片

$materialId = 1;

/** @var \kadam\KadamApi $kadamApi */
$result = $kadamApi->updateMaterial($materialId, [
    'title' => 'New Title for teaser',
    'bids' => [
        187 => [
            'bid' => 0.3,
        ],
        83 => [
            'bid' => 0.4,
        ],
    ],
//    'categories' => [1,2,3],
]);
var_dump($result);

启用/禁用存档广告

$materialId = [1];
/** @var \kadam\KadamApi $kadamApi */
$result = $kadamApi->archiveAdvertisements($materialId);
var_dump($result);

更新广告状态

$materialId = 1;
/** @var \kadam\KadamApi $kadamApi */
$id = $kadamApi->toggleAdvertisementState(
    $materialId,
    10
);
var_dump($id);

横幅尺寸

/** @var \kadam\KadamApi $kadamApi */
$sizes = $kadamApi->getBannerSizes();
var_dump($sizes);

结果

array(2) {
  ["count"]=>int
  ["items"]=>
  array {
    [0]=>
    array(2) {
      ["id"] => int
      ["title"] => string
    }
    [1]=>
    array(2) {
      ["id"]=>int
      ["title"]=>string
    }
    ....
  }
}

创意统计

$campaignIds = [1];
$creativeIds = [1];
/** @var \kadam\KadamApi $kadamApi */
$stats = $kadamApi->getCreativeStats(
    $campaignIds,
    $creativeIds,
    ['date', 'creative'],
    '2020-01-01',
    '2020-02-01'
);
var_dump($stats);

上传图片

$url = 'http://site.ru/image.jpg';
// or
// $url = file_get_contents('http://site.ru/image.jpg');
// or 
// $url = file_get_contents(__DIR__.'/image.jpg');
$adType = 10;
/** @var \kadam\KadamApi $kadamApi */
$image = $kadamApi->uploadImage($url,$adType);
var_dump($image);

结果

https//kadam.net/path-to-file/file.extension

地理国家

/** @var \kadam\KadamApi $kadamApi */
$countries = $kadamApi->getGeoCountries();
var_dump($countries);

地理地区

/** @var \kadam\KadamApi $kadamApi */
$countryId = 2017370;
$regions = $kadamApi->getGeoRegions($countryId);
var_dump($regions);