Ekranlar

Temel platform
display_brand_settings_writeEkranlar

Changes Display Screens settings shared by every facility in the facility's brand: the boot screen shown while screens start up, the settings new screens start with, and what templated content shows. Organisation admins only; read the current values and canEdit with display_settings_read boot_screen, screen_defaults or templated.

Actions:

  • save_boot_screen: Save the boot screen. Sets the boot screen image (PNG, JPEG or WebP, up to 10 MB, from a public https imageUrl or imageBase64) and/or how it is laid out. Without an image, fit and background re-render the current one. Screens pick it up when they next start. Asks for confirmation.
  • reset_boot_screen: Reset the boot screen. Removes the brand's boot screen; screens go back to the default one when they next start. Asks for confirmation.
  • save_screen_defaults: Save the screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities. Only the settings you pass change. Screens that are already paired keep their own settings; change those with device_inventory_write configure_screen. Asks for confirmation.
  • save_templated: Save templated content settings. What templated content screens and the Schedule show: the data source name, workout names, programs in the Schedule and how far ahead, training phases and how far ahead, and Program Builder training camps (one banner per week) and how far ahead. Asks for confirmation.

Parametreler

AdTürAçıklama
action*"save_boot_screen" | "reset_boot_screen" | "save_screen_defaults" | "save_templated"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
imageUrlstringGörüntünün herkese açık https URL'si (save_boot_screen)
imageBase64stringURL yoksa base64 olarak görüntü (save_boot_screen)
fit"logo" | "fill"(save_boot_screen)
backgroundstringArka plan rengi (#RRGGBB) (save_boot_screen)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
orientation"normal" | "left" | "right" | "inverted"Screen rotation (save_screen_defaults)
airplayEnabledbooleanScreens accept AirPlay (save_screen_defaults)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (save_screen_defaults)
sonosEnabledbooleanSonos speaker control (save_screen_defaults)
duressEnabledbooleanBluetooth duress button monitoring (save_screen_defaults)
cameraRestreamingEnabledbooleanRestream local camera feeds from the screen (save_screen_defaults)
wifiSupportbooleanCaptive Wi-Fi setup portal (save_screen_defaults)
showSourceNameboolean(save_templated)
showWorkoutNamesboolean(save_templated)
showProgramsInScheduleboolean(save_templated)
programLookaheadDaysintegernullİleriye dönük gün sayısı (0–90) veya sınır olmaması için null (save_templated)
showTrainingPhasesboolean(save_templated)
phaseLookaheadDaysintegernullİleriye dönük gün sayısı (0–90) veya sınır olmaması için null (save_templated)
showTrainingCampsboolean(save_templated)
campLookaheadDaysintegernullİleriye dönük gün sayısı (0–90) veya sınır olmaması için null (save_templated)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_groups_writeEkranlar

Bir tesisteki Display Screen gruplarını oluşturur, yeniden adlandırır ve siler; hangi ekranların bu gruplarda olduğunu ayarlar. Gruplar yayımlama hedefleri (display_publish targets.groupIds) ve komut hedefleridir (display_screen_command groupIds). Birden fazla ekran, grup veya hedef verildiğinde bu araç tek çağrıda hepsine uygulanır; çok sayıda öğe üzerinde işlem yapmadan önce kullanıcıya danışın.

Eylemler:

  • save: Bir grubu kaydeder. Oluşturma: name (ve isteğe bağlı olarak screenIds). Yeniden adlandırma: groupId (kimlik veya geçerli ad) ve name. screenIds üyelerin yerini alır; listelenmeyen ekranlar bu gruptan çıkar ancak diğer gruplarında kalır.
  • delete: Bir grubu siler. Grubu siler: ekranları gruptan çıkar (diğer gruplarında kalırlar) ve gruba yayımlanan içerik programdan kaldırılır. groupId gerektirir. Onay ister.

Parametreler

AdTürAçıklama
action*"save" | "delete"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
groupIdstringYeniden adlandırmak veya üyeleri değiştirmek için mevcut grup kimliği veya adı
namestringGrup adı (oluştururken zorunlu) (save)
screenIdsarrayGruptaki ekranlar; geçerli üyelerin yerini alır (save)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_hosted_apps_writeEkranlar

Display Screens için statik HTML uygulamaları ("barındırılan uygulamalar") yayımlar. Ekran boyutları, tasarım kuralları, sınırlar ve SDK için önce display_library_read app_guidelines'ı, sonucu bir ekranda kontrol etmek için ardından display_screenshot'ı çağırın. Birden fazla ekran, grup veya hedef verildiğinde bu araç tek çağrıda hepsine uygulanır; çok sayıda öğe üzerinde işlem yapmadan önce kullanıcıya danışın.

Eylemler:

  • publish: Barındırılan bir uygulamayı yayımlar. Barındırılan bir uygulama oluşturur (name + files) veya yeni bir sürüm yayımlar (appId + files; uygulamanın gösterildiği her yerde yayına girer, rollback bunu geri alır). publishTo, display_publish gibi uygulamayı ekranlara da yerleştirir; marka veya organizasyon hedefi confirm gerektirir. files gerektirir. Onay isteyebilir.
  • rollback: Barındırılan bir uygulamayı geri alır. Uygulamanın gösterildiği her yerde önceki bir sürümü yeniden geçerli yapar. Sürümleri display_library_read app_versions ile listeleyin. appId, version gerektirir.

Parametreler

AdTürAçıklama
action*"publish" | "rollback"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
appIdstringYeni sürümü yayımlanacak mevcut barındırılan uygulamanın kimliği (app_…)
namestringUygulama adı (oluştururken zorunlu) (publish)
filesarrayUygulama dosyaları. encoding utf8 (varsayılan) veya ikili dosyalar için base64'tür. (publish)
entrystringGiriş HTML dosyası (varsayılan index.html) (publish)
durationSecnumberOynatma listelerinde varsayılan ekranda kalma süresi, saniye cinsinden (publish)
tagsarray(publish)
ownerScope"facility" | "brand" | "organisation"Yeni içeriğin sahibi (varsayılan facility). brand ve organisation, organizasyon genelinde erişim gerektirir. (publish)
publishToobject(publish)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
versionintegerGeçerli yapılacak sürüm (rollback)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_library_readEkranlar

Bir tesisin görebildiği Display Screens içerik kitaplığını okur: medya (görüntüler, videolar), uygulamalar (web sayfaları, barındırılan HTML uygulamaları, Yapay Zeka Ajanı uygulamaları, güvenlik kamerası görünümleri) ve oynatma listeleri; ayrıca eklenebilecek Yapay Zeka Ajanı uygulamaları ve güvenlik kamerası kaynakları.

Her öğenin display_publish ve oynatma listeleri için bir contentRef'i (media#…, app#…, playlist#…) vardır. ownerScope sahibini gösterir (facility#, brand# veya org#); içerik yalnızca sahibinin kapsamında yayımlanabilir. Durumu processing olan medya henüz hazır değildir; failed olan medyanın yeniden yüklenmesi gerekir. frameable: false olan web sayfaları oynatma listelerinde oynatılamaz, yalnızca tam sayfa ekran olarak gösterilebilir. displayIssue içeren öğeler ekranlar tarafından atlanır: yayımlanmamış, duraklatılmış, display-off, audience-limited veya Custom Apps'i olmayan bir Yapay Zeka Ajanı uygulaması; no-cctv, cctv-off (bir tesis yöneticisi Display Screens ayarlarında ekranlar için CCTV'yi açar) veya no-cameras durumundaki bir güvenlik kamerası görünümü.

Eylemler:

  • list: Kitaplık öğelerini listeler. Medya ve uygulamalar (sayfalı; type, kind, tag veya ada göre filtrelenir) ya da type agent-apps ile ekranlarda izin verilen ve display_publish content.agentAppId ile yayımlayabileceğiniz Yapay Zeka Ajanı uygulamaları. Her öğenin bir type'ı vardır: media, app veya agent-app.
  • cctv_sources: Güvenlik kamerası kaynaklarını listeler. display_publish content.cctv için tesisin kameraları ve paylaşılan Canlı Görüntüler ile ekranlarda CCTV'nin açık olup olmadığı. Tesiste güvenlik kamerası erişimi gerektirir.
  • get: Bir kitaplık öğesini getirir. contentRef ile tek bir medya öğesi, uygulama veya oynatma listesi. contentRef gerektirir.
  • usages: İçeriğin nerede kullanıldığı. Bir medya öğesini veya uygulamayı kullanan canlı program atamaları ve oynatma listeleri (ya da bir oynatma listesinin atamaları). Kullanımdaki içerik silinemez. contentRef gerektirir.
  • app_versions: Barındırılan uygulama sürümlerini listeler. display_hosted_apps_write rollback için barındırılan bir uygulamanın sürümleri ve hangisinin geçerli olduğu. appId gerektirir.
  • app_guidelines: Barındırılan uygulama yönergeleri. Ekran boyutları, tasarım kuralları, paket sınırları, Display App SDK ve bir başlangıç şablonu. display_hosted_apps_write publish için bir uygulama oluşturmadan önce bunu çağırın.
  • check_url: Bir web sayfasını kontrol eder. Bir web sayfasının oynatma listelerinde gösterilip gösterilemeyeceği (bazı siteler çerçeve içinde gösterilmeyi reddeder) ve nasıl göründüğüne dair ipuçları. Çerçevelemeyi reddeden sayfalar yine de tam sayfa ekran olabilir. url gerektirir.
  • playlists: Oynatma listelerini listeler. Tesisin görebildiği oynatma listeleri (sayfalı), her biri öğeleriyle (contentRef, duration, fit).

Parametreler

AdTürAçıklama
action*"list" | "cctv_sources" | "get" | "usages" | "app_versions" | "app_guidelines" | "check_url" | "playlists"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
type"media" | "apps" | "agent-apps"Yalnızca tek bir öğe türü (varsayılan: medya ve uygulamalar) (list)
kind"image" | "video" | "url" | "hosted" | "agent-app" | "cctv-view"(list)
tagstringYalnızca bu etikete sahip öğeler (list)
searchstringBüyük/küçük harfe duyarsız ad filtresi (list)
limitintegerSayfa başına öğe (varsayılan 25, en fazla 100) (list, playlists)
cursorstringÖnceki sayfadan nextCursor (list, playlists)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. (list, cctv_sources, get, usages, app_versions, check_url, playlists)
contentRefstringdisplay_library_read list veya playlists'ten media#<id>, app#<id> veya playlist#<id> (get, usages)
appIdstringBarındırılan uygulama kimliği (app_…) (app_versions)
urlstringHerkese açık https URL'si (check_url)
display_library_writeEkranlar

Display Screens kitaplık içeriğini ekler ve değiştirir: görüntü ve video yükleme; web sayfası, Yapay Zeka Ajanı uygulaması ve güvenlik kamerası görünümü uygulamaları oluşturma; adları, etiketleri, süreleri ve tarihleri düzenleme; kullanılmayan öğeleri silme ve bir uygulamanın önizlemesini yenileme. Barındırılan HTML uygulamaları display_hosted_apps_write ile, oynatma listeleri display_playlists_write ile yayımlanır.

Görüntüleri 1920×1080 (yatay) veya 1080×1920 (dikey) olarak tasarlayın. Yeni medya, web'e hazır sürümleri oluşturulurken processing durumunda başlar; hemen oynatma listelerine eklenebilir ve hazır olduğunda oynatılır. ownerScope: facility (varsayılan), brand veya organisation (brand ve organisation, organizasyon genelinde erişim gerektirir).

Eylemler:

  • upload_media: Bir görüntü veya video yükler. Herkese açık bir https url'den (tercih edilen; görüntüler en fazla 25 MB, videolar en fazla 200 MB) veya mimeType ile base64'ten (en fazla 20 MB) bir görüntü veya video ekler. JPEG, PNG, WebP, GIF görüntüleri; MP4, WebM, MOV videoları (en fazla 1080p H.264 MP4'e dönüştürülür). Daha büyük videolar için: create_video_upload.
  • create_video_upload: Büyük bir video yüklemesi başlatır. En fazla 2 GB'lık videolar için: videoyu kaydeder ve önceden imzalanmış bir yükleme döndürür (dosyayı upload.expiresAt'ten önce upload.headers ile upload.url'ye PUT edin), ardından contentRef'iyle transcode'u çağırın. name, mimeType, bytes gerektirir.
  • transcode: Bir videoyu işler. Bir videoyu ekranlar için dönüştürür: create_video_upload'dan sonra, bir hatadan sonra yeniden veya ekranların oynatamadığı eski bir video için. contentRef gerektirir.
  • create_app: Bir uygulama ekler. Bir web sayfası (kind url, url iletin; çerçeveleme açısından kontrol edilir), bir Yapay Zeka Ajanı uygulaması (kind agent-app, display_library_read list type agent-apps'ten agentAppId iletin) veya bir güvenlik kamerası görünümü (kind cctv-view, tesise ait, güvenlik kamerası erişimi gerektirir) ekler. kind, name gerektirir.
  • update: Bir kitaplık öğesini günceller. Bir medya öğesinin veya uygulamanın adını, etiketlerini ya da süresini; bir medya öğesinin validFrom/validTo değerlerini (ISO, null temizler; bu aralığın dışında atlanır); bir web sayfasının url'sini ya da bir güvenlik kamerası görünümünün kameralarını, görünümünü, yerleşimini veya kalitesini değiştirir. contentRef gerektirir.
  • delete: Bir kitaplık öğesini siler. Bir medya öğesini veya uygulamayı siler. Canlı bir programda veya oynatma listesinde bulunduğu sürece engellenir: hata bunları listeler (önce display_schedule_write delete veya display_playlists_write save ile kaldırın). contentRef gerektirir. Onay ister.
  • refresh_preview: Bir uygulamanın önizlemesini yeniler. Kitaplık önizlemesi için uygulamanın yeni bir ekran görüntüsünü alır (örneğin sayfa değiştikten sonra). contentRef gerektirir.

Parametreler

AdTürAçıklama
action*"upload_media" | "create_video_upload" | "transcode" | "create_app" | "update" | "delete" | "refresh_preview"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
urlstringGörüntünün veya videonun herkese açık https URL'si (tercih edilen) (upload_media, create_app, update)
base64stringURL yoksa base64 olarak dosya içeriği (en fazla 20 MB) (upload_media)
mimeTypestringbase64 ile zorunludur, ör. image/png (upload_media, create_video_upload)
namestringKitaplık adı (upload_media, create_video_upload, create_app, update)
tagsarrayEtiketler (geçerli etiketlerin yerini alır) (upload_media, create_video_upload, create_app, update)
ownerScope"facility" | "brand" | "organisation"Yeni içeriğin sahibi (varsayılan facility). brand ve organisation, organizasyon genelinde erişim gerektirir. (upload_media, create_video_upload, create_app)
durationSecnumberGörüntüler için varsayılan ekranda kalma süresi, saniye cinsinden (upload_media, create_app, update)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
bytesintegerBayt cinsinden dosya boyutu (create_video_upload)
resolution"720" | "1080" | "1440" | "2160" | "original"Videonun ekranlar için dönüştürüleceği en büyük boyut (varsayılan 1080; original boyutunu korur) (create_video_upload, transcode)
contentRefstringdisplay_library_read list veya playlists'ten media#<id>, app#<id> veya playlist#<id> (transcode, update, delete, refresh_preview)
kind"url" | "agent-app" | "cctv-view"(create_app)
agentAppIdstringYapay Zeka Ajanı uygulamaları: uygulama kimliği (create_app)
source"view" | "cameras"Güvenlik kamerası görünümleri: view (viewId iletin) veya cameras (cameras iletin) (create_app, update)
viewIdstringGüvenlik kamerası görünümleri: Canlı Görüntü kimliği (display_library_read cctv_sources) (create_app, update)
camerasarrayGüvenlik kamerası görünümleri: kamera kimlikleri (display_library_read cctv_sources) (create_app, update)
layout"auto" | "1x1" | "2x1" | "1+2" | "2x2" | "1+5" | "2x3" | "3x3"Güvenlik kamerası görünümleri: döşeme yerleşimi (create_app, update)
quality"auto" | "native" | "1080p" | "720p" | "480p" | "360p" | "240p"Güvenlik kamerası görünümleri: yayın kalitesi (create_app, update)
showNamesbooleanGüvenlik kamerası görünümleri: kamera adlarını döşemelerde gösterir (create_app, update)
validFromstringnullMedya: oynatılmaya başladığı ISO tarih-saati; null temizler (update)
validTostringnullMedya: oynatılmasının durduğu ISO tarih-saati; null temizler (update)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_playlists_writeEkranlar

Display Screens oynatma listelerini oluşturur, günceller ve siler: medya ve uygulamalardan oluşan sıralı döngüler. Değişiklikler, oynatma listesini gösteren her ekrana saniyeler içinde ulaşır. Bir oynatma listesini display_publish content.contentRef "playlist#" ile yayımlayın.

Eylemler:

  • save: Bir oynatma listesini kaydeder. Oluşturma: name + items (items boş olabilir). Güncelleme: playlistId + name, items, transition alanlarından herhangi biri; items tüm listenin yerini alır, bu nedenle her öğeyi sırasıyla gönderin.
  • delete: Bir oynatma listesini siler. Oynatma listesini siler. Herhangi bir yerde yayımlandığı sürece engellenir: hata önce kaldırılması gereken atamaları listeler (display_schedule_write delete). playlistId gerektirir. Onay ister.

Parametreler

AdTürAçıklama
action*"save" | "delete"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
playlistIdstringGüncellenecek mevcut oynatma listesi kimliği (pl_…)
namestringOynatma listesi adı (oluştururken zorunlu) (save)
transition"fade" | "none"(save)
ownerScope"facility" | "brand" | "organisation"Yeni içeriğin sahibi (varsayılan facility). brand ve organisation, organizasyon genelinde erişim gerektirir. (save)
itemsarraySıralı olarak tüm liste (geçerli öğelerin yerini alır; bir öğeyi korumak için itemId'sini koruyun). frameable: false olan web sayfaları oynatılmaz. (save)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_publishEkranlar

İçeriği Display Screens'e yerleştirir: bir medya öğesi, oynatma listesi, uygulama, web sayfası, Yapay Zeka Ajanı uygulaması veya canlı güvenlik kamerası görünümünü ekranlara, gruplara, tesise, markasına veya organizasyonuna.

mode: now (varsayılan) hedeflerin normalde gösterdiği içeriğin yerini alır; scheduled içeriği yalnızca haftalık zaman aralıklarında (tesis saat dilimi) ve/veya from ile to arasında gösterir; takeover durationMin boyunca (veya belirli bir saate kadar) her şeyi keser, ardından kendiliğinden sona erer (display_takeover_stop ile erken durdurun). Ekranlar ne göstereceklerini önce katmana (takeover > scheduled > default), sonra hedefin ne kadar belirli olduğuna (screen > group > facility > brand > organisation) göre belirler.

Güvenlik kamerası: canlı kamera görüntüleri ekranların yakınındaki herkes tarafından görülebilir. İlk çağrı requiresConfirmation döndürür (kod CCTV_CONFIRMATION_REQUIRED); kullanıcıya sorun, ardından confirmCctv: true ile yeniden çağırın. Tesiste "Allow CCTV on display screens" ayarı açık olmalıdır.

Yayımlanan içeriği yalnızca player modundaki ekranlar gösterir; diğerleri warnings içinde listelenir. Bir batchId döndürür; bununla display_schedule_write delete tüm yayımlamayı geri alır. Birden fazla ekran, grup veya hedef verildiğinde bu araç tek çağrıda hepsine uygulanır; çok sayıda öğe üzerinde işlem yapmadan önce kullanıcıya danışın.

Parametreler

AdTürAçıklama
targets*objectİçeriğin gideceği yer. Bunlardan herhangi birini birleştirebilirsiniz. Grup adları da kimlikler gibi çalışır. brand ve organisation, organizasyon genelinde Display Screens erişimi gerektirir.
content*objectGösterilecek içerik: contentRef, url, agentAppId veya cctv alanlarından tam olarak biri.
mode"now" | "default" | "scheduled" | "takeover"`now`/`default` (varsayılan): hedeflerin normalde gösterdiği içeriğin yerini alır. `scheduled`: yalnızca zaman aralıklarında ve/veya from ile to arasında. `takeover`: durationMin boyunca (veya belirli bir saate kadar) her şeyi keser, ardından kendiliğinden sona erer.
windowsarrayTesis saat dilimindeki haftalık zaman aralıkları. days ISO hafta günleridir (1 = Pazartesi … 7 = Pazar); start/end "HH:MM" biçimindedir (end için "24:00" kullanılabilir).
fromstringPlanlanmış bir yayımlamanın başladığı ISO tarih-saati
tostringPlanlanmış bir yayımlamanın sona erdiği ISO tarih-saati
durationMinnumberDakika cinsinden devralma süresi (en fazla 7 gün)
untilstringDevralmanın sona erdiği ISO tarih-saati (durationMin yerine)
priorityintegerÇakışan planlanmış öğeler arasındaki eşitliği bozar (yüksek olan kazanır)
confirmCctvbooleanYalnızca kullanıcı canlı güvenlik kamerası görüntüsü gösterilmesini açıkça onayladıktan sonra ayarlayın
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_schedule_readEkranlar

Display Screens'e yayımlananları okur: tek bir ekran için belirli bir anda ve bir zaman aralığında ne gösterdiği (devraldığı tüm katmanlar ve hedefler genelinde çözümlenmiş) ve ona ulaşan atamalar; ya da bir gruba, tesise, markasına veya organizasyonuna yayımlanan atamalar.

Atama kimlikleri (as_…) ve toplu işlem kimlikleri (bt_…), display_schedule_write'ın güncellediği veya sildiği öğelerdir. Saatler ISO biçimindedir; zaman aralıkları tesis saat dilimindedir.

Eylemler:

  • get: Bir ekranın programını getirir. Bir ekranın at anında (varsayılan şimdi) ne gösterdiği, from ile to arasındaki zaman çizelgesi (varsayılan 24 saat) ve ona ulaşan her atama. screenId gerektirir.
  • list_assignments: Atamaları listeler. Bir gruba (groupId) ya da tesise, markasına veya organizasyonuna (target, varsayılan facility) yayımlanan atamalar. Sayfalı, en yeni değişiklik önce.

Parametreler

AdTürAçıklama
action*"get" | "list_assignments"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
screenIdstringdisplay_screens_read list'ten ekran kimliği (6 karakterlik kod) (get)
atstringEkranda ne olduğunu kontrol etmek için ISO tarih-saati (varsayılan şimdi) (get)
fromstringISO zaman çizelgesi başlangıcı (varsayılan at, yoksa şimdi) (get)
tostringISO zaman çizelgesi bitişi (varsayılan from'dan 24 saat sonra) (get)
includeExpiredbooleanSona ermiş atamaları dahil et
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
groupIdstringdisplay_screens_read groups'tan ekran grubu kimliği veya adı (list_assignments)
target"facility" | "brand" | "organisation"groupId verilmediğinde (varsayılan facility) (list_assignments)
limitintegerSayfa başına öğe (varsayılan 25, en fazla 100) (list_assignments)
cursorstringÖnceki sayfadan nextCursor (list_assignments)
display_schedule_writeEkranlar

Display Screens'e yayımlananları değiştirir: bir atamanın zamanlamasını, önceliğini veya içeriğini düzenleme (isteğe bağlı olarak tüm yayımlama genelinde) ya da tek bir atamayı veya tüm yayımlamayı kaldırma. Kimlikleri display_schedule_read ile bulun. İçeriği programdan kaldırmak onu kitaplıkta bırakır; bir devralmayı erken bitirip geçmişini korumak için display_takeover_stop kullanın.

Eylemler:

  • update: Bir atamayı günceller. Bir atamanın zamanlamasını (haftalık zaman aralıkları, from/to; null bir tarihi temizler), önceliğini veya içeriğini değiştirir. applyToBatch aynı değişikliği yayımlamanın her hedefine uygular. Bir devralmaya yalnızca yeni bir bitiş saati verilebilir. Güvenlik kamerası içeriği, kullanıcı kabul ettikten sonra confirmCctv gerektirir. assignmentId gerektirir.
  • delete: Programdan kaldırır. Tek bir atamayı (assignmentId) veya bir yayımlamadaki her şeyi (batchId) kaldırır. Ekranlar saniyeler içinde aksi halde gösterecekleri içeriğe döner. Onay ister.

Parametreler

AdTürAçıklama
action*"update" | "delete"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
assignmentIdstringdisplay_schedule_read'den tek bir atama (as_…)
applyToBatchbooleanAynı değişikliği yayımlamanın her hedefine uygular (update)
windowsarrayTesis saat dilimindeki haftalık zaman aralıkları. days ISO hafta günleridir (1 = Pazartesi … 7 = Pazar); start/end "HH:MM" biçimindedir (end için "24:00" kullanılabilir). (update)
fromstringnullBaşladığı ISO tarih-saati; null temizler (update)
tostringnullSona erdiği ISO tarih-saati; null temizler (update)
priorityintegerÇakışan planlanmış öğeler arasındaki eşitliği bozar (yüksek olan kazanır) (update)
contentRefstringdisplay_library_read list veya playlists'ten media#<id>, app#<id> veya playlist#<id> (update)
confirmCctvbooleanYalnızca kullanıcı canlı güvenlik kamerası görüntüsü gösterilmesini açıkça onayladıktan sonra ayarlayın (update)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
batchIdstringdisplay_publish veya display_schedule_read'den, tüm hedefleri genelinde bir yayımlamanın tamamı (bt_…) (delete)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_screen_commandEkranlar

Bir tesisteki Display Screens'e canlı bir komut gönderir: reload (player ekranları programlarını yeniden alır), identify (ekranı mekânda bulmak için adını ve kodunu yanıp söndürür), displayOn/displayOff (TV paneli), rebootDevice (ekranın bilgisayarını yeniden başlatır, 1–2 dakika boş kalır; confirm: true gerektirir) veya osd (kısa bir ekran mesajı; message iletin).

Ekranları screenIds ve/veya groupIds ile (bu grupların tesisteki her ekranı) ya da tesisteki her ekran için allScreens: true ile seçin (bu durumda displayOn/displayOff templated content ekranlarına da ulaşır). Ekran başına sonuçlar döndürür. Birden fazla ekran, grup veya hedef verildiğinde bu araç tek çağrıda hepsine uygulanır; çok sayıda öğe üzerinde işlem yapmadan önce kullanıcıya danışın.

Parametreler

AdTürAçıklama
screenIdsarraydisplay_screens_read list'ten ekran kimlikleri (6 karakterlik kodlar). allScreens kullanırken boş bırakın.
groupIdsarrayEkran grubu kimlikleri veya adları: bu grupların tesisteki her ekranı
allScreensbooleantemplated content ekranları dahil, tesisteki her ekran
command*"reload" | "identify" | "displayOn" | "displayOff" | "rebootDevice" | "osd"Yapılacak işlem (rebootDevice, confirm gerektirir)
messagestringosd için metin
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_screens_readEkranlar

Bir tesisin Display Screens'ini okur: ekranları durumları ve şu anda ve sırada ne olduğuyla listeleme (gruba, duruma veya görüntüleme moduna göre filtreleme), tek bir ekranın tüm ayrıntılarını ve zaman çizelgesini getirme ya da ekran gruplarını ekranlarıyla listeleme.

Görüntüleme modu kullanıcılara "Data Source" olarak gösterilir: player "User managed content", program-builder "Templated content" (kullanıcılara asla eski ürün adını söylemeyin), url ise "Full-page website (Kiosk Mode)" olarak görünür. Saatler ISO biçimindedir; tesis saat dilimi döndürülür.

Eylemler:

  • list: Ekranları listeler. Tesisteki ekranlar (sayfalı), her biri durumu, son sinyali, grupları, etiketleri ve şu anda ve sırada ne olduğuyla. Grupları da döndürür.
  • get: Bir ekranı getirir. Tek bir ekranın tüm ayrıntıları (durum, sinyal, oynatıcı sürümü, son hatalar) ve player ekranları için bir zaman aralığında ne gösterdiği (varsayılan sonraki 24 saat, en fazla 14 gün). screenId gerektirir.
  • groups: Ekran gruplarını listeler. Tesisteki ekran grupları (sayfalı), her biri ekranlarıyla.

Parametreler

AdTürAçıklama
action*"list" | "get" | "groups"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
groupIdstringYalnızca bu gruptaki ekranlar (kimlik veya ad) (list)
status"playing" | "provisioning" | "display-off" | "not-responding" | "offline" | "online"(list)
mode"player" | "program-builder" | "url"(list)
limitintegerSayfa başına öğe (varsayılan 25, en fazla 100) (list, groups)
cursorstringÖnceki sayfadan nextCursor (list, groups)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
screenIdstringdisplay_screens_read list'ten ekran kimliği (6 karakterlik kod) (get)
fromstringZaman çizelgesinin ISO başlangıcı (varsayılan şimdi) (get)
tostringZaman çizelgesinin ISO bitişi (varsayılan from'dan 24 saat sonra) (get)
display_screens_writeEkranlarAygıt Yönetimi

Display Screens'i değiştirir: yeni bir ekranı eşleştirme koduyla eşleştirme; bir ekranı yeniden adlandırma, gruplarını ve etiketlerini ayarlama veya görüntüleme modunu değiştirme (kullanıcılara "Data Source" olarak gösterilir); bir player ekranının belirtecini yenileme; bir ekranın veya içeriğin süre sınırlı önizleme bağlantısını oluşturma ya da bir ekranı fabrika ayarlarına sıfırlama (ekranı tesisten kaldırır).

Görüntüleme modları: player ("User managed content"), url ("Full-page website (Kiosk Mode)", url iletin, yalnızca https), program-builder ("Templated content"; kullanıcılara asla eski ürün adını söylemeyin). Modu değiştirmek ekranı hemen yeniden yükler ve üyelerin gördüğünü değiştirir, bu nedenle kullanıcının onayını gerektirir.

Eylemler:

  • update: Bir ekranı günceller. Bir ekranın adını, gruplarını (kimlikler veya adlar; geçerli grupların yerini alır), etiketlerini (mevcut etiketlerin yerini alır) ve/veya görüntüleme modunu ayarlar. Mod değişikliği önce requiresConfirmation döndürür. screenId gerektirir. Onay isteyebilir.
  • rotate_token: Ekran belirtecini yeniler. Bir player ekranı için yeni bir belirteç verir ve ekranı yeniden yükler; eski belirteç çalışmaz hale gelir. Bir ekranın player URL'si sızmış olabilecekse kullanın. screenId gerektirir. Onay ister.
  • create_preview_link: Bir önizleme bağlantısı oluşturur. Bir ekranın ne gösterdiğini veya içeriğin nasıl göründüğünü, isteğe bağlı olarak gelecekteki bir zamanda gösteren (sınırlı süre geçerli) bir bağlantı. Bağlantıya sahip herkes, süresi dolana kadar görüntüleyebilir.
  • reset: Bir ekranı fabrika ayarlarına sıfırlar. Ekranı tesisten kaldırır ve fabrika ayarlarına sıfırlar; kapalı bir ekran bir sonraki çevrimiçi olduğunda sıfırlanır, ardından eşleştirme sayfasını gösterir. confirmName iletin: ekran adı, kullanıcının yazdığı şekliyle tam olarak. Aygıt Yönetimi gerektirir. screenId, confirmName gerektirir. Onay ister.
  • pair: Yeni bir ekranı eşleştirir. Eşleştirme sayfasındaki 6 karakterlik kodla tesise yeni bir ekran ekler, ardından ekranı yeniden yükler. Yalnızca Display Screens'i olan tesisler ekranı player modunda başlatır; templated content de varsa modu mode belirler (varsayılan program-builder). Aygıt Yönetimi gerektirir. pairingCode, name gerektirir. Onay ister.

Parametreler

AdTürAçıklama
action*"update" | "rotate_token" | "create_preview_link" | "reset" | "pair"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
screenIdstringdisplay_screens_read list'ten ekran kimliği (6 karakterlik kod) (update, rotate_token, create_preview_link, reset)
namestringEkran adı (update, pair)
groupIdsarrayGrup kimlikleri veya adları; geçerli grupların yerini alır (grupları display_groups_write save ile oluşturun) (update)
tagsarrayGeçerli etiketlerin yerini alır (update)
mode"player" | "program-builder" | "url"Görüntüleme modu ("Data Source") (update, pair)
urlstringurl modu için web sitesi (https) (update)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
contentRefstringdisplay_library_read list veya playlists'ten media#<id>, app#<id> veya playlist#<id> (create_preview_link)
orientation"landscape" | "portrait"contentRef önizlemeleri için (varsayılan landscape) (create_preview_link)
atstringÖnizlemenin yapılacağı ISO tarih-saati (varsayılan şimdi) (create_preview_link)
confirmNamestringOnaylamak için kullanıcının yazdığı ekran adı (tam olarak eşleşmelidir) (reset)
pairingCodestringEkranın eşleştirme sayfasında gösterdiği kod (0 ve O birbirine benzer) (pair)
contentStreamstringTemplated content: oynattığı akış (tur), varsayılan 1 (pair)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_screenshotEkranlar

Bir Display Screen'in şu anda gösterdiğini yakalar ve görüntüyü döndürür; böylece yayımladıktan sonra kendi çalışmanızı kontrol edebilirsiniz (yerleşim, metin boyutu, kesilen veya kayan bir şey olmaması). Ekranın yanıt vermesi için en fazla 15 saniye bekler; çevrimdışı ekranlarda zaman aşımı olur. JPEG için bir portal URL'si de döndürür (yalnızca oturum açmış kullanıcılar, 10 dakika saklanır).

Ekran görüntüleri canlı güvenlik kamerası görüntüsü ve görüş alanındaki üyeleri içerebilir; bunları konuşmanın dışında paylaşmayın.

Parametreler

AdTürAçıklama
screenId*stringdisplay_screens_read list'ten ekran kimliği (6 karakterlik kod)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
display_settings_readEkranlar

Reads Display Screens settings for a facility: the fallback slate, polling and nightly reload, CCTV on screens; the screen power schedule (with the next days' on/off times); automations (brightness, bell volume, check-in power, round timer state); the brand's boot screen, screen defaults and templated content settings; and, with templated content, the scheduled program dates and the templated schedule.

Actions:

  • settings: Get facility display settings. The fallback slate (message, background, logo, facility name), polling interval, nightly reload time and whether CCTV may be shown on screens.
  • power_schedule: Get the power schedule. When screens turn on and off: the saved schedule (or the older automations' equivalent), the facility time zone and the on/off times for the next 7 days.
  • power_schedule_preview: Preview a power schedule. The on/off times a schedule would give over the next 7 days, without saving it. Needs schedule.
  • automations: Get display automations. Automatic brightness (day/night levels and triggers), bell volume levels and schedule (decimal hours, 6.5 = 06:30), check-in power, and the round timer state, for one or several facilities. usesGlobalDefaults is true until the facility saves its own.
  • boot_screen: Get the brand's boot screen. The image the facility's brand shows while screens start up (fit, background, image URLs) and whether you can change it (organisation admins).
  • screen_defaults: Get the brand's screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities (orientation, screen mirroring, session timer, speaker control, duress monitoring, camera restreaming, Wi-Fi support) and whether you can change them (organisation admins). Screens that are already paired keep their own settings; see device_inventory_read for those.
  • templated: Get the brand's templated content settings. What templated content screens and the Schedule show for the facility's brand (source name, workout names, programs and training phases, look-ahead days) and whether you can change it (organisation admins).
  • program_dates: List scheduled program dates. The dates with a workout program, from the start of this month to the brand's look-ahead. Needs templated content (Program Builder) at the facility.
  • templated_schedule: Get the templated schedule. Programs and training phases between two dates (YYYY-MM-DD, at most 62 days), as the brand shows them. Needs templated content (Program Builder) at the facility. Needs from, to.

Parametreler

AdTürAçıklama
action*"settings" | "power_schedule" | "power_schedule_preview" | "automations" | "boot_screen" | "screen_defaults" | "templated" | "program_dates" | "templated_schedule"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
scheduleobjectEkranlar personelli saatlerde (sapmalarla genişletilmiş) veya özel haftalık zaman aralıklarında, bir tatil kuralıyla açıktır. (power_schedule_preview)
facilityIdsarrayAynı isteği her birinde çalıştırmak için birden fazla tesis kimliği. facilityId yerine kullanın. (automations)
fromstringİlk tarih (YYYY-MM-DD) (templated_schedule)
tostringSon tarih (YYYY-MM-DD) (templated_schedule)
display_settings_writeEkranlar

Bir tesisin Display Screens ayarlarını değiştirir: Fallback Slate, yoklama ve gece yeniden yükleme ile "Allow CCTV on display screens"; ekran güç programı ve otomasyonlar (parlaklık, zil sesi düzeyi, check-in ile açılma). Belirtmediğiniz alanlar geçerli değerlerini korur. Marka genelindeki ayarlar (açılış ekranı, templated content) display_brand_settings_write içindedir.

Eylemler:

  • save_settings: Tesis ekran ayarlarını kaydeder. Hiçbir şey planlanmadığında gösterilen Fallback Slate, yoklama aralığı (30–300 sn), gece yeniden yükleme saati (HH:mm) ve allowCctv. allowCctv'yi açmak kullanıcının onayını ve güvenlik kamerası erişimi olan bir tesis yöneticisini gerektirir. Onay isteyebilir.
  • save_power_schedule: Güç programını kaydeder. Ekranların ne zaman açılıp kapandığını değiştirir; ilettiğiniz alanlar kayıtlı programla birleştirilir. Sonraki 7 günün açılma/kapanma saatlerini döndürür. Önce display_settings_read power_schedule_preview ile kontrol edin. schedule gerektirir.
  • save_automations: Ekran otomasyonlarını kaydeder. Otomatik parlaklık, zil sesi düzeyi ve check-in ile açılma ayarlarını değiştirir. Tesis bundan sonra genel varsayılanlar yerine kendi ayarlarını korur.

Parametreler

AdTürAçıklama
action*"save_settings" | "save_power_schedule" | "save_automations"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
slateobject(save_settings)
pollIntervalSecinteger(save_settings)
nightlyReloadTimestringHH:mm (save_settings)
allowCctvbooleanEkranlarda güvenlik kamerasına izin ver (save_settings)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
scheduleobjectEkranlar personelli saatlerde (sapmalarla genişletilmiş) veya özel haftalık zaman aralıklarında, bir tatil kuralıyla açıktır. (save_power_schedule)
autoPowerDisplaysbooleanEski güç otomasyonu açık/kapalı (güç programı bunun yerini alır) (save_automations)
minsBeforeOpenDisplayOnintegerEski güç otomasyonu: açılıştan önceki dakika (save_automations)
minsAfterCloseDisplayOffintegerEski güç otomasyonu: kapanıştan sonraki dakika (save_automations)
displaysOnCheckInbooleanBiri check-in yaptığında ekranları açar (save_automations)
minsLastCheckInDisplayOffintegerdisplaysOnCheckIn ile: ekranların son check-in'den kaç dakika sonra kapanacağı (save_automations)
enableAutoBrightnessbooleanGündüz ve gece parlaklığı arasında geçiş yapar (save_automations)
dayTriggerType"auto" | "staffed" | "custom"Gündüz parlaklığının başladığı zaman (save_automations)
dayTimeStartstringdayTriggerType custom için: HH:mm (tesis saati) (save_automations)
dayOffsetMinutesintegerŞafaktan veya açılıştan sonraki dakika (save_automations)
dayBrightnessLevelintegerGündüz parlaklığı, % (save_automations)
nightTriggerType"auto" | "staffed" | "custom"Gece parlaklığının başladığı zaman (save_automations)
nightTimeStartstringnightTriggerType custom için: HH:mm (tesis saati) (save_automations)
nightOffsetMinutesintegerHava karardıktan sonraki veya kapanıştan önceki dakika (save_automations)
nightBrightnessLevelintegerGece parlaklığı, % (save_automations)
bellMasterLevelintegerAna zil sesi düzeyi, % (save_automations)
bellClubHoursLevelintegerPersonelli saatlerde zil sesi düzeyi, % (save_automations)
bellExtendedHoursLevelintegerGenişletilmiş saatlerde zil sesi düzeyi, % (save_automations)
enableBellAutoVolumebooleanZil sesi düzeyi programını izler (save_automations)
bellVolumeScheduleobjectHafta günü başına haftalık zil sesi düzeyi blokları (mon … sun); tüm programın yerini alır (save_automations)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın
display_takeover_stopEkranlar

Devam eden Display Screens devralmalarını hemen sona erdirir: tek bir yayımlama için (display_publish'ten batchId), hedefler için (varsayılan: tesisin tamamına yayımlanan devralmalar) veya allScreens ile tesise, ekranlarına ya da gruplarına yayımlanan her devralma için. Marka ve organizasyon devralmaları yalnızca batchId ile durdurulur. Ekranlar saniyeler içinde planlanmış veya varsayılan içeriklerine döner; kaç devralmanın durdurulduğunu döndürür. Birden fazla ekran, grup veya hedef verildiğinde bu araç tek çağrıda hepsine uygulanır; çok sayıda öğe üzerinde işlem yapmadan önce kullanıcıya danışın.

Parametreler

AdTürAçıklama
batchIdstringdisplay_publish'ten devralma yayımlaması (bt_…)
targetsobjectİçeriğin gideceği yer. Bunlardan herhangi birini birleştirebilirsiniz. Grup adları da kimlikler gibi çalışır. brand ve organisation, organizasyon genelinde Display Screens erişimi gerektirir.
allScreensbooleanTesise, ekranlarına veya gruplarına yayımlanan her devralma
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
display_templated_writeEkranlar

Templated content ekranlarını denetler (display_screens_read'de görüntüleme modu "Templated content"): bu ekranlara bir günün antrenman programını yükleme veya tur zamanlayıcısını denetleme. User managed content ve tam sayfa web sitesi ekranları hiçbir zaman etkilenmez.

Eylemler:

  • load_program: Bir antrenman programı yükler. Bir veya birden fazla tesisteki her templated content ekranına, tesisin veri kaynağından bir tarihin antrenman programını (YYYY-MM-DD, varsayılan bugün) yükler; ekranlar saniyeler içinde yeniden yüklenir. Bugünün veya başka bir günün antrenmanını göstermek ya da ekranlar yanlış antrenmanı gösterdiğinde kullanın. Birden fazla tesis confirm gerektirir. Onay isteyebilir.
  • clock: Tur zamanlayıcısını denetler. Templated content ekranlarındaki tur zamanlayıcısını başlatır, duraklatır, yeniden başlatır veya durdurur; tur seslerini kapatır veya açar; zil sesi düzeyini ayarlar (volume 0–100 ile setvolume) ya da durumunu sorar. Tesiste templated content gerektirir. command gerektirir.

Parametreler

AdTürAçıklama
action*"load_program" | "clock"Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır.
facilityIdsarrayAynı isteği her birinde çalıştırmak için birden fazla tesis kimliği. facilityId yerine kullanın. (load_program)
datestringAntrenman tarihi, YYYY-MM-DD (varsayılan bugün) (load_program)
facilityIdstringTesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır.
command"getstate" | "play" | "pause" | "restart" | "stop" | "mute" | "unmute" | "setvolume"(clock)
volumeintegersetvolume için: zil sesi düzeyi, % (clock)
confirmbooleanYalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın