package android.bundle

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AbiTargeting, MultiAbi, NativeDirectoryTargeting

• Abi.AbiAlias alias = 1

Used in: Abi

• UNSPECIFIED_CPU_ARCHITECTURE = 0

• ARMEABI = 1

• ARMEABI_V7A = 2

• ARM64_V8A = 3

• X86 = 4

• X86_64 = 5

• MIPS = 6

• MIPS64 = 7

Used in: ApkTargeting, AssetsDirectoryTargeting, VariantTargeting

• repeated Abi value = 1

• repeated Abi alternatives = 2

  Targeting of other sibling directories that were in the Bundle. For master splits this is targeting of other master splits.

Holds data specific to APEX APKs.

Used in: ApkDescription

• repeated ApexEmbeddedApkConfig apex_embedded_apk_config = 1

  Configuration for processing of APKs embedded in an APEX image.

Configuration for processing APEX bundles. https://source.android.com/devices/tech/ota/apex

Used in: BundleConfig

• repeated ApexEmbeddedApkConfig apex_embedded_apk_config = 1

  Configuration for processing of APKs embedded in an APEX image.

• repeated SupportedAbiSet supported_abi_set = 2

  Explicit list of supported ABIs. Default: See ApexBundleValidator.REQUIRED_ONE_OF_ABI_SETS

Used in: ApexApkMetadata, ApexConfig

• string package_name = 1

  Android package name of the APK.

• string path = 2

  Path to the APK within the APEX system image.

Targeting specific for image files under apex/.

Used in: TargetedApexImage

• optional MultiAbiTargeting multi_abi = 1

Describes the APEX images in the App Bundle.

• repeated TargetedApexImage image = 1

  List of all the image files under "apex/".

Used in: ApkSet, AssetSliceSet

• optional ApkTargeting targeting = 1

• string path = 2

  Path to the APK file.

• oneof apk_metadata_oneof_value

  • SplitApkMetadata split_apk_metadata = 3

    Set only for Split APKs.

  • StandaloneApkMetadata standalone_apk_metadata = 4

    Set only for standalone APKs.

  • SplitApkMetadata instant_apk_metadata = 5

    Set only for Instant split APKs.

  • SystemApkMetadata system_apk_metadata = 6

    Set only for system APKs.

  • SplitApkMetadata asset_slice_metadata = 7

    Set only for asset slices.

  • ApexApkMetadata apex_apk_metadata = 8

    Set only for APEX APKs.

  • ArchivedApkMetadata archived_apk_metadata = 9

    Set only for archived APKs.

• optional SigningDescription signing_description = 10

Represents a module. For pre-L devices multiple modules (possibly all) may be merged into one.

Used in: Variant

• optional ModuleMetadata module_metadata = 1

• repeated ApkDescription apk_description = 2

  APKs.

Targeting on the level of individual APKs.

Used in: ApkDescription

• optional AbiTargeting abi_targeting = 1

• optional LanguageTargeting language_targeting = 3

• optional ScreenDensityTargeting screen_density_targeting = 4

• optional SdkVersionTargeting sdk_version_targeting = 5

• optional TextureCompressionFormatTargeting texture_compression_format_targeting = 6

• optional MultiAbiTargeting multi_abi_targeting = 7

• optional SanitizerTargeting sanitizer_targeting = 8

• optional DeviceTierTargeting device_tier_targeting = 9

• optional CountrySetTargeting country_set_targeting = 10

Lists the dependencies of an application.

• repeated Library library = 1

  List of all the dependencies, direct and indirect.

• repeated LibraryDependencies library_dependencies = 2

  Dependencies of the libraries from the list above.

• repeated ModuleDependencies module_dependencies = 3

  List of direct dependencies per bundle module.

• repeated Repository repositories = 4

  List of repositories where dependencies were found.

Specifies integrity protection options that should be applied to an app bundle. Next tag: 8.

• bool enabled = 1

• optional LicenseCheck license_check = 2

• optional InstallerCheck installer_check = 3

• optional DebuggerCheck debugger_check_deprecated = 4

• optional EmulatorCheck emulator_check = 5

• optional DexProtectionConfig dex_protection_config = 6

  Optional. If present, java/kotlin code will be obfuscated according to the config.

• string version_label = 7

Holds data specific to Archived APKs.

Used in: ApkDescription

(message has no fields)

Used in: AssetSliceSet

• string name = 1

  Module name.

• DeliveryType delivery_type = 4

  Indicates the delivery type for persistent install.

• optional InstantMetadata instant_metadata = 3

  Metadata for instant installs.

• bool on_demand_deprecated = 2

  Deprecated. Use delivery_type.

Used in: BundleConfig

• repeated int64 app_version = 1

  App versionCodes that will be updated with these asset modules. Only relevant for asset-only bundles.

• string asset_version_tag = 2

  Version tag for the asset upload. Only relevant for asset-only bundles.

Holds metadata for asset only bundles.

Used in: BuildApksResult

• repeated int64 app_version = 1

  App versionCodes that will be updated with these asset modules. Only relevant for asset-only bundles.

• string asset_version_tag = 2

  Version tag for the asset upload. Only relevant for asset-only bundles.

Set of asset slices belonging to a single asset module.

Used in: BuildApksResult

• optional AssetModuleMetadata asset_module_metadata = 1

  Module level metadata.

• repeated ApkDescription apk_description = 2

  Asset slices.

Describes the assets in the App Bundle.

• repeated TargetedAssetsDirectory directory = 1

  List of all the directories (and subdirectories recursively) under "assets/" that contain at least one file. They may be explicitly targeted or not.

Targeting specific for directories under assets/.

Used in: TargetedAssetsDirectory

• optional AbiTargeting abi = 1

• optional TextureCompressionFormatTargeting texture_compression_format = 3

• optional LanguageTargeting language = 4

• optional DeviceTierTargeting device_tier = 5

• optional CountrySetTargeting country_set = 6

Breakdown of APK, or an aggregate.

• optional Sizes total = 1

  Total size of entries and ZIP format overheads.

• optional Sizes dex = 2

  Only dex code.

• optional Sizes resources = 3

  Resources, resource table and Android Manifest.

• optional Sizes assets = 4

  Only assets.

• optional Sizes native_libs = 5

  Only native libraries.

• optional Sizes other = 6

  Other entries e.g. META-INF/ and ZIP format overheads.

Describes the output of the "build-apks" command.

• string package_name = 4

  The package name of this app.

• repeated Variant variant = 1

  List of the created variants.

• optional Bundletool bundletool = 2

  Metadata about BundleTool used to build the APKs.

• repeated AssetSliceSet asset_slice_set = 3

  List of the created asset slices.

• optional LocalTestingInfo local_testing_info = 5

  Information about local testing mode.

• optional AssetModulesInfo asset_modules_info = 6

  Asset modules metadata for asset only bundles.

• repeated DefaultTargetingValue default_targeting_value = 7

  Default values for targeting dimensions, as specified in the BundleConfig. Only set for dimensions that have a default suffix specified.

• repeated PermanentlyFusedModule permanently_fused_modules = 8

  Information about permanently fused install-time modules, which were presented in original bundle but fused into base in all variants.

• string package_name = 1

  The package name of the SDK. For instance, for SDK “com.foo.bar” with major version “15”, the package name stored here is simply “com.foo.bar”. This is different from the package name that is installed in Android PackageManager on sandbox-enabled devices (which is “com.foo.bar_15”).

• repeated Variant variant = 2

  Variants generated for the SDK. At the moment, there is always a single variant.

• optional Bundletool bundletool = 3

• optional SdkVersionInformation version = 4

A build stamp. Next tag: 8.

Used in: BuildStampFile

• string source_revision = 1

  Source revision for the build, e.g. HEAD commit hash.

• string job_id = 2

  ID of the build job which created this bundle.

• string job_url = 3

  URL to the build job which created this bundle. Does not need to be public, and probably will not be.

• string build_id = 4

  ID for the specific build, e.g. a UUID.

• string label = 5

  Build label: an arbitrary string set by the build system. May be used to embed a release label.

• optional google.protobuf.Timestamp build_start_timestamp = 6

  Time at which the build was started.

• BuildStamp.WorktreeStatus worktree_status = 7

  Status of the working tree this bundle was built from.

Status of the working tree this bundle was built from.

Used in: BuildStamp

• WORKTREE_STATUS_UNSPECIFIED = 0

• WORKTREE_STATUS_CLEAN = 1

  Clean. No uncommitted modifications or files.

• WORKTREE_STATUS_DIRTY = 2

  Dirty. One or more uncommitted modifications or files.

Build stamp metadata.

• optional BuildStamp build_stamp = 1

  The build stamp for this bundle.

• optional Bundletool bundletool = 1

• optional Optimizations optimizations = 2

• optional Compression compression = 3

• optional MasterResources master_resources = 4

  Resources to be always kept in the master split.

• optional ApexConfig apex_config = 5

• repeated UnsignedEmbeddedApkConfig unsigned_embedded_apk_config = 6

  APKs to be signed with the same key as generated APKs.

• optional AssetModulesConfig asset_modules_config = 7

• BundleConfig.BundleType type = 8

• optional Locales locales = 9

  Configuration for locales.

Used in: BundleConfig

• REGULAR = 0

• APEX = 1

• ASSET_ONLY = 2

Next ID: 30

• string exception_message = 1

  The exception message that the bundle tool outputs. NOTE: this may not be safe to show to users since it might include server paths and configuration.

• string user_message = 28

  The exception message that can be exposed to third party developers.

• BundleToolError.ErrorType error_type = 29

  Type of error.

Used in: BundleToolError

• UNDEFINED = 0

• INVALID_BUNDLE_ERROR = 1

  Indicates invalid bundle.

• INVALID_VERSION_CODE_ERROR = 2

  Indicates bundle with invalid version code in AndroidManifest.xml.

• INCOMPATIBLE_DEVICE_ERROR = 3

  Indicates that command is incompatible with requested device.

• INVALID_DEVICE_SPEC_ERROR = 4

  Indicates invalid device spec provided to command.

• INVALID_COMMAND_ERROR = 5

  Indicates that command is invalid, like options mismatch.

• COMMAND_EXECUTION_ERROR = 6

  Indicates that something happened during command execution.

• INVALID_SIGNING_CONFIGURATION_ERROR = 7

  Indicates invalid signing configuration.

Used in: BuildApksResult, BuildSdkApksResult, BundleConfig, SdkModulesConfig

• string version = 2

  Version of BundleTool used to build the Bundle.

Contains information on certificate digest overrides for a specific SDK.

Used in: CertificateOverrides

• string sdk_package_name = 1

  Package name of the SDK that we want to override the certificate digest for.

• string certificate_digest = 2

  Certificate digest that we should override to.

Contains information on certificate digests that should be overridden in runtime-enabled SDK dependency config for local deployment.

Used in: LocalDeploymentRuntimeEnabledSdkConfig

• repeated CertificateOverride per_sdk_certificate_override = 1

  Certificate digest override for specific SDKs.

• optional string default_certificate_override = 2

  Default certificate override. If set, certificate digests of SDKs that are not present in per_sdk_certificate_override field will be overriden to this value.

Used in: CodeTransparency

• oneof source

  Code related file may come from either Android App Bundle (AAB) or bundletool repo. Bundletool repo is used as a source for a DEX file for an archived APK which is not the part AAB and is injected when APKs are generated from the AAB. Required.

  • string path = 1

    Path to file in the bundle.

  • string bundletool_repo_path = 5

    Path to a file that will be injected at build time. Contained in the bundletool source code.

• CodeRelatedFile.Type type = 2

  Type of code-related file. Required.

• string apk_path = 3

  Path to file in the APK. Only set for NATIVE_LIBRARY types.

• string sha256 = 4

  SHA256 digest of the code-related file.

Used in: CodeRelatedFile

• TYPE_UNSPECIFIED = 0

• NATIVE_LIBRARY = 1

• DEX = 2

Code transparency related metadata.

• repeated CodeRelatedFile code_related_file = 1

  List of code-related files in the bundle.

• int32 version = 2

  Version of code transparency file format. Required.

Used in: BundleConfig

• repeated string uncompressed_glob = 1

  Glob matching the list of files to leave uncompressed in the APKs. The matching is done against the path of files in the APK, thus excluding the name of the modules, and using forward slash ("/") as a name separator. Examples: "res/raw/**", "assets/**/*.uncompressed", etc.

• Compression.AssetModuleCompression install_time_asset_module_default_compression = 2

  Default compression strategy for install-time asset modules. If the compression strategy indicates to compress a file and the same file matches one of the `uncompressed_glob` values, the `uncompressed_glob` takes precedence (the file is left uncompressed in the generated APK). If unspecified, asset module content is left uncompressed in the generated asset modules. Note: this flag only configures the compression strategy for install-time asset modules; the content of on-demand and fast-follow asset modules is always kept uncompressed.

• Compression.ApkCompressionAlgorithm apk_compression_algorithm = 3

  Compression algorithm which is used to compress entries in final APKs.

Used in: Compression

• DEFAULT_APK_COMPRESSION_ALGORITHM = 0

  Default in the current version of bundletool is zlib deflate algorithm with compression level 9 for the application's resources and compression level 6 for other entries. This is a good trade-off between size of final APK and size of patches which are used to update the application from previous to next version.

• P7ZIP = 1

  7zip implementation of deflate algorithm which gives smaller APK size but size of patches required to update the application are larger.

Used in: Compression

• UNSPECIFIED = 0

• UNCOMPRESSED = 1

  Assets are left uncompressed in the generated asset module.

• COMPRESSED = 2

  Assets are compressed in the generated asset module. This option can be overridden at a finer granularity by specifying files or folders to keep uncompressed in `uncompressed_glob`. This option should only be used if the app is able to handle compressed asset module content at runtime (some runtime APIs may misbehave).

Targets assets and APKs to a specific country set. For Example:- The values and alternatives for the following files in assets directory targeting would be as follows: assetpack1/assets/foo#countries_latam/bar.txt -> { value: [latam], alternatives: [sea] } assetpack1/assets/foo#countries_sea/bar.txt -> { value: [sea], alternatives: [latam] } assetpack1/assets/foo/bar.txt -> { value: [], alternatives: [sea, latam] } The values and alternatives for the following targeted split apks would be as follows: splits/base-countries_latam.apk -> { value: [latam], alternatives: [sea] } splits/base-countries_sea.apk -> { value: [sea], alternatives: [latam] } splits/base-other_countries.apk -> { value: [], alternatives: [sea, latam] }

Used in: ApkTargeting, AssetsDirectoryTargeting

• repeated string value = 1

  Country set name defined in device tier config.

• repeated string alternatives = 2

  Targeting of other sibling directories that were in the Bundle.

Next tag: 2

Used in: AppIntegrityConfig

• bool enabled = 1

Default value targeted by a particular dimension.

Used in: BuildApksResult

• SplitDimension.Value dimension = 1

  The dimension being targeted.

• string default_value = 2

  The default value being targeted.

Used in: AssetModuleMetadata, ExtractedApk, InstantMetadata, ModuleMetadata

• UNKNOWN_DELIVERY_TYPE = 0

• INSTALL_TIME = 1

• ON_DEMAND = 2

• FAST_FOLLOW = 3

Used in: DeviceFeatureTargeting

• string feature_name = 1

• int32 feature_version = 2

  Equivalent of android:glEsVersion or android:version in <uses-feature>.

Since other atom targeting messages have the "OR" semantic on values the DeviceFeatureTargeting represents only one device feature to retain that convention.

Used in: ModuleTargeting

• optional DeviceFeature required_feature = 1

A group of devices. A group is defined by a set of device selectors. A device belongs to the group if it matches any selector (logical OR).

Used in: DeviceTierConfig

• string name = 1

  The name of the group.

• repeated DeviceSelector device_selectors = 2

  Device selectors for this group. A device matching any of the selectors is included in this group.

Targets conditional modules to a set of device groups.

Used in: ModuleTargeting

• repeated string value = 1

Identifier of a device.

Used in: DeviceProperties, DeviceSelector

• string build_brand = 1

  Value of Build.BRAND.

• string build_device = 2

  Value of Build.DEVICE.

Properties of a particular device.

• int64 ram = 1

  Device RAM in bytes.

• optional DeviceId device_id = 2

  Device ID of device.

• repeated SystemFeature system_features = 3

  System features in device.

Conditions about a device's RAM capabilities.

Used in: DeviceSelector

• int64 min_bytes = 1

  Minimum RAM in bytes (bound included).

• int64 max_bytes = 2

  Maximum RAM in bytes (bound excluded).

Selector for a device group. A selector consists of a set of conditions on the device that should all match (logical AND) to determine a device group eligibility. For instance, if a selector specifies RAM conditions, device model inclusion and device model exclusion, a device is considered to match if: device matches RAM conditions AND device matches one of the included device models AND device doesn't match excluded device models

Used in: DeviceGroup

• optional DeviceRam device_ram = 1

  Conditions on the device's RAM.

• repeated DeviceId included_device_ids = 2

  Device models included by this selector.

• repeated DeviceId excluded_device_ids = 3

  Device models excluded by this selector, even if they match all other conditions.

• repeated SystemFeature required_system_features = 4

  A device needs to have all these system features to be included by the selector.

• repeated SystemFeature forbidden_system_features = 5

  A device that has any of these system features is excluded by this selector, even if it matches all other conditions.

• repeated string supported_abis = 1

  Supported ABI architectures in the order of preference. The values should be the string as reported by the platform, e.g. "armeabi-v7a" or "x86_64".

• repeated string supported_locales = 2

  All installed locales represented as BCP-47 strings.

• repeated string device_features = 3

  List of device features returned by the package manager utility.

• repeated string gl_extensions = 4

  List of OpenGL extension strings supported by the device.

• uint32 screen_density = 5

  Screen dpi.

• uint32 sdk_version = 6

  getprop ro.build.version.sdk

• string codename = 7

  getprop ro.build.version.codename

• optional google.protobuf.Int32Value device_tier = 8

  Device tier.

• repeated string device_groups = 9

  Device groups the device belongs to.

• optional SdkRuntime sdk_runtime = 10

  Information about the runtime-enabled SDK capabilities of the device.

• optional google.protobuf.StringValue country_set = 11

  Country set.

A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.

Used in: DeviceTierSet

• repeated string device_group_names = 1

  Groups of devices included in this tier. These groups must be defined explicitly under device_groups in this configuration.

• int32 level = 2

  The priority level of the tier. Tiers are evaluated in descending order of level: the highest level tier has the highest priority. The highest tier matching a given device is selected for that device. You should use a contiguous range of levels for your tiers in a tier set; tier levels in a tier set must be unique. For instance, if your tier set has 4 tiers (including the global fallback), you should define tiers 1, 2 and 3 in this configuration. Note: tier 0 is implicitly defined as a global fallback and selected for devices that don't match any of the tiers explicitly defined here. You mustn't define level 0 explicitly in this configuration.

Configuration describing device targeting criteria for the content of an app.

• repeated DeviceGroup device_groups = 1

  Definition of device groups for the app.

• optional DeviceTierSet device_tier_set = 2

  Definition of the set of device tiers for the app.

• repeated UserCountrySet user_country_sets = 5

  Definition of user country sets for the app.

A set of device tiers. A tier set determines what variation of app content gets served to a specific device, for device-targeted content. You should assign a priority level to each tier, which determines the ordering by which they are evaluated by Play. See the documentation of DeviceTier.level for more details.

Used in: DeviceTierConfig

• repeated DeviceTier device_tiers = 1

  Device tiers belonging to the set.

Targets assets and APKs to a concrete device tier.

Used in: ApkTargeting, AssetsDirectoryTargeting

• repeated google.protobuf.Int32Value value = 3

• repeated google.protobuf.Int32Value alternatives = 4

Configuration of java-related obfuscation.

Used in: AppIntegrityConfig

• bool enabled = 1

• repeated string method_to_obfuscate = 2

  Either fully qualified method reference e.g. `java.lang.MyClass#myMethod(int,float,java.lang.String)`, or a partially qualified reference e.g. `java.lang.MyClass#myMethod`.

• DexProtectionConfig.TargetingMode targeting_mode = 3

Describes how to look for methods to obfuscate.

Used in: DexProtectionConfig

• TARGETING_MODE_UNSPECIFIED = 0

• TARGETING_MODE_AUTOMATIC = 1

  We'll try to automatically find methods for obfuscation, in addition to the methods specified in this config.

• TARGETING_MODE_PROPOSED_ONLY = 2

  Only methods spefied in this config will be considered for obfuscation.

Next tag: 2

Used in: AppIntegrityConfig

• bool enabled = 1

Describes the output of the "extract-apks" command.

• repeated ExtractedApk apks = 1

  Set of extracted APKs.

• optional LocalTestingInfoForMetadata local_testing_info = 2

  Information about the APKs if built with local testing enabled.

Describes extracted APK.

Used in: ExtractApksResult

• string module_name = 1

  Module name.

• string path = 2

  Path

• DeliveryType delivery_type = 3

  Indicates the delivery type (e.g. on-demand) of the APK.

Used in: ModuleMetadata

• UNKNOWN_MODULE_TYPE = 0

• FEATURE_MODULE = 1

• ML_MODULE = 2

• SDK_MODULE = 3

• string invalid_directory = 1

• string invalid_file = 1

• string resource_directory = 1

• string invalid_file = 2

• string bundle_directory = 1

• string invalid_file = 2

• string bundle_directory = 1

• string required_extension = 2

• string invalid_file = 3

• string bundle_directory = 1

• repeated string allowed_file_name = 2

• string invalid_file = 3

• string invalid_architecture_directory = 1

• string bundle_directory = 1

• string invalid_file = 2

• string invalid_file = 1

Next tag: 4.

Used in: AppIntegrityConfig

• bool enabled = 1

• optional Policy policy = 2

• repeated string additional_install_source = 3

Used in: AssetModuleMetadata

• bool is_instant = 1

  Indicates whether this module is marked "instant".

• DeliveryType delivery_type = 3

  Indicates the delivery type for instant install.

• bool on_demand_deprecated = 2

  Deprecated. Use delivery_type.

Used in: Repository

• optional string url = 1

  The root url for the repository.

Used in: ApkTargeting, AssetsDirectoryTargeting

• repeated string value = 1

  ISO-639: 2 or 3 letter language code.

• repeated string alternatives = 2

  Targeting of other sibling directories that were in the Bundle. For master splits this is targeting of other master splits.

Next ID: 5

Used in: AppDependencies

• oneof library_oneof

  Type of library dependency.

  • MavenLibrary maven_library = 1

    A library downloaded from a Maven repository.

  • UnityLibrary unity_library = 4

    A library downloaded from a Unity repository.

• optional Library.Digests digests = 2

• optional google.protobuf.Int32Value repo_index = 3

  Repository from which the artifact was retrieved (if known). Index is from pool of repositories defined in AppDependencies.

This message contains various digests of the library contents.

Used in: Library

• optional bytes sha256 = 1

  SHA256 hash value of the file contents.

List of dependencies of a given library.

Used in: AppDependencies

• optional int32 library_index = 1

  Indices correspond to the pool of libraries defined in AppDependencies.

• repeated int32 library_dep_index = 2

Next tag: 4.

Used in: AppIntegrityConfig

• bool enabled = 1

• bool online_only = 2

• optional Policy policy = 3

Options for overriding parts of runtime-enabled SDK dependency configuration for local deployment and testing.

• optional CertificateOverrides certificate_overrides = 1

  Options for overriding SDK certificate digests in RuntimeEnabledSdkConfig of the app bundle.

Used in: BuildApksResult

• bool enabled = 1

  Indicates if the bundle is built in local testing mode.

• string local_testing_path = 2

  The local testing path, as specified in the base manifest. This refers to the relative path on the external directory of the app where APKs will be pushed for local testing. Set only if local testing is enabled.

Used in: ExtractApksResult

• string local_testing_dir = 1

  The absolute path on the device that files targeted by local testing mode will be pushed to.

Used in: BundleConfig

• bool inject_locale_config = 1

  Instructs bundletool to generate locale config and inject it into AndroidManifest.xml. A locale is marked as supported by the application if there is at least one resource value in this locale. Be very careful with this setting because if some of your libraries expose resources in some locales which are not actually supported by your application it will mark this locale as supported. Disabled by default.

• string missing_file = 1

• string module_name = 1

• string missing_file = 2

(message has no fields)

• string attribute_name = 1

• string module_name = 2

• string module_name = 1

(message has no fields)

• string max_sdk = 1

• int32 max_sdk = 1

• int32 min_sdk = 1

• int32 max_sdk = 2

• string min_sdk = 1

(message has no fields)

• string module_name = 1

• repeated int32 version_codes = 1

Resources to keep in the master split.

Used in: BundleConfig

• repeated int32 resource_ids = 1

  Resource IDs to be kept in master split.

• repeated string resource_names = 2

  Resource names to be kept in master split.

Used in: Library

• optional string group_id = 1

• optional string artifact_id = 2

• optional string packaging = 3

• optional string classifier = 4

• optional string version = 5

Used in: Repository

• optional string url = 1

  The root url for the repository.

Lists the dependencies of a given module.

Used in: AppDependencies

• optional string module_name = 1

• repeated int32 dependency_index = 2

  Direct module dependencies. Index is from the pool of libraries defined in AppDependencies.

Used in: ApkSet

• string name = 1

  Module name.

• FeatureModuleType module_type = 7

  Indicates the type of this feature module.

• DeliveryType delivery_type = 6

  Indicates the delivery type (e.g. on-demand) of the module.

• bool is_instant = 3

  Indicates whether this module is marked "instant".

• repeated string dependencies = 4

  Names of the modules that this module directly depends on. Each module implicitly depends on the base module.

• optional ModuleTargeting targeting = 5

  The targeting that makes a conditional module installed. Relevant only for Split APKs.

• bool on_demand_deprecated = 2

  Deprecated. Please use delivery_type.

• repeated RuntimeEnabledSdkDependency runtime_enabled_sdk_dependencies = 8

  Runtime-enabled SDK dependencies of this module.

• optional SdkModuleMetadata sdk_module_metadata = 9

  Information about the SDK that this module was generated from. Only set for modules with module_type FeatureModuleType.SDK_MODULE.

Targeting on the module level. The semantic of the targeting is the "AND" rule on all immediate values.

Used in: ModuleMetadata

• optional SdkVersionTargeting sdk_version_targeting = 1

• repeated DeviceFeatureTargeting device_feature_targeting = 2

• optional UserCountriesTargeting user_countries_targeting = 3

• optional DeviceGroupModuleTargeting device_group_targeting = 5

Used in: MultiAbiTargeting

• repeated Abi abi = 1

Used in: ApexImageTargeting, ApkTargeting, VariantTargeting

• repeated MultiAbi value = 1

• repeated MultiAbi alternatives = 2

  Targeting of other sibling directories that were in the Bundle. For master splits this is targeting of other master splits.

Targeting specific for directories under lib/.

Used in: TargetedNativeDirectory

• optional Abi abi = 1

• optional TextureCompressionFormat texture_compression_format = 3

• optional Sanitizer sanitizer = 4

Describes the native libraries in the App Bundle.

• repeated TargetedNativeDirectory directory = 1

  List of all the directories in under "lib/" that contain at least one file.

Used in: BundleConfig

• optional SplitsConfig splits_config = 1

• optional UncompressNativeLibraries uncompress_native_libraries = 2

  This is for uncompressing native libraries on M+ devices (L+ devices on instant apps).

• optional UncompressDexFiles uncompress_dex_files = 3

  This is for uncompressing dex files.

• optional StandaloneConfig standalone_config = 4

  Configuration for the generation of standalone APKs. If no StandaloneConfig is set, the configuration is inherited from splits_config.

• optional ResourceOptimizations resource_optimizations = 5

  Optimizations that are applied to resources.

• optional StoreArchive store_archive = 6

  Configuration for archiving the app.

Used in: BuildApksResult

• string name = 1

  Module name.

Next tag: 2

Used in: InstallerCheck, LicenseCheck

• Policy.Action action = 1

Used in: Policy

• UNSPECIFIED = 0

• WARN = 1

• DISABLE = 2

• WARN_THEN_DISABLE = 3

A repository for resolving artifacts and metadata.

Used in: AppDependencies

• oneof repo_oneof

  The type of the repository, and any type-specific configuration info.

  • MavenRepo maven_repo = 1

  • IvyRepo ivy_repo = 2

  • UnityRepo unity_repo = 3

Used in: Optimizations

• ResourceOptimizations.SparseEncoding sparse_encoding = 1

  Whether to use sparse encoding for resource tables. Resources in sparse resource table are accessed using a binary search tree. This decreases APK size at the cost of resource retrieval performance.

• optional ResourceOptimizations.CollapsedResourceNames collapsed_resource_names = 2

  Optimizations related to collapsed resource names.

Optimizations related to collapsed resource names.

Used in: ResourceOptimizations

• bool collapse_resource_names = 1

  Whether to collapse resource names. Resources with collapsed resource names are only accessible by their ids. These names are not stored inside 'resources.arsc'.

• repeated ResourceTypeAndName no_collapse_resources = 2

  Instructs to not collapse resource names for specific resources which makes certain resources to be accessible by their names. Applicable only if 'collapse_resource_names' is 'true'.

• repeated string no_collapse_resource_types = 4

  Instructs to not collapse all resources of certain types. Applicable only if 'collapse_resource_names' is 'true'.

• bool deduplicate_resource_entries = 3

  Whether to store only unique resource entries in 'resources.arsc'. For example if there are 3 'bool' resources defined with 'true' value with this flag only one 'true' entry is stored and all 3 resources are referencing this entry. By default all 3 entries are stored. This only works with resources where names are collapsed (either using 'collapse_resource_names' flag or manually) because resource name is a part of resource entry and if names are preserved - all entries are unique.

Pair of resource type and name, like 'layout/foo', 'string/bar'.

Used in: CollapsedResourceNames

• string type = 1

• string name = 2

Used in: ResourceOptimizations

• UNSPECIFIED = 0

  Disables sparse encoding.

• VARIANT_FOR_SDK_32 = 2

  Generates special APKs for Android SDK +32 with sparse resource tables. Devices with Android SDK below 32 will still receive APKs with regular resource tables.

• string module_name = 1

• string module_name = 1

• string file_path = 2

• string module_name = 1

• repeated string file_path = 2

• string module_name = 1

• repeated string file_path = 2

Specifies the config that gets applied to the rotation aspect of the signing process of the App Bundle. Next tag: 3

• string signing_certificate_sha256_fingerprint = 1

  The SHA256 fingerprint of the expected certificate to sign the APKs generated from the Bundle. Example: FE:C0:E6:5B:F3:76:5D:A1:C2:56:13:C7:A3:60:35:A9:26:BC:3B:3A:39:9B:C8:55:40:F1:6D:55:17:3F:F5:9B

• int32 rotation_min_sdk_version = 2

  The minimum API level for which an APK's rotated signing key should be used to produce the APK's signature. The original signing key for the APK will be used for all previous platform versions.

Used in: RuntimeEnabledSdkConfig

• string package_name = 1

  Package name of the runtime-enabled SDK.

• int32 version_major = 2

  Major version of the runtime-enabled SDK.

• int32 version_minor = 3

  Minor version of the runtime-enabled SDK.

• int32 build_time_version_patch = 6

  Patch version of the runtime-enabled SDK. The dependency on a specific patch version is a build-time soft dependency, that ensures reproducibility of local builds; it does not imply that all app stores will honour it when delivering apps to end-users. For instance, some stores may just honour the dependency on a specific major and minor, while serve the latest available patch for the given major.minor version of the SDK.

• string certificate_digest = 4

  SHA-256 hash of the runtime-enabled SDK's signing certificate, represented as a string of bytes in hexadecimal form, with ':' separating the bytes.

• int32 resources_package_id = 5

  Package ID that the resource IDs of this runtime-enabled SDK must be remapped to.

Information about runtime-enabled SDK dependencies of a specific module inside the App Bundle.

• repeated RuntimeEnabledSdk runtime_enabled_sdk = 1

  Runtime-enabled SDKs in this config.

Describes a runtime-enabled SDK that the app depends on.

Used in: ModuleMetadata

• string package_name = 1

  Package name of the runtime-enabled SDK. Required.

• int32 major_version = 2

  Major version of the runtime-enabled SDK. Required.

• int32 minor_version = 3

  Minor version of the runtime-enabled SDK. Required.

Used in: SdkMetadata, SdkModulesConfig

• int32 major = 1

  The major version of the RE SDK.

• int32 minor = 2

  The minor version of the RE SDK.

• int32 patch = 3

  The patch version of the RE SDK.

Used in: NativeDirectoryTargeting, SanitizerTargeting

• Sanitizer.SanitizerAlias alias = 1

Used in: Sanitizer

• NONE = 0

• HWADDRESS = 1

Used in: ApkTargeting

• repeated Sanitizer value = 1

Used in: ScreenDensityTargeting

• oneof density_oneof

  • ScreenDensity.DensityAlias density_alias = 1

  • int32 density_dpi = 2

Used in: ScreenDensity

• DENSITY_UNSPECIFIED = 0

• NODPI = 1

• LDPI = 2

• MDPI = 3

• TVDPI = 4

• HDPI = 5

• XHDPI = 6

• XXHDPI = 7

• XXXHDPI = 8

Used in: ApkTargeting, VariantTargeting

• repeated ScreenDensity value = 1

• repeated ScreenDensity alternatives = 2

  Targeting of other sibling directories that were in the Bundle. For master splits this is targeting of other master splits.

Used in: SdkBundleConfig

• string package_name = 1

  Package name of the SDK bundle.

• int32 version_major = 2

  Major version of the SDK bundle.

• int32 version_minor = 3

  Minor version of the SDK bundle.

• int32 build_time_version_patch = 4

  Patch version of the SDK bundle. The dependency on a specific patch version is a build-time soft dependency, that ensures reproducibility of local builds; it does not imply that all app stores will honour it when delivering apps to end-users. For instance, some stores may just honour the dependency on a specific major and minor, while serve the latest available patch for the given major.minor version of the SDK.

• string certificate_digest = 5

  SHA-256 hash of the SDK's signing certificate, represented as a string of bytes in hexadecimal form, with ':' separating the bytes.

• SdkDependencyType dependency_type = 6

  Whether the dependency is optional or required. Only required dependencies will be included in the final POM file. Unspecified dependency types will be treated as required.

• repeated SdkBundle sdk_dependencies = 1

  Runtime-enabled SDKs this SDK depends on.

Used in: SdkBundle

• SDK_DEPENDENCY_TYPE_UNSPECIFIED = 0

• SDK_DEPENDENCY_TYPE_REQUIRED = 1

  The dependency should be installed automatically.

• SDK_DEPENDENCY_TYPE_OPTIONAL = 2

  The dependency is only needed at compile time.

Information that uniquely identifies this runtime-enabled SDK version. This will be stored inside the ASAR for an SDK.

• string package_name = 1

  Package name of the runtime-enabled SDK.

• optional RuntimeEnabledSdkVersion sdk_version = 2

  Version information for the runtime-enabled SDK.

• string certificate_digest = 3

  SHA-256 hash of the runtime-enabled SDK's signing certificate, represented as a string of bytes in hexadecimal form, with ':' separating the bytes.

Metadata of the app module generated from a runtime-enabled SDK that the app depends on.

Used in: ModuleMetadata

• optional SdkModuleVersion sdk_module_version = 1

  Version of the Runtime-enabled SDK that this module was generated from.

• optional string sdk_package_name = 2

  Package name of the runtime-enabled SDK that this module was generated from.

Versioning information about the SDK that the app module was generated from.

Used in: SdkModuleMetadata

• optional int32 major = 1

  Major version of the SDK. Required.

• optional int32 minor = 2

  Minor version of the SDK. Required.

• optional int32 patch = 3

  Patch version of the SDK. Required.

Contains the package name and versioning information of the Android SDK Bundle. These are required to generate the installable APKs.

• optional Bundletool bundletool = 1

  Version of BundleTool used to generate the Android SDK Bundle.

• string sdk_package_name = 2

  Package name of the runtime-enabled SDK.

• optional RuntimeEnabledSdkVersion sdk_version = 3

  Version of the runtime-enabled SDK.

• string sdk_provider_class_name = 4

  The fully qualified name for the platform SDK provider entrypoint class.

• string compat_sdk_provider_class_name = 5

  The fully qualified name for the compatibility SDK provider entrypoint class. Expected to be set for SDKs that support devices without the privacy sandbox.

Used in: DeviceSpec

• bool supported = 1

  Whether runtime-enabled SDKs can run on the device

Variant targeting based on SDK Runtime availability on device.

Used in: VariantTargeting

• bool requires_sdk_runtime = 1

  Whether the variant requires SDK Runtime to be available on the device.

Properties that backwards-compatible SDK split inherits from the app.

• string package_name = 1

  Package name of the app.

• int32 version_code = 2

  Version code of the app.

• int32 min_sdk_version = 3

  minSdkVersion of the app.

• int32 resources_package_id = 4

  Package ID that the SDK resources should be remapped to so that they do not conflict with the app's resources.

Used in: SdkVersionTargeting

• optional google.protobuf.Int32Value min = 1

  Inclusive.

Used in: BuildSdkApksResult

• int32 major = 1

  Major version of the SDK.

• int32 minor = 2

  Minor version of the SDK.

• int32 patch = 3

  Patch version of the SDK.

• int32 version_code = 4

  A unique version code assigned to the SDK by the caller of build-sdk-apks.

Used in: ApkTargeting, ModuleTargeting, VariantTargeting

• repeated SdkVersion value = 1

• repeated SdkVersion alternatives = 2

  Targeting of other sibling directories that were in the Bundle. For master splits this is targeting of other master splits.

Holds data specific to signing configuration applied on the APKs.

Used in: ApkDescription

• bool signed_with_rotated_key = 1

  Denotes if the generated APK to be signed with the rotated key.

Sizes of the breakdown item: bytes in the APK, and bytes over the wire.

Used in: Breakdown

• int64 disk_size = 1

• int64 download_size = 2

Holds data specific to Split APKs.

Used in: ApkDescription

• string split_id = 1

• bool is_master_split = 2

  Indicates whether this APK is the master split of the module.

Used in: SplitsConfig, StandaloneConfig

• SplitDimension.Value value = 1

• bool negate = 2

  If set to 'true', indicates that APKs should *not* be split by this dimension.

• optional SuffixStripping suffix_stripping = 3

  Optional transformation to be applied to asset directories where the targeting is encoded in the directory name (e.g: assets/foo#tcf_etc1)

Used in: DefaultTargetingValue, SplitDimension

• UNSPECIFIED_VALUE = 0

• ABI = 1

• SCREEN_DENSITY = 2

• LANGUAGE = 3

• TEXTURE_COMPRESSION_FORMAT = 4

• DEVICE_TIER = 6

• COUNTRY_SET = 7

Optimization configuration used to generate Split APKs.

Used in: Optimizations

• repeated SplitDimension split_dimension = 1

Holds data specific to Standalone APKs.

Used in: ApkDescription

• repeated string fused_module_name = 1

  Names of the modules fused in this standalone APK.

Optimization configuration used to generate Standalone APKs.

Used in: Optimizations

• repeated SplitDimension split_dimension = 1

  Device targeting dimensions to shard.

• bool strip_64_bit_libraries = 2

  Whether 64 bit libraries should be stripped from Standalone APKs.

• StandaloneConfig.DexMergingStrategy dex_merging_strategy = 3

  Dex merging strategy that should be applied to produce Standalone APKs.

• StandaloneConfig.FeatureModulesMode feature_modules_mode = 4

  Defines how to deal with feature modules in standalone variants (minSdk < 21).

Used in: StandaloneConfig

• MERGE_IF_NEEDED = 0

  Strategy that does dex merging for applications that have minimum SDK below 21 to ensure dex files from all modules are merged into one or mainDexList is applied when merging into one dex is not possible. For applications with minSdk >= 21 dex files from all modules are copied into standalone APK as is because Android supports multiple dex files natively starting from Android 5.0.

• NEVER_MERGE = 1

  Requires to copy dex files from all modules into standalone APK as is. If an application supports SDKs below 21 this strategy puts responsibility of providing dex files compatible with legacy multidex on application developers.

Used in: StandaloneConfig

• FUSED_FEATURE_MODULES = 0

  Default mode which fuses feature modules with respect to its fusing attribute into base.apk.

• SEPARATE_FEATURE_MODULES = 1

  Advanced mode, which allows to generate a single separate apk per each feature module in variants with minSdk < 21.

Used in: Optimizations

• bool enabled = 1

  Archive is an app state that allows an official app store to reclaim device storage and disable app functionality temporarily until the user interacts with the app again. Upon interaction the latest available version of the app will be restored while leaving user data unaffected. Enabled by default.

Used in: SplitDimension

• bool enabled = 1

  If set to 'true', indicates that the targeting suffix should be removed from assets paths for this dimension when splits (e.g: "asset packs") or standalone/universal APKs are generated. This only applies to assets. For example a folder with path "assets/level1_textures#tcf_etc1" would be outputted to "assets/level1_textures". File contents are unchanged.

• string default_suffix = 2

  The default suffix to be used for the cases where separate slices can't be generated for this dimension - typically for standalone or universal APKs. This default suffix defines the directories to retain. The others are discarded: standalone/universal APKs will contain only directories targeted at this value for the dimension. If not set or empty, the fallback directory in each directory group will be used (for example, if both "assets/level1_textures#tcf_etc1" and "assets/level1_textures" are present and the default suffix is empty, then only "assets/level1_textures" will be used).

Represents a set of ABIs which must be supported by a single APEX image.

Used in: ApexConfig

• repeated string abi = 1

Holds data specific to system APKs.

Used in: ApkDescription

• repeated string fused_module_name = 1

  Names of the modules fused in this system APK.

Representation of a system feature.

Used in: DeviceProperties, DeviceSelector

• string name = 1

  The name of the feature.

An APEX image file in the module that contains targeting information. This information will be used when generating the APK to determine which image it contains.

Used in: ApexImages

• string path = 1

• string build_info_path = 3

  Path to binary protocol buffer file containing apex.proto.ApexBuildInfo with metadata about how the individual APEX filesystem image was built. May be empty if APEX build info was not provided for this image.

• optional ApexImageTargeting targeting = 2

An assets directory in the module that contains targeting information. This information will be used when generating the APKs to determine how to best split them.

Used in: Assets

• string path = 1

  Path of the directory relative to the root of the module. Required.

• optional AssetsDirectoryTargeting targeting = 2

  Targeting of the directory. Required.

A native directory in the module that contains targeting information. This information will be used when generating the APKs to determine how to best split them.

Used in: NativeLibraries

• string path = 1

  Path of the directory relative to the root of the module. Required.

• optional NativeDirectoryTargeting targeting = 2

  Targeting of the directory. Required.

Used in: NativeDirectoryTargeting, TextureCompressionFormatTargeting

• TextureCompressionFormat.TextureCompressionFormatAlias alias = 1

Used in: TextureCompressionFormat

• UNSPECIFIED_TEXTURE_COMPRESSION_FORMAT = 0

• ETC1_RGB8 = 1

• PALETTED = 2

• THREE_DC = 3

• ATC = 4

• LATC = 5

• DXT1 = 6

• S3TC = 7

• PVRTC = 8

• ASTC = 9

• ETC2 = 10

Used in: ApkTargeting, AssetsDirectoryTargeting, VariantTargeting

• repeated TextureCompressionFormat value = 1

• repeated TextureCompressionFormat alternatives = 2

  Targeting of other sibling directories that were in the Bundle. For master splits this is targeting of other master splits.

Used in: Optimizations

• bool enabled = 1

  A new variant with uncompressed dex will be generated. The sdk targeting of the variant is determined by 'uncompressed_dex_target_sdk'.

• UncompressDexFiles.UncompressedDexTargetSdk uncompressed_dex_target_sdk = 2

  If 'enabled' field is set, this will determine the sdk targeting of the generated variant.

Used in: UncompressDexFiles

• UNSPECIFIED = 0

  Q+ variant will be generated.

• SDK_31 = 1

  S+ variant will be generated.

Used in: Optimizations

• bool enabled = 1

Used in: Library

• optional string package_name = 1

  Corresponds to the "name" field in the package.json, uniquely identifying the library.

• optional string version = 2

  Corresponds to the "version" field in the package.json file of the version of the library actually compiled in the app.

Used in: Repository

• optional string url = 1

  The root url for the repository.

Used in: BundleConfig

• string path = 1

  Path to the APK inside the module (e.g. if the path inside the bundle is split/assets/example.apk, this will be assets/example.apk).

User Countries targeting describing an inclusive/exclusive list of country codes that module targets.

Used in: ModuleTargeting

• repeated string country_codes = 1

  List of country codes in the two-letter CLDR territory format.

• bool exclude = 2

  Indicates if the list above is exclusive.

A set of user countries. A country set determines what variation of app content gets served to a specific location.

Used in: DeviceTierConfig

• string name = 1

  Country set name.

• repeated string country_codes = 2

  List of country codes representing countries. A Country code is represented in ISO 3166 alpha-2 format. For Example:- "IT" for Italy, "GE" for Georgia.

Variant is a group of APKs that covers a part of the device configuration space. APKs from multiple variants are never combined on one device.

Used in: BuildApksResult, BuildSdkApksResult

• optional VariantTargeting targeting = 1

  Variant-level targeting. This targeting is fairly high-level and each APK has its own targeting as well.

• repeated ApkSet apk_set = 2

  Set of APKs, one set per module.

• uint32 variant_number = 3

  Number of the variant, starting at 0 (unless overridden). A device will receive APKs from the first variant that matches the device configuration, with higher variant numbers having priority over lower variant numbers.

• optional VariantProperties variant_properties = 4

  Extra information about the variant e.g. has uncompressed dex files or uncompressed native libraries

Describes properties of a variant

Used in: Variant

• bool uncompressed_dex = 1

  Variant has uncompressed dex files

• bool uncompressed_native_libraries = 2

  Variant has uncompressed native libraries

• bool sparse_encoding = 3

  Variant has sparse encoded resource tables

Targeting on the level of variants.

Used in: Variant

• optional SdkVersionTargeting sdk_version_targeting = 1

• optional AbiTargeting abi_targeting = 2

• optional ScreenDensityTargeting screen_density_targeting = 3

• optional MultiAbiTargeting multi_abi_targeting = 4

• optional TextureCompressionFormatTargeting texture_compression_format_targeting = 5

• optional SdkRuntimeTargeting sdk_runtime_targeting = 6