Google Search Appliance OneBox for Enterprise Developers Guide - Manual (Page 26)

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide 26
OneBox Results Schema Reference
Results are returned to a search appliance in the form of XML that conforms to the OneBox Results
schema.
Results Definition Schema
The results definition schema file is available in the oneboxresults.xsd file, which is included in the
OneBox simulator download (
http://google-developers.appspot.com/search-appliance/download/
downloadsdk ).
Note: Do not set the id= attributes that appear in the oneboxresults.xsd file. The search appliance
does not use any of the id attributes.
Your OneBox module definition XML file must conform to this schema.
Syntax
<OneBoxResults>
<resultCode>result_code</resultCode>
<Diagnostics>failure_reason</Diagnostics>
<provider>provider_name</provider>
<searchTerm>query_escape</searchTerm>
<totalResults>total_results_escape</totalResults>
<title>
<urlText>results_title</urlText>
<urlLink>results_url</urlLink>
</title>
<IMAGE_SOURCE>image_url</IMAGE_SOURCE>
<MODULE_RESULT>
<U>url</U>
<Title>title</Title>
<Field name="name1">value1</Field>
<Field name="name2">value2</Field>
<Field name="nameN">valueN</Field>
</MODULE_RESULT>
</OneBoxResults>