TAŇBA-OOH Разработчикам

The audience multiplier of a quarter hour of a screen

GET /api/v1/market/multipliers

https://app.tanba-ooh.kz/api/v1/market/multipliers

Технический текст справочника написан на английском.

Scope read:inventory. Served only once the platform has switched the audience service on (it is off by default); until then 404. The multiplier is impacts divided by spots for the structure, the month, the ISO weekday and the quarter hour of at read in Almaty time, from the newest released release of an approved audience source. When the source has no row for that quarter hour the answer has no qty at all: there is no default value, and the placeholder audience estimate is never used. qty is the OpenRTB 2.6 object for imp.qty, with sourcetype 1 (measurement vendor) and vendor tanba-ooh.kz. Free for registered participants and the same for every one of them; a release is served to all from its release day.

Аутентификация

Ключ API в заголовке Authorization или сессия консоли.

Право доступа: read:inventory

Параметры

ИмяГдеТипОбязательныйОписаниеПример
structureзапросstringдаStructure code.ALM-0001
atзапросstring (date-time)даThe instant of the impression (RFC 3339).2027-03-10T10:07:00+05:00

Ответы

200 The slot, with `qty` when the source has a row for it.

application/json

MultiplierAnswer

ИмяТипОбязательныйОписаниеПример
structurestringдаStructure code."ALM-0001"
atstring (date-time)даThe instant asked about, Almaty time."2027-03-10T10:07:00+05:00"
slotobjectдаThe table cell the instant falls in.
slot.monthstringдаMonth in Almaty time."2027-03"
slot.weekdayintegerдаISO weekday, 1 Monday.3
slot.quarterintegerдаQuarter hour of the day, 0 is 00:00-00:15.40
qtyobjectOpenRTB 2.6 imp.qty; absent when no approved source has a row for the slot.
qty.multipliernumberдаImpressions per spot in this quarter hour.6.003
qty.sourcetypeintegerдаMeasurement vendor. 1
qty.vendorstringдаVendor domain. tanba-ooh.kz
sourceobjectWho measured it; present with qty.
source.vendorstringдаName of the audience source."Example Mobility Ltd"
source.releasestringдаLabel of the release."2027-A"

Пример

{
  "structure": "ALM-0001",
  "at": "2027-03-10T10:07:00+05:00",
  "slot": {
    "month": "2027-03",
    "weekday": 3,
    "quarter": 40
  },
  "qty": {
    "multiplier": 6.003,
    "sourcetype": 1,
    "vendor": "tanba-ooh.kz"
  },
  "source": {
    "vendor": "Example Mobility Ltd",
    "release": "2027-A"
  }
}

Ошибки

Ошибки приходят документом problem (application/problem+json) со стабильным полем code.

СтатусЗначение
401Нет действительной сессии или ключа API (unauthenticated, session_expired, invalid_api_key).
403Роль или право ключа этого не допускает (forbidden, key_scope_denied, key_route_denied).
404Ничего нет или вызывающему это не видно.
422Ошибки полей (validation_failed).
defaultОшибка в виде документа problem.

Примеры кода

curl

curl 'https://app.tanba-ooh.kz/api/v1/market/multipliers?structure=ALM-0001&at=2027-03-10T10%3A07%3A00%2B05%3A00' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Python
import requests

response = requests.get(
    "https://app.tanba-ooh.kz/api/v1/market/multipliers?structure=ALM-0001&at=2027-03-10T10%3A07%3A00%2B05%3A00",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
    },
)
print(response.status_code, response.text)
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://app.tanba-ooh.kz/api/v1/market/multipliers?structure=ALM-0001&at=2027-03-10T10%3A07%3A00%2B05%3A00", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}