CGI参数

搜索CGI参数

提供了可复制并粘贴到站点HTML的搜索表单代码( Design > Auto-Complete > Form Source)。

请参阅将搜索表单的HTML代码复制到…….

您还可以设置在搜索表单本身或脚本中列出的参数。除了下面列出的参数之外，您还可以使用后端搜索参数来控制搜索。

请参阅后端搜索CGI参数。

搜索请求由基本URL组成。基本URL指示客户正在搜索的帐户，以及一组CGI参数（键值对），这些参数指示如何返回所需的关联帐户搜索结果。

基本URL与特定帐户以及分阶段或实时环境关联。您可以从客户经理请求基本URL的多个别名。例如，名为Megacorp的公司可能具有两个与其帐户关联的基本URL: https://search.megacorp.com 和 https://stage.megacorp.com。前一个URL搜索其实时索引，后一个URL搜索其分阶段索引。

支持三种格式的CGI参数。默认情况下，您的帐户配置为使用分号分隔CGI参数，如下例所示：

https://search.megacorp.com?q=shoes;page=2

如果您愿意，您可以让客户经理将您的帐户配置为使用&符分隔CGI参数，如下例所示：

https://search.megacorp.com?q=shoes&page=2

还支持第三种格式（称为SEO格式），其中正斜杠 / 代替分隔符，并与以下示例中的等号相同：

https://search.megacorp.com/q/shoes/page/2

每当使用SEO格式发送请求时，所有输出链接都将以相同格式返回。

向导式搜索参数	示例	描述
q	`q=string`	指定搜索的查询字符串。此参数映射到后端 `sp_q` 搜索参数。请参阅后端搜索CGI参数。
q#	`q#=string`	分面（在给定字段内搜索）是通过编号q和x参数完成的。 q参数定义要在facet中搜索的术语，由相应的编号x参数表示。例如，如果您有两个彩块化，分别命名为大小和颜色，则可以有类似q1=small;x1=size;q2=red;x2=color的内容。此参数映射到后端 `sp_q_exact_#` 搜索参数。请参阅后端搜索CGI参数。
x 不支持跨域跟踪#	`q#=string`	分面（在给定字段内搜索）是通过编号q和x参数完成的。 q参数定义要在facet中搜索的术语，由相应的编号x参数表示。例如，如果您有两个彩块化，分别命名为大小和颜色，则可以有类似q1=small;x1=size;q2=red;x2=color的内容。此参数映射到后端 `sp_x_#` 搜索参数。请参阅后端搜索CGI参数。
collection（集合）	`collection=string`	指定用于搜索的集合。此参数映射到后端 `sp_k` 搜索参数。请参阅后端搜索CGI参数。
count（计数）	`count=number`	指定显示的结果总数。默认值在> Settings > Searching 中定 Searches义。. 此参数映射到后端 `sp_c` 搜索参数。请参阅后端搜索CGI参数。
page	`page=number`	指定返回的结果页。
秩	`rank=field`	指定用于静态排名的排名字段。该字段必须是“排名”类型且相关度大于0的字段。此参数映射到后端 `sp_sr` 参数。请参阅后端搜索CGI参数。
排序	`sort=number`	指定排序顺序。 “0”为默认值，按相关性得分排序；“1”按日期排序；“-1”不排序。用户可以指定参数值的字段名 `sp_s` 称。例如， `sp_s=title` 根据标题字段中包含的值对结果进行排序。当字段名称用于参数的值时，结果 `sp_s` 将按该字段排序，然后按相关性进行子排序。 To enable this feature, click Settings > Metadata > Definitions. 在“定义”页面上，单 Add New Field 击或单 Edit 击特定字段名称。在下 Sorting 拉列表中，选择或 Ascending 选 Descending项。此参数映射到后端 `sp_s` 搜索参数。请参 [阅后端搜索CGI参数]。(/docs/search-promote/using/appendices/c-cgiparameters.html?lang=zh-Hans#reference_582E85C3886740C98FE88CA9DF7918E8)。

后端搜索CGI参数

通常，客户会与称为“向导式搜索”的表示层交互。但是，理论上可以跳过引导搜索层，直接使用本页中描述的CGI参数与后端核心搜索交互。

您可以从下表中选择后端搜索CGI参数：

	单一查询支持	多查询支持	示例	描述
1	sp_a		`sp_a= string`	指定帐号字符串。此参数是必需的，并且必须是有效的帐号字符串。您可以在“设置”>“帐户选项”>“帐户设置”下查找您的帐户号码字符串。
2	sp_advanced		`sp_advanced= 0 or 1`	如 `sp_advanced=1` 果提交查询，则搜索模板中标记 `<search-if-advanced>` 和标 `</search-if-advanced>` 记之间的所有代码将用于搜索表单。将忽略标记 `<search-if-not-advanced>` 和标记 `</search-if-not-advanced>` 之间的所有代码。如果 `sp_advanced=0` 提交了（或任何其他值），则忽略<search-if-advanced>模板块，并使用<search-if-not-advanced>模板块。
3	sp_c		`sp_c= number`	指定要显示的结果总数。默认值为 10。
4	sp_context_field		`sp_context_field= field`	收集给定字段的上下文信息。收集的信息通过模板标签在搜索结果中 `<search-context>` 输出。默认值为 `body` .
5	sp_d		`sp_d= type`	指定要执行的日期范围搜索的类型。类型的可能值是任意值，这意味着不执行日期范围搜索，自定义，指 `sp_date_range` 示应使用的值确定要搜索的日期，特定，指示使用、、 `sp_start_day` 、 `sp_start_month` 和中的值确定要搜索的日 `sp_start_year` `sp_end_day` `sp_end_month` `sp_end_year` 期范围。 `sp_d` 仅当您的搜索表单包含按自定义范围（通过）或按特定开始和结束日期范围 `sp_date_range` 进行搜索的选项时，才需要此选项。
6		sp_d_#	`sp_d_#= type`	指定要对相应查询执行的日期范围搜索的类 `sp_q_#` 型。将“#”替换为介于1和16之间的数字(例如， `sp_d_8` 应用于编号查询 `sp_q_8` )。您可以设 `type` 置为任何，即不执行日期范围搜索、自定义，这表示使用的值确定要搜索的日期，而特定 `sp_date_range_#` ，指 `sp_q_min_day_#` 示应使用、、、 `sp_q_min_month_#` 、 `sp_q_min_year_#` 和中的值确 `sp_q_max_day_#` `sp_q_max_month_#` `sp_q_max_year_#` 定日期范围。仅当搜 `sp_d_#` 索表单包含按自定义范围（通过）或特定开始和结束日期范围进行搜索的 `sp_date_range_#` 选项时，才需要使用。
7	sp_date_range		`sp_date_range= number`	指定要应用于搜索的预定义日期范围。大于或等于零的值指定今天之前要搜索的天数——例如，值“0”指定“今天”，值“1”指定“今天和昨天”，值“30”指定“过去30天内”，依此类推。低于零的值指定自定义范围，如下所示： -1 = "None"，与指定无日期范围相同。 -2 =“本周”，从周日到周六搜索。 -3 = "Last week"，搜索时间从当前周前一周的星期日到星期六。 -4 =“本月”，搜索日期在当月内。 -5 =“上个月”，搜索日期在当月之前的一个月内。 -6 =“今年”，搜索日期在当年。 -7 =“去年”，搜索日期在当前年度之前的一年。
8		sp_date_range_#	`sp_date_range_#= number`	指定要应用于相应查询的预定义日期范 `sp_q_#` 围。将“#”替换为介于1和16之间的数字(例如， `sp_date_range_8` 应用于编号查询 `sp_q_8` )。大于或等于零的值指定今天之前要搜索的天数。例如，值0指定今天；值1指定今天和昨天；值30指定在过去30天内，依此类推。低于零的值指定自定义范围，如下所示： -1 = "None"，与指定无日期范围相同。 -2 =“本周”，从周日到周六搜索。 -3 = "Last week"，搜索时间从当前周前一周的星期日到星期六。 -4 =“本月”，搜索日期在当月内。 -5 =“上个月”，搜索日期在当月之前的一个月内。 -6 =“今年”，搜索日期在当年。 -7 =“去年”，搜索日期在当前年度之前的一年。
9	sp_dedupe_field		`sp_dedupe_field= fieldname`	指定单个字段以对搜索结果进行重复数据消除。该字段上的所有重复结果都将从搜索结果中删除。例如，如果是， `sp_dedupe_field=title` 则在搜索结果中只显示给定标题的顶部结果（没有两个结果将具有相同的标题字段内容）。对于多值(允许列表)类型字段，整个字段内容用于比较。只能指定一个字段。字段名称中不允许使用“table-qualifier”。
10	sp_e		`sp_e= number`	指定对于查询字符串中的任意字应进行自动通配符扩展，该字符数多于数字。换言之，指 `sp_e=5` 定包含5个或更多字符的单词(如“查询”或“数字”)应使用通配符“”展开，使搜索等同于搜索“查询”或“数字*”。字符数较少的单词不会展开，因此搜索“单词”时不会自动扩展通配符。
11		sp_e_#	`sp_e_#= number`	指定对来自相应查询字符串的任意字进行自动通配符扩 `sp_q_#` 展，该字符串的字符数多于数字。换句话说， `sp_e_2=5` 指定查询字符串中包含5个或5个以上字符的词(如“查询”或“数字”)应使用通配符“ `sp_q_2` `` ”展开，使搜索等同于搜索“查询”或“数字*”。字符数较少的单词不会展开，因此在中搜索“单词” `sp_q_2` 将不会自动扩展通配符。
12	sp_end_day、sp_end_month、sp_end_year		`sp_end_day= number,sp_end_month= number, sp_end_year= number`	这三个值指定搜索的结束日期范围，并且必须作为集提供。
13	sp_f		`sp_f= string`	指定查询参数字符串的字符集(如 `sp_q` )。此字符串必须始终与包含搜索表单的页面的字符集匹配。
14	sp_field_table		`sp_field_ table=table: field,field...`	定义包含给定字段的逻辑数据表。例如，由“color”、“size”和“price”字段组成的名为“items”的表定义为： `sp_field_table=items:color,size,price` 逻辑表与检查了“允许列表”的字段(在“设置”>“元数据” >“定义 ”下) 一起使用时最有用的方式。所有以字段名称为值的CGI参数和模板标记都可以选择指定表名称，后跟“”。在字段名称之前(例如 `sp_x_1=tablename.fieldname` )。例如，要搜索包含大小为“large”（其中项目表示为并行元数据行）的一个或多个“red”项目的文档，可以使用以下代码： `sp_q_exact_1=red&sp_x_1=items.color& sp_q_exact_2=large&sp_x_2=items.size&sp_field_table=items:color,size,price`
15	sp_i			`sp_i=1` `sp_i=2`
			`sp_k= string`
			`sp_l= string`	`sp_q` `string`
			`sp_literal= 0 or 1`	`sp_literal=1` `sp_literal=0`
			`sp_m= number`
			`sp_n= number`
			`sp_not_found_page= url`
			`sp_p= any/all/phrase`	`any` `all` `phrase` `phrase` `all` `sp_p` `sp_p`
			`sp_p_#= any/all/phrase`	`sp_q_#` `sp_p_8` `sp_q_8` `any` `all` `phrase` `all` `phrase` `sp_p_#` `any`
			`sp_pt= exact/equivalent/compatible`	`exact` `equivalent` `compatible` `sp_p` `exact` `sp_p` `all` `phrase` `equivalent` `sp_pt` `compatible`
			`sp_pt_#= exact/equivalent/compatible`	`sp_q_#` `sp_p_8` `sp_q_8` `exact` `equivalent` `exact` `compatible` `sp_p_#` `exact` `sp_p_#` `equivalent` `sp_pt_#` `compatible`
			`sp_q= string`
			`sp_q_#= text`	`sp_q_#` `sp_q_1` `sp_q_16` `Search for: <input type="text" name="sp_q" value="great"> Search for: <input type="text" name="sp_q_1" value="books">`
			`sp_q_day= integer value` `sp_q_month= integer value` `sp_q_year= integer value` `sp_q_day_#= integer value` `sp_q_month_#= integer value` `sp_q_year_#= integer value`	`sp_q_day` `sp_q_month` `sp_q_year` `sp_q` `#` `sp_q_day_6` `sp_q_6` `PublishDate` `<input type="hidden" name="sp_x_1" value="PublishDate"> Search for: <input type="text" name="sp_q" value="orange">On : <input type="text" name="sp_q_day_1" size="2" value="1"> Day<input type="text" name="sp_q_month_1" size="2" value="1"> Month <input type="text" name="sp_q_year_1" size="4" value="2000"> Year`
			`sp_q_location=latitude/longitude OR areacode OR zipcode` `sp_q_location_#= latitude/longitude OR areacode OR zipcode`	`sp_q_location` `sp_q_location_#` `#`
			`sp_q_max_relevant_distance= value` `sp_q_max_relevant_distance_#= value`	`sp_q_max_relevant_distance` `sp_q_max_relevant_distance_#` `#` `sp_q_max_relevant_distance` `sp_q_max_relevant_distance_#`
			`sp_q_min_day=integer value` `sp_q_min_month=integer value` `sp_q_min_year=integer value` `sp_q_max_day=integer value` `sp_q_max_month=integer value` `sp_q_max_year=integer value` `sp_q_min_day_#=integer value` `sp_q_min_month_#=integer value` `sp_q_min_year_#=integer value` `sp_q_max_day_#=integer value` `sp_q_max_month_#=integer value` `sp_q_max_year_#=integer value`	`sp_q_min_day` `sp_q_min_month` `sp_q_min_year` `sp_q_max_day` `sp_q_max_month` `sp_q` `#` `sp_q_min_day_6` `sp_q_6` `PublishDate` <input type="hidden" name="sp_x_1" value="PublishDate">Search for: <input type="text" name="sp_q" value="orange">Between: <input type="text" name="sp_q_min_day_1" size="2" value="1"> Start Day<input type="text" name="sp_q_min_month_1" size="2" value="1"> Start Month <input type="text" name="sp_q_min_year_1" size="4" value="2000"> Start Year And: <input type="text" name="sp_q_max_day_1" size="2" value="31"> End Day <input type="text" name="sp_q_max_month_1" size="2" value="12"> End Month <input type="text" name="sp_q_max_year_1" size="4" value="2000"> End Year
			`sp_q_min= value` `sp_q_max= value` `sp_q_min_#= value` `sp_q_max_#= value` `sp_q_exact_#=value`	`sp_q_min` `sp_q_max` `sp_q_exact` `sp_q` `#` `sp_q_min_8` `sp_q_8` `sp_q_exact_#` `sp_q_min_#` `sp_q_max_#` `sp_q_exact_#` `sp_q_min_#` `sp_q_max_#` `sp_q_min_#` `sp_q_max_#` `sp_q_exact_#` `...&sp_q_exact_1=green\|red&sp_x_1=color`
			`sp_q_nocp= 1 or 0` `sp_q_nocp_#= 1 or 0`	`0` `1` `sp_q_nocp` `sp_q` `#` `sp_q_nocp_8` `sp_q_8`
			`sp_q_required= 1 or 0 or -1` `sp_q_required_#= 1 or 0 or -1`	`sp_q_required` `sp_q` `#` `sp_q_required_8` `sp_q_8` `<input type="hidden" name="sp_x_1" value="platform"> Search for: <input type="text" name="sp_q" value="calc"> Exclude: <input type="text" name="sp_q_1" value="mac win all"> <input type="hidden" name="sp_q_required_1" value="-1">`
			`sp_redirect_ if_one_result= 0 or 1`
			`sp_referrer= url`
				`ro` `sp_ro=body:10` `sp_ro=body:9\|title:9` `sp_ro=title:10` `title` `sp_ro` `sp_ro`
			`sp_s= number`	`sp_s` `sp_s=title` `sp_s` `sp_s` `<input type="hidden" name="sp_s" value="artist"> <input type="hidden" name="sp_s" value="album"> <input type="hidden" name="sp_s" value="track"> Search for: <input type="text" name="sp_q" value="Music Search">` `sp_field_table`
			`sp_sr= field`	`sp_sr` `sp_sr` `<input type="hidden" name="sp_sr" value="">`
			`sp_sfvl_field= string`	`search-field-value-list` `sp_sfvl_field`
				`search-field-value-list` `dynamic-facet-field-count` `dynamic-facet-field-count` `sp_sfvl_df_count` `dynamic-facet-field-count` `sp_sfvl_df_count` `sp_sfvl_df_count`

				`sp_sfvl_df_count` `sp_sfvl_df_include` `sp_sfvl_df_include` `sp_sfvl_df_count`
			`sp_staged= 0 or 1`	`sp_staged=1`
			`sp_start_day= number` `sp_start_month= number` `sp_start_year= number`
			`sp_suggest_q= number`	`sp_suggest_q` `sp_q[_#]` `sp_suggest_q` `sp_q` `sp_suggest_q=1` `sp_q_1`
			`sp_t= string`
			`sp_trace= 0 or 1`	`sp_stage=1`
			`sp_w= sound-alike-enable` `sp_w_control=sound-alike-control`	`sp_w_control` `sp_w_control=0` `sp_w` `<input type=hidden name="sp_w_control" value="0"><input type=checkbox name="sp_w" value="exact">No Sound-Alike matching` `sp_w_control=1` `sp_w` `<input type=hidden name="sp_w_control" value="1"><input type=checkbox name="sp_w" value="alike">Sound-Alike matching` `sp_w_control` `sp_w`
			`sp_x= field`	`sp_q` `sp_x` `sp_x` `sp_x=any` `sp_x` `sp_x` `<input type="hidden" name="sp_x" value="title"><input type="hidden" name="sp_x" value="author">Search for: <input type="text" name="sp_q" value="Great Books">`
			`sp_x_#= field-name`	`sp_q_#` `#` `sp_x_8` `sp_x_#` `Search for: <input type="text" name="sp_q" value="great"><input type="hidden" name="sp_x_1" value="author">Search only documents written by: <input type="text" name="sp_q_1" value="Fitzgerald">` `sp_x` `sp_x_#` `<input type="hidden" name="sp_x_1" value="body"><input type="hidden" name="sp_x_1" value="keys">Search for: <input type="text" name="sp_q_1" value="flower">`

使用后端搜索CGI参数的典型示例

以下链接查询开始使用“音乐”作为搜索查询的搜索，并使用所有默认参数。请注意，URL将分为两行，以便可读。在您的HTML中，此链接应全部在一行上。

<a href="https://search.atomz.com/search/?sp_q=Music&sp_a=sp99999999"> 
Testing...</a>

同一功能通常使用表单进行定义：

<form action="https://search.atomz.com/search/"> 
<input size=12 name="sp_q" value="Music"><br> 
<input type=hidden name="sp_a" value="sp99999999"> 
<input type=submit value="Search"><br> 
</form>

在启动搜索时，通常应使用默认参数。这样，第一页就会显示，并按相关性进行排序，客户还可以选择其他页面和其他选项。如果站点上的搜索表单包含集合选项，请将集合名称作为参数传递。

使用后端搜索CGI参数的详细示例

以下表单查询显 25 示结果从结果开始 10。不会显示摘要，排序顺序按日期排列，并且使用名为的 support 集合。仅返回最近30天内文档。

<form action="https://search.atomz.com/search/"> 
<input size=12 name="sp_q"><br> 
<input type=hidden name="sp_a" value="sp99999999"> 
<input type=submit value="Search"><br> 
<input type=hidden name=sp_n value=10> 
<input type=hidden name=sp_c value=25> 
<input type=hidden name=sp_m value=0> 
<input type=hidden name=sp_s value=1> 
<input type=hidden name=sp_k value="support"> 
<input type=hidden name=sp_date_range value=30> 
</form>

adobe.com 上的资源

Ab Multivariate Testing Email Creation Audio Analytics Voice Analytics Customer Journey Analytics Demand Side Platform

在此页面上

查看下一个：

隐私（已更新）

使用条款