PHPackages                             kadam/php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. kadam/php-sdk

ActiveLibrary[Utility & Helpers](/categories/utility)

kadam/php-sdk
=============

PHP-SDK for kadam.net

1.5.0(5y ago)02.3k1MITPHPPHP >=7.0

Since Dec 3Pushed 4y ago1 watchersCompare

[ Source](https://github.com/kadam-official/php-sdk)[ Packagist](https://packagist.org/packages/kadam/php-sdk)[ Docs](https://kadam.net)[ RSS](/packages/kadam-php-sdk/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (8)Dependencies (1)Versions (9)Used By (0)

KADAM PHP-SDK
=============

[](#kadam-php-sdk)

Overview
--------

[](#overview)

- [Installation](#install)
- Campaigns
    - [Create Campaign](#campaign-create)
    - [Update Campaign](#campaign-update)
    - [Toggle Campaign State](#campaign-update-state)
    - [Stats Campaign](#campaign-stats)
    - [Campaign Placement Stats](#campaign-placement-stats)
    - Targeting
        - [Ages](#target-ages)
        - [Browsers](#target-browsers)
        - [Platforms](#target-platforms)
        - [Devices](#target-devices)
        - [Languages](#target-langs)
        - [Countries](#target-countries)
        - [Regions](#target-regions)
        - [Cities](#target-cities)
- Advertisements
    - [Create Advertisement (ex.Teaser)](#adv-create)
    - [Update Advertisement (ex.Teaser)](#adv-update)
    - [Archive Advertisements Enable/Disable](#adv-archive)
    - [Update Advertisements State](#adv-state)
- Creatives
    - [Creative Stats](#creative-stats)
- Images
    - [Upload Image](#upload-image)
- Materials
    - [Banner Sizes](#banner-sizes)
- Data
    - [Geo Countries](#geo-countries)
    - [Geo Regions](#geo-regions)
- [Examples](./examples)
- [Changelog](./CHANGELOG.md)

 Installation
------------------------------------------------

[](#-installation)

### Step 1

[](#step-1)

```
composer require kadam/php-sdk

```

### Step 2

[](#step-2)

#### Variant 1

[](#variant-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);
```

#### Variant 2

[](#variant-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);
```

 Create Campaign
-----------------------------------------------------------

[](#-create-campaign)

```
/** @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);
```

 Update Campaign
-----------------------------------------------------------

[](#-update-campaign)

```
$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);
```

 Stats Campaign
---------------------------------------------------------

[](#-stats-campaign)

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

 Campaign Placement Stats
-----------------------------------------------------------------------------

[](#-campaign-placement-stats)

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

 Ages target
---------------------------------------------------

[](#-ages-target)

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

### result

[](#result)

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

```

 Browsers target
-----------------------------------------------------------

[](#-browsers-target)

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

### result

[](#result-1)

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

```

 Platforms target
-------------------------------------------------------------

[](#-platforms-target)

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

### result

[](#result-2)

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

```

 Languages target
---------------------------------------------------------

[](#-languages-target)

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

### result

[](#result-3)

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

```

 Devices target
---------------------------------------------------------

[](#-devices-target)

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

### result

[](#result-4)

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

```

 Countries target
-------------------------------------------------------------

[](#-countries-target)

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

### result

[](#result-5)

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

```

 Regions target
---------------------------------------------------------

[](#-regions-target)

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

### result

[](#result-6)

```
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
    }
    ....
  }
}

```

 Cities target
-------------------------------------------------------

[](#-cities-target)

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

### result

[](#result-7)

```
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
    }
    ....
  }
}

```

 Create Teaser
----------------------------------------------------

[](#-create-teaser)

```
$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);
```

 Update Teaser
----------------------------------------------------

[](#-update-teaser)

```
$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);
```

 Archive Advertisements Enable/Disable
-----------------------------------------------------------------------------

[](#-archive-advertisements-enabledisable)

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

 Update Advertisements State
-----------------------------------------------------------------

[](#-update-advertisements-state)

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

 Banner Sizes
-----------------------------------------------------

[](#-banner-sizes)

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

### result

[](#result-8)

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

```

 Creative Stats
---------------------------------------------------------

[](#-creative-stats)

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

 Upload Image
-------------------------------------------------------

[](#-upload-image)

```
$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);
```

### result

[](#result-9)

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

```

 Geo Countries
-------------------------------------------------------

[](#-geo-countries)

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

 Geo Regions
---------------------------------------------------

[](#-geo-regions)

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

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~40 days

Recently: every ~47 days

Total

8

Last Release

1706d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/45e2d0dae2036b3074f04ccb0592b5888c8503a3d3246104947087e7356b5c25?d=identicon)[SIA Kadam](/maintainers/SIA%20Kadam)

---

Top Contributors

[![darkfriend](https://avatars.githubusercontent.com/u/7825114?v=4)](https://github.com/darkfriend "darkfriend (1 commits)")[![shadowspan](https://avatars.githubusercontent.com/u/49658769?v=4)](https://github.com/shadowspan "shadowspan (1 commits)")

---

Tags

phpsdkkadamkadam sdk

### Embed Badge

![Health badge](/badges/kadam-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/kadam-php-sdk/health.svg)](https://phpackages.com/packages/kadam-php-sdk)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)