# ProductFlavor


```
public interface ProductFlavor extends Named, BaseFlavor, ExtensionAware
```

<br />

Known direct subclasses [ApplicationProductFlavor](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApplicationProductFlavor), [DynamicFeatureProductFlavor](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DynamicFeatureProductFlavor), [LibraryProductFlavor](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/LibraryProductFlavor), [TestProductFlavor](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/TestProductFlavor)

|---|---|
| `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApplicationProductFlavor` | Encapsulates all product flavors properties for application projects. |
| `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DynamicFeatureProductFlavor` | Encapsulates all product flavors properties for dynamic feature projects. |
| `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/LibraryProductFlavor` | Encapsulates all product flavors properties for library projects. |
| `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/TestProductFlavor` | Encapsulates all product flavors properties for test projects. |

*** ** * ** ***

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](https://developer.android.com/studio/build/build-variants.html#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 `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DefaultConfig` block---this is because `defaultConfig` defines a `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/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`](https://d.android.com/studio/build/application-id.html).

When using Android plugin 3.0.0 and higher, *`https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#dimension()`*.

When you configure product flavors, the Android plugin automatically combines them with your `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BuildType` configurations to [create build variants](https://developer.android.com/studio/build/build-variants.html). If the plugin creates certain build variants that you don't want, you can [filter variants using `android.variantFilter`](https://developer.android.com/studio/build/build-variants.html#filter-variants).

## Summary

| ### Public methods |
|---|---|
| `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#getDimension()()` Specifies the flavor dimension that this product flavor belongs to. |
| `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html>` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#getMatchingFallbacks()()` 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. |
| `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Void.html` | `[setDimension](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setDimension(kotlin.String))(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html dimension)` **This method is deprecated.** Replaced with the dimension property |
| `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setDimension(kotlin.String)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html dimension)` Specifies the flavor dimension that this product flavor belongs to. |
| `abstract void` | `[setMatchingFallbacks](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setMatchingFallbacks(kotlin.collections.List))(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html> fallbacks)` **This method is deprecated.** Replaced with property matchingFallbacks |
| `abstract void` | `[setMatchingFallbacks](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setMatchingFallbacks(kotlin.Array))(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html fallbacks)` **This method is deprecated.** Replaced with property matchingFallbacks |

| ### Inherited methods |
|---|
| From [com.android.build.api.dsl.BaseFlavor](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor) |---|---| | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getMinSdk()()` The minimum SDK version. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getMinSdkPreview()()` The minimum SDK version. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getRenderscriptNdkModeEnabled()()` Whether the renderscript code should be compiled to generate C/C++ bindings. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getRenderscriptSupportModeBlasEnabled()()` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getRenderscriptSupportModeEnabled()()` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getRenderscriptTargetApi()()` The renderscript target api, or null if not specified. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html>` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getResourceConfigurations()()` Specifies a list of [alternative resources](https://d.android.com/guide/topics/resources/providing-resources.html#AlternativeResources) to keep. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getTestApplicationId()()` Test application ID. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getTestFunctionalTest()()` See [instrumentation](http://developer.android.com/guide/topics/manifest/instrumentation-element.html). | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getTestHandleProfiling()()` See [instrumentation](http://developer.android.com/guide/topics/manifest/instrumentation-element.html). | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getTestInstrumentationRunner()()` Test instrumentation runner class name. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html>` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getTestInstrumentationRunnerArguments()()` Test instrumentation runner custom arguments. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VectorDrawables` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getVectorDrawables()()` Options to configure the build-time support for `vector` drawables. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#getWearAppUnbundled()()` Whether to enable unbundling mode for embedded wear app. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#initWith(com.android.build.api.dsl.BaseFlavor)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor that)` Copies all properties from the given flavor. | | `abstract void` | `[minSdkVersion](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#minSdkVersion(kotlin.Int))(int minSdkVersion)` **This method is deprecated.** Replaced by minSdk property | | `abstract void` | `[minSdkVersion](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#minSdkVersion(kotlin.String))(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html minSdkVersion)` **This method is deprecated.** Replaced by minSdkPreview property | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#missingDimensionStrategy(kotlin.String,kotlin.String)( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html dimension, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html requestedValue )` Specifies a flavor that the plugin should try to use from a given dimension in a dependency. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#missingDimensionStrategy(kotlin.String,kotlin.collections.List)( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html dimension, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html> requestedValues )` Specifies a sorted list of flavors that the plugin should try to use from a given dimension in a dependency. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#missingDimensionStrategy(kotlin.String,kotlin.Array)( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html dimension, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html requestedValues )` Specifies a sorted list of flavors that the plugin should try to use from a given dimension in a dependency. | | `abstract void` | `[resConfig](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#resConfig(kotlin.String))(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html config)` **This method is deprecated.** Replaced by resourceConfigurations field | | `abstract void` | `[resConfigs](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#resConfigs(kotlin.collections.Collection))(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html> config)` **This method is deprecated.** Replaced by resourceConfigurations field | | `abstract void` | `[resConfigs](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#resConfigs(kotlin.Array))(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html config)` **This method is deprecated.** Replaced by resourceConfigurations field | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setMinSdk(kotlin.Int)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html minSdk)` The minimum SDK version. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setMinSdkPreview(kotlin.String)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html minSdkPreview)` The minimum SDK version. | | `abstract void` | `[setMinSdkVersion](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setMinSdkVersion(kotlin.Int))(int minSdkVersion)` **This method is deprecated.** Replaced by minSdk property | | `abstract void` | `[setMinSdkVersion](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setMinSdkVersion(kotlin.String))(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html minSdkVersion)` **This method is deprecated.** Replaced by minSdkPreview property | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setRenderscriptNdkModeEnabled(kotlin.Boolean)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html renderscriptNdkModeEnabled)` Whether the renderscript code should be compiled to generate C/C++ bindings. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setRenderscriptSupportModeBlasEnabled(kotlin.Boolean)( https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html renderscriptSupportModeBlasEnabled )` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setRenderscriptSupportModeEnabled(kotlin.Boolean)( https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html renderscriptSupportModeEnabled )` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setRenderscriptTargetApi(kotlin.Int)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html renderscriptTargetApi)` The renderscript target api, or null if not specified. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestApplicationId(kotlin.String)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html testApplicationId)` Test application ID. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `[setTestFunctionalTest](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestFunctionalTest(kotlin.Boolean))(boolean testFunctionalTest)` **This method is deprecated.** Replaced by testFunctionalTest property | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestFunctionalTest(kotlin.Boolean)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html testFunctionalTest)` See [instrumentation](http://developer.android.com/guide/topics/manifest/instrumentation-element.html). | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `[setTestHandleProfiling](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestHandleProfiling(kotlin.Boolean))(boolean testHandleProfiling)` **This method is deprecated.** Replaced by testFunctionalTest property | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestHandleProfiling(kotlin.Boolean)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html testHandleProfiling)` See [instrumentation](http://developer.android.com/guide/topics/manifest/instrumentation-element.html). | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestInstrumentationRunner(kotlin.String)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html testInstrumentationRunner)` Test instrumentation runner class name. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `[setTestInstrumentationRunnerArguments](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setTestInstrumentationRunnerArguments(kotlin.collections.MutableMap))( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html> testInstrumentationRunnerArguments )` **This method is deprecated.** Replaced by testInstrumentationRunnerArguments property | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#setWearAppUnbundled(kotlin.Boolean)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html wearAppUnbundled)` Whether to enable unbundling mode for embedded wear app. | | `abstract void` | `[testInstrumentationRunnerArgument](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#testInstrumentationRunnerArgument(kotlin.String,kotlin.String))( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html key, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html value )` **This method is deprecated.** Replaced by testInstrumentationRunnerArguments property | | `abstract void` | `[testInstrumentationRunnerArguments](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#testInstrumentationRunnerArguments(kotlin.collections.Map))( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html> args )` **This method is deprecated.** Replaced by testInstrumentationRunnerArguments property | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#vectorDrawables(kotlin.Function1)( @https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VectorDrawables, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html> action )` Configures `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VectorDrawables`. | |
| From [org.gradle.api.plugins.ExtensionAware](https://docs.gradle.org/current/javadoc/org/gradle/api/plugins/ExtensionAware.html) |---|---| | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.gradle.org/current/javadoc/org/gradle/api/plugins/ExtensionContainer.html` | `@https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/Internal.html https://docs.gradle.org/current/javadoc/org/gradle/api/plugins/ExtensionAware.html#getExtensions--()` | |
| From [org.gradle.api.Named](https://docs.gradle.org/current/javadoc/org/gradle/api/Named.html) |---|---| | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html` | `https://docs.gradle.org/current/javadoc/org/gradle/api/Named.html#getName--()` | |
| From [com.android.build.api.dsl.VariantDimension](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension) |---|---| | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#addManifestPlaceholders(kotlin.collections.Map)( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html> manifestPlaceholders )` Adds manifest placeholders. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#buildConfigField(kotlin.String,kotlin.String,kotlin.String)( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html type, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html name, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html value )` Adds a new field to the generated BuildConfig class. | | `abstract void` | `@https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#externalNativeBuild(kotlin.Function1)( @https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ExternalNativeBuildFlags, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html> action )` Encapsulates per-variant CMake and ndk-build configurations for your external native build. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ExternalNativeBuildFlags` | `@https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getExternalNativeBuild()()` Encapsulates per-variant CMake and ndk-build configurations for your external native build. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/JavaCompileOptions` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getJavaCompileOptions()()` Options for configuring Java compilation. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html>` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getManifestPlaceholders()()` The manifest placeholders. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getMultiDexKeepFile()()` Text file that specifies additional classes that will be compiled into the main dex file. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getMultiDexKeepProguard()()` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Ndk` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getNdk()()` Encapsulates per-variant configurations for the NDK, such as ABI filters. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Optimization` | `@https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getOptimization()()` | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html>` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getProguardFiles()()` Specifies the ProGuard configuration files that the plugin should use. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Shaders` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getShaders()()` Options for configuring the shader compiler. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html>` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#getTestProguardFiles()()` The collection of proguard rule files to be used when processing test code. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#javaCompileOptions(kotlin.Function1)( @https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/JavaCompileOptions, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html> action )` Options for configuring Java compilation. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#ndk(kotlin.Function1)(@https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Ndk, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html> action)` Encapsulates per-variant configurations for the NDK, such as ABI filters. | | `abstract void` | `@https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#optimization(kotlin.Function1)( @https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Optimization, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html> action )` | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#proguardFile(kotlin.Any)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html proguardFile)` Adds a new ProGuard configuration file. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#proguardFiles(kotlin.Array)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html files)` Adds new ProGuard configuration files. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#resValue(kotlin.String,kotlin.String,kotlin.String)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html type, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html name, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html value)` Adds a new generated resource. | | `abstract https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Void.html` | `[setManifestPlaceholders](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#setManifestPlaceholders(kotlin.collections.Map))( @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html, @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html> manifestPlaceholders )` **This method is deprecated.** Use manifestPlaceholders property instead | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#setMultiDexKeepFile(java.io.File)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html multiDexKeepFile)` Text file that specifies additional classes that will be compiled into the main dex file. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#setMultiDexKeepProguard(java.io.File)(https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html multiDexKeepProguard)` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#setProguardFiles(kotlin.collections.Iterable)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull ?> proguardFileIterable)` Replaces the ProGuard configuration files. | | `abstract void` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#shaders(kotlin.Function1)( @https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/Shaders, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html> action )` Configure the shader compiler options. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#testProguardFile(kotlin.Any)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html proguardFile)` Adds a proguard rule file to be used when processing test code. | | `abstract @https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html` | `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/VariantDimension#testProguardFiles(kotlin.Array)(@https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html proguardFiles)` Adds proguard rule files to be used when processing test code. | |

## Public methods

### getDimension

```
abstract String getDimension()
```

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](https://developer.android.com/studio/build/build-variants.html#flavor-dimensions).

### getMatchingFallbacks

```
abstract @NonNull List<@NonNull String> getMatchingFallbacks()
```

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 dependency does 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 a flavor dimension that your app does not** , use `https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/BaseFlavor#missingDimensionStrategy(kotlin.String,kotlin.String)`.

### setDimension

```
abstract Void [setDimension](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setDimension(kotlin.String))(String dimension)
```

> [!CAUTION]
> **This method is deprecated.**   
> Replaced with the dimension property

### setDimension

```
abstract void setDimension(String dimension)
```

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](https://developer.android.com/studio/build/build-variants.html#flavor-dimensions).

### setMatchingFallbacks

```
abstract void [setMatchingFallbacks](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setMatchingFallbacks(kotlin.collections.List))(@NonNull List<@NonNull String> fallbacks)
```

> [!CAUTION]
> **This method is deprecated.**   
> Replaced with property matchingFallbacks

### setMatchingFallbacks

```
abstract void [setMatchingFallbacks](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ProductFlavor#setMatchingFallbacks(kotlin.Array))(@NonNull String fallbacks)
```

> [!CAUTION]
> **This method is deprecated.**   
> Replaced with property matchingFallbacks