CommonExtension

public interface CommonExtension<BuildFeaturesT extends BuildFeatures, BuildTypeT extends BuildType, DefaultConfigT extends DefaultConfig, ProductFlavorT extends ProductFlavor, AndroidResourcesT extends AndroidResources>

Known direct subclasses
ApplicationExtension

Extension for the Android Gradle Plugin Application plugin.
DynamicFeatureExtension

Extension for the Android Dynamic Feature Gradle Plugin.
LibraryExtension

Extension for the Android Library Gradle Plugin.
TestExtension

Extension for the Android Test Gradle Plugin.

Common extension properties for the Android Application. Library and Dynamic Feature Plugins.

Only the Android Gradle Plugin should create instances of this interface.

Summary

Public methods
abstract void

This method is deprecated. Replaced by

abstract void

This method is deprecated. Replaced by installation
abstract void
androidResources(
    @ExtensionFunctionType @NonNull Function1<@NonNull AndroidResourcesT, Unit> action
)

Specifies options related to the processing of Android Resources.
abstract void
buildFeatures(
    @ExtensionFunctionType @NonNull Function1<@NonNull BuildFeaturesT, Unit> action
)

A list of build features that can be enabled or disabled on the Android Project.
abstract void
buildToolsVersion(@NonNull String buildToolsVersion)

This method is deprecated. Replaced by buildToolsVersion property
abstract void

Encapsulates all build type configurations for this project.
abstract void

Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.
abstract void
compileSdkAddon(@NonNull String vendor, @NonNull String name, int version)

Specify an SDK add-on to compile your project against.
abstract void
compileSdkVersion(int apiLevel)

This method is deprecated. Replaced by compileSdk
abstract void

This method is deprecated. Replaced by compileSdkPreview
abstract void
abstract void

Specifies options for the Data Binding Library.
abstract void
debug(
    @NonNull NamedDomainObjectContainer<@NonNull BuildTypeT> receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull BuildTypeT, Unit> action
)

Shortcut extension method to allow easy access to the predefined debug BuildType
abstract void
defaultConfig(
    @ExtensionFunctionType @NonNull Function1<@NonNull DefaultConfigT, Unit> action
)

Specifies defaults for variant properties that the Android plugin applies to all build variants.
abstract void

Specifies options for external native build using CMake or ndk-build.
abstract void

This method is deprecated. Replaced by flavorDimensions property
abstract @NonNull AaptOptions

Specifies options for the Android Asset Packaging Tool (AAPT).
abstract @NonNull AdbOptions

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
abstract @NonNull AndroidResourcesT

Specifies options related to the processing of Android Resources.
abstract @NonNull BuildFeaturesT

A list of build features that can be enabled or disabled on the Android Project.
abstract @NonNull String

Specifies the version of the SDK Build Tools to use when building your project.
abstract @NonNull NamedDomainObjectContainer<@NonNull BuildTypeT>

Encapsulates all build type configurations for this project.
abstract @NonNull CompileOptions

Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.
abstract Integer

Specifies the API level to compile your project against.
abstract Integer

Specifies the SDK Extension level to compile your project against.
abstract String

Specify a preview API to compile your project against.
abstract @NonNull ComposeOptions
abstract @NonNull DataBinding

Specifies options for the Data Binding Library.
abstract @NonNull DefaultConfigT

Specifies defaults for variant properties that the Android plugin applies to all build variants.
abstract @NonNull File
abstract @NonNull Map<@NonNull String, @NonNull Object>

Additional per module experimental properties.
abstract @NonNull ExternalNativeBuild

Specifies options for external native build using CMake or ndk-build.
abstract @NonNull List<@NonNull String>

Specifies the names of product flavor dimensions for this project.
abstract @NonNull Installation

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
abstract @NonNull JacocoOptions

Configure the gathering of code-coverage from tests.
abstract @NonNull Lint

Specifies options for the lint tool.
abstract @NonNull LintOptions

Specifies options for the lint tool.
abstract String

The namespace of the generated R and BuildConfig classes.
abstract String

Requires the specified path to NDK be used.
abstract @NonNull String

Requires the specified NDK version to be used.
abstract @NonNull Packaging

Specifies options and rules that determine which files the Android plugin packages into your APK.
abstract @NonNull Packaging

Specifies options and rules that determine which files the Android plugin packages into your APK.
abstract @NonNull NamedDomainObjectContainer<@NonNull ProductFlavorT>

Encapsulates all product flavors configurations for this project.
abstract String

Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks.
abstract @NonNull SdkComponents
abstract @NonNull NamedDomainObjectContainer<@NonNull ApkSigningConfig>

Encapsulates signing configurations that you can apply to [ ] and [ ] configurations.
abstract @NonNull NamedDomainObjectContainer<@NonNull AndroidSourceSet>

Encapsulates source set configurations for all variants.
abstract @NonNull Splits

Specifies configurations for building multiple APKs or APK splits.
abstract @NonNull TestCoverage

Configure the gathering of code-coverage from tests.
abstract @NonNull TestOptions

Specifies options for how the Android plugin should run local and instrumented tests.
abstract @NonNull ViewBinding

Specifies options for the View Binding Library.
abstract void

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.
abstract void

This method is deprecated. Renamed to testCoverage
abstract void

Specifies options for the lint tool.
abstract void

This method is deprecated. Renamed to lint
abstract void
packaging(
    @ExtensionFunctionType @NonNull Function1<@NonNull Packaging, Unit> action
)

Specifies options and rules that determine which files the Android plugin packages into your APK.
abstract void

This method is deprecated. Renamed to packaging
abstract void

Encapsulates all product flavors configurations for this project.
abstract void
release(
    @NonNull NamedDomainObjectContainer<@NonNull BuildTypeT> receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull BuildTypeT, Unit> action
)

Shortcut extension method to allow easy access to the predefined release BuildType
abstract void
setBuildToolsVersion(@NonNull String buildToolsVersion)

Specifies the version of the SDK Build Tools to use when building your project.
abstract void
setCompileSdk(Integer compileSdk)

Specifies the API level to compile your project against.
abstract void
setCompileSdkExtension(Integer compileSdkExtension)

Specifies the SDK Extension level to compile your project against.
abstract void
setCompileSdkPreview(String compileSdkPreview)

Specify a preview API to compile your project against.
abstract void
setNamespace(String namespace)

The namespace of the generated R and BuildConfig classes.
abstract void
setNdkPath(String ndkPath)

Requires the specified path to NDK be used.
abstract void

Requires the specified NDK version to be used.
abstract void
setResourcePrefix(String resourcePrefix)

Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks.
abstract void

Encapsulates signing configurations that you can apply to BuildType and ProductFlavor configurations.
abstract void

Encapsulates source set configurations for all variants.
abstract void
splits(
    @ExtensionFunctionType @NonNull Function1<@NonNull Splits, Unit> action
)

Specifies configurations for building multiple APKs or APK splits.
abstract void

Configure the gathering of code-coverage from tests.
abstract void

Specifies options for how the Android plugin should run local and instrumented tests.
abstract void

Includes the specified library to the classpath.
abstract void
useLibrary(@NonNull String name, boolean required)

Includes the specified library to the classpath.
abstract void

Specifies options for the View Binding Library.

Public methods

aaptOptions

abstract void aaptOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull AaptOptions, Unit> action
)

Specifies options for the Android Asset Packaging Tool (AAPT).

For more information about the properties you can configure in this block, see AaptOptions.

adbOptions

abstract void adbOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull AdbOptions, Unit> action
)

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.

For more information about the properties you can configure in this block, see AdbOptions.

androidResources

abstract void androidResources(
    @ExtensionFunctionType @NonNull Function1<@NonNull AndroidResourcesT, Unit> action
)

Specifies options related to the processing of Android Resources.

For more information about the properties you can configure in this block, see AndroidResources.

buildFeatures

abstract void buildFeatures(
    @ExtensionFunctionType @NonNull Function1<@NonNull BuildFeaturesT, Unit> action
)

A list of build features that can be enabled or disabled on the Android Project.

buildToolsVersion

abstract void buildToolsVersion(@NonNull String buildToolsVersion)

buildTypes

abstract void buildTypes(
    @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull BuildTypeT>, Unit> action
)

Encapsulates all build type configurations for this project.

For more information about the properties you can configure in this block, see BuildType

compileOptions

abstract void compileOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull CompileOptions, Unit> action
)

Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.

For more information about the properties you can configure in this block, see CompileOptions.

compileSdkAddon

abstract void compileSdkAddon(@NonNull String vendor, @NonNull String name, int version)

Specify an SDK add-on to compile your project against.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdkAddon

Parameters
@NonNull String vendor

the vendor name of the add-on.
@NonNull String name

the name of the add-on
int version

the integer API level of the add-on

compileSdkVersion

abstract void compileSdkVersion(int apiLevel)

compileSdkVersion

abstract void compileSdkVersion(@NonNull String version)

composeOptions

abstract void composeOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull ComposeOptions, Unit> action
)

dataBinding

abstract void dataBinding(
    @ExtensionFunctionType @NonNull Function1<@NonNull DataBinding, Unit> action
)

Specifies options for the Data Binding Library.

For more information about the properties you can configure in this block, see DataBinding

debug

abstract void debug(
    @NonNull NamedDomainObjectContainer<@NonNull BuildTypeT> receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull BuildTypeT, Unit> action
)

Shortcut extension method to allow easy access to the predefined debug BuildType

For example:

 android {
     buildTypes {
         debug {
             // ...
         }
     }
}

defaultConfig

abstract void defaultConfig(
    @ExtensionFunctionType @NonNull Function1<@NonNull DefaultConfigT, Unit> action
)

Specifies defaults for variant properties that the Android plugin applies to all build variants.

You can override any defaultConfig property when configuring product flavors

For more information about the properties you can configure in this block, see DefaultConfig.

externalNativeBuild

abstract void externalNativeBuild(
    @ExtensionFunctionType @NonNull Function1<@NonNull ExternalNativeBuild, Unit> action
)

Specifies options for external native build using CMake or ndk-build.

When using Android Studio 2.2 or higher with Android plugin 2.2.0 or higher, you can compile C and C++ code into a native library that Gradle packages into your APK.

To learn more, read Add C and C++ Code to Your Project.

See also
ExternalNativeBuild

since 2.2.0

flavorDimensions

abstract void flavorDimensions(@NonNull String dimensions)

getAaptOptions

abstract @NonNull AaptOptions getAaptOptions()

Specifies options for the Android Asset Packaging Tool (AAPT).

For more information about the properties you can configure in this block, see AaptOptions.

getAdbOptions

abstract @NonNull AdbOptions getAdbOptions()

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.

For more information about the properties you can configure in this block, see AdbOptions.

getAndroidResources

abstract @NonNull AndroidResourcesT getAndroidResources()

Specifies options related to the processing of Android Resources.

For more information about the properties you can configure in this block, see AndroidResources.

getBuildFeatures

abstract @NonNull BuildFeaturesT getBuildFeatures()

A list of build features that can be enabled or disabled on the Android Project.

getBuildToolsVersion

abstract @NonNull String getBuildToolsVersion()

Specifies the version of the SDK Build Tools to use when building your project.

When using Android plugin 3.0.0 or later, configuring this property is optional. By default, the plugin uses the minimum version of the build tools required by the version of the plugin you're using. To specify a different version of the build tools for the plugin to use, specify the version as follows:

android {
    // Specifying this property is optional.
    buildToolsVersion "26.0.0"
}

For a list of build tools releases, read the release notes.

Note that the value assigned to this property is parsed and stored in a normalized form, so reading it back may give a slightly different result.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.buildToolsVersion

getBuildTypes

abstract @NonNull NamedDomainObjectContainer<@NonNull BuildTypeT> getBuildTypes()

Encapsulates all build type configurations for this project.

Unlike using ProductFlavor to create different versions of your project that you expect to co-exist on a single device, build types determine how Gradle builds and packages each version of your project. Developers typically use them to configure projects for various stages of a development lifecycle. For example, when creating a new project from Android Studio, the Android plugin configures a 'debug' and 'release' build type for you. By default, the 'debug' build type enables debugging options and signs your APK with a generic debug keystore. Conversely, The 'release' build type strips out debug symbols and requires you to create a release key and keystore for your app. You can then combine build types with product flavors to create build variants.

See also
BuildType

getCompileOptions

abstract @NonNull CompileOptions getCompileOptions()

Specifies Java compiler options, such as the language level of the Java source code and generated bytecode.

For more information about the properties you can configure in this block, see CompileOptions.

getCompileSdk

abstract Integer getCompileSdk()

Specifies the API level to compile your project against. The Android plugin requires you to configure this property.

This means your code can use only the Android APIs included in that API level and lower. You can configure the compile sdk version by adding the following to the android block: compileSdk = 26.

You should generally use the most up-to-date API level available. If you are planning to also support older API levels, it's good practice to use the Lint tool to check if you are using APIs that are not available in earlier API levels.

The value you assign to this property is parsed and stored in a normalized form, so reading it back may return a slightly different value.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdk

getCompileSdkExtension

abstract Integer getCompileSdkExtension()

Specifies the SDK Extension level to compile your project against. This value is optional.

When not provided the base extension for the given compileSdk API level will be selected.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdkExtension

getCompileSdkPreview

abstract String getCompileSdkPreview()

Specify a preview API to compile your project against.

For example, to try out the Android S preview, rather than compileSdk = 30 you can use compileSdkPreview = "S"

Once the preview APIs are finalized, they will be allocated a stable integer value.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdkPreview

getComposeOptions

abstract @NonNull ComposeOptions getComposeOptions()

getDataBinding

abstract @NonNull DataBinding getDataBinding()

Specifies options for the Data Binding Library.

For more information about the properties you can configure in this block, see DataBinding

getDefaultConfig

abstract @NonNull DefaultConfigT getDefaultConfig()

Specifies defaults for variant properties that the Android plugin applies to all build variants.

You can override any defaultConfig property when configuring product flavors

For more information about the properties you can configure in this block, see DefaultConfig.

getDefaultProguardFile

abstract @NonNull File getDefaultProguardFile(@NonNull String name)

getExperimentalProperties

@Incubating
abstract @NonNull Map<@NonNull String, @NonNull Object> getExperimentalProperties()

Additional per module experimental properties.

getExternalNativeBuild

abstract @NonNull ExternalNativeBuild getExternalNativeBuild()

Specifies options for external native build using CMake or ndk-build.

When using Android Studio 2.2 or higher with Android plugin 2.2.0 or higher, you can compile C and C++ code into a native library that Gradle packages into your APK.

To learn more, read Add C and C++ Code to Your Project.

See also
ExternalNativeBuild

since 2.2.0

getFlavorDimensions

abstract @NonNull List<@NonNull String> getFlavorDimensions()

Specifies the names of product flavor dimensions for this project.

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.

Flavor dimensions allow you to create groups of product flavors that you can combine with flavors from other flavor dimensions. For example, you can have one dimension that includes a 'free' and 'paid' version of your app, and another dimension for flavors that support different API levels, such as 'minApi21' and 'minApi24'. The Android plugin can then combine flavors from these dimensions—including their settings, code, and resources—to create variants such as 'debugFreeMinApi21' and 'releasePaidMinApi24', and so on. The sample below shows you how to specify flavor dimensions and add product flavors to them.

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, read Combine multiple flavors.

getInstallation

abstract @NonNull Installation getInstallation()

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.

For more information about the properties you can configure in this block, see AdbOptions.

getJacoco

@Incubating
abstract @NonNull JacocoOptions getJacoco()

Configure the gathering of code-coverage from tests.

This is replaced by testCoverage.

getLint

abstract @NonNull Lint getLint()

Specifies options for the lint tool.

For more information about the properties you can configure in this block, see Lint.

getLintOptions

@Incubating
abstract @NonNull LintOptions getLintOptions()

Specifies options for the lint tool.

For more information about the properties you can configure in this block, see LintOptions.

getNamespace

abstract String getNamespace()

The namespace of the generated R and BuildConfig classes. Also, the namespace used to resolve any relative class names that are declared in the AndroidManifest.xml.

getNdkPath

abstract String getNdkPath()

Requires the specified path to NDK be used.

Use this to specify a path to the NDK folder to be used for C and C++ builds.

android {
    // Path to custom NDK location
    ndkPath '/path/to/ndk'
}

If this field is specified, then the version it refers to need to match the one specified in ndkVersion. If ndkVersion is not specified, ndkPath need to match the default ndkVersion

For additional information about NDK installation see Install and configure the NDK.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.ndkPath

getNdkVersion

abstract @NonNull String getNdkVersion()

Requires the specified NDK version to be used.

Use this to specify a fixed NDK version. Without this, each new version of the Android Gradle Plugin will choose a specific version of NDK to use, so upgrading the plugin also means upgrading the NDK. Locking to a specific version can increase repeatability of the build.

android {
    // Use a fixed NDK version
    ndkVersion '20.1.5948944'
}

If this field is specified then android.ndkPath may not be specified. If this field is not specified, a default value will be provided depending on the AGP version

The required format of the version is major.minor.build. It's not legal to specify less precision. If ndk.dir is specified in local.properties file then the NDK that it points to must match the android.ndkVersion.

Prior to Android Gradle Plugin version 3.5, the highest installed version of NDK will be used. In Android Gradle Plugin 3.4, specifying android.ndkVersion was not an error, but the value would be ignored. Prior to Android Gradle Plugin version 3.4, it was illegal to specify android.ndkVersion.

For additional information about NDK installation see Install and configure the NDK.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.ndkVersion

getPackaging

abstract @NonNull Packaging getPackaging()

Specifies options and rules that determine which files the Android plugin packages into your APK.

For more information about the properties you can configure in this block, see Packaging.

getPackagingOptions

abstract @NonNull Packaging getPackagingOptions()

Specifies options and rules that determine which files the Android plugin packages into your APK.

For more information about the properties you can configure in this block, see Packaging.

getProductFlavors

abstract @NonNull NamedDomainObjectContainer<@NonNull ProductFlavorT> getProductFlavors()

Encapsulates all product flavors configurations 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 an 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 com.android.build.gradle.BaseExtension.html#com.android.build.gradle.BaseExtension:flavorDimensions(java.lang.String[]) value. By default, when you specify only one dimension, all flavors you configure belong to that dimension. If you specify more than one flavor dimension, you need to manually assign each flavor to a dimension. To learn more, read Use Flavor Dimensions for variant-aware dependency management.

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.

See also
ProductFlavor

getResourcePrefix

abstract String getResourcePrefix()

Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks. This property is useful only when using Android Studio.

Including unique prefixes for project resources helps avoid naming collisions with resources from other projects.

For example, when creating a library with String resources, you may want to name each resource with a unique prefix, such as "mylib_" to avoid naming collisions with similar resources that the consumer defines.

You can then specify this prefix, as shown below, so that Android Studio expects this prefix when you name project resources:

// This property is useful only when developing your project in Android Studio.
resourcePrefix 'mylib_'

getSdkComponents

abstract @NonNull SdkComponents getSdkComponents()

getSigningConfigs

abstract @NonNull NamedDomainObjectContainer<@NonNull ApkSigningConfig> getSigningConfigs()

Encapsulates signing configurations that you can apply to [ ] and [ ] configurations.

Android requires that all APKs be digitally signed with a certificate before they can be installed onto a device. When deploying a debug version of your project from Android Studio, the Android plugin automatically signs your APK with a generic debug certificate. However, to build an APK for release, you must sign the APK with a release key and keystore. You can do this by either using the Android Studio UI or manually configuring your build.gradle file.

See also
ApkSigningConfig

getSourceSets

abstract @NonNull NamedDomainObjectContainer<@NonNull AndroidSourceSet> getSourceSets()

Encapsulates source set configurations for all variants.

Note that the Android plugin uses its own implementation of source sets. For more information about the properties you can configure in this block, see AndroidSourceSet.

getSplits

abstract @NonNull Splits getSplits()

Specifies configurations for building multiple APKs or APK splits.

For more information about the properties you can configure in this block, see Splits.

getTestCoverage

abstract @NonNull TestCoverage getTestCoverage()

Configure the gathering of code-coverage from tests.

To override the JaCoCo version that is used for offline instrumentation and coverage report, add the following to build.gradle file:

android {
    testCoverage {
        jacocoVersion "<jacoco-version>"
    }
}

For more information about the properties you can configure in this block, see TestCoverage.

getTestOptions

@Incubating
abstract @NonNull TestOptions getTestOptions()

Specifies options for how the Android plugin should run local and instrumented tests.

For more information about the properties you can configure in this block, see TestOptions.

getViewBinding

abstract @NonNull ViewBinding getViewBinding()

Specifies options for the View Binding Library.

For more information about the properties you can configure in this block, see ViewBinding

installation

abstract void installation(
    @ExtensionFunctionType @NonNull Function1<@NonNull Installation, Unit> action
)

Specifies options for the Android Debug Bridge (ADB), such as APK installation options.

For more information about the properties you can configure in this block, see AdbOptions.

jacoco

@Incubating
abstract void jacoco(
    @ExtensionFunctionType @NonNull Function1<@NonNull JacocoOptions, Unit> action
)

Configure the gathering of code-coverage from tests.

This is replaced by testCoverage.

lint

abstract void lint(@ExtensionFunctionType @NonNull Function1<@NonNull Lint, Unit> action)

Specifies options for the lint tool.

For more information about the properties you can configure in this block, see Lint.

lintOptions

@Incubating
abstract void lintOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull LintOptions, Unit> action
)

Specifies options for the lint tool.

For more information about the properties you can configure in this block, see LintOptions.

packaging

abstract void packaging(
    @ExtensionFunctionType @NonNull Function1<@NonNull Packaging, Unit> action
)

Specifies options and rules that determine which files the Android plugin packages into your APK.

For more information about the properties you can configure in this block, see Packaging.

packagingOptions

abstract void packagingOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull Packaging, Unit> action
)

Specifies options and rules that determine which files the Android plugin packages into your APK.

For more information about the properties you can configure in this block, see Packaging.

productFlavors

abstract void productFlavors(
    @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull ProductFlavorT>, Unit> action
)

Encapsulates all product flavors configurations for this project.

For more information about the properties you can configure in this block, see ProductFlavor

release

abstract void release(
    @NonNull NamedDomainObjectContainer<@NonNull BuildTypeT> receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull BuildTypeT, Unit> action
)

Shortcut extension method to allow easy access to the predefined release BuildType

For example:

 android {
     buildTypes {
         release {
             // ...
         }
     }
}

setBuildToolsVersion

abstract void setBuildToolsVersion(@NonNull String buildToolsVersion)

Specifies the version of the SDK Build Tools to use when building your project.

When using Android plugin 3.0.0 or later, configuring this property is optional. By default, the plugin uses the minimum version of the build tools required by the version of the plugin you're using. To specify a different version of the build tools for the plugin to use, specify the version as follows:

android {
    // Specifying this property is optional.
    buildToolsVersion "26.0.0"
}

For a list of build tools releases, read the release notes.

Note that the value assigned to this property is parsed and stored in a normalized form, so reading it back may give a slightly different result.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.buildToolsVersion

setCompileSdk

abstract void setCompileSdk(Integer compileSdk)

Specifies the API level to compile your project against. The Android plugin requires you to configure this property.

This means your code can use only the Android APIs included in that API level and lower. You can configure the compile sdk version by adding the following to the android block: compileSdk = 26.

You should generally use the most up-to-date API level available. If you are planning to also support older API levels, it's good practice to use the Lint tool to check if you are using APIs that are not available in earlier API levels.

The value you assign to this property is parsed and stored in a normalized form, so reading it back may return a slightly different value.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdk

setCompileSdkExtension

abstract void setCompileSdkExtension(Integer compileSdkExtension)

Specifies the SDK Extension level to compile your project against. This value is optional.

When not provided the base extension for the given compileSdk API level will be selected.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdkExtension

setCompileSdkPreview

abstract void setCompileSdkPreview(String compileSdkPreview)

Specify a preview API to compile your project against.

For example, to try out the Android S preview, rather than compileSdk = 30 you can use compileSdkPreview = "S"

Once the preview APIs are finalized, they will be allocated a stable integer value.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.compileSdkPreview

setNamespace

abstract void setNamespace(String namespace)

The namespace of the generated R and BuildConfig classes. Also, the namespace used to resolve any relative class names that are declared in the AndroidManifest.xml.

setNdkPath

abstract void setNdkPath(String ndkPath)

Requires the specified path to NDK be used.

Use this to specify a path to the NDK folder to be used for C and C++ builds.

android {
    // Path to custom NDK location
    ndkPath '/path/to/ndk'
}

If this field is specified, then the version it refers to need to match the one specified in ndkVersion. If ndkVersion is not specified, ndkPath need to match the default ndkVersion

For additional information about NDK installation see Install and configure the NDK.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.ndkPath

setNdkVersion

abstract void setNdkVersion(@NonNull String ndkVersion)

Requires the specified NDK version to be used.

Use this to specify a fixed NDK version. Without this, each new version of the Android Gradle Plugin will choose a specific version of NDK to use, so upgrading the plugin also means upgrading the NDK. Locking to a specific version can increase repeatability of the build.

android {
    // Use a fixed NDK version
    ndkVersion '20.1.5948944'
}

If this field is specified then android.ndkPath may not be specified. If this field is not specified, a default value will be provided depending on the AGP version

The required format of the version is major.minor.build. It's not legal to specify less precision. If ndk.dir is specified in local.properties file then the NDK that it points to must match the android.ndkVersion.

Prior to Android Gradle Plugin version 3.5, the highest installed version of NDK will be used. In Android Gradle Plugin 3.4, specifying android.ndkVersion was not an error, but the value would be ignored. Prior to Android Gradle Plugin version 3.4, it was illegal to specify android.ndkVersion.

For additional information about NDK installation see Install and configure the NDK.

This can be set on all Gradle projects with com.android.build.api.dsl.SettingsExtension.ndkVersion

setResourcePrefix

abstract void setResourcePrefix(String resourcePrefix)

Specifies this project's resource prefix to Android Studio for editor features, such as Lint checks. This property is useful only when using Android Studio.

Including unique prefixes for project resources helps avoid naming collisions with resources from other projects.

For example, when creating a library with String resources, you may want to name each resource with a unique prefix, such as "mylib_" to avoid naming collisions with similar resources that the consumer defines.

You can then specify this prefix, as shown below, so that Android Studio expects this prefix when you name project resources:

// This property is useful only when developing your project in Android Studio.
resourcePrefix 'mylib_'

signingConfigs

abstract void signingConfigs(
    @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull ApkSigningConfig>, Unit> action
)

Encapsulates signing configurations that you can apply to BuildType and ProductFlavor configurations.

For more information about the properties you can configure in this block, see ApkSigningConfig.

sourceSets

abstract void sourceSets(
    @ExtensionFunctionType @NonNull Function1<@NonNull NamedDomainObjectContainer<@NonNull AndroidSourceSet>, Unit> action
)

Encapsulates source set configurations for all variants.

Note that the Android plugin uses its own implementation of source sets. For more information about the properties you can configure in this block, see AndroidSourceSet.

splits

abstract void splits(
    @ExtensionFunctionType @NonNull Function1<@NonNull Splits, Unit> action
)

Specifies configurations for building multiple APKs or APK splits.

For more information about the properties you can configure in this block, see Splits.

testCoverage

abstract void testCoverage(
    @ExtensionFunctionType @NonNull Function1<@NonNull TestCoverage, Unit> action
)

Configure the gathering of code-coverage from tests.

To override the JaCoCo version that is used for offline instrumentation and coverage report, add the following to build.gradle file:

android {
    testCoverage {
        jacocoVersion "<jacoco-version>"
    }
}

For more information about the properties you can configure in this block, see TestCoverage.

testOptions

@Incubating
abstract void testOptions(
    @ExtensionFunctionType @NonNull Function1<@NonNull TestOptions, Unit> action
)

Specifies options for how the Android plugin should run local and instrumented tests.

For more information about the properties you can configure in this block, see TestOptions.

useLibrary

abstract void useLibrary(@NonNull String name)

Includes the specified library to the classpath.

You typically use this property to support optional platform libraries that ship with the Android SDK. The following sample adds the Apache HTTP API library to the project classpath:

android {
    // Adds a platform library that ships with the Android SDK.
    useLibrary 'org.apache.http.legacy'
}

To include libraries that do not ship with the SDK, such as local library modules or binaries from remote repositories, add the libraries as dependencies in the dependencies block. Note that Android plugin 3.0.0 and later introduce new dependency configurations. To learn more about Gradle dependencies, read Dependency Management Basics.

Parameters
@NonNull String name

the name of the library.

useLibrary

abstract void useLibrary(@NonNull String name, boolean required)

Includes the specified library to the classpath.

You typically use this property to support optional platform libraries that ship with the Android SDK. The following sample adds the Apache HTTP API library to the project classpath:

android {
    // Adds a platform library that ships with the Android SDK.
    useLibrary 'org.apache.http.legacy'
}

To include libraries that do not ship with the SDK, such as local library modules or binaries from remote repositories, "https://developer.android.com/studio/build/dependencies.html in the dependencies block. Note that Android plugin 3.0.0 and later introduce new dependency configurations. To learn more about Gradle dependencies, read Dependency Management Basics

Parameters
@NonNull String name

the name of the library.
boolean required

if using the library requires a manifest entry, the entry will indicate that the library is not required.

viewBinding

abstract void viewBinding(
    @ExtensionFunctionType @NonNull Function1<@NonNull ViewBinding, Unit> action
)

Specifies options for the View Binding Library.

For more information about the properties you can configure in this block, see ViewBinding