ProductFlavor
@Incubating interface ProductFlavor : Named, BaseFlavor, ExtensionAware
Encapsulates all product flavors properties for this project.
Product flavors represent different versions of your project that you expect to co-exist on a
single device, the Google Play store, or repository. For example, you can configure 'demo' and
'full' product flavors for your app, and each of those flavors can specify different features,
device requirements, resources, and application ID's--while sharing common source code and
resources. So, product flavors allow you to output different versions of your project by simply
changing only the components and settings that are different between them.
Configuring product flavors is similar to
configuring build types:
add them to the productFlavors block of your project's build.gradle file
and configure the settings you want.
Product flavors support the same properties as the DefaultConfig block—this is because
defaultConfig defines a ProductFlavor object that the plugin uses as the base configuration
for all other flavors.
Each flavor you configure can then override any of the default values in defaultConfig, such as
the applicationId.
When using Android plugin 3.0.0 and higher,
each flavor must belong to a dimension.
When you configure product flavors, the Android plugin automatically combines them with your
BuildType configurations to
create build variants.
If the plugin creates certain build variants that you don't want, you can
filter variants using android.variantFilter.
Summary
Inherited functions
|
From class VariantDimension
Unit |
addManifestPlaceholders(manifestPlaceholders: Map<String, Any>)
Adds manifest placeholders.
See
Inject Build Variables into the Manifest.
|
Unit |
buildConfigField(type: String, name: String, value: String)
Adds a new field to the generated BuildConfig class.
The field is generated as: <type> <name> = <value>;
This means each of these must have valid Java content. If the type is a String, then the
value should include quotes.
|
Unit |
externalNativeBuild(action: ExternalNativeBuildOptions.() -> Unit)
Encapsulates per-variant CMake and ndk-build configurations for your external native build.
To learn more, see
Add C and C++ Code to Your Project.
|
Unit |
javaCompileOptions(action: JavaCompileOptions.() -> Unit)
Options for configuring Java compilation.
|
Unit |
ndk(action: Ndk.() -> Unit)
Encapsulates per-variant configurations for the NDK, such as ABI filters.
|
Any |
proguardFile(proguardFile: Any)
Adds a new ProGuard configuration file.
proguardFile getDefaultProguardFile('proguard-android.txt')
There are two ProGuard rules files that ship with the Android plugin and are used by
default:
- proguard-android.txt
- proguard-android-optimize.txt
proguard-android-optimize.txt is identical to proguard-android.txt,
except with optimizations enabled. You can use getDefaultProguardFileString
to return the full path of the files.
This method has a return value for legacy reasons.
|
Any |
proguardFiles(vararg files: Any)
Adds new ProGuard configuration files.
There are two ProGuard rules files that ship with the Android plugin and are used by
default:
- proguard-android.txt
- proguard-android-optimize.txt
proguard-android-optimize.txt is identical to proguard-android.txt,
except with optimizations enabled. You can use getDefaultProguardFileString
to return the full path of the files.
This method has a return value for legacy reasons.
|
Unit |
resValue(type: String, name: String, value: String)
Adds a new generated resource.
This is equivalent to specifying a resource in res/values.
See Resource Types.
|
Void? |
setManifestPlaceholders(manifestPlaceholders: Map<String, Any>)
|
Any |
setProguardFiles(proguardFileIterable: Iterable<*>)
Replaces the ProGuard configuration files.
This method has a return value for legacy reasons.
|
Unit |
shaders(action: Shaders.() -> Unit)
Configure the shader compiler options.
|
Any |
testProguardFile(proguardFile: Any)
Adds a proguard rule file to be used when processing test code.
Test code needs to be processed to apply the same obfuscation as was done to main code.
This method has a return value for legacy reasons.
|
Any |
testProguardFiles(vararg proguardFiles: Any)
Adds proguard rule files to be used when processing test code.
Test code needs to be processed to apply the same obfuscation as was done to main code.
This method has a return value for legacy reasons.
|
|
From class BaseFlavor
Unit |
minSdkVersion(minSdkVersion: Int)
|
Unit |
minSdkVersion(minSdkVersion: String?)
|
Unit |
missingDimensionStrategy(dimension: String, requestedValue: String)
Specifies a flavor that the plugin should try to use from a given dimension in a dependency.
Android plugin 3.0.0 and higher try to match each variant of your module with the same one
from its dependencies. For example, consider if both your app and its dependencies include a
"tier" flavor dimension,
with flavors "free" and "paid". When you build a "freeDebug" version of your app, the plugin
tries to match it with "freeDebug" versions of the local library modules the app depends on.
However, there may be situations in which a library dependency includes a flavordimension that your app does not. For example, consider if a library dependency includes
flavors for a "minApi" dimension, but your app includes flavors for only the "tier"
dimension. So, when you want to build the "freeDebug" version of your app, the plugin doesn't
know whether to use the "minApi23Debug" or "minApi18Debug" version of the dependency, and
you'll see an error message similar to the following:
Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
project :app
In this type of situation, use missingDimensionStrategy in the
defaultConfig
block to specify the default flavor the plugin should select from each missing
dimension, as shown in the sample below. You can also override your selection in the
productFlavors
block, so each flavor can specify a different matching strategy for a missing dimension.
(Tip: you can also use this property if you simply want to change the matching strategy for a
dimension that exists in both the app and its dependencies.)
// In the app's build.gradle file.
android {
defaultConfig {
// Specifies a flavor that the plugin should try to use from
// a given dimension. The following tells the plugin that, when encountering
// a dependency that includes a "minApi" dimension, it should select the
// "minApi18" flavor.
missingDimensionStrategy 'minApi', 'minApi18'
// You should specify a missingDimensionStrategy property for each
// dimension that exists in a local dependency but not in your app.
missingDimensionStrategy 'abi', 'x86'
}
flavorDimensions 'tier'
productFlavors {
free {
dimension 'tier'
// You can override the default selection at the product flavor
// level by configuring another missingDimensionStrategy property
// for the "minApi" dimension.
missingDimensionStrategy 'minApi', 'minApi23'
}
paid { }
}
}
|
Unit |
missingDimensionStrategy(dimension: String, vararg requestedValues: String)
Specifies a sorted list of flavors that the plugin should try to use from a given dimension
in a dependency.
Android plugin 3.0.0 and higher try to match each variant of your module with the same one
from its dependencies. For example, consider if both your app and its dependencies include a
"tier" flavor dimension,
with flavors "free" and "paid". When you build a "freeDebug" version of your app, the plugin
tries to match it with "freeDebug" versions of the local library modules the app depends on.
However, there may be situations in which a library dependency includes a flavordimension that your app does not. For example, consider if a library dependency includes
flavors for a "minApi" dimension, but your app includes flavors for only the "tier"
dimension. So, when you want to build the "freeDebug" version of your app, the plugin doesn't
know whether to use the "minApi23Debug" or "minApi18Debug" version of the dependency, and
you'll see an error message similar to the following:
Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
project :app
In this type of situation, use missingDimensionStrategy in the
defaultConfig
block to specify the default flavor the plugin should select from each missing
dimension, as shown in the sample below. You can also override your selection in the
productFlavors
block, so each flavor can specify a different matching strategy for a missing dimension.
(Tip: you can also use this property if you simply want to change the matching strategy for a
dimension that exists in both the app and its dependencies.)
// In the app's build.gradle file.
android {
defaultConfig {
// Specifies a flavor that the plugin should try to use from
// a given dimension. The following tells the plugin that, when encountering
// a dependency that includes a "minApi" dimension, it should select the
// "minApi18" flavor.
missingDimensionStrategy 'minApi', 'minApi18'
// You should specify a missingDimensionStrategy property for each
// dimension that exists in a local dependency but not in your app.
missingDimensionStrategy 'abi', 'x86'
}
flavorDimensions 'tier'
productFlavors {
free {
dimension 'tier'
// You can override the default selection at the product flavor
// level by configuring another missingDimensionStrategy property
// for the "minApi" dimension.
missingDimensionStrategy 'minApi', 'minApi23'
}
paid { }
}
}
|
Unit |
missingDimensionStrategy(dimension: String, requestedValues: List<String>)
Specifies a sorted list of flavors that the plugin should try to use from a given dimension
in a dependency.
Android plugin 3.0.0 and higher try to match each variant of your module with the same one
from its dependencies. For example, consider if both your app and its dependencies include a
"tier" flavor dimension,
with flavors "free" and "paid". When you build a "freeDebug" version of your app, the plugin
tries to match it with "freeDebug" versions of the local library modules the app depends on.
However, there may be situations in which a library dependency includes a flavordimension that your app does not. For example, consider if a library dependency includes
flavors for a "minApi" dimension, but your app includes flavors for only the "tier"
dimension. So, when you want to build the "freeDebug" version of your app, the plugin doesn't
know whether to use the "minApi23Debug" or "minApi18Debug" version of the dependency, and
you'll see an error message similar to the following:
Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
project :app
In this type of situation, use missingDimensionStrategy in the
defaultConfig
block to specify the default flavor the plugin should select from each missing
dimension, as shown in the sample below. You can also override your selection in the
productFlavors
block, so each flavor can specify a different matching strategy for a missing dimension.
(Tip: you can also use this property if you simply want to change the matching strategy for a
dimension that exists in both the app and its dependencies.)
// In the app's build.gradle file.
android {
defaultConfig {
// Specifies a flavor that the plugin should try to use from
// a given dimension. The following tells the plugin that, when encountering
// a dependency that includes a "minApi" dimension, it should select the
// "minApi18" flavor.
missingDimensionStrategy 'minApi', 'minApi18'
// You should specify a missingDimensionStrategy property for each
// dimension that exists in a local dependency but not in your app.
missingDimensionStrategy 'abi', 'x86'
}
flavorDimensions 'tier'
productFlavors {
free {
dimension 'tier'
// You can override the default selection at the product flavor
// level by configuring another missingDimensionStrategy property
// for the "minApi" dimension.
missingDimensionStrategy 'minApi', 'minApi23'
}
paid { }
}
}
|
Unit |
resConfig(config: String)
|
Unit |
resConfigs(config: Collection<String>)
|
Unit |
resConfigs(vararg config: String)
|
Unit |
setMinSdkVersion(minSdkVersion: Int)
|
Unit |
setMinSdkVersion(minSdkVersion: String?)
|
Any? |
setTestFunctionalTest(testFunctionalTest: Boolean)
|
Any? |
setTestHandleProfiling(testHandleProfiling: Boolean)
|
Any? |
setTestInstrumentationRunnerArguments(testInstrumentationRunnerArguments: MutableMap<String, String>)
|
Unit |
testInstrumentationRunnerArgument(key: String, value: String)
|
Unit |
testInstrumentationRunnerArguments(args: Map<String, String>)
|
Unit |
vectorDrawables(action: VectorDrawables.() -> Unit)
Configures VectorDrawables.
|
|
Properties
|
| abstract String? |
Specifies the flavor dimension that this product flavor belongs to.
|
| abstract MutableList<String> |
Specifies a sorted list of product flavors that the plugin should try to use when a direct
variant match with a local module dependency is not possible.
|
Inherited properties
|
|
|
From class BaseFlavor
Int? |
minSdk
The minimum SDK version.
Setting this it will override previous calls of minSdk and minSdkPreview setters. Only
one of minSdk and minSdkPreview should be set.
See uses-sdk element documentation.
|
String? |
minSdkPreview
The minimum SDK version.
Setting this it will override previous calls of minSdk and minSdkPreview setters. Only
one of minSdk and minSdkPreview should be set.
See uses-sdk element documentation.
|
Boolean? |
renderscriptNdkModeEnabled
Whether the renderscript code should be compiled to generate C/C++ bindings.
True for C/C++ generation, false for Java, null if not specified.
|
Boolean? |
renderscriptSupportModeBlasEnabled
Whether the renderscript BLAS support lib should be used to make it compatible with older
versions of Android.
True if BLAS support lib is enabled, false if not, and null if not specified.
|
Boolean? |
renderscriptSupportModeEnabled
Whether the renderscript code should be compiled in support mode to make it compatible with
older versions of Android.
True if support mode is enabled, false if not, and null if not specified.
|
Int? |
renderscriptTargetApi
The renderscript target api, or null if not specified. This is only the value set on this
product flavor.
|
MutableSet<String> |
resourceConfigurations
Specifies a list of
alternative resources
to keep.
For example, if you are using a library that includes language resources (such as
AppCompat or Google Play Services), then your APK includes all translated language strings
for the messages in those libraries whether the rest of your app is translated to the same
languages or not. If you'd like to keep only the languages that your app officially supports,
you can specify those languages using the resConfigs property, as shown in the
sample below. Any resources for languages not specified are removed.
android {
defaultConfig {
...
// Keeps language resources for only the locales specified below.
resConfigs "en", "fr"
}
}
You can also use this property to filter resources for screen densities. For example,
specifying hdpi removes all other screen density resources (such as mdpi,
xhdpi, etc) from the final APK.
Note: auto is no longer supported because it created a number of
issues with multi-module projects. Instead, you should specify a list of locales that your
app supports, as shown in the sample above. Android plugin 3.1.0 and higher ignore the
auto argument, and Gradle packages all string resources your app and its dependencies
provide.
To learn more, see
Remove unused alternative resources.
|
String? |
testApplicationId
Test application ID.
See Set the Application ID
|
Boolean? |
testFunctionalTest
See instrumentation.
|
Boolean? |
testHandleProfiling
See instrumentation.
|
String? |
testInstrumentationRunner
Test instrumentation runner class name.
This is a fully qualified class name of the runner, e.g.
android.test.InstrumentationTestRunner
See instrumentation.
|
MutableMap<String, String> |
testInstrumentationRunnerArguments
Test instrumentation runner custom arguments.
e.g. [key: "value"] will give adb shell am instrument -w -e key value com.example...
See instrumentation.
Test runner arguments can also be specified from the command line:
./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.size=medium
./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.foo=bar
|
VectorDrawables |
vectorDrawables
Options to configure the build-time support for vector drawables.
|
Boolean? |
wearAppUnbundled
Whether to enable unbundling mode for embedded wear app.
If true, this enables the app to transition from an embedded wear app to one
distributed by the play store directly.
|
|
Public methods
setDimension
@Incubating abstract fun setDimension(dimension: String?): Void?
Deprecated.
setMatchingFallbacks
@Incubating abstract fun setMatchingFallbacks(vararg fallbacks: String): Unit
Deprecated.
setMatchingFallbacks
@Incubating abstract fun setMatchingFallbacks(fallbacks: List<String>): Unit
Deprecated.
Properties
dimension
abstract var dimension: String?
Specifies the flavor dimension that this product flavor belongs to.
When configuring product flavors with Android plugin 3.0.0 and higher, you must specify at
least one flavor dimension, using the flavorDimensions property, and then assign each
flavor to a dimension.
Otherwise, you will get the following build error:
Error:All flavors must now belong to a named flavor dimension.
The flavor 'flavor_name' is not assigned to a flavor dimension.
By default, when you specify only one dimension, all flavors you configure automatically
belong to that dimension. If you specify more than one dimension, you need to manually assign
each flavor to a dimension, as shown in the sample below:
android {
...
// Specifies the flavor dimensions you want to use. The order in which you
// list each dimension determines its priority, from highest to lowest,
// when Gradle merges variant sources and configurations. You must assign
// each product flavor you configure to one of the flavor dimensions.
flavorDimensions 'api', 'version'
productFlavors {
demo {
// Assigns this product flavor to the 'version' flavor dimension.
dimension 'version'
...
}
full {
dimension 'version'
...
}
minApi24 {
// Assigns this flavor to the 'api' dimension.
dimension 'api'
minSdkVersion '24'
versionNameSuffix "-minApi24"
...
}
minApi21 {
dimension "api"
minSdkVersion '21'
versionNameSuffix "-minApi21"
...
}
}
}
To learn more about configuring flavor dimensions, read
Combine multiple flavors.
matchingFallbacks
abstract val matchingFallbacks: MutableList<String>
Specifies a sorted list of product flavors that the plugin should try to use when a direct
variant match with a local module dependency is not possible.
Android plugin 3.0.0 and higher try to match each variant of your module with the same one
from its dependencies. For example, when you build a "freeDebug" version of your app, the
plugin tries to match it with "freeDebug" versions of the local library modules the app
depends on.
However, there may be situations in which, for a given flavor dimension that exists in
both the app and its library dependencies, your app includes flavors that a dependencydoes not. For example, consider if both your app and its library dependencies include a
"tier" flavor dimension. However, the "tier" dimension in the app includes "free" and "paid"
flavors, but one of its dependencies includes only "demo" and "paid" flavors for the same
dimension. When the plugin tries to build the "free" version of your app, it won't know which
version of the dependency to use, and you'll see an error message similar to the following:
Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
project :app
In this situation, you should use matchingFallbacks to specify alternative
matches for the app's "free" product flavor, as shown below:
// In the app's build.gradle file.
android {
flavorDimensions 'tier'
productFlavors {
paid {
dimension 'tier'
// Because the dependency already includes a "paid" flavor in its
// "tier" dimension, you don't need to provide a list of fallbacks
// for the "paid" flavor.
}
free {
dimension 'tier'
// Specifies a sorted list of fallback flavors that the plugin
// should try to use when a dependency's matching dimension does
// not include a "free" flavor. You may specify as many
// fallbacks as you like, and the plugin selects the first flavor
// that's available in the dependency's "tier" dimension.
matchingFallbacks = ['demo', 'trial']
}
}
}
Note that, for a given flavor dimension that exists in both the app and its library
dependencies, there is no issue when a library includes a product flavor that your app does
not. That's because the plugin simply never requests that flavor from the dependency.
If instead you are trying to resolve an issue in which a library dependency includes aflavor dimension that your app does not, use missingDimensionStrategy.
