Google logo
Google Search Appliance Documentation
Search Protocol Reference
 PDF Previous Next
Front Matter
Introduction
Request Format
Results Format
Dynamic Result Clustering Service /cluster Protocol
Query Suggestion Service /suggest Protocol
Advanced Search Reporting Service /click Protocol
Appendices
Index

Index

A
access search parameter 10
advanced search reporting
description 102
HTTP response 105
processing 103
request parameters 103
allinanchor query term 23
allintext query term 29
allintitle query term 29
allinurl query term 30
ampersand (&) character 6, 47
anchor text search 23
as_dt search parameter 10, 26
as_epq search parameter 11, 28
as_eq search parameter 11
as_filetype search parameter 11
as_ft search parameter 11
as_lq search parameter 12, 24
as_occt search parameter 12
as_oq search parameter 12
as_q search parameter 12
as_sitesearch search parameter 13, 26
automatic languge filters 32
automatic search results filtering 107
B
back links 24
BLOB tag 56
Boolean operators
meta tag filtering 46
OR search 24
C
C tag 57
cache query term 24, 25
CACHE tag 58
CACHE_CONTENT_TYPE tag 58
CACHE_ENCODING tag 59
CACHE_HTML tag 59
CACHE_LANGUAGE tag 60
CACHE_LAST_MODIFIED tag 60
CACHE_LEGEND_FOUND tag 61
CACHE_LEGEND_NOTFOUND tag 61
CACHE_LEGEND_TEXT tag 62
CACHE_REDIR_URL tag 62
CACHE_URL tag 63
character encoding
supported 54
URLs 108
used with parameters 36
XML output 55
client search parameter 13
cluster requests 89
compressed search results 112
CRAWLDATE tag 63
CT tag 64
custom HTML output 53
custom search parameter 22
CUSTOM tag 64
D
date formatting 109
date range search
description 25
ISO 8601 format 25
Julian format 25
daterange keyword 25
decimal point (.) character 47
directory restricted search 26
Document Type Definition
dynamic result clusters 93
XML output 55
Duplicate Directory Filter 31
Duplicate Snippet Filter 31
dynamic result clusters
cluster requests 89
description 87
DTD 93
JSON request and response 89
processing 87
XML request and response 91
E
encoding, character 54, 108
ENTOBRESULTS tag 65
entqr search parameter 13
entqrm search parameter 14
ENT_SOURCE tag 65
entsp search parameter 14
estimated vs. actual results 106
excluding
file extensions 27
file types 27
words from search 26
ext query term 27
eXtensible Stylesheet Language Transformation (XSLT) 53
F
FI tag 66
file extensions
exclusion 27
filtering 27
file type
exclusion 27
filtering 27
filetype query term 27
filter search parameter 15, 31, 37
filtering
automatic 31, 107
by meta tags 48
combining language filters 34
duplicate directories 31
duplicate snippets 31
file extensions 27
file types 27
language 32
search results 107
search results by meta tag 28
traditional and simplified Chinese 34
FS tag 66
G
GD tag 67
GET command 6
getfields search parameter 15, 43
GL tag 67
GM tag 68
GSP tag 68
H
HAS tag 69
HN tag 69
HTML output 6, 53
I
ie search parameter 16, 35
info query term 24, 30
inmeta query term 28, 48
internationalization 35, 54
intext query term 28
intitle query term 29
inurl query term 29
ip search parameter 16
ISO 8601 format, date range search 25
J
JavaScript variables
ss_allow_non_query 95
ss_form_element 95
ss_g_max_to_display 96
ss_g_more_names_to_display 96
ss_g_one_name_to_display 96
ss_max_to_display 96
ss_non_query_empty_title 96
ss_popup_element 96
ss_protocol 97
Julian format, date range search 25
L
L tag 70
LANG tag 70
language filters 32
latin1 encoding 54
limits
query terms 52
search requests 52
link query term 24
lr search parameter 16
M
M tag 71
meta tags
filtering by 44
matches 42
nested Boolean filtering 46
query expansion 14
requesting values 43
searching 28
usage notes 48
MT tag 71
N
NB tag 72
non-alphanumeric characters in partialfields query 47
NU tag 72
num search parameter 16
number range search 28
numgm search parameter 17
O
OBRES tag 73
oe search parameter 17, 35
OneSynomym tag 73
OR operator 24
output search parameter 17
P
PageRank 37
PARAM tag 74
partialfields search parameter 17, 44
phrase search 28
POST command 7
proxycustom search parameter 18
proxyreload search parameter 18
proxystylesheet search parameter 18
PU tag 76
Q
q search parameter 18
Q tag 77
query string 8
query suggestions
desciption 94
JavaScript variables 95
legacy format 98
OpenSearch format 99
processing 95
request and response 98
rich output format 100
service 94
XSLT stylesheet 97
query terms
allinanchor 23
allintext 29
allintitle 29
allinurl 30
cache 24, 25
description 22
ext 27
info 24, 30
inmeta 28, 48
intext 28
intitle 29
inurl 29
limits 52
link 24
separators 22
site 26
special 23
R
R tag 77
rc search parameter 19
requiredfields search parameter 19, 44
RES tag 78
RK tag 79
S
S tag 80
SCOREBIAS tag 81
seach parameters
wc 21
search parameters
access 10
as_dt 10, 26
as_epq 11, 28
as_eq 11
as_filetype 11
as_ft 11
as_lq 12, 24
as_occt 12
as_oq 12
as_sitesearch 13, 26
client 13
entqr 13
entqrm 14
entsp 14
filter 15, 31, 37
getfields 15, 43
ie 16, 35
ip 16
lr 16
num 16
numgm 17
oe 17, 35
output 17
partialfields 17, 44
proxycustom 18
proxyreload 18
proxystylesheet 18
q 12, 18
rc 19
requiredfields 19, 44
secure_estimates 19
site 19
sitesearch 20
sort 20
start 20
tlen 20
ud 21
ulang 21
wc_mc 21
search request
URL components 6
search requests
anchor text search 23
back links 24
Boolean OR 24
cached results page 25
character encoding 16, 17
collections 19
custom XML tags for results 18
date range 25
directories 26
domains 13, 20, 26
file extensions 27
file formats 11
file types 27
filters 15
front ends 13
hosts 13, 20
index number 20
internationalized domain name 21
ip addresses 16
KeyMatches 17
languages 16
limits 52
maximum number of results 16
meanings, exclude 26
meta tags 15, 17, 19, 28
number range 28
pages that link 12
phrases 11, 28
public content 10
query expansion policy 13
query terms on page 12
request count of results 19
result biasing 14
results format 17, 18
secure content 10
secure results, estimates 19
sort results 20
submitting 8
terms, add 12
terms, combine 12
terms, exclude 11
text 28
titles 20, 29
URLs 29–30
user query 18
web directories 10, 13, 20
XSL stylesheet, refresh 18
search results
additional details 66
additional results 69
biasing 81
cached 57–63
comments 64
compressed 112
crawl date 63
details 77
estimated vs. actual 106
filtering 66
HTML data, encoded 56
KeyMatches 67
languages 70
links 70
meta tags 71
navigation 72
navigation structure 107
next page 72
number to return 107
OneBox modules 65, 73
previous page 76
query parameters 74, 77
ranking 79
related queries 73, 83
search appliance ID 65
set of all 78
snippets 80
sorting 37
special features 69
spelling 82
suggestions 82
time to return 84
titles 83
total number, estimated 71, 85
URLs 84–85
XML format 55
XML root element 68
XML, custom 64
search terms, excluding 26
secure_estimates search parameter 19
separators in query terms 22
show_suggest variable 95
site query term 26
site search parameter 19
sitesearch search parameter 20
sort search parameter 20
sorting
by date 37
by relevance 37
special query terms 23
Spelling tag 82
ss_allow_non_query variable 95
ss_form_element variable 95
ss_g_max_to_display variable 96
ss_g_more_names_to_display variable 96
ss_g_one_name_to_display variable 96
ss_max_to_display variable 96
ss_non_query_empty_title variable 96
ss_popup_element variable 96
ss_protocol variable 97
start search parameter 20
Suggestion tag 82
Synonyms tag 83
T
T tag 83
text search 28
title search 29
tlen search parameter 20
TM tag 84
U
U tag 84
ud search parameter 21
UD tag 85
UE tag 85
ulang search parameter 21
underscore (_) character 47
URL
encoding 108
search 29
usage notes for inmeta 48
UTF8 encoding 54
W
wc search parameter 21
wc_mc search parameter 21
web document info 30
wildcard search 30
X
XML output
character encoding 55
DTD 55
search results 6, 55
xml parameter 56
XML tags
BLOB 56
C 57
CACHE 58
CACHE_CONTENT_TYPE 58
CACHE_ENCODING 59
CACHE_HTML 59
CACHE_LANGUAGE 60
CACHE_LAST_MODIFIED 60
CACHE_LEGEND_FOUND 61
CACHE_LEGEND_NOTFOUND 61
CACHE_LEGEND_TEXT 62
CACHE_REDIR_URL 62
CACHE_URL 63
CRAWLDATE 63
CT 64
CUSTOM 64
definitions 56
ENTOBRESULTS 65
ENT_SOURCE 65
FI 66
FS 66
GD 67
GL 67
GM 68
GSP 68
HAS 69
HN 69
L 70
LANG 70
M 71
MT 71
NB 72
NU 72
OBRES 73
OneSynonym 73
PARAM 74
PU 76
Q 77
R 77
RES 78
RK 79
S 80
SCOREBIAS 81
Spelling 82
Suggestion 82
Synonyms 83
T 83
TM 84
U 84
UD 85
UE 85
XT 86
xml_no_dtd parameter 56
XSLT 53
dynamic result clusters 87
query suggestions 95
XT tag 86

Back to top

PDF Previous Next