上下文:定义可编程搜索引擎

本页介绍了如何使用上下文文件定义搜索引擎规范。

  1. 概览
  2. CustomSearchEngine 元素

概览

上下文文件描述搜索引擎的结构并定义其行为。了解上下文文件的最佳方式是查看一个简单的示例。建立信心后,您可能希望开始尝试各种元素和属性。您可以试用控制台中的设置,然后查看从概览页下载的生成的 XML 版本。

以下代码描述了一个气候变化搜索引擎。请注意,此搜索引擎已启用图片搜索。

<CustomSearchEngine keywords="climate &quot;global warming&quot; &quot;greenhouse gases&quot;"
                    language="en">
  <Title>RealClimate</Title>
  <Description>Science behind global warming and climate change.</Description>
  <Context>
    <BackgroundLabels>
      <Label name="_include_" mode="FILTER"/>
      <Label name="_exclude_" mode="ELIMINATE"/>
    </BackgroundLabels>
  </Context>
  <LookAndFeel/>
  <ImageSearchSettings enable="true"/>
</CustomSearchEngine>

CustomSearchEngine 元素

基本上下文文件包含以下主要元素和子元素。

元素 必需 说明
CustomSearchEngine 必需 包含相应搜索引擎的所有相关信息。具有以下属性:
  • keywords。指定与搜索引擎关联的用空格分隔的关键字列表(最多 100 个字符)。如果未指定,可编程搜索引擎将使用空值。
  • language - 指定界面中显示的其中一种支持的语言。指定某种语言的结果以该语言显示,但不会过滤掉其他语言的结果。如果未指定,可编程搜索引擎将使用 en(英语)。如果值为 null,可编程搜索引擎将使用用户语言区域的语言。
  • autocompletions。指明可编程搜索引擎是否应为您的搜索引擎生成术语表自动填充内容。允许的值为 truefalse。请注意,如果为 true,生成自动补全查询可能需要几个小时。设置此值后,您必须修改搜索框代码以请求自动补全功能。您可以从控制台的获取代码标签获取更新后的代码。只有搜索已包含网站的搜索引擎(即预先确定的网站集合)可以具有自动填充的查询。
Title 必需 您的搜索引擎的名称。它会显示在可编程搜索引擎的首页和结果页中。
Description 必需 在您的搜索引擎概览页面上显示的描述性文字。
Context 必需 包含标签相关信息。包含子元素 BackgroundLabelsFacet
BackgroundLabels 可选 用于宣传、包含或排除网站和网页的标签的容器。包含一个或多个 Label 子元素。
Label 可选 用于宣传网站或确定包含/排除网站的标签。具有以下属性:
  • name:标签名称。
  • modeFILTER(宣传或专门显示首选网站)或 ELIMINATE(排除网站)。您可以根据需要自定义这些标签。
LookAndFeel 必需 控制搜索引擎的外观和风格。它具有多个属性和子元素,外观和风格页面对这些属性和子元素进行了详细介绍。

ImageSearchSettings 可选

指定是否启用图片搜索。具有以下属性:

  • enable:指定是否为此搜索引擎启用图片搜索。允许的值为 truefalse