Google Search Appliance Protocol Reference User Manual

Google Search ApplianceSearch Protocol ReferenceGoogle Search Appliance software version 7.2

Google Search Appliance: Search Protocol Reference Request Format 10This request returns the first 10 results that match the search query terms “bill”

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 100Request:/suggest?q=<query>&max=<num>&

Google Search Appliance: Search Protocol Reference 101Chapter 6Advanced Search Reporting Service /click Protocol Chapter 6Advanced search reporting en

Google Search Appliance: Search Protocol Reference Advanced Search Reporting Service /click Protocol 1027. The search appliance takes the /click URL i

Google Search Appliance: Search Protocol Reference Advanced Search Reporting Service /click Protocol 103The following is an example request for advanc

Google Search Appliance: Search Protocol Reference Advanced Search Reporting Service /click Protocol 104ResponsesIn response to the /click URL, the se

Google Search Appliance: Search Protocol Reference 105AppendicesThis section contains:• “Appendix A: Estimated vs. Actual Number of Results” on page 1

Google Search Appliance: Search Protocol Reference Appendices 106How the Google Search Appliance Determines the Number of Results to ReturnWhen search

Google Search Appliance: Search Protocol Reference Appendices 107The underlined text in the message should be a hypertext link to submit the same sear

Google Search Appliance: Search Protocol Reference Appendices 108ExamplesAppendix C: Date FormattingThe search appliance recognizes dates in most reas

Google Search Appliance: Search Protocol Reference Appendices 109Acceptable Date FormatsThe following table lists date formats that you can use with t

Google Search Appliance: Search Protocol Reference Request Format 11as_epqAdds the specified phrase to the search query in parameter q. For example, t

Google Search Appliance: Search Protocol Reference Appendices 110Date Formatting Notes1. The YYYYMMDDHH and YYYYMMDDHHmm patterns for specifying dates

Google Search Appliance: Search Protocol Reference Appendices 111Examples of RulesBecause the document http://www.foo.com/example/foo.html matches the

Google Search Appliance: Search Protocol Reference 112IndexAaccess search parameter 10advanced search reportingdescription 101HTTP response 104process

Google Search Appliance: Search Protocol Reference Index 113Eencoding, character 53, 107ENTOBRESULTS tag 64entqr search parameter 13entqrm search para

Google Search Appliance: Search Protocol Reference Index 114phrase search 28POST command 7proxycustom search parameter 18proxyreload search parameter

Google Search Appliance: Search Protocol Reference Index 115search requestsanchor text search 23back links 24Boolean OR 24cached results page 24charac

Google Search Appliance: Search Protocol Reference Index 116ss_protocol variable 96start search parameter 20Suggestion tag 81Synonyms tag 82TT tag 82t

Google Search Appliance: Search Protocol Reference Request Format 12as_lqSpecifies a URL, and causes search results to show pages that link to the tha

Google Search Appliance: Search Protocol Reference Request Format 13as_sitesearchLimits search results to documents in the specified domain, host or w

Google Search Appliance: Search Protocol Reference Request Format 14Standard terms use only the search appliance’s internal contextual (synonym) files

Google Search Appliance: Search Protocol Reference Request Format 15exclude_appsControls whether Google Apps content from the user’s Google Apps domai

Google Search Appliance: Search Protocol Reference Request Format 16gsaRequestIDA GSA-generated ID that is set at the start of a query session and tha

Google Search Appliance: Search Protocol Reference Request Format 17numgmNumber of KeyMatch results to return with the results. A value between 0 to 5

Google Search Appliance: Search Protocol Reference Request Format 18proxycustomSpecifies custom XML tags to be included in the XML results. The defaul

Google Search Appliance: Search Protocol Reference Request Format 19rcRequest an accurate result count for up to 1M documents. When rc = 1, the user w

Google Search Appliance: Search Protocol Reference 2Google, Inc.1600 Amphitheatre ParkwayMountain View, CA 94043www.google.comGSA-XML_100.09December 2

Google Search Appliance: Search Protocol Reference Request Format 20sitesearch Limits search results to documents in the specified domain, host, or we

Google Search Appliance: Search Protocol Reference Request Format 21As an example, if the result URLs contain files whose names are in Chinese charact

Google Search Appliance: Search Protocol Reference Request Format 22This search request includes the custom parameter myparam with a value of test+thi

Google Search Appliance: Search Protocol Reference Request Format 23If a document contains a number, with or without a decimal point, that has letters

Google Search Appliance: Search Protocol Reference Request Format 24Back LinksThe query prefix link: lists web pages that have links to the specified

Google Search Appliance: Search Protocol Reference Request Format 25Date Range SearchRestrict search to documents with modification dates that fall wi

Google Search Appliance: Search Protocol Reference Request Format 26The URLs used with site must contain fewer than 119 characters. The exclusion oper

Google Search Appliance: Search Protocol Reference Request Format 27You can exclude multiple file types by adding more -ext: terms to the search query

Google Search Appliance: Search Protocol Reference Request Format 28Number Range SearchTo search for documents or items that contain numbers within a

Google Search Appliance: Search Protocol Reference Request Format 29Sample usage:intitle:googleTitle Search (all terms)If you precede a query with all

Google Search Appliance: Search Protocol Reference 3ContentsChapter 1 Introduction ...

Google Search Appliance: Search Protocol Reference Request Format 30Wildcard SearchIf you precede a query with wildcard:, you can search by entering a

Google Search Appliance: Search Protocol Reference Request Format 31Automatic FilteringGoogle uses automatic filtering to ensure the highest quality s

Google Search Appliance: Search Protocol Reference Request Format 32Automatic Language FiltersThe Google Search Appliance automatically detects the la

Google Search Appliance: Search Protocol Reference Request Format 33If you want to filter languages other than the above, obtain the language code fro

Google Search Appliance: Search Protocol Reference Request Format 34Combining Language FiltersSearch requests that use the lr parameter support the Bo

Google Search Appliance: Search Protocol Reference Request Format 35Example 2. This request interprets the search query “gloves” using latin2 encoding

Google Search Appliance: Search Protocol Reference Request Format 36SortingGoogle search provides three sorting options for search results:• “Sort By

Google Search Appliance: Search Protocol Reference Request Format 37ExampleThe following request returns the first 10 top results that match the query

Google Search Appliance: Search Protocol Reference Request Format 38• How much metadata exists for each document• The sorting options specifiedThe val

Google Search Appliance: Search Protocol Reference Request Format 39<mode> Value DescriptionE Return the 1000 most relevant results, then sort b

Google Search Appliance: Search Protocol Reference Contents 4Chapter 4 Dynamic Result Clustering Service /cluster Protocol ...

Google Search Appliance: Search Protocol Reference Request Format 40For more information about the language options, case options, and numeric options

Google Search Appliance: Search Protocol Reference Request Format 41Sort currencySort English-looking numbersThis is a very fast option, if all the nu

Google Search Appliance: Search Protocol Reference Request Format 42At search time, if the encoded value of the search attribute (requiredfields, part

Google Search Appliance: Search Protocol Reference Request Format 43If any of the results contain the author, title or keywords meta tags, then the va

Google Search Appliance: Search Protocol Reference Request Format 44ExamplesExample 1:The following search request returns the first 10 results that m

Google Search Appliance: Search Protocol Reference Request Format 45• Boolean AND [ . ]Returns results that satisfy both meta tag constraints.Example:

Google Search Appliance: Search Protocol Reference Request Format 46Searches with unsupported expressions are not performed and do not return results.

Google Search Appliance: Search Protocol Reference Request Format 47Using inmeta to Filter by Meta TagsThe special query term inmeta provides meta tag

Google Search Appliance: Search Protocol Reference Request Format 48Usage Notes:1. By default documents that contain ALL query terms are returned. Thi

Google Search Appliance: Search Protocol Reference Request Format 496. An inmeta search is unable to search by multiple keywords or perform phrase sea

Google Search Appliance: Search Protocol Reference 5Chapter 1Introduction Chapter 1The Google Search Appliance uses a simple HTTP-based protocol for s

Google Search Appliance: Search Protocol Reference Request Format 5011. Metadata can have multiple attributes with the same name. For example:<meta

Google Search Appliance: Search Protocol Reference Request Format 51Example 4. The following is an open-ended date range search request that returns r

Google Search Appliance: Search Protocol Reference 52Chapter 3Results Format Cha pter 3This section covers the following topics:• “Custom HTML” on pag

Google Search Appliance: Search Protocol Reference Results Format 53Notes: • XSL stylesheets used by the XSLT server are cached for 15 minutes. To for

Google Search Appliance: Search Protocol Reference Results Format 54XML Output OverviewFor maximum flexibility, Google provides search results in XML

Google Search Appliance: Search Protocol Reference Results Format 55To get results in XML output format, use one of the following parameters in the se

Google Search Appliance: Search Protocol Reference Results Format 56CFormat/ParentHASSubtagsNoneDefinitionIndicates that the “cache:” special query te

Google Search Appliance: Search Protocol Reference Results Format 57CACHEFormat/ParentGSPSubtagsCACHE_URL, CACHE_REDIR_URL, CACHE_LAST_MODIFIED, CACHE

Google Search Appliance: Search Protocol Reference Results Format 58CACHE_HTMLFormat/ParentText (HTML) (Custom HTML output only)CACHESubtagsBLOB? (XML

Google Search Appliance: Search Protocol Reference Results Format 59CACHE_LANGUAGEFormat/ParentText (Google language tag)CACHESubtagsNoneDefinitionThe

Google Search Appliance: Search Protocol Reference 6Chapter 2Request Format Chapter 2The information in this section helps you create custom searches

Google Search Appliance: Search Protocol Reference Results Format 60CACHE_LEGEND_FOUNDFormat/ParentCACHESubtagsCACHE_LEGEND_TEXT*DefinitionEncapsulate

Google Search Appliance: Search Protocol Reference Results Format 61CACHE_LEGEND_TEXTFormat/ParentText (Custom HTML output only)CACHE_LEGEND_FOUNDSubt

Google Search Appliance: Search Protocol Reference Results Format 62CACHE_URLFormat/ParentText (Absolute URL)CACHESubtagsNoneDefinitionInitial URL of

Google Search Appliance: Search Protocol Reference Results Format 63CTFormat/ParentHTMLGSPSubtagsNoneDefinitionSearch comments.Example comment: Sorry,

Google Search Appliance: Search Protocol Reference Results Format 64ENT_SOURCEFormat/ParentRSubtagsNoneDefinitionIdentifies the application ID (serial

Google Search Appliance: Search Protocol Reference Results Format 65FIFormat/ParentRESSubtagsNoneDefinitionIndicates that document filtering was perfo

Google Search Appliance: Search Protocol Reference Results Format 66GDFormat/ParentText (HTML)GMSubtagsNoneDefinitionContains the description of a Key

Google Search Appliance: Search Protocol Reference Results Format 67GMFormat/ParentGSPSubtagsGL, GD?DefinitionEncapsulates a single KeyMatch result.At

Google Search Appliance: Search Protocol Reference Results Format 68HASFormat/ParentRSubtagsL?, C?DefinitionEncapsulates special features that are inc

Google Search Appliance: Search Protocol Reference Results Format 69LFormat/ParentHASSubtagsNoneDefinitionIndicates that the “link:” special query ter

Google Search Appliance: Search Protocol Reference Request Format 7Using the POST CommandIn some instances, your query strings might exceed the 2KB UR

Google Search Appliance: Search Protocol Reference Results Format 70MFormat/ParentText (Integer)RESSubtagsNoneDefinitionThe estimated total number of

Google Search Appliance: Search Protocol Reference Results Format 71NBFormat/ParentRESSubtagsPU?, NU?DefinitionEncapsulates the navigation information

Google Search Appliance: Search Protocol Reference Results Format 72OBRESFormat/ParentENTOBRESULTSSubtagsThe contents of the OBRES element are provide

Google Search Appliance: Search Protocol Reference Results Format 73PARAMFormat/ParentGSPSubtagsNoneDefinitionThe search request parameters that were

Google Search Appliance: Search Protocol Reference Results Format 74PCFormat/ParentText (Integer 0 or 1)PARMSubtagsNoneDefinitionIndicates whether the

Google Search Appliance: Search Protocol Reference Results Format 75PUFormat/ParentText (Relative URL)NBSubtagsNoneDefinitionContains relative URL to

Google Search Appliance: Search Protocol Reference Results Format 76QFormat/ParentHTMLGSPSubtagsNoneDefinitionThe search query terms submitted to the

Google Search Appliance: Search Protocol Reference Results Format 77RESFormat/ParentGSPSubtagsFI?, M, NB?, PARM?, R*, XT?DefinitionEncapsulates the se

Google Search Appliance: Search Protocol Reference Results Format 78RKFormat/ParentText (Integer in the range 0-10)SubtagsNoneDefinitionThe RK paramet

Google Search Appliance: Search Protocol Reference Results Format 79SFormat/ParentText (HTML)RSubtagsNoneDefinitionThe snippet for the search result.Q

Google Search Appliance: Search Protocol Reference Request Format 8Submitting a Search RequestTypically, search users make search requests by entering

Google Search Appliance: Search Protocol Reference Results Format 80SCOREBIASFormat/ParentText (XML)RSubtagsNoneDefinitionThe SCOREBIAS tag can appear

Google Search Appliance: Search Protocol Reference Results Format 81SpellingFormat/ParentGSPSubtagsSuggestion+DefinitionEncapsulates alternate spellin

Google Search Appliance: Search Protocol Reference Results Format 82SynonymsFormat/ParentGSPSubtagsOneSynonym+DefinitionEncapsulates the related queri

Google Search Appliance: Search Protocol Reference Results Format 83TMFormat/ParentText (Floating-point number)GSPSubtagsNoneDefinitionTotal server ti

Google Search Appliance: Search Protocol Reference Results Format 84UDFormat/ParentText (URL to display for non-ASCII URLs)RSubtagsNoneDefinitionThe U

Google Search Appliance: Search Protocol Reference Results Format 85XTFormat/ParentRESSubtagsNoneDefinitionIndicates that the estimated total number o

Google Search Appliance: Search Protocol Reference 86Chapter 4Dynamic Result Clustering Service /cluster Protocol Chapter 4Dynamic result clustering n

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 873. Triggers an A JAX call to the cluster serv

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 88Dynamic Result Clustering RequestAdministrato

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 89The search appliance returns the following JS

Google Search Appliance: Search Protocol Reference Request Format 9Example 2. This request returns results numbered 11-15 that match the same query te

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 90Dynamic Result Clustering XML Request and Res

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 91The search appliance returns the following XM

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 92The top-level entries are described in the fo

Google Search Appliance: Search Protocol Reference 93Chapter 5Query Suggestion Service /suggest Protocol Chapter 5The query suggestion service provide

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 94Queries with Special Query Terms, such as inmeta, are

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 95ss_g_max_to_displayThe maximum number of query suggest

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 96ss_protocolThe three values are:Default value: richQue

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 97Query Suggestion Requests and ResponsesThe output form

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 98Response:[ "<term 1>", "<term

Google Search Appliance: Search Protocol Reference Query Suggestion Service /suggest Protocol 99Response:["<query>",[ "<term 1