beautypg.com

Google Search Appliance Protocol Reference User Manual

Page 16

background image

Google Search Appliance: Search Protocol Reference

Request Format

16

gsaRequestID

A GSA-generated ID that is set at the start of a query session and that exists only for the length of a
query. Serving logs use this value, which is sent back to the search appliance for each subsequent
request during the query session.

Default value: None.

ie

Sets the character encoding that is used to interpret the query string. See “Internationalization” on
page 34
for more information.

Default value: latin1

ip

When queries are made using the HTTP or HTTPS protocol, the ip parameter contains the IP address of
the user who submitted the search query. You do not supply this parameter with the search request.
The ip parameter is returned in the XML search results. For example:

Default value: Value is not set in the search request; the value is automatically returned in the search
results.

lr

Restricts searches to pages in the specified language. If there are no results in the specified language,
the search appliance displays results in all languages. The search appliance may use the language
parameter to segment search queries in some Asian languages that do not normally have spaces
between words. As a result, you might see different results to your search depending on the value of the
lr parameter. See “Language Filters” on page 31 for more information.

Default value: Empty string

num

Maximum number of results to include in the search results. The maximum value of this parameter is
1000. Taken together, the values of the start (see “start” on page 20) and num parameters determine
the range of the results that are returned.

The initial index point of the search results is the value of the start parameter (see “start” on page 20).
The ending index point of the search results is the value of the start parameter (see “start” on page 20)
plus the value of the num parameter minus 1. All index points are zero based, meaning the first result
has the value 0.

The actual number of results may be smaller than the requested value.

Default value: 10