From 5305627d5b78b8d63ce344c4eb5d1a28ef44d3d0 Mon Sep 17 00:00:00 2001 From: Dirk Dougherty Date: Mon, 26 Apr 2010 18:15:25 -0700 Subject: [PATCH] Doc change: New doc that describes how market filters work Change-Id: I99696502b38d952df8fe07c8982d0cf6b95b31bd --- docs/html/guide/appendix/market-filters.jd | 307 ++++++++++++++++++ docs/html/guide/guide_toc.cs | 3 + .../topics/manifest/uses-feature-element.jd | 3 +- .../guide/topics/manifest/uses-sdk-element.jd | 3 +- 4 files changed, 314 insertions(+), 2 deletions(-) create mode 100644 docs/html/guide/appendix/market-filters.jd diff --git a/docs/html/guide/appendix/market-filters.jd b/docs/html/guide/appendix/market-filters.jd new file mode 100644 index 0000000000000..0b1afaec83f6e --- /dev/null +++ b/docs/html/guide/appendix/market-filters.jd @@ -0,0 +1,307 @@ +page.title=Market Filters +@jd:body + +
+
+ +

Market Filters quickview

+
  • Android Market applies filters to control which apps are visible to a +user.
  • Filtering is determined by elements in an app's manifest file, +aspects of the device being used, and other factors.
+ +

In this document

+ +
  1. How Filters Work in Android Market
    2. +
  2. The Manifest File +
      +
    1. Elements that affect filtering
      2. +
    +
    3. +
  3. Other Filters
    4. +
+ +

See also

+
    +
  1. <supports-screens>
    2. +
  2. <uses-configuration>
    3. +
  3. <uses-feature>
    4. +
  4. <uses-library>
    5. +
  5. <uses-permission>
    6. +
  6. <uses-sdk>
    7. +
+ +
+

Interested in +publishing your app on Android Market?

Go to Android Market »
+
+ +
+ +

When a user searches or browses in Android Market, the results are filtered, and +some applications might not be visible. For example, if an application requires a +trackball (as specified in the manifest file), then Android Market will not show +the app on any device that does not have a trackball.

The manifest file and +the device's hardware and features are only part of how applications are filtered +— filtering also depends on the country and carrier, the presence or absence +of a SIM card, and other factors.

+ +

Changes to the Android Market filters are independent of changes +to the Android platform itself. This document will be updated periodically to reflect +any changes that might occur.

+ +

How Filters Work in Android Market

+ +

If any one of the filter restrictions described in the following sections applies to +an application, then the application will not appear in search results or category +browsing on Android Market.

You can request any combination of the available filters for your +app — for example, you could set a minSdkVersion of 4 and set +smallScreens to false in the app, then when uploading the app to +Market you could target European countries (carriers) only. Android Market's +filters would prevent the application from being visible on any device that did not +match all three of these requirements.

+ +

A filtered app is not visible within Market, even if a user specifically requests +the app by clicking a deep link that points directly to the app's ID within Market. +All filtering restrictions are associated with an application's version and can +change between versions. For example:

+ + + +

The Manifest File

+

Most Market filters are triggered by elements within an application's manifest file, AndroidManifest.xml, +although not everything in the manifest file can trigger filtering.

+

Elements that affect filtering

+

The following table lists the manifest elements that can be used to trigger +Android Market filtering, and explains how they work.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Manifest ElementFilter NameHow It Works
<supports-screens> + Screen Size + +

An application indicates the screen sizes that it is capable of supporting by +setting attributes of the <supports-screens> element. When +the application is published, Market uses those attributes to determine whether +to show the application to users, based on the screen sizes of their +devices.

+ +

As a general rule, Market assumes that the platform on the device can adapt +smaller layouts to larger screens, but cannot adapt larger layouts to smaller +screens. Thus, if an application declares support for "normal" screen size only, +Market makes the application available to both normal- and large-screen devices, +but filters the application so that it is not available to small-screen +devices.

+ +

If an application does not declare attributes for +<supports-screens>, Market uses the default values for those +attributes, which vary by API Level. Specifically:

+ +
    +

  • In API level 3, the <supports-screens> element itself +is undefined and no attributes are available. In this case, Market assumes that +the application is designed for normal-size screens and shows the application to +devices that have normal or large screens.

    + +

    This behavior is especially significant for applications that set their +android: +minSdkVersion to 3 or lower, since Market will filter them from +small-screen devices by default. Such applications can enable support for +small-screen devices by adding a android:targetSdkVersion="4" +attribute to the <uses-sdk> element in their manifest +files. For more information, see Strategies for +Legacy Applications.

    • + +
  • In API Level 4, the defaults for all of the attributes is +"true". If an application does not declare a +<supports-screens> element, Market assumes that the +application is designed for all screen sizes and does not filter it from any +devices. If the application does not declare one of the attributes, Market uses +the default value of "true" and does not filter the app for devices +of corresponding screen size.
    • +
+ +

Example 1
+ The manifest declares <uses-sdk android:minSdkVersion="3"> + and does not does not include a <supports-screens> element. + Result: Android Market will not show the app to a user of a + small-screen device, but will show it to users of normal and large-screen + devices, users, unless other filters apply.

+

Example 2
+ The manifest declares <uses-sdk android:minSdkVersion="3" + android:targetSdkVersion="4"> and does not include a + <supports-screens> element. + Result: Android Market will show the app to users on all + devices, unless other filters apply.

+

Example 3
+ The manifest declares <uses-sdk android:minSdkVersion="4"> + and does not include a <supports-screens> element. + Result: Android Market will show the app to all users, + unless other filters apply.

+

For more information on how to declare support for screen sizes in your + application, see <supports-screens> + and Supporting Multiple + Screens.

+
<uses-configuration> + Device + Configuration:
+ keyboard, navigation, touch screen

An application can + request certain hardware features, and Android Market will show the app only on devices that have the required hardware.

+

Example 1
+ The manifest includes <uses-configuration android:reqFiveWayNav="true" />, and a user is searching for apps on a device that does not have a five-way navigational control. Result: Android Market will not show the app to the user.

+

Example 2
+ The manifest does not include a <uses-configuration> element. Result: Android Market will show the app to all users, unless other filters apply.

+

For more details, see <uses-configuration>.

<uses-feature> + Device Features
+ (name)

An + application can require certain device features to be present on the device. This functionality + was introduced in Android 2.0 (API Level 5).

+

Example 1
+ The manifest includes <uses-feature android:name="android.hardware.sensor.light" />, and a user is searching for apps on a device that does not have a light sensor. Result: Android Market will not show the app to the user.

+

Example 2
+ The manifest does not include a <uses-feature> element. Result: Android Market will show the app to all users, unless other filters apply.

+

For more details, see <uses-feature>.

+

A note about camera: If an + application requests the CAMERA permission using the <uses-permission> element, Market assumes that the + application requires the camera and autofocus features. For applications that require the camera and are designed to run on Android 1.5 (API Level 3), declaring the CAMERA permission is an effective way of ensuring that Market filters your app properly, since uses-feature filtering is not available to applications compiled against the Android 1.5 platform. For more details about requiring or requesting a camera, see the required attribute of <uses-feature>.

OpenGL-ES + Version
+(openGlEsVersion)

An application can require that the device support a specific + OpenGL-ES version using the <uses-feature + android:openGlEsVersion="int"> attribute.

+

Example 1
+ An app + requests multiple OpenGL-ES versions by specifying openGlEsVersion multiple times in the + manifest. Result: Market assumes that the app requires the highest of the indicated versions.

+

Example 2
+An app + requests OpenGL-ES version 1.1, and a user is searching for apps on a device that supports OpenGL-ES version 2.0. Result: Android Market will show the app to the user, unless other filters apply. If a + device reports that it supports OpenGL-ES version X, Market assumes that it + also supports any version earlier than X. +

+

Example 3
+A user is searching for apps on a device that does not + report an OpenGL-ES version (for example, a device running Android 1.5 or earlier). Result: Android Market assumes that the device + supports only OpenGL-ES 1.0. Market will only show the user apps that do not specify openGlEsVersion, or apps that do not specify an OpenGL-ES version higher than 1.0.

+

Example 4
+ The manifest does not specify openGlEsVersion. Result: Android Market will show the app to all users, unless other filters apply.

+

For more details, see <uses-feature>.

<uses-library>Software Libraries

An application can require specific + shared libraries to be present on the device.

+

Example 1
+ An app requires the com.google.android.maps library, and a user is searching for apps on a device that does not have the com.google.android.maps library. Result: Android Market will not show the app to the user.

+

Example 2
+ The manifest does not include a <uses-library> element. Result: Android Market will show the app to all users, unless other filters apply.

+

For more details, see <uses-library>.

<uses-permission> (See the note in the description of <uses-feature>, above.)
<uses-sdk>Minimum Framework Version (minSdkVersion)

An application can require a minimum API level.

+

Example 1
+ The manifest includes <uses-sdk + android:minSdkVersion="3">, and the app uses APIs that were introduced in API Level 3. A user is searching for apps on a device that has API Level 2. Result: Android Market will not show the app to the user.

+

Example 2
+ The manifest does not include minSdkVersion, and the app uses APIs that were introduced in API Level 3. A user is searching for apps on a device that has API Level 2. Result: Android Market assumes that minSdkVersion is "1" and that the app is compatible with all versions of Android. Market shows the app to the user and allows the user to download the app. The app crashes at runtime.

+

Because you want to avoid this second scenario, we recommend that you always declare a minSdkVersion. For details, see android:minSdkVersion.

Maximum Framework Version (maxSdkVersion)

Deprecated. Android + 2.1 and later do not check or enforce the maxSdkVersion attribute, and + the SDK will not compile if maxSdkVersion is set in an app's manifest. For devices already + compiled with maxSdkVersion, Market will respect it and use it for + filtering.

+

Declaring maxSdkVersion is not recommended. For details, see android:maxSdkVersion.

+ +

Other Filters

+

The following table describes other application characteristics that trigger Android Market filtering.

+ + + + + + + + + + + +
Filter Name How It Works
Publishing Status

Only published applications will appear in + searches and browsing within Android Market.

Even if an app is unpublished, it can + be installed if users can see it in their Downloads area among their purchased, + installed, or recently uninstalled apps.

If an application has been + suspended, users will not be able to reinstall or update it, even if it appears in their Downloads.

Priced + Status

Not all users can see paid apps. To show paid apps, a device +must have a SIM card and be running Android 1.1 or later, and it must be in a +country (as determined by SIM carrier) in which paid apps are available.

Country / Carrier Targeting

When you upload your app to + the Android Market, you can select specific countries to target. The app will only + be visible to the countries (carriers) that you select, as follows:

+

  • A device's country is determined based on the carrier, if a carrier is + available. If no carrier can be determined, the Market application tries to + determine the country based on IP.

  • Carrier is determined based on + the device's SIM (for GSM devices), not the current roaming carrier.

+
Native Platform

An application that includes native + libraries that target a specific platform (ARM EABI v7, for example) will only be + visible on devices that support that platform. For details about the NDK and using + native libraries, see What is the + Android NDK?

Forward-Locked Applications

To + forward lock an application, set copy protection to "On" when you upload the + application to Market. Market will not show copy-protected applications on +developer devices or unreleased devices.
+ + diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index 8f66bddb5d6e5..11058a6675d2d 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -410,6 +410,9 @@
  • Android API Levels
    • +
  • + Market Filters + new!
  • Supported Media Formats
    • diff --git a/docs/html/guide/topics/manifest/uses-feature-element.jd b/docs/html/guide/topics/manifest/uses-feature-element.jd index 8594452932dc1..4066daaf50618 100644 --- a/docs/html/guide/topics/manifest/uses-feature-element.jd +++ b/docs/html/guide/topics/manifest/uses-feature-element.jd @@ -27,7 +27,8 @@ devices. One of the ways Market filters applications is by feature compatibility <uses-feature> elements in each application's manifest, to establish the app's feature needs. Market then shows or hides the application to each user, based on a comparison with the features available on the user's -device.

    +device. For more information, see Market Filters.

    By specifying the features your application requires, you enable Android Market to present your application only to users whose diff --git a/docs/html/guide/topics/manifest/uses-sdk-element.jd b/docs/html/guide/topics/manifest/uses-sdk-element.jd index f8aff1e992b5e..971d4cb3aba74 100644 --- a/docs/html/guide/topics/manifest/uses-sdk-element.jd +++ b/docs/html/guide/topics/manifest/uses-sdk-element.jd @@ -39,7 +39,8 @@ devices. One of the ways Market filters applications is by Android version-compatibility. To do this, Market checks the <uses-sdk> attributes in each application's manifest to establish its version-compatibility range, then shows or hides the application based on a comparison with the API -Level of the user's Android system version.

    +Level of the user's Android system version. For more information, see Market Filters.