Sitesearch, Sort, Start – Google Search Appliance Protocol Reference User Manual

Page 20: Tlen

Advertising
background image

Google Search Appliance: Search Protocol Reference

Request Format

20

sitesearch

Limits search results to documents in the specified domain, host, or web directory. Has no effect if the q
parameter is empty. This parameter has the same effect as the site special query term.

Unlike the as_sitesearch parameter, the sitesearch parameter is not affected by the as_dt
parameter. The sitesearch and as_sitesearch parameters are handled differently in the XML results.
The sitesearch parameter’s value is not appended to the search query in the results. The original
query term is not modified when you use the sitesearch parameter. The specified value for this
parameter must contain fewer than 125 characters.

Default value: Empty string

sort

Specifies a sorting method. Results can be sorted by date. (See “Sorting” on page 36 for sort parameter
format and details.)

Default value: Empty string

start

Specifies the index number of the first entry in the result set that is to be returned. Use this parameter
and the num parameter (see “num” on page 16) to implement page navigation for search results. The
index number of the results is 0-based. For example:

start=0, num=10, returns the first 10 results. These are returned by default if you do not specify
values for start or num.

start=10, num=10, returns the next 10 results.

The maximum number of results available for a query is 1,000, i.e., the value of the start parameter
added to the value of the num parameter cannot exceed 1,000.

Default value: 0

tlen

Specifies the number of bytes that would be used to return the search results title. If titles contain
characters that need more bytes per character, for example in utf-8, this parameter can be used to
specify a higher number of bytes to get more characters for titles in the search results.

Default value: 70 bytes

ud

Specifies whether results include ud tags. A ud tag contains internationalized domain name (IDN)
encoding for a result URL. IDN encoding is a mechanism for including non-ASCII characters. When a ud
tag is present, the search appliance uses its value to display the result URL, including non-ASCII
characters.

The value of the ud parameter can be zero (0) or one (1):

A value of 0 excludes ud tags from the results.

A value of 1 includes ud tags in the results.

Advertising