Skip to content

search.schema.md

Latest commit

 

History

History
187 lines (101 loc) · 3.39 KB

search.schema.md

File metadata and controls

187 lines (101 loc) · 3.39 KB

Search Schema

https://ns.adobe.com/xdm/context/search

Information about web search activity.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/search.schema.json

Schema Hierarchy

Search Example

{
  "xdm:searchEngine": "Google",
  "xdm:searchEngineID": "https://ns.adobe.com/searchengines/3",
  "xdm:keywords": "rice cooker",
  "xdm:isPaid": true,
  "xdm:pageDepth": 1
}

Search Properties

Property Type Required Defined by
xdm:isPaid boolean Optional Search (this schema)
xdm:keywords string Optional Search (this schema)
xdm:pageDepth integer Optional Search (this schema)
xdm:position integer Optional Search (this schema)
xdm:searchEngine string Optional Search (this schema)
xdm:searchEngineID string Optional Search (this schema)
xdm:slot string Optional Search (this schema)
* any Additional this schema allows additional properties

xdm:isPaid

Is paid

Indicate if the search is paid or not.

xdm:isPaid

  • is optional
  • type: boolean
  • defined in this schema

xdm:isPaid Type

boolean

xdm:keywords

Keywords

Keywords for the search.

xdm:keywords

  • is optional
  • type: string
  • defined in this schema

xdm:keywords Type

string

xdm:pageDepth

Page depth

Page depth in the search results.

xdm:pageDepth

  • is optional
  • type: integer
  • defined in this schema

xdm:pageDepth Type

integer

xdm:position

Listing position

Position or rank of the listing in the search result page.

xdm:position

  • is optional
  • type: integer
  • defined in this schema

xdm:position Type

integer

xdm:searchEngine

Search engine

The search engine used by the search.

xdm:searchEngine

  • is optional
  • type: string
  • defined in this schema

xdm:searchEngine Type

string

xdm:searchEngineID

Search engine ID

The application specified identifier used to identify the search engine used by the search.

xdm:searchEngineID

  • is optional
  • type: string
  • defined in this schema

xdm:searchEngineID Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:slot

Page slot

Named section of the page where the search result appeared, for example, top or side.

xdm:slot

  • is optional
  • type: string
  • defined in this schema

xdm:slot Type

string

xdm:slot Known Values

Value Description
top Top of the page
side Side of the page