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

Словарь открытых данных

GET /v1/open/dictionary.json

https://verify.tanba-ooh.kz/v1/open/dictionary.json

Что в файлах: столбцы, таблицы, статусы ячеек, коды районов, форматов и времени суток с названиями на трех языках, пороги правил раскрытия и примечание о лицензии. Без учетных данных. Пока публикация выключена, отвечает 404 с кодом not_published.

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

Не требуется. Вызов открытый.

Ответы

200 Словарь.

application/json

OpenDataDictionary

ИмяТипОбязательныйОписаниеПример
versionstringдаВерсия словаря."1.0"
licenceobjectдаПримечание о лицензии на файлы. Условия использования определяет город; пока решения нет, примечание об этом сообщает.
licence.statusstringдаdraft, пока город не решил. draft
licence.textobjectдаПримечание на английском, русском и казахском языках.
licence.text.enstringдаТекст на английском."Draft - pending the city's decision."
licence.text.rustringдаТекст на русском."Проект - ожидает решения города."
licence.text.kkstringдаТекст на казахском."Жоба - қаланың шешімін күтуде."
basisobjectдаОдин описанный элемент: файл, таблица, столбец, статус или основа подсчета.
basis.namestringНазвание элемента; есть у файлов, таблиц, столбцов и основы подсчета."plays"
basis.codestringКод элемента; есть у статусов."published"
basis.descriptionobjectдаТекст на английском, русском и казахском языках.
basis.description.enstringдаТекст на английском."Plays in the month."
basis.description.rustringдаТекст на русском."Показы за месяц."
basis.description.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
filesarray of OpenDataEntryдаДва файла выпуска.
files[].namestringНазвание элемента; есть у файлов, таблиц, столбцов и основы подсчета."plays"
files[].codestringКод элемента; есть у статусов."published"
files[].descriptionobjectдаТекст на английском, русском и казахском языках.
files[].description.enstringдаТекст на английском."Plays in the month."
files[].description.rustringдаТекст на русском."Показы за месяц."
files[].description.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
tablesarray of OpenDataEntryдаТаблицы в файлах.
tables[].namestringНазвание элемента; есть у файлов, таблиц, столбцов и основы подсчета."plays"
tables[].codestringКод элемента; есть у статусов."published"
tables[].descriptionobjectдаТекст на английском, русском и казахском языках.
tables[].description.enstringдаТекст на английском."Plays in the month."
tables[].description.rustringдаТекст на русском."Показы за месяц."
tables[].description.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
columnsarray of OpenDataEntryдаСтолбцы файла CSV.
columns[].namestringНазвание элемента; есть у файлов, таблиц, столбцов и основы подсчета."plays"
columns[].codestringКод элемента; есть у статусов."published"
columns[].descriptionobjectдаТекст на английском, русском и казахском языках.
columns[].description.enstringдаТекст на английском."Plays in the month."
columns[].description.rustringдаТекст на русском."Показы за месяц."
columns[].description.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
statusesarray of OpenDataEntryдаСтатусы, которые может иметь ячейка.
statuses[].namestringНазвание элемента; есть у файлов, таблиц, столбцов и основы подсчета."plays"
statuses[].codestringКод элемента; есть у статусов."published"
statuses[].descriptionobjectдаТекст на английском, русском и казахском языках.
statuses[].description.enstringдаТекст на английском."Plays in the month."
statuses[].description.rustringдаТекст на русском."Показы за месяц."
statuses[].description.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
codesobjectдаКоды в столбцах row и col с названиями на трех языках.
codes.districtarray of OpenDataCodeдаРайоны.
codes.district[].codestringдаКод, который используется в файлах."medeu"
codes.district[].nameobjectдаТекст на английском, русском и казахском языках.
codes.district[].name.enstringдаТекст на английском."Plays in the month."
codes.district[].name.rustringдаТекст на русском."Показы за месяц."
codes.district[].name.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
codes.district[].start_hourintegerТолько части суток: первый час, время Алматы.6
codes.district[].end_hourintegerТолько части суток: час окончания, не включительно.10
codes.formatarray of OpenDataCodeдаФорматы.
codes.format[].codestringдаКод, который используется в файлах."medeu"
codes.format[].nameobjectдаТекст на английском, русском и казахском языках.
codes.format[].name.enstringдаТекст на английском."Plays in the month."
codes.format[].name.rustringдаТекст на русском."Показы за месяц."
codes.format[].name.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
codes.format[].start_hourintegerТолько части суток: первый час, время Алматы.6
codes.format[].end_hourintegerТолько части суток: час окончания, не включительно.10
codes.daypartarray of OpenDataCodeдаЧасти суток по Алматы; start_hour включительно, end_hour не включительно.
codes.daypart[].codestringдаКод, который используется в файлах."medeu"
codes.daypart[].nameobjectдаТекст на английском, русском и казахском языках.
codes.daypart[].name.enstringдаТекст на английском."Plays in the month."
codes.daypart[].name.rustringдаТекст на русском."Показы за месяц."
codes.daypart[].name.kkstringдаТекст на казахском."Айдағы көрсетілімдер."
codes.daypart[].start_hourintegerТолько части суток: первый час, время Алматы.6
codes.daypart[].end_hourintegerТолько части суток: час окончания, не включительно.10
disclosureobjectдаДействующие правила раскрытия.
disclosure.min_operatorsintegerдаСколько операторов нужно опубликованной ячейке.3
disclosure.min_advertisersintegerдаСколько рекламодателей нужно опубликованной ячейке.3
disclosure.max_party_share_pctintegerдаКакой наибольший процент показов ячейки может быть у одного оператора или рекламодателя.70
disclosure.lag_monthsintegerдаСколько полных месяцев проходит между концом месяца и его выпуском.1
disclosure.descriptionobjectдаТекст на английском, русском и казахском языках.
disclosure.description.enstringдаТекст на английском."Plays in the month."
disclosure.description.rustringдаТекст на русском."Показы за месяц."
disclosure.description.kkstringдаТекст на казахском."Айдағы көрсетілімдер."

Пример

{
  "version": "1.0",
  "licence": {
    "status": "draft",
    "text": {
      "en": "Draft - pending the city's decision.",
      "ru": "Проект - ожидает решения города.",
      "kk": "Жоба - қаланың шешімін күтуде."
    }
  },
  "basis": {
    "name": "plays",
    "code": "published",
    "description": {
      "en": "Plays in the month.",
      "ru": "Показы за месяц.",
      "kk": "Айдағы көрсетілімдер."
    }
  },
  "files": [
    {
      "name": "plays",
      "code": "published",
      "description": {
        "en": "Plays in the month.",
        "ru": "Показы за месяц.",
        "kk": "Айдағы көрсетілімдер."
      }
    }
  ],
  "tables": [
    {
      "name": "plays",
      "code": "published",
      "description": {
        "en": "Plays in the month.",
        "ru": "Показы за месяц.",
        "kk": "Айдағы көрсетілімдер."
      }
    }
  ],
  "columns": [
    {
      "name": "plays",
      "code": "published",
      "description": {
        "en": "Plays in the month.",
        "ru": "Показы за месяц.",
        "kk": "Айдағы көрсетілімдер."
      }
    }
  ],
  "statuses": [
    {
      "name": "plays",
      "code": "published",
      "description": {
        "en": "Plays in the month.",
        "ru": "Показы за месяц.",
        "kk": "Айдағы көрсетілімдер."
      }
    }
  ],
  "codes": {
    "district": [
      {
        "code": "medeu",
        "name": {
          "en": "Plays in the month.",
          "ru": "Показы за месяц.",
          "kk": "Айдағы көрсетілімдер."
        },
        "start_hour": 6,
        "end_hour": 10
      }
    ],
    "format": [
      {
        "code": "medeu",
        "name": {
          "en": "Plays in the month.",
          "ru": "Показы за месяц.",
          "kk": "Айдағы көрсетілімдер."
        },
        "start_hour": 6,
        "end_hour": 10
      }
    ],
    "daypart": [
      {
        "code": "medeu",
        "name": {
          "en": "Plays in the month.",
          "ru": "Показы за месяц.",
          "kk": "Айдағы көрсетілімдер."
        },
        "start_hour": 6,
        "end_hour": 10
      }
    ]
  },
  "disclosure": {
    "min_operators": 3,
    "min_advertisers": 3,
    "max_party_share_pct": 70,
    "lag_months": 1,
    "description": {
      "en": "Plays in the month.",
      "ru": "Показы за месяц.",
      "kk": "Айдағы көрсетілімдер."
    }
  }
}

Ошибки

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

СтатусЗначение
404Открытые данные выключены (not_published) либо месяц или файл не опубликован или не существует (not_found).
429Превышен предел частоты; см. Retry-After.

Примеры кода

curl

curl 'https://verify.tanba-ooh.kz/v1/open/dictionary.json'
Python
import requests

response = requests.get(
    "https://verify.tanba-ooh.kz/v1/open/dictionary.json",
)
print(response.status_code, response.text)
Go
package main

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

func main() {
	req, err := http.NewRequest("GET", "https://verify.tanba-ooh.kz/v1/open/dictionary.json", nil)
	if err != nil {
		panic(err)
	}
	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))
}