Retrieving keymatch settings – Google Search Appliance Administrative API Developers Guide: Protocol User Manual
Page 49
Google Search Appliance: Administrative API Developer’s Guide: Protocol
49
A KeyMatch configuration rule is in the following format:
Search_Terms,KeyMatch_Type,URL,Title
The KeyMatch_Type is one of the three values, KeywordMatch, PhraseMatch, and ExactMatch. The
Search_Terms and URL fields cannot be empty. The KeyMatch configuration conforms to the CSV
format, which uses a comma to separate values.
Retrieving KeyMatch Settings
To get KeyMatch settings, send an authenticated GET request to the following URL:
http://Search_Appliance:8000/feeds/keymatch/
Front_End_Name?query=Search_String&startLine=Start_Line&maxLines=Max_Lines;
The following example retrieves KeyMatch settings—note that gsa:content name="2" (or 0 or 1)
shows the use of the line_number property:
xmlns:gsa="http://schemas.google.com/gsa/2007"> rel="self" type="application/atom+xml"/> rel="edit" type="application/atom+xml"/> Google News,ExactMatch,http://news.google.com/,News Google Search,PhraseMatch,http://www.google.com/,I’m Feeling Lucky! Python,KeywordMatch,http://www.python.org/,Python Programming Language
startLine
The starting line number of the KeyMatch configuration to change. The
minimum value is 0.
updateMethod
The method to change KeyMatch configurations. Possible values are:
•
update. Update part of the KeyMatch configuration table to the new
configurations. You can also delete KeyMatch configurations using the
update method, as shown in “Updating KeyMatch Settings” on page 50.
•
append. Add a new KeyMatch configuration to the end of the KeyMatch
configuration table.
•
replace. Delete all rules in the KeyMatch configuration table and then
append the new rules that you provide.
Property
Description