Apis console deployment – Google Commerce Search Deployment Guide User Manual
Page 5
panel does allow additional accounts to be added for access, so sharing credentials shouldn’t
be needed.
APIs Console
The APIs Console (
is a third tool used in conjunction
with GCS.
To use GCS, you must have an API key--many Google services rely on developer keys to
control access. A key for the “Search API for Shopping” is required when creating your GCS
instance. By default, your key is limited to 2,500 queries per day--this needs to be raised by
Google Support before putting your search engine into production. Typically, your API key is
provided during the initial account provisioning. You can verify your daily quota in the Quotas
section of the API console.
Best Practice: Use two different API keys:
●
One key for any client side code, such as Search As You Type (SAYT), Query
Autocompletions, and so on
●
One key for your server-side code
This practice enables you to use Traffic Filters (in Quotas section) efficiently to control which
domains or servers can utilize your API keys.
Best Practice: For server-side code, increase your per-user limit. Because all requests will be
coming from a limited number of IP addresses (your servers), these appear as single “users.”
Your per-user rate should be enough to handle peak queries per second (QPS).
Deployment
The actual deployment of GCS involves installing some code on your web site. The bulk of
this code is typically in the form of a server-side application or script. Although it is possible to
implement GCS with browser-based, client-side code only (Javascript), that method is strongly
discouraged.
Best Practice: Use server-side code (php, java, .Net, and so on) for your search pages. While
the Shopping API can return JSON and be implemented in JavaScript, this tends to be very
hard to maintain.
While Javascript may have an advantage of speed (results served directly from Google API to
end users), it is typically harder to maintain and debug. Current JavaScript frameworks, such as
JQuery and GWT, relieve many of the cross-browser headaches, but some functionality is lost
or harder to implement. For example, the back button often no longer functions, so users can’t
easily go back to previous searches/pages, and bookmarkable URLs are harder to achieve.
That said, the API does support JSON and can be used to deploy a fully or partially client-
side search engine implementation if you are comfortable doing so. However, only server-side
deployments are fully supported by Google’s Enterprise Support team.
The server-side code performs the following steps:
1. Handles the search form request when a user submits a search query on your site
5