Search registration and launch reference for Windows Phone 8
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Starting with Windows Phone OS 7.1, apps can extend the Search experience on Windows Phone. Using Search extensibility in your app primarily involves two steps: registering for search extensions that are relevant to your app and handling launches from deep link URIs. For each type of quick card, this topic describes the available extensions and the quick card parameters that are passed via the deep link URI. For more information about using Search extensibility with your app, see Search extensibility for Windows Phone 8 and How to extend the Search experience for Windows Phone 8.
The purpose of Search extensibility is to save the user time. Apps must use the deep link URI parameters in a meaningful way. For example, use them to automatically search within your own app when launched from a quick card. Use the Quick Card Sample to learn more about the URI parameter values that are passed from quick cards.
Important Note: |
---|
Apps that misuse Search extensibility risk being pulled from the Windows Phone Store. Register only for search extensions that are relevant to your app. To learn more about which extensions Bing associates with various quick cards, experiment with the Quick Card Sample. |
This topic describes the extensions and URI parameters associated with each of the following quick cards:
Product Card: for items listed under the products heading in the web pivot page of search results
Place Card: for locations listed in the local pivot page of search results
Movie Card: for movies currently playing in theaters listed under the “Movies near…” heading in the web pivot page of search results
Event Card: for events listed on the see+do pivot page of Local Scout (event cards are available only in Windows Phone 8)
Product card
A product card describes information about a product. Product cards are typically launched from a list under the products heading in the web pivot page of search results. Products are categorized into multiple extensions. When launched by a Product card, event information is sent in the parameters of the deep link URI to your app.
Product card extensions
This section lists the extensions for product cards.
Bing_Products_Arts_and_Crafts
Bing_Products_Baby_and_Nursery
Bing_Products_Beauty_and_Fragrance
Bing_Products_Books_and_Magazines
Bing_Products_Cameras_and_Optics
Bing_Products_Car_and_Garage
Bing_Products_Clothing_and_Shoes
Bing_Products_Collectibles_and_Memorabilia
Bing_Products_Computing
Bing_Products_Electronics
Bing_Products_Flowers
Bing_Products_Gourmet_Food_and_Chocolate
Bing_Products_Health_and_Wellness
Bing_Products_Home_Furnishings
Bing_Products_Jewelry_and_Watches
Bing_Products_Kitchen_and_Housewares
Bing_Products_Lawn_and_Garden
Bing_Products_Miscellaneous
Bing_Products_Movies
Bing_Products_Music
Bing_Products_Musical_Instruments
Bing_Products_Office_Products
Bing_Products_Pet_Supplies
Bing_Products_Software
Bing_Products_Sports_and_Outdoors
Bing_Products_Tools_and_Hardware
Bing_Products_Toys
Bing_Products_Travel
Bing_Products_Vehicles
Bing_Products_Video_Games
Product card launch parameters
The following parameters are sent in the deep link URI when your app is launched from a product card.
URI Parameter |
Description |
Supported in Windows Phone OS 7.1 |
Supported in Windows Phone 8 |
---|---|---|---|
ProductName |
The product name |
||
Category |
A comma-delimited list of extensions related to the product |
Example:
/SearchExtras?ProductName=Xbox+360&Category=Bing_Products_Electronics,Bing_Products_Office_Products
Place card
A place card describes information about a location. Place cards are typically launched from a list of locations in the local pivot page of search results. Places are categorized into multiple extensions. When launched by a place card, place information is sent in the parameters of the deep link URI to your app.
Place card extensions
This section lists the extensions for place cards.
Bing_Places_Arts_and_Entertainment
Bing_Places_Automotive_and_Vehicles
Bing_Places_Business_to_Business
Bing_Places_Computers_and_Technology
Bing_Places_Education
Bing_Places_Food_and_Dining
Bing_Places_Government_and_Community
Bing_Places_Health_and_Beauty
Bing_Places_Home_and_Family
Bing_Places_Legal_and_Finance
Bing_Places_Professionals_and_Services
Bing_Places_Real_Estate_and_Construction
Bing_Places_Sports_and_Recreation
Bing_Places_Shopping
Bing_Places_Travel
Place card launch parameters
The following parameters are sent in the deep link URI when your app is launched from a place card.
URI Parameter |
Description |
Supported in Windows Phone OS 7.1 |
Supported in Windows Phone 8 |
---|---|---|---|
PlaceName |
The name of the place |
||
PlaceLatitude |
The latitude of the place |
||
PlaceLongitude |
The longitude of the place |
||
PlaceAddress |
The address of the place |
||
PhoneNumber |
The telephone number of the place |
||
Category |
A comma-delineated list of extensions related to the place |
Example:
/SearchExtras?PlaceName=Fourth+Coffee&PlaceLatitude=47.64602&PlaceLongitude=-122.135074&PlaceAddress=1234+MicrosoftWay%2c+Redmond%2c+WA%2c+98101&PhoneNumber=(425)+555-0123&Category=Bing_Places_Food_and_Dining
Movie card
A movie card describes information about a movie currently playing in theaters. Movie cards are typically launched from a list under the “Movies near…” heading in the web pivot page of search results. Movies are not categorized into multiple extensions. When launched by a Movie card, movie information is sent in the parameters of the deep link URI to your app.
Movie card extension
Use the following extension to register for movie cards:
- Bing_Movies
Movie card launch parameters
The following parameters are sent in the deep link URI when your app is launched from a movie card.
URI Parameter |
Description |
Supported in Windows Phone OS 7.1 |
Supported in Windows Phone 8 |
---|---|---|---|
MovieName |
The name of the movie currently playing in theaters |
||
ReleaseDate |
When the movie was released in theaters |
||
Category |
The extensions related to the movie |
Example:
/SearchExtras?MovieName=Adventure+Works&ReleaseDate=129836124000000000&Category=Bing_Movies
The ReleaseDate value is expressed in units of 100-nanosecond ticks. The ticks represent the 100-nanosecond intervals that have elapsed since 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC). To create a Sytem.DateTime structure from the ReleaseDate value, use the FromFileTimeUtc method.
Event card
An event card describes information about an occasion that a user may want to attend, such as a concert or sporting event. Events are categorized into multiple extensions. When launched by an Event card, event information is sent in the parameters of the deep link URI to your app.
Note
Event cards are available only in Windows Phone 8.
Event card extensions
Use the following extension to register for event cards.
- Bing_Events
Event card launch parameters
The following parameters are sent in the deep link URI when your app is launched from an event card.
URI Parameter |
Description |
Supported in Windows Phone OS 7.1 |
Supported in Windows Phone 8 |
---|---|---|---|
EventName |
The name of the event |
(not available) |
|
StartDate |
When the event starts |
(not available) |
|
PlaceName |
The name of the event location |
(not available) |
|
PlaceLatitude |
The latitude of the event location |
(not available) |
|
PlaceLongitude |
The longitude of the event location |
(not available) |
|
PlaceAddress |
The address of the event |
(not available) |
Example:
/SearchExtras?EventName=Adventure+Works+Adventure&StartDate=130044060000000000&PlaceName=Apine+Ski+House&PlaceLatitude=47.64602&PlaceLongitude=-122.135074&PlaceAddress=1234+MicrosoftWay%2c+Redmond%2c+WA%2c+98101&PhoneNumber=1-425-555-0123&Category=Bing_Events
The StartDate value is expressed in units of 100-nanosecond ticks. The ticks represent the 100-nanosecond intervals that have elapsed since 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC). To create a Sytem.DateTime structure from the StartDate value, use the FromFileTimeUtc method.
See Also
Other Resources
Search extensibility for Windows Phone 8
How to extend the Search experience for Windows Phone 8
How to integrate with App Instant Answer for Windows Phone 8