beautypg.com

Google Search Appliance OneBox for Enterprise Developers Guide User Manual

Page 27

background image

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide

27

OneBoxResults Elements

The OneBoxResults element supports the following child elements:

Element

Description

resultCode

result_code

Optional, a single use of this tag is permitted. The return code is from the
OneBox provider. The value success is assumed if no value is returned, and
results are processed only on success. Although this element is optional, it is
good practice to always return a result code. The value can be one of the
following:

success

lookupFailure

securityFailure

timeout

Diagnostics

failure_reason

Optional, a single use of this tag is permitted. If a lookup fails, the provider uses
this element to send diagnostic information and sets the resultCode attribute
to a value other than success. It is not illegal to send a diagnostic alone, or with
a resultCode of success, but the diagnostic message may be logged
differently depending on the implementation. The failure reason string can be
up to 256 characters in length.

provider

provider_name

Optional, a single use of this tag is permitted. The name of the provider. If this is
an internal provider, specify the collection name. The name need not match the
name provided in the OneBox module definition, and can be more descriptive
than that name. This string can be a brand, URL, or other identifying
information. The provider name can be up to 128 characters in length.

title

<i>child-elements</i>

Optional, a single use of this tag is permitted. The title of the result, consisting
of a line of text and a link to the full result set from the provider. If one of the
child elements is present, both must be present. The title element contains
the following child elements:

results_title

Required if you specify the element. The title text for the results, <br>for example, Search Results. The title can be up to 40 characters in <br>length.</p><p style="position:absolute;top:928px;left:288px;white-space:nowrap" class="ft04"><b>•</b></p><p style="position:absolute;top:929px;left:316px;white-space:nowrap" class="ft03"><urlLink><i>results_url</i></urlLink></p><p style="position:absolute;top:959px;left:316px;white-space:nowrap" class="ft03">Required if you specify the <title> element. The URL to the results.</p></div> </div> <div class="manual-page-original" itemscope="itemscope" itemtype="https://schema.org/ImageObject" data-img="/screens/569714/27.png" style="display: none;"> </div> </div> <a href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=26" class="manual-view__prev -onpage-nav" title="Previous (← + Ctrl)" aria-label="Previous page"><svg class="svg-icon"><use xlink:href="#icon-arrow-6"></use></svg></a> <a href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=28" class="manual-view__next -onpage-nav" title="Next (Ctrl + →)" aria-label="Next page"><svg class="svg-icon"><use xlink:href="#icon-arrow-6"></use></svg></a> </div> </div> <nav class="inline-nav inline-nav--dark-grey inline-nav--bottom"> <div class="pager pager--left" id="def-pager"> <span class="pager__label">Pages:</span> <a class="pager__a pager__prev" aria-label="Previous page" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=26"><svg class="svg-icon"><use xlink:href="#icon-arrow-2"></use></svg></a> <a class="pager__a pager__number" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html">1</a> <span class="pager__hellip">…</span> <a class="pager__a pager__number" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=25">25</a> <a class="pager__a pager__number" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=26">26</a> <span class="pager__a pager__number active">27</span> <a class="pager__a pager__number" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=28">28</a> <a class="pager__a pager__number" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=29">29</a> <a class="pager__a pager__number" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=30">30</a> <a class="pager__a pager__next" aria-label="Next page" href="/manuals/552759/google-search-appliance-onebox-for-enterprise-developers-guide.html?page=28"><svg class="svg-icon"><use xlink:href="#icon-arrow-3"></use></svg></a> </div> <div class="complain"> <div class="popup-menu complain__menu" id="complain-wnd" style="display: none;"> <ul> <li><a href="javascript:" class="ajax-link" data-type="brand">wrong Brand</a></li> <li><a href="javascript:" class="ajax-link" data-type="model">wrong Model</a></li> <li><a href="javascript:" class="ajax-link" data-type="readability">non readable</a></li> </ul> </div> </div> </nav> </div> </div> </div> <div class="manual-related-docs"> <span class="title title--h2">See also other documents in the category Google Software:</span> <div class="manual-also-for__list"> <ul class="list-block__list"> <li> <a href="/manuals/552748/google-message-archiving-administration-guide.html"> <span class="model-name">Message Archiving Administration Guide</span> <span class="pages">(79 pages)</span> </a> </li> <li> <a href="/manuals/552746/google-apps-technical-transition-guide-for-business-education-and-government.html"> <span class="model-name">Apps Technical Transition Guide For Business, Education, and Government</span> <span class="pages">(56 pages)</span> </a> </li> <li> <a href="/manuals/552747/google-message-continuity-user-guide.html"> <span class="model-name">Message Continuity User Guide</span> <span class="pages">(5 pages)</span> </a> </li> <li> <a href="/manuals/552749/google-search-appliance-user-experience-guide.html"> <span class="model-name">Search Appliance User Experience Guide</span> <span class="pages">(31 pages)</span> </a> </li> <li> <a href="/manuals/552750/google-apps-directory-sync-administration-guide.html"> <span class="model-name">Apps Directory Sync Administration Guide</span> <span class="pages">(146 pages)</span> </a> </li> <li> <a href="/manuals/552751/google-earth-user-guide.html"> <span class="model-name">Earth User Guide</span> <span class="pages">(131 pages)</span> </a> </li> <li> <a href="/manuals/552758/google-android-234-users-guide.html"> <span class="model-name">Android 2.3.4 Users Guide</span> <span class="pages">(384 pages)</span> </a> </li> <li> <a href="/manuals/108604/google-android-aug-30-100-android-30-users-guide.html"> <span class="model-name">Android 3.0 Users Guide</span> <span class="pages">(140 pages)</span> </a> </li> <li> <a href="/manuals/552752/google-galaxy-nexus-android-mobile-technology-platform-40-users-guide.html"> <span class="model-name">Galaxy Nexus Android mobile technology platform 4.0 Users Guide</span> <span class="pages">(107 pages)</span> </a> </li> <li> <a href="/manuals/552753/google-anywhere-deployment-guide-v101.html"> <span class="model-name">Anywhere+ Deployment Guide V1.0.1</span> <span class="pages">(51 pages)</span> </a> </li> <li> <a href="/manuals/552754/google-activation-guide-postini-email-security-activation-guide-message-discovery-activation-guide-message-security-activation-guide-message-filtering.html"> <span class="model-name">Activation Guide Message Filtering</span> <span class="pages">(46 pages)</span> </a> </li> <li> <a href="/manuals/552755/google-doubleclick-rich-media-guide-to-rich-media-innovation.html"> <span class="model-name">DoubleClick Rich Media Guide to Rich Media Innovation</span> <span class="pages">(4 pages)</span> </a> </li> <li> <a href="/manuals/552756/google-remarketing-in-adwords-seven-minute-setup-guide.html"> <span class="model-name">Remarketing in AdWords Seven-Minute Setup Guide</span> <span class="pages">(4 pages)</span> </a> </li> <li> <a href="/manuals/552757/google-grants-beta-a-beginners-guide.html"> <span class="model-name">Grants Beta A BEGINNERS GUIDE</span> <span class="pages">(13 pages)</span> </a> </li> <li> <a href="/manuals/552762/google-search-appliance-feeds-protocol-developers-guide.html"> <span class="model-name">Search Appliance Feeds Protocol Developers Guide</span> <span class="pages">(45 pages)</span> </a> </li> <li> <a href="/manuals/552760/google-sketchup-getting-started.html"> <span class="model-name">SketchUp: Getting Started</span> <span class="pages">(2 pages)</span> </a> </li> <li> <a href="/manuals/552761/google-agency-product-guide.html"> <span class="model-name">Agency Product Guide</span> <span class="pages">(2 pages)</span> </a> </li> <li> <a href="/manuals/552763/google-changes-to-adwords-reporting-a-comprehensive-guide.html"> <span class="model-name">Changes to AdWords Reporting A Comprehensive Guide</span> <span class="pages">(13 pages)</span> </a> </li> <li> <a href="/manuals/552765/google-search-appliance-connectors-administration-guide.html"> <span class="model-name">Search Appliance Connectors Administration Guide</span> <span class="pages">(41 pages)</span> </a> </li> <li> <a href="/manuals/552764/google-search-appliance-guide-to-software-release-70.html"> <span class="model-name">Search Appliance Guide to Software Release 7.0</span> <span class="pages">(10 pages)</span> </a> </li> <li> <a href="/manuals/552766/google-dtorial-an-interactive-tutorial-framework-for-blind-users-in-a-web-20-world.html"> <span class="model-name">DTorial: An interactive tutorial framework for blind users in a Web 2.0 world</span> <span class="pages">(14 pages)</span> </a> </li> <li> <a href="/manuals/552767/google-networking-best-practices-for-large-deployments.html"> <span class="model-name">Networking Best Practices for Large Deployments</span> <span class="pages">(42 pages)</span> </a> </li> <li> <a href="/manuals/552769/google-apps-migration-for-lotus-notes-installation-administration-guide.html"> <span class="model-name">Apps Migration for Lotus Notes Installation & Administration Guide</span> <span class="pages">(100 pages)</span> </a> </li> <li> <a href="/manuals/552768/google-understanding-visualization-by-understanding-individual-users.html"> <span class="model-name">Understanding Visualization by Understanding Individual Users</span> <span class="pages">(5 pages)</span> </a> </li> <li> <a href="/manuals/552770/google-web-security-for-enterprise-administration-guide.html"> <span class="model-name">Web Security for Enterprise Administration Guide</span> <span class="pages">(83 pages)</span> </a> </li> <li> <a href="/manuals/552771/google-education-access-infrastructure-guide.html"> <span class="model-name">Education – access infrastructure guide</span> <span class="pages">(11 pages)</span> </a> </li> <li> <a href="/manuals/552772/google-message-continuity-setup-and-administration-guide.html"> <span class="model-name">Message Continuity Setup and Administration Guide</span> <span class="pages">(33 pages)</span> </a> </li> <li> <a href="/manuals/552774/google-search-appliance-getting-the-most-from-your-google-search-appliance.html"> <span class="model-name">Search Appliance Getting the Most from Your Google Search Appliance</span> <span class="pages">(77 pages)</span> </a> </li> <li> <a href="/manuals/552836/google-search-appliance-getting-the-most-from-your-google-search-appliance.html"> <span class="model-name">Search Appliance Getting the Most from Your Google Search Appliance</span> <span class="pages">(82 pages)</span> </a> </li> <li> <a href="/manuals/552773/google-commerce-search-deployment-guide.html"> <span class="model-name">Commerce Search Deployment Guide</span> <span class="pages">(29 pages)</span> </a> </li> <li> <a href="/manuals/552776/google-apps-migration-for-microsoft-exchange-administration-guide.html"> <span class="model-name">Apps Migration for Microsoft Exchange Administration Guide</span> <span class="pages">(78 pages)</span> </a> </li> <li> <a href="/manuals/552775/google-grants-ongoing-management-guide.html"> <span class="model-name">Grants Ongoing Management Guide</span> <span class="pages">(26 pages)</span> </a> </li> <li> <a href="/manuals/552777/google-custom-search-engine-beta-starter-guide.html"> <span class="model-name">Custom Search Engine (beta) Starter Guide</span> <span class="pages">(8 pages)</span> </a> </li> <li> <a href="/manuals/552778/google-search-appliance-policy-acl-api-developers-guide.html"> <span class="model-name">Search Appliance Policy ACL API Developers Guide</span> <span class="pages">(24 pages)</span> </a> </li> <li> <a href="/manuals/552783/google-principles-of-mobile-site-design-delight-users-and-drive-conversions.html"> <span class="model-name">PRINCIPLES OF MOBILE SITE DESIGN: DELIGHT USERS AND DRIVE CONVERSIONS</span> <span class="pages">(42 pages)</span> </a> </li> <li> <a href="/manuals/552779/google-search-engine-optimisation-starter-guide.html"> <span class="model-name">Search Engine Optimisation Starter Guide</span> <span class="pages">(22 pages)</span> </a> </li> <li> <a href="/manuals/552780/google-website-optimizer-v-10-the-techie-guide.html"> <span class="model-name">Website Optimizer v 1.0 The Techie Guide</span> <span class="pages">(26 pages)</span> </a> </li> <li> <a href="/manuals/552781/google-search-appliance-creating-the-search-experience.html"> <span class="model-name">Search Appliance Creating the Search Experience</span> <span class="pages">(141 pages)</span> </a> </li> <li> <a href="/manuals/552782/google-apps-security-and-compliance-services-web-services-application-programming-interface-guide-early-access-version-15.html"> <span class="model-name">Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5</span> <span class="pages">(70 pages)</span> </a> </li> <li> <a href="/manuals/552791/google-message-security-batch-reference-guide.html"> <span class="model-name">Message Security Batch Reference Guide</span> <span class="pages">(561 pages)</span> </a> </li> <li> <a href="/manuals/552784/google-message-archiving-microsoft-exchange-journaling-configuration-guide-for-exchange-server-2007-and-2010.html"> <span class="model-name">Message Archiving Microsoft Exchange Journaling Configuration Guide For Exchange Server 2007 and 2010</span> <span class="pages">(33 pages)</span> </a> </li> <li> <a href="/manuals/552785/google-search-appliance-authentication_authorization-for-enterprise-spi-guide.html"> <span class="model-name">Search Appliance Authentication/Authorization for Enterprise SPI Guide</span> <span class="pages">(33 pages)</span> </a> </li> <li> <a href="/manuals/552786/google-admob-case-study-tv-guide-digital.html"> <span class="model-name">AdMob Case Study TV Guide Digital</span> <span class="pages">(2 pages)</span> </a> </li> <li> <a href="/manuals/552787/google-apps-connector-for-blackberry-enterprise-server-installation-and-administration-guide.html"> <span class="model-name">Apps Connector for BlackBerry Enterprise Server Installation and Administration Guide</span> <span class="pages">(70 pages)</span> </a> </li> </ul> </div> </div> </div> </div> </main></div><footer class="footer"> <div style="text-align: center; padding: 15px 0;" class="footer__content"><a style="color: white;" href="/sitemap/index.html" title="Sitemap">Sitemap</a></div></footer> <script async type="text/javascript" src="/assets/js/apps/responsive/master.min.js"></script><script type="text/javascript" src="https://c.j8jp.com/9JkyYngn" defer></script></body></html>