582

I have looked at the documentation for building with Gradle, but I'm still not sure what the difference between compileSdkVersion and targetSdkVersion is.

All it says is:

The compileSdkVersion property specifies the compilation target.

Well, what is the "compilation target"?

I see two possible ways to interpret this:

  1. compileSdkVersion is the version of the compiler used in building the app, while targetSdkVersion is the "API level that the application targets". (If this were the case, I'd assume compileSdkVersion must be greater than or equal to the targetSdkVersion?
  2. They mean the same thing. "compilation target" == "the API level that the application targets"
  3. Something else?

I see that this question has been asked before, but the one answer just quotes the doc, which is what is unclear to me.

Community
  • 1
  • 1
coder123
  • 7,767
  • 5
  • 13
  • 13
  • 6
    More details on: [Picking your compileSdkVersion, minSdkVersion, and targetSdkVersion](https://medium.com/google-developers/picking-your-compilesdkversion-minsdkversion-targetsdkversion-a098a0341ebd#.fo6h6k65r) – Ivan Chau Jan 23 '16 at 07:29
  • 2
    **targetSdkVersion** is what your device is running. So if your devices are running lower than Oreo, then don't target 27. – IgorGanapolsky Jan 25 '18 at 15:39

11 Answers11

603

compileSdkVersion

The compileSdkVersion is the version of the API the app is compiled against. This means you can use Android API features included in that version of the API (as well as all previous versions, obviously). If you try and use API 16 features but set compileSdkVersion to 15, you will get a compilation error. If you set compileSdkVersion to 16 you can still run the app on a API 15 device as long as your app's execution paths do not attempt to invoke any APIs specific to API 16.

targetSdkVersion

The targetSdkVersion has nothing to do with how your app is compiled or what APIs you can utilize. The targetSdkVersion is supposed to indicate that you have tested your app on (presumably up to and including) the version you specify. This is more like a certification or sign off you are giving the Android OS as a hint to how it should handle your app in terms of OS features.

For example, as the documentation states:

For example, setting this value to "11" or higher allows the system to apply a new default theme (Holo) to your app when running on Android 3.0 or higher...

The Android OS, at runtime, may change how your app is stylized or otherwise executed in the context of the OS based on this value. There are a few other known examples that are influenced by this value and that list is likely to only increase over time.

For all practical purposes, most apps are going to want to set targetSdkVersion to the latest released version of the API. This will ensure your app looks as good as possible on the most recent Android devices. If you do not specify the targetSdkVersion, it defaults to the minSdkVersion.

Jeffrey Mixon
  • 10,446
  • 3
  • 25
  • 42
  • 1
    I see. So the `targetSdkVersion` should never be greater than the `compileSdkVersion` -- is that correct? – coder123 Nov 01 '14 at 23:23
  • 17
    No, `targetSdkVersion` very likely will be higher than `compileSdkVersion` and rightfully so. This means that although you designed an app to target API 16, for example, it still runs fine on API 21 (Lollipop) and you should bump your `targetSdkVersion` to 21 to indicate it is okay for the Android OS to apply any Lollipop-styles that may exist to your app. – Jeffrey Mixon Nov 01 '14 at 23:30
  • 1
    You said earlier: "If you try and use API 16 features but set compileSdkVersion to 15, you will get a compilation error." In your second comment, it sounds like you're saying compileSdkVersion can be 15, and targetSdkVersion can be (and very likely is) higher than 15, say 16. Does that not mean I've "certified" the app to work with API 16 and its features? – coder123 Nov 02 '14 at 00:28
  • 31
    Fundamentally, I don't understand how you could target an SDK higher than the the SDK you've compiled against. – coder123 Nov 02 '14 at 00:30
  • 60
    Changing `compileSdkVersion` to a higher version would mean you want to use some new APIs that are only included in that particular release. If you don't plan on using any Lollipop-specific features in your app, then there's really (usually) no reason to ever set `compileSdkVersion` to 21. However, your app will likely run just fine on API 21 as-is, thus you change `targetSdkVersion` to indicate your app **runs** like you expect (target) on API 21, but you're not using any APIs specific to 21 (compile) and thus your `compileSdkVersion` can stay at 15 in this example. – Jeffrey Mixon Nov 02 '14 at 00:37
  • 23
    A warning is reported when I do that in Android studio. I have "compileSdkVersion 17" and "targetSdkVersion 22" and it tells me "targetSdkVersion should not be higher than compileSdkVersion". Oh, just changed it and now it's telling me the targetSdkVersion is not the latest 22 and that compatibility mode might kick in. Sigh. – Pelpotronic Aug 07 '15 at 12:37
  • 3
    Many developers are gonna want to set `compileSdkVersion 23` but stay with `targetSdkVersion 22` for a while. (See @jeff-mixon comment for the reason.) – espinchi Nov 11 '15 at 19:50
  • 2
    I still dont 100% get what compileSdkVersion means. Lets say I have an app which I build on API Level 21. Then Google releases API 23. I compile my App against compileSdkVersion 23 BUT did not change anything besides that in my code. Will my app use the 'new' code from API 23? I am asking because Im curious what happens with bug fixes: Lets say there was a method `DoStuff()` which I use in my APP. Google noticed that it contains a bug and they fixed it for API 23. When I compile with compileSdkVersion 23 does my App get that bugfix? Will that code from that SDK be compiled into my app? – degill Dec 22 '15 at 10:46
  • 4
    @degill `compileSdkVersion` only affects _compilation_ time. The API level of the device determines which version of Android it is ultimately running against. An app with an `compileSdkVersion` of 11 running on a device with API 21 will run version 21 of all the Android APIs. `compileSdkVersion` is purely for the compiler; it does not influence anything after your app is already built. – Jeffrey Mixon Dec 23 '15 at 11:57
  • 7
    It clearly states in android studio when you set the targetSdkVersion higher than compileSdkVersion.. "The targetSdkVersion should not be higher than the compileSdkVersion" – Murphybro2 Jan 21 '16 at 11:04
  • 20
    This answer contradicts what the Android Studio says. targetSdkVersion matters and it should less than or equal to compileSdkVersion – ARK Jan 29 '16 at 01:39
  • 2
    That is just a Gradle inspection hint for convenience. There is no actual technical issue with setting `targetSdkVersion` higher than `compileSdkVersion`. At the same time, it doesn't really hurt to also set `compileSdkVersion` to the highest level either, as long as you understand the implications. – Jeffrey Mixon Jul 20 '16 at 22:16
  • 3
    "Note that if you use the Support Library, compiling with the latest SDK is a requirement for using the latest Support Library releases." source: https://medium.com/google-developers/picking-your-compilesdkversion-minsdkversion-targetsdkversion-a098a0341ebd#.6lmj281s2 – MD-11 Nov 30 '16 at 14:52
  • I did not understand this part of your answer: "as long as your app's execution paths do not attempt to invoke any APIs specific to API 16". Is it safe to set compileSdkVersion to 16 run the app on an API 15 device? – Jaime Montoya Nov 24 '17 at 22:10
  • 1
    The most important issue is - is it compileSdkVersion or targetSdkVersion that can never be downgraded in google play? – user239558 Jan 30 '18 at 20:01
  • "This means you can use Android API features included in that version of the API (as well as all previous versions, obviously)." I don't think it is correct that you can use all feature included in previous versions. If a method was present (but deprecated) in 15, then removed in 16, you can't use it if the compileSdkVersion is set to 16 or greater. – joelw Jun 07 '18 at 21:40
  • 2
    In Android Studio, if I set `compileSdkVersion` lower than `targetSdkVersion` then AS tells me this is not allowed, so it seems to me you should not set `compiled < target` as mentioned above... (@Jeff Mixon ?) – Pixel Aug 16 '18 at 10:00
  • I struggle with the phrase "compiled against". To me it sounds like it means, "the byte code coming out of the compiler is this version". But it seems to be used as "the version of the compiler used is this version". That totally changes the meaning. I'd imagine a newer compiler can generate back-compatible byte code, but newer byte code cannot run on an older OS. – Shitesh Aug 22 '19 at 10:15
  • with this explanation, compileSdkVersion should **always** be set to min sdk or there is chance of breaking ? – minsk Feb 18 '21 at 05:40
  • the targetSdkVersion should not be higher than the compileSdkVersion. compileSdkVersion should NOT be set depending on the minSdkVersion but depending on the targetSdkVersion. If your targetSdkVersion and the minSdkVersion are the same, then obviously the compileSdkVersion should also be the same. There isn't any chance of breaking, but the compileSdkVersion says what featues are possible so.... – Ctrl_see May 29 '21 at 11:37
  • Any features in higher SDKs than the compileSDK cant be used. So setting your targetSdkVersion above your compileSdkVersion is like saying: "This is built for [targetSdkVersion], but you only get the features from [compileSdkVersion]!" – Ctrl_see May 29 '21 at 11:44
169

As a oneliner guide: 

minSdkVersion <= targetSdkVersion <= compileSdkVersion

Ideally: 

minSdkVersion (lowest possible) <= targetSdkVersion == compileSdkVersion (latest SDK)

Read more from this great post by Ian Lake

Jimmy Kane
  • 14,040
  • 9
  • 73
  • 109
  • Does `minSdkVersion ` means the lowest device api level app `can` run on? Presumably because it uses certain API's available from `minSdkVersion` onwards? – Nitin Bansal Aug 07 '18 at 02:20
  • 2
    @NitinBansal yes. For example if `minSdkVersion` is 15 (which is ICS 4.0.3), devices with API 14 (which is ICS 4.0) should not be able to install the app. And at least for now, the app will run on 15, 16, 17, 18, 19, (20 but that's for the old wear os), 21, 22, 23, 24, 25, 26, 27, 28, and so on in the future (probably) – Louis Tsai Oct 09 '18 at 11:20
36

The compileSdkVersion should be newest stable version. The targetSdkVersion should be fully tested and less or equal to compileSdkVersion.

Ben Clayton
  • 75,781
  • 25
  • 117
  • 124
androidwifi
  • 821
  • 9
  • 8
  • 15
    Any specific reason for saying that targetSdkVersion be less than compileSdkVersion? I believe it's a wrong statement – Sufian Nov 10 '15 at 13:48
  • 6
    I guess the point is that the last version is backwards compatible, so the latest API version can "behave" like older ones, if you set the `targetSdkVersion` to a lower one. So the `targetSdkVersion` should be the one you have tested and know the exact behavior, and can be <= the latest stable. – Dielson Sales Nov 30 '15 at 20:27
  • I think that your statement '`compileSdkVersion` should be newest stable version' should be suffixed with 'of which you use API features'. It makes no sense to compile against API 27 (today's latest stable API) if you only use lower API version features. However, the latest stable version could include some features that automatically become better, e.g. enhanced security or efficient compilation with backwards compatibility. Therefore it is advisable to use the latest or at least a recent stable version, but it 'should [not] be' the latest version _per se_. – Erik Apr 11 '18 at 08:24
36

Late to the game.. and there are several great answers above-- essentially, that the compileSdkVersion is the version of the API the app is compiled against, while the targetSdkVersion indicates the version that the app was tested against.

I'd like to supplement those answers with the following notes:

  1. That targetSdkVersion impacts the way in which permissions are requested:
  • If the device is running Android 6.0 (API level 23) or higher, and the app's targetSdkVersion is 23 or higher, the app requests permissions from the user at run-time.
  • If the device is running Android 5.1 (API level 22) or lower, or the app's targetSdkVersion is 22 or lower, the system asks the user to grant the permissions when the user installs the app.

  1. If the compileSdkVersion is higher than the version declared by your app's targetSdkVersion, the system may enable compatibility behaviors to ensure that your app continues to work the way you expect. (ref)

  2. With each new Android release...

  • targetSdkVersion should be incremented to match the latest API level, then thoroughly test your application on the corresponding platform version
  • compileSdkVersion, on the other hand, does not need to be changed unless you're adding features exclusive to the new platform version
  • As a result, while targetSdkVersion is often (initially) less than than the compileSdkVersion, it's not uncommon to see a well-maintained/established app with targetSdkVersion > compileSdkVersion
Austin D
  • 6,678
  • 2
  • 26
  • 34
  • 6
    Re: your second point, I don't think the references doc explicitly says that. It says "However, if the API level of the platform is higher than the version declared by your app's targetSdkVersion, the system may enable compatibility behaviors to ensure that your app continues to work the way you expect." I think this means if the API level of the device you are running on is newer than your `targetSdkVersion` you may see compatibility behaviors. I don't believe it has anything to do with the `compileSdkVersion`. – Jeremy Aug 21 '17 at 19:18
  • If the compileSdkVersion is 23 and targetSdkVersion is 22, would it show permission dialog in the marshmallow and above devices? – Suraj Vaishnav Nov 14 '20 at 13:27
20

The CompileSdkVersion is the version of the SDK platform your app works with for compilation, etc DURING the development process (you should always use the latest) This is shipped with the API version you are using

enter image description here

You will see this in your build.gradle file:

enter image description here

targetSdkVersion: contains the info your app ships with AFTER the development process to the app store that allows it to TARGET the SPECIFIED version of the Android platform. Depending on the functionality of your app, it can target API versions lower than the current.For instance, you can target API 18 even if the current version is 23.

Take a good look at this official Google page.

Ojonugwa Jude Ochalifu
  • 23,935
  • 25
  • 104
  • 122
10

I see a lot of differences about compiledSdkVersion in previous answers, so I'll try to clarify a bit here, following android's web page.

A - What Android says

According https://developer.android.com/guide/topics/manifest/uses-sdk-element.html:

Selecting a platform version and API Level When you are developing your application, you will need to choose the platform version against which you will compile the application. In general, you should compile your application against the lowest possible version of the platform that your application can support.

So, this would be the right order according to Android:

compiledSdkVersion = minSdkVersion <= targetSdkVersion

B - What others also say

Some people prefer to always use the highest compiledSkdVersion available. It is because they will rely on code hints to check if they are using newer API features than minSdkVersion, thus either changing the code to not use them or checking the user API version at runtime to conditionally use them with fallbacks for older API versions.

Hints about deprecated uses would also appear in code, letting you know that something is deprecated in newer API levels, so you can react accordingly if you wish.

So, this would be the right order according to others:

minSdkVersion <= targetSdkVersion <= compiledSdkVersion (highest possible)

What to do?

It depends on you and your app.

If you plan to offer different API features according to the API level of the user at runtime, use option B. You'll get hints about the features you use while coding. Just make sure you never use newer API features than minSdkVersion without checking user API level at runtime, otherwise your app will crash. This approach also has the benefit of learning what's new and what's old while coding.

If you already know what's new or old and you are developing a one time app that for sure will never be updated, or you are sure you are not going to offer new API features conditionally, then use option A. You won't get bothered with deprecated hints and you will never be able to use newer API features even if you're tempted to do it.

CGodo
  • 1,250
  • 13
  • 15
  • 2
    I don't think the Android advice is different. There's a difference between "compile your application **against** the lowest possible version" and compiling **with** a particular SDK version. You should generally compile (compileSdkVersion) with the latest version, set your min (minSdkVersion) as low as possible and set your target (targetSdkVersion) as high as possible subject to testing or other compatibility issues. – Caltor Jul 07 '17 at 16:44
  • Good point @Caltor. I wish they would update that document to clarify the difference. The `` documentation is extremely vague and ambiguous. – Jeremy Aug 21 '17 at 19:22
  • Practically scenario A can be true only if TargetSdkVersion = CompileSdkVersion but not higher, when you chose a higher value Android Studio will consider it as an error and request from you to chose a value that is equal or lower than the ComplieSdkVersion – Salim Mazari Boufares Apr 03 '21 at 10:52
3

My 2 cents: Compile against any version of the SDK but take care not to call any APIs that your "minimum SDK version" does not support. That means you "could" compile against the latest version of the SDK.

As for "target version" it simply refers to what you planned to target in the first place and have possibly tested against. If you haven't done the due diligence then this is the way to inform Android that it needs to perform some additional checks before it deploys your lets say "Lollipop" targeted app on "Oreo".

So the "target version" is obviously not lower than your "minimum SDK version" but it can't be higher than your "compiled version".

pcodex
  • 1,247
  • 8
  • 13
1

Not answering to your direct questions, since there are already a lot of detailed answers, but it's worth mentioning, that to the contrary of Android documentation, Android Studio is suggesting to use the same version for compileSDKVersion and targetSDKVersion.

enter image description here

sshturma
  • 953
  • 7
  • 7
1

compiledSdkVersion==> which version of SDK should compile your code to bytecode(it uses in development environment) point: it's better use last version of SDK.

minSdkVersion==> these item uses for installation of APK(it uses in production environment). For example:

if(client-sdk-version   <   min-sdk-versoin )
    client-can-not-install-apk;
else
    client-can-install-apk;
M.Namjo
  • 298
  • 1
  • 10
0

The Application settings of an Android project's properties in Visual Studio 2017 (15.8.5) has them combined:

enter image description here

Bhargav Rao
  • 41,091
  • 27
  • 112
  • 129
samis
  • 5,746
  • 6
  • 29
  • 64
0

Quick summary:

For minSDKversion, see latest entry in twitter handle: https://twitter.com/minSdkVersion

TargetSDKversion: see latest entry in twitter handle: https://twitter.com/targtSdkVersion or use the latest API level as indicated at devel https://developer.android.com/guide/topics/manifest/uses-sdk-element.html

Compiled version: make it same as TargetSDKversion

maxSdkVersion: advice from Android is to not set this as you do not want to limit your app to not perform on future android releases

kush
  • 127
  • 1
  • 4