Усі статті
2 хв читання#agents#api#reference

Шість типів блоків на одній сторінці

Сторінка — це список блоків і більше нічого. Вивчіть шість штук, і ви вивчили всю модель даних.

Шістка

Кожен блок — це об’єкт із типом і полями цього типу. На агентних ендпоїнтах ідентифікатор, порядок і ознака видимості необов’язкові: сервер видасть ідентифікатор, збереже надісланий порядок і покаже блок. Надсилайте їх назад лише тоді, коли прочитали сторінку і правите її на місці.

ТипПотрібноМоже бути ще
linklabel, urlnote, image, badge, featured, adult, path, apps, imageFocus
socialRowitems із platform і urlдо двадцяти елементів
socialplatform, urlcounter
messengerplatform, handlelabel
embedprovider, urltitle
textcontentvariant: heading або paragraph

url — це http або https, або телефон як tel з кодом країни, або адреса як mailto. Голе ім’я хоста теж приймається і зберігається з https. Картинки — це ключі сховища з роута завантаження, а не адреси. У будь-якого блока може бути момент початку і момент кінця, поза якими він не малюється.

Обмеження, яких схема виразити не може

  • Короткі шляхи унікальні всередині сторінки: два посилання не можуть бути «shop», і зіткнення повернеться помилкою з назвою шляху.
  • Службові слова — api, go, gate, media — коротким шляхом бути не можуть.
  • Вісімдесят блоків на сторінку — стеля, і сторінка, що до неї наближається, уже надто довга, щоб її читали.
  • Надіслані в оновленні блоки замінюють увесь список: часткового злиття немає, бо в злиття двох списків блоків немає розумного визначення.

Форма, яка зазвичай працює

Одне виділене посилання на головне цього місяця, за ним два-п’ять звичайних у порядку важливості, один рядок соцмереж з усіма платформами, кнопка месенджера чи телефона, якщо звернення приходять так, і текстовий заголовок — лише якщо сторінка достатньо довга, щоб її ділити.

Це п’ять-дев’ять блоків. Уміщається в півтора екрана телефона, читається за один прохід, і рівно це видають рецепти в документації для музиканта, ресторану, фотографа чи крамниці — із заміною іменників і більше нічим.

Читати далі