Настройки канала и графики

Настройки определяют, как запуск ведёт себя на канале. Читать их может любой ключ, менять — ключ с правом channels.

ПрочитатьСкопировать ссылку на раздел

curl https://api.skystream.su/app/v1/channels/ch_12/settings \  -H "Authorization: Bearer $API_KEY"

Кроме самих настроек ответ содержит поле available: что из настроек сейчас можно менять — страны географии, группы источников просмотров, автопросмотры. Настройки, которых нет у площадки канала или которые для него недоступны, равны null; автопросмотры, выключенные владельцем сервиса, — 0.

ИзменитьСкопировать ссылку на раздел

PATCH /channels/{id}/settings меняет только переданные поля:

curl https://api.skystream.su/app/v1/channels/ch_12/settings \  -X PATCH \  -H "Authorization: Bearer $API_KEY" \  -H "Content-Type: application/json" \  -d '{    "start_viewers": 40,    "ramp_up_minutes": 20,    "fluctuation_percent": 10  }'

Число зрителей, разгон и плавающий онлайн применяются к следующему запуску; чтобы изменить идущий, используйте PATCH /channels/{id}/run. График онлайна (graph_id) и поля просмотров — geo, view_targeting, unique_ratio, auto_views_per_hour — действуют и на идущий запуск. Если применить поля просмотров к идущим просмотрам не удалось, настройки всё равно сохранены, а API отвечает 502 live_apply_failed; повторите запрос.

Число зрителей, разгон и плавающий онлайнСкопировать ссылку на раздел

Поля списка и рейда (list_percent, raid_percent) задают, какая доля зрителей видна в списке зрителей канала и какая уходит с рейдом. Они есть только у Twitch.

Графики онлайнаСкопировать ссылку на раздел

График задаёт число зрителей по минутам эфира. Как создавать, менять и удалять графики и проверять их расчётом онлайна — в руководстве Графики онлайна.

curl https://api.skystream.su/app/v1/graphs \  -H "Authorization: Bearer $API_KEY"

Назначить график:

curl https://api.skystream.su/app/v1/channels/ch_12/settings \  -X PATCH \  -H "Authorization: Bearer $API_KEY" \  -H "Content-Type: application/json" \  -d '{    "graph_id": "gr_3"  }'

Пока график назначен, разгон и плавающий онлайн задаёт он. График, назначенный во время эфира, начинает отсчёт с момента назначения. Снять график — "graph_id": null. Каналы, которым назначен график, перечислены в его channel_ids.

ГеографияСкопировать ссылку на раздел

Поле geo задаёт страны зрителей:

{ "geo": { "mode": "all" } }
{ "geo": { "mode": "single", "country": "RU" } }
{ "geo": { "mode": "percent", "percents": { "RU": 70, "KZ": 30 } } }

Коды стран — из available.geo_countries. Страна не из списка отклоняется с ошибкой country_unavailable.

Источники просмотровСкопировать ссылку на раздел

Поле view_targeting задаёт доли по группам: устройства зрителей (platform), источники внутри Twitch (source), источники вне Twitch (external). Допустимые ключи каждой группы перечислены в справочнике. Группа, переданная в запросе, заменяется целиком; группы, которых в запросе нет, не меняются. Доступные группы — в available.view_targeting_groups.

АвтопросмотрыСкопировать ссылку на раздел

Автопросмотры оплачиваются поминутно со счёта аккаунта, пока идёт эфир, и суточный потолок трат ключа на них не распространяется. Поэтому через API их можно только выключить:

{ "auto_views_per_hour": 0 }

Значение больше нуля отклоняется с ошибкой auto_views_panel_only. Включаются автопросмотры в панели.

Каналы KickСкопировать ссылку на раздел

У каналов Kick нет списка, рейдов и просмотров. Поля list_percent, raid_percent, unique_ratio, auto_views_per_hour, geo и view_targeting для них отклоняются с ошибкой setting_not_supported, а не пропускаются молча.

ОшибкиСкопировать ссылку на раздел