Home » Community » Proposal » Specifications » OpenSearch » Extensions » Mobile » 1.0 » Draft 1

Contents

[edit] Notice

This is a draft document for public review.

[edit] Introduction

Mobile uses of the Internet differ from PC-based access patterns. The purpose of the OpenSearch Mobile extensions is to provide a standard mechanism for querying mobile-centric and PC-centric data providers and displaying results relevant for mobile subscribers and devices.

Mobile search requests include information about the device, operator and subscriber. Mobile search responses include answers, not links. Mobile search results are federated from numerous content sources and presented in categories.

Example of a search result that includes mobile elements:

 <feed xmlns="http://www.w3.org/2005/Atom" 
       xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
       xmlns:advertisement="http://a9.com/-/opensearch/extensions/advertisement/1.0/">
   <!-- ... -->
   <entry>
     <!-- ... -->
   </entry>
   <!-- ... -->
   <m:device m:make="Motorola" m:model="V3r" m:id="mot_v3r_ver1">MOT-V3r</m:device>
   <m:subscriber>2065551212</m:subscriber>
 </feed>

[edit] Namespace

The XML namespace of the OpenSearch Mobile Extension is:

http://a9.com/-/opensearch/extensions/mobile/1.0/

This namespace and a corresponding namespace prefix must be included when the extension is used in an OpenSearch response.

[edit] Parameters

The OpenSearch Mobile extension introduces the following parameters.

[edit] The "userAgent" parameter

Replaced with a string describing the User-Agent of the mobile device for which to target search results. This string is parsed and managed by the search service.

If the search request includes the User-Agent as a header, then this parameter should not be included in the URL. If the User-Agent header is not provided, or is the value of a proxy or other intermediate server, then this parameter must be included.

When the User-Agent parameter is provided, the search engine may filter or format search results to target the specified mobile device.

An identifying substring of the User-Agent may be submitted only when the entire User-Agent is not available.

Example URL template:

 http://example.com/?q={searchTerms}&pw={startPage?}&userAgent={m:userAgent?}&format=atom

Example request:

 http://example.com/?q=pizza&userAgent=MOT-V3r%2F08.BD.20I%20MIB%2F2.2.1%20Profile%2FMIDP-2.0%20Configuration%2FCLDC-1.1&format=atom

[edit] The "subId" parameter

Replaced with the unique identifier of the subscriber or handset.

Example URL template:

 http://example.com/?q={searchTerms}&pw={startPage?}&subId={m:subId?}&format=atom

Example request:

 http://example.com/?q=pizza&userAgent=MOT-V3r&subId=A12C92JXV558&format=atom


[edit] The "mcc" and "mnc" parameters

The mcc parameter specifies the Mobile Country Code (MCC) of the country, and the mnc parameter specifies the Mobile Network Code (MNC)of the operator network of the handset where the search request originated.

The MCC and MNC are used in combination to uniquely identify a mobile phone operator within the GSM, CDMA, iDEN and UMTS mobile networks and some satellite mobile networks.

Example URL template:

 http://example.com/?q={searchTerms}&pw={startPage?}&mcc={m:mcc?}&mnc={m:mnc?}&format=atom

Example request from a Verizon Wireless handset in the United States:

 http://example.com/?q=pizza&userAgent=MOT-V3r&mcc=310&mnc=012&format=atom

[edit] Optional Parameters

The search server should use the "?" flag in the URL template when requesting the source parameter to indicate that this parameter is optional and that a search can still be performed even if the client does not recognize the extension.

Example:

 http://example.com/?q={searchTerms}&pw={startPage?}&userAgent={m:userAgent?}&subId={m:subId?}&mnc={m:mnc?}&mcc={m:mcc?}&format=atom

[edit] Atom Extensions

[edit] New Relation Values for Atom Link Elements

To capture link relationships for mobile search results, this extension introduces the following new values of the rel attribute of the Atom Link element.

rel Attribute Value Description
next-page The value of the href attribute identifies the next full page of search results.
page-# The value of the href attribute identifies a target page of search results. (i.e. page-2, page-3, etc.)
section The value of the href attribute identifies a section of search results. (See below for the definition of "section".)
detail The value of the href attribute identifies a page containing details for a single search result.
spelling The value of the href attribute identifies the first full page of search results for a spell-corrected search query.


[edit] Elements

The OpenSearch Mobile extension introduces the following elements.

[edit] The "device" element

The device element is used to describe the mobile device targeted by the search results.

Restrictions: The element value is a String that is the User-Agent provided in the search request, either as a parameter or in the request headers.
Requirements: This element may appear zero or one time.
Attribute Name Attribute Value
make The device make or manufacturer.
model The model name of the device.
id The search service's unique identifier for the device.

Examples of device elements:

 <m:device m:make="Motorola" m:model="V3r" m:id="mot_v3r_ver1">MOT-V3r</m:device>
 <m:device m:make="Nokia" m:model="N73" m:id="nokia_n73_ver1">NokiaN73</m:device>


[edit] The "subscriber" element

The subscriber element is used to identify the mobile subscriber targeted by the search results.

Restrictions: The element value is a String that is the unique identifier of the subscriber. The alphanumeric format of the identifier varies from operator to operator and is out of scope of this specification.
Requirements: This element may appear zero or one time.

Examples of subscriber elements:

 <m:subscriber>2065551212</m:subscriber>
 <m:subscriber>1a854e9c02fd2520</m:subscriber>

[edit] Nesting Search Results into Sections using Atom Entries

Mobile search is not desktop web search. Mobile search results are presented in a federated format with search results categorized into sections. A section generally corresponds to a.

In OpenSearch Mobile, the relationship between sections and search results is expressed in the following way:


[edit] Suggested Extensions to an Atom Entry Element for Sections

Here is a list of suggested extension elements for an Atom Entry element that represents a section of mobile search results.

Suggested Element Source Description
totalResults OpenSearch The total number of mobile search results in this section.
entry Atom A mobile search result item related to the section. (One atom:entry element per mobile search result.)

[edit] An Example Atom Entry Element for a Section of Search Results

Here is an example of a section of mobile search results.

 <atom:entry xs:type="m:sectionEntry" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance">
   <atom:category term="local-directory" label="LOCAL_DIRECTORY"/>
   <atom:title atom:type="TEXT">Local Business</atom:title>
   <atom:link title="9 Results" rel="self" href="http://example.com/opensearch?q=..."/>
   <opensearch:totalResults>9</opensearch:totalResults>
   <atom:entry>
     <atom:title atom:type="TEXT">Cafe 5ive</atom:title>
     <atom:link rel="self" href="http://example.com/opensearch?q=..."/>
   </atom:entry>
   <atom:entry>
     <atom:title atom:type="TEXT">M & M Associates</atom:title>
     <atom:link rel="self" href="http://example.com/opensearch?q=..."/>
   </atom:entry>
   <atom:entry>
     <atom:title atom:type="TEXT">Simons Espresso Cafe</atom:title>
     <atom:link rel="self" href="http://example.com/opensearch?q=..."/>
   </atom:entry>
 </atom:entry>


[edit] Suggested Extensions to an Atom Feed Element for Mobile Search

Here is a list of suggested extension elements for an Atom Feed element that represents a feed of mobile search results.

Suggested Element OpenSearch Extension Description
device Mobile The device targeted for search results.
subscriber Mobile The subscriber targeted for search results.
advertisement Advertisement An advertisement to display with mobile search results. (Multiple instances allowed.)


[edit] Related Extensions

Designers of OpenSearch-compliant mobile search systems should consider supporting these additional extensions:


[edit] Authors

Gail Rahn Frederick, Damon Lanphear and Michael "Luni" Libes <opensearch@medio.com> (Medio Systems)

[edit] License

This document is made available by Medio Systems subject to the terms of the Creative Commons Attribution-ShareAlike 3.0 License.