EntryPoint

Тип schema.org ?

Канонический URL: https://schema.org/EntryPoint
👉 Проверить на наличие открытых проблем.

Содержание: Описание, Свойства которые можно использовать, Подходит для свойств, Благодарности, Примеры использования.

Описание:

Точка входа в рамках некоторого веб-протокола.

EntryPoint — это тип данных в Schema.org, который используется для описания точки доступа к определенному веб-протоколу. Этот тип позволяет структурировать информацию о том, как пользователи или системы могут взаимодействовать с веб-сервисом или API (интерфейсом программирования приложений).

Основная функция EntryPoint заключается в том, чтобы предоставить четкую информацию о том, как можно начать взаимодействие с определенным ресурсом или сервисом в интернете. Это может включать в себя детали о том, какие URL-адреса использовать, какие методы HTTP поддерживаются (например, GET, POST), а также какие параметры могут быть переданы в запросах.

EntryPoint может быть полезен в различных сценариях, включая:

Документация API: Разработчики могут использовать EntryPoint для описания точек доступа к своим API, что упрощает интеграцию для других разработчиков.
Поисковые системы: Поисковые системы могут использовать информацию о EntryPoint для улучшения индексации и поиска веб-сервисов, предоставляя пользователям более точные результаты.
Интерактивные приложения: Веб-приложения могут использовать EntryPoint для указания, как пользователи могут взаимодействовать с их функциональностью.

Таким образом, EntryPoint служит важным инструментом для стандартизации и упрощения взаимодействия с веб-сервисами, обеспечивая ясность и доступность информации о точках доступа.

Свойство	Ожидаемый тип	Описание
Свойство из EntryPoint
actionApplication	SoftwareApplication	Приложение, которое может выполнить запрос.
actionPlatform	DigitalPlatformEnumeration, Text, URL	Высокоуровневые платформы, на которых может быть выполнено действие для заданного URL. Для указания конкретного приложения или экземпляра операционной системы используйте actionApplication.
contentType	Text	Поддерживаемый(е) тип(ы) контента для ответа EntryPoint.
encodingType	Text	Поддерживаемый тип(ы) кодирования для запроса EntryPoint.
httpMethod	Text	HTTP-метод, который указывает соответствующий HTTP-метод для запроса к HTTP EntryPoint. Значения представляют собой строки с заглавными буквами, как это используется в HTTP.
urlTemplate	Text	Шаблон URL (RFC6570), который будет использоваться для построения цели выполнения действия.
Свойство из Thing
additionalType	URL, Text	Дополнительный тип для элемента, обычно используемый для добавления более специфичных типов из внешних словарей в синтаксисе микроданных. Это отношение между чем-то и классом, к которому это что-то относится. Обычно значение является URI-идентифицированным классом RDF, и в этом случае соответствует использованию rdf:type в RDF. Текстовые значения могут использоваться экономно, в случаях, когда полезная информация может быть добавлена без наличия соответствующей схемы для ссылки. В случае текстовых значений, метка класса должна следовать руководству по стилю schema.org.
alternateName	Text	Псевдоним для элемента.
description	Text, TextObject	Описание предмета.
disambiguatingDescription	Text	Субсвойство описания. Краткое описание элемента, используемое для различения его от других, похожих элементов. Информация из других свойств (в частности, имени) может быть необходима для того, чтобы описание было полезным для различения.
identifier	PropertyValue, Text, URL	Свойство identifier представляет собой любой вид идентификатора для любого рода Thing, такого как ISBN, коды GTIN, UUID и т.д. Schema.org предоставляет специальные свойства для представления многих из них, как в виде текстовых строк, так и в виде ссылок URL (URI). См. фоновую информацию для получения дополнительных деталей.
image	ImageObject, URL	Изображение предмета. Это может быть URL или полностью описанный ImageObject.
mainEntityOfPage	CreativeWork, URL	Указывает на страницу (или другое творческое произведение), для которой этот объект является основным описываемым объектом. См. фоновую информацию для получения деталей.
name	Text	Название элемента.
potentialAction	Action	Указывает на потенциальное действие, которое описывает идеализированное действие, в котором этот объект будет играть роль 'объекта'.
sameAs	URL	URL страницы в Интернете, которая однозначно указывает на идентичность элемента. Например, URL страницы элемента в Википедии, запись в Викиданных или официальный сайт.
subjectOf	CreativeWork, Event	Творческое произведение или событие, связанное с этой вещью.
url	URL	URL предмета.

Экземпляры EntryPoint могут использоваться в качестве значения для следующих свойств.

Свойство	Типы	Описание
target	Action	Указывает целевую точку входа (EntryPoint) или URL для действия (Action).

Благодарности

Проект Hydra

Механизм Actions schema.org получил значительную пользу от обширных обсуждений в сообществе стандартов веба вокруг W3C, в частности от группы сообщества проекта Hydra.

Примеры

Пример 1

Пример заметки или HTML разметки.


A Restaurant named "Tartine Bakery" with a ViewAction as a
potentialAction, with several target endpoints including
the simple url http://example.com/player?id=123 and
full EntryPoint descriptions for Windows and iOS SoftwareApplication
apps.

Пример, закодированный в формате JSON-LD в теге <script> HTML.


<script type="application/ld+json">

{
  "@context": "https://schema.org",
  "@type": "Restaurant",
  "name": "Tartine Bakery",
  "potentialAction": {
    "@type": "ViewAction",
    "target": [
      "http://www.urbanspoon.com/r/6/92204",
      {
        "@type": "EntryPoint",
        "urlTemplate": "http://api.urbanspoon.com/r/6/92204",
        "contentType": "application/json+ld"
      },
      "android-app://com.urbanspoon/http/www.urbanspoon.com/r/6/92204",
      {
        "@type": "EntryPoint",
        "urlTemplate": "urbanspoon://r/6/92204",
        "actionApplication": {
          "@type": "SoftwareApplication",
          "@id": "284708449",
          "name": "Urbanspoon iPhone & iPad App",
          "operatingSystem": "iOS"
        }
      },
      {
        "@type": "EntryPoint",
        "urlTemplate": "urbanspoon://r/6/92204",
        "actionApplication": {
          "@type": "SoftwareApplication",
          "@id": "5b23b738-bb64-4829-9296-5bcb59bb0d2d",
          "name": "Windows Phone App",
          "operatingSystem": "Windows Phone 8"
        }
      }
    ]
  }
}
</script>

Структурированное представление примера JSON-LD.

@context

https://schema.org

@type

Restaurant

name

Tartine Bakery

potentialAction

@type

ViewAction

target

0