Skip to content

Commit 118b8aa

Browse files
authored
Syw UID2-3502 fix android doco (#581)
* add more info from android sdk repo readme into IMA/GMA plugin guide, and change minimum requirements for different uses of SDK and make it clearer to app publishers
1 parent 32840e1 commit 118b8aa

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

docs/guides/integration-mobile-client-side.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Follow the applicable instructions, for Android or iOS:
7777
<TabItem value='android' label='Android'>
7878

7979
1. Check out the main branch of the [UID2 SDK for Android source code repository on GitHub](https://github.com/IABTechLab/uid2-android-sdk/tree/main).
80-
1. In Android Studio (Jellyfish/v2023.3.1 or whichever future version supports the Android Gradle Plugin version required by the UID2 SDK for Android release at the time), open the directory that you checked out.
80+
1. In Android Studio (check the version required in the [Minimum Requirements](../sdks/uid2-sdk-ref-android.md#minimum-requirements) section in the UID2 SDK for Android Reference Guide), open the directory that you checked out.
8181
1. Run the **dev-app** app.
8282
1. When you've started the app, make sure that the **Client Side** checkbox is checked.
8383
1. Enter an email or phone number, and then click the arrow to the right.

docs/guides/mobile-plugin-gma-android.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ To run this plugin, install the following:
3838
- [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk)
3939
- [UID2 SDK for Android Reference Guide](../sdks/uid2-sdk-ref-android.md)
4040
1. [UID2 Android GMA Plugin v0.5.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-gma/)
41+
1. If you are using R8 or Proguard, add the applicable option specified in [Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard)
4142

4243
## Installation
4344

@@ -67,3 +68,10 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
6768
<version>0.5.0</version>
6869
</dependency>
6970
```
71+
72+
## Notes for Using R8 or ProGuard
73+
74+
If you are using R8, the shrinking and obfuscation rules are included automatically.
75+
76+
If you are using ProGuard, you must manually add the option specified in [uid2-gma.pro](https://github.com/IABTechLab/uid2-android-sdk/blob/main/securesignals-gma/uid2-gma.pro).
77+

docs/guides/mobile-plugin-ima-android.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ To run this plugin, install the following:
3838
- [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk)
3939
- [UID2 SDK for Android Reference Guide](../sdks/uid2-sdk-ref-android.md)
4040
1. [UID2 IMA Plugin for Android v0.5.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-ima)
41+
1. If you are using R8 or Proguard, add the applicable option specified in [Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard)
4142

4243
## Installation
4344

@@ -67,3 +68,10 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
6768
<version>0.5.0</version>
6869
</dependency>
6970
```
71+
72+
## Notes for Using R8 or ProGuard
73+
74+
If you are using R8, the shrinking and obfuscation rules are included automatically.
75+
76+
If you are using ProGuard, you must manually add the option specified in [uid2-ima.pro](https://github.com/IABTechLab/uid2-android-sdk/blob/main/securesignals-ima/uid2-ima.pro).
77+

docs/sdks/uid2-sdk-ref-android.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,14 @@ The binary is published on Sonatype:
8181

8282
## Minimum Requirements
8383

84-
Minimum requirements for this SDK are as follows:
84+
To consume the binary package of this SDK in your app:
8585

86-
- Android Studio version: v2023.3.1+
86+
- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+
87+
88+
89+
To run the development app (see [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or to build binary from source code, the minimum requirements are as follows:
90+
91+
- Android Studio version: Check the Android Gradle Plugin (AGP) version required by the UID2 SDK specified in the [code repository](https://github.com/IABTechLab/uid2-android-sdk/blob/main/gradle/libs.versions.toml) (see the stated `agp` version), and check [the Android Gradle Plugin release notes](https://developer.android.com/build/releases/gradle-plugin) for the corresponding Android Studio version required.
8792
- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+ / API 21+ (Dev-App)
8893

8994
<!-- See also: [Requirements](https://github.com/IABTechLab/uid2-android-sdk/blob/main/README.md#requirements). -->
@@ -94,7 +99,7 @@ There are two options for installing the Android UID2 SDK:
9499

95100
- [Gradle](#installing-with-gradle)
96101

97-
- [ Maven](#installing-with-maven)
102+
- [Maven](#installing-with-maven)
98103

99104
### Installing with Gradle
100105

0 commit comments

Comments
 (0)