Makita BTD140RFE User Manual [es]
BOSS API Guide
A Guide for BOSS Developers
BOSS API Guide: A Guide for BOSS Developers
Copyright © 2008, Yahoo! Inc.
Abstract
Yahoo! Search BOSS (Build your Own Search Service) is an initiative in Yahoo! Search to open up Yahoo!'s search
infrastructure and enable third parties to build revolutionary search products leveraging their own data, content, technology, social graph, or other assets. This release includes Web, News, and Image Search as well as Spelling Suggestions.
Table of Contents
1. Getting Started ................................................................................................................. 1
Getting Started ............................................................................................................ 1
Who Should Read This Document .......................................................................... 1
Contact Information ............................................................................................. 1
Terms of Use .............................................................................................................. 1
BOSS Overview .......................................................................................................... 1
Hostname ........................................................................................................... 2
BOSS APPID ...................................................................................................... 2
Universal BOSS API Arguments: Apply to Web, Images and News ............................... 2
Universal BOSS API Query Operators: Apply to Web, Images and News ........................ 2
2. Web Search ..................................................................................................................... 5
Hostname Basic Example .............................................................................................. 5
Optional Arguments (in addition to Universal arguments described in BOSS over-
view) ................................................................................................................. 5
Response Fields .......................................................................................................... 7
Recommended Region/Language Usage ................................................................... 7
Example XML Output .......................................................................................... 8
3. Image Search ................................................................................................................... 9
Hostname Basic Example .............................................................................................. 9
Optional arguments (in addition to Universal arguments described in Boss Over-
view) ................................................................................................................. 9
Response fields ........................................................................................................... 9
Example XML Output ........................................................................................ 10
Sample implementation ....................................................................................... 11
4. News Search .................................................................................................................. 12
Hostname Basic Example ............................................................................................ 12
Optional Arguments ........................................................................................... 12
Response fields ......................................................................................................... 12
Example XML Output ........................................................................................ 13
5. Spelling Suggestions ....................................................................................................... 14
Response fields ......................................................................................................... 14
6. Appendix and FAQ's ........................................................................................................ 15
Reserved Characters and Escape Values .......................................................................... 15
Supported Regions and Languages for Web and News Search ............................................. 16
FAQ's ...................................................................................................................... 17
iii
Chapter 1. Getting Started
Y ahoo! Search BOSS (Build your Own Search Service) is an initiati ve in Yahoo! Search to open up Yahoo!'s
search infrastructure and enable third parties to build revolutionary search products leveraging their own
data, content, technology, social graph, or other assets. This release includes Web, News, and Image Search
as well as Spelling Suggestions.
Getting Started
1.
Go to http://developer.yahoo.com/boss.
2. Sign-up and get your BOSS App ID to get started with the BOSS API.
Note
The BOSS A pp ID is different from the standard W eb services developer App ID. Please
select the BOSS checkbox during signup.
3. Click on the links to find the Developer documentation, FAQ's, Feedback.
Who Should Read This Document
This manual is intended for programmers developing applications to access the Yahoo! Internet search
engine. The manual assumes an understanding of HTTP, XML, JSON, and a cursory knowledge of query
languages.
Contact Information
BOSS developers are encouraged to sign up for the BOSS Yahoo! Group1, a good place to share ideas
with the BOSS developer community.
For account related issues, ideas or suggestions please use the form at http://developer .yahoo.com/re gister/
and select BOSS.
Terms of Use
Use of the Yahoo! Search BOSS services, related software, and this documentation is subject to Terms of
Use2.
BOSS Overview
URI
http://boss.yahooapis.com/ysearch/{vertical}/v1/{query}?appid=xyz[¶m1=val1¶m2=val2&etc]
1
http://tech.groups.yahoo.com/group/ysearchboss/
2
http://info.yahoo.com/legal/us/yahoo/search/bosstos/bosstos-2317.html
1
Getting Started
Hostname
boss.yahooapis.com
BOSS APPID
Bossdemo
All examples in this documentation require a Boss App ID. Please add the appid= parameter for proper
query execution.
Universal BOSS API Arguments: Apply to Web, Images and News
Ordinal position of first result. First position is 0. Default sets start to 0.start
Total number of results to return. Maximum value is 50. Default sets count to 10.count
lang
region
format
callback
sites
Specifies the language search product to query. See “Supported Re gions and Languages for Web
and News Search” [16]. Default sets lang to "en". Must be used in parallel with region.
Specifies which regional (country) search product to query. See “Supported Regions and Lan-
guages for Web and News Search” [16]. Default sets region to "us". Must be used in parallel
with lang.
The data format of the response. Value can be set to either "xml" or "json". Default sets
format to "json".
The name of the callback function to wrap the result. Parameter is valid only if format is set to
"json". No default value exists.
Restrict BOSS search results to a set of pre-defined sites. Multiple sites must be comma separated.
Example: (sites=abc.com,cnn.com). The Images service does not yet support multiple
sites. Note: This argument can use a single site parameter.
Universal BOSS API Query Operators: Apply to Web, Images and News
Note
URL encode any reserved characters in the query and parameters before sending the BOSS
API call. See “Reserved Characters and Escape Values” [15] for more information.
Phrase Words
T o ensure the exact query ke ywords are present in the search result, in the e xact order , use quotation marks
" " around the query keywords.
Example: http://boss.yahooapis.com/ysearch/web/v1/"Apple Pie"?appid=xyz&format=xml
2
-(minus) Operator
To exclude content that contains certain keywords, use the - (minus) operator. This operator can be used
in conjunction with other operators in the search query.
Example 1:http://boss.yahooapis.com/ysearch/web/v1/Apple -Pie +Recipes?appid=xyz&format=xml
Example 2: http://boss.yahooapis.com/ysearch/web/v1/"Ice Cream" -Chocolate?appid=bossdemo&format=xml
Site (Domain) search
You can pre-append site: to queries to search for or exclude documents based on the domain of the
document:
Syntax: site:<domain_suffix_value>
The domain name from the URL can be broken into fragments, from right to left. The domain name
www.widget.org could be matched by any of the following queries:
site:www.widget.orgsite:widget.orgsite:org
Getting Started
To select documents from a site or domain we recommend that you use site:
chocolate cake site:widget.org
You can exclude sites (create a negative domain selection) by using the minus operator with site: in
the query. This query (shown unescaped) locates all documents containing the word "food" that do not
have a URL containing the domain "suffix com":
food -site:xyz.com
Example:The following is a query example to find recipe pages at epicurious.com that include salt, pepper ,
ginger, and garlic AND do not include onions:
http://host/ysearch/web/v1/salt%20pepper%20ginger%20garlic%20-onion%20+site:epicurious.com?appid=bossdemo&format=xml
url vs clickurl
Examine the following XML elements:
Note
All dates and times are in GMT.
Note
There is a requirement to include the clickurl in anchor link of your search results.
<result>
<clickurl>http://us.lrd.yahoo.com/_ylc=X3oDMTE1ZWc4MDY3BGFwcGlkAwRwb3MDMARzZXJ2aWNlA1lTZWFyY2gEc3JjcHZpZAM-/SIG=1107v296h/
**http%3A//www.apple.com/itunes</clickurl>
<url>http://www.apple.com/itunes/</url>
</result>
3
Getting Started
You would then generate the following HTML fragment for a search results page:
<a href=
"http://us.lrd.yahoo.com/_ylc=X3oDMTE1ZWc4MDY3BGFwcGlkAwRwb3MDMARzZXJ2aWNlA1lTZWFyY2gEc3JjcHZpZAM-/SIG=
1107v296h/**http%3A//www.apple.com/itunes">http://www.apple.com/itunes/</A>
4
Loading...