SearchAction

Тип schema.org ?

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

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

Описание:

Акт поиска объекта.

Связанные действия:

FindAction: SearchAction обычно приводит к FindAction, но не обязательно.

SearchAction — это тип, описанный в Schema.org, который используется для обозначения действия поиска объекта. Он служит для структурирования данных, чтобы поисковые системы и другие платформы могли лучше понимать содержание веб-страниц и взаимодействия пользователей с ними.

Основная цель SearchAction заключается в том, чтобы указать, что пользователь инициирует поиск информации или объектов на сайте. Это может быть полезно для улучшения видимости сайта в поисковых системах, так как они могут распознавать и интерпретировать действия пользователей более эффективно.

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

Важно отметить, что SearchAction может быть связан с другим типом действия, называемым FindAction, которое обозначает более конкретное действие нахождения объекта после поиска. Однако SearchAction не обязательно всегда приводит к FindAction, так как пользователь может не найти искомую информацию.

Использование SearchAction помогает улучшить семантическую структуру данных на веб-сайте, что может привести к лучшему ранжированию в поисковых системах и более качественному взаимодействию с пользователями.

Свойство	Ожидаемый тип	Описание
Свойство из SearchAction
query	Text	Субсвойство инструмента. Запрос, используемый в этом действии.
Свойство из Action
actionStatus	ActionStatusType	Указывает текущее состояние Действия.
agent	Organization, Person	Непосредственный исполнитель или движущая сила действия (живое или неживое). Например, Джон написал книгу.
endTime	DateTime, Time	Время окончания чего-либо. Для зарезервированного события или услуги (например, FoodEstablishmentReservation) — время, когда ожидается его завершение. Для действий, которые занимают определенный период времени, это время выполнения действия. Например, Джон писал книгу с января по декабрь. Для медиа, включая аудио и видео, это временной смещение конца клипа в рамках более крупного файла. Обратите внимание, что событие использует startDate/endDate вместо startTime/endTime, даже когда описываются даты с указанием времени. Эта ситуация может быть уточнена в будущих редакциях.
error	Thing	Для неудачных действий, дополнительная информация о причине неудачи.
instrument	Thing	Объект, который помог агенту выполнить действие. Например, Джон написал книгу с помощью ручки.
location	VirtualLocation, Text, PostalAddress, Place	Место, например, где проходит событие, где расположена организация или где происходит действие.
object	Thing	Объект, над которым выполняется действие, состояние которого остается неизменным или изменяется. Также известен как семантические роли пациент, затронутый или подвергающийся (которые изменяют свое состояние) или тема (которая не изменяет своего состояния). Например, Джон прочитал книгу.
participant	Organization, Person	Другие соучастники, которые косвенно участвовали в действии. Например, Джон написал книгу с Стивом.
provider	Organization, Person	Поставщик услуг, оператор услуг или исполнитель услуг; производитель товаров. Другая сторона (продавец) может предлагать эти услуги или товары от имени поставщика. Поставщик также может выступать в качестве продавца.
result	Thing	Результат, полученный в результате действия. Например, Джон написал книгу.
startTime	DateTime, Time	Время начала чего-либо. Для зарезервированного события или услуги (например, FoodEstablishmentReservation) это время, когда ожидается его начало. Для действий, которые занимают определенный период времени, это время, когда действие было выполнено. Например, Джон писал книгу с января по декабрь. Для медиа, включая аудио и видео, это временной смещение начала клипа в рамках большего файла. Обратите внимание, что событие использует startDate/endDate вместо startTime/endTime, даже при описании дат с указанием времени. Эта ситуация может быть уточнена в будущих редакциях.
target	EntryPoint, URL	Указывает целевую точку входа (EntryPoint) или URL для действия (Action).
Свойство из 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 предмета.

Примеры

Пример 1

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


John searched for 'What is the answer to life the universe and everything?'.

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


<!--  John searched for 'What is the answer to life the universe and everything?'.-->
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "SearchAction",
  "agent": {
    "@type": "Person",
    "name": "John"
  },
  "query": "What is the answer to life the universe and everything?"
}
</script>

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

@context

https://schema.org

@type

SearchAction

agent

@type: Person
name: John

query

What is the answer to life the universe and everything?

Пример 2

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


John searched for hotels.

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


<!--  John searched for hotels.-->
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "SearchAction",
  "agent": {
    "@type": "Person",
    "name": "John"
  },
  "query": "Hotels"
}
</script>

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

@context

https://schema.org

@type

SearchAction

agent

@type: Person
name: John

query

Hotels

Пример 3

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


<p>(A WebSite describing its search options)</p>

Пример, закодированный в формате Microdata, встроенный в HTML.


<div itemscope itemtype="https://schema.org/WebSite">
    <link itemprop="url" href="http://www.example.com/"/>
    <form itemprop="potentialAction" itemscope itemtype="https://schema.org/SearchAction">
	  <meta itemprop="target" content="http://example.com/search?q={query}"/>
      <input itemprop="query" type="text" name="query"/>
      <input type="submit"/>
    </form>
</div>

Пример, закодированный в формате RDFa, встроенный в HTML.


<div vocab="https://schema.org/" typeof="WebSite">
    <link property="url" href="http://www.example.com/"/>
    <form property="potentialAction" typeof="https://schema.org/SearchAction">
      <meta property="target" content="http://www.example.com/search?q={query}"/>
      <input property="query" type="text" name="query">
      <input type="submit">
    </form>
</div>

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


<script type="application/ld+json">
{
    "@context": "https://schema.org",
    "@type": "WebSite",
    "url": "http://example.com/",
    "potentialAction": {
      "@type": "SearchAction",
      "target": "http://example.com/search?&q={query}",
      "query": "required"
    }
}
</script>

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

@context

https://schema.org

@type

WebSite

url

http://example.com/

potentialAction