Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/integration-mobile-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Follow the applicable instructions, for Android or iOS:
<TabItem value='android' label='Android'>

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).
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.
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.
1. Run the **dev-app** app.
1. When you've started the app, make sure that the **Client Side** checkbox is checked.
1. Enter an email or phone number, and then click the arrow to the right.
Expand Down
8 changes: 8 additions & 0 deletions docs/guides/mobile-plugin-gma-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ To run this plugin, install the following:
- [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk)
- [UID2 SDK for Android Reference Guide](../sdks/uid2-sdk-ref-android.md)
1. [UID2 Android GMA Plugin v0.5.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-gma/)
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)

## Installation

Expand Down Expand Up @@ -67,3 +68,10 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
<version>0.5.0</version>
</dependency>
```

## Notes for Using R8 or ProGuard

If you are using R8, the shrinking and obfuscation rules are included automatically.

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).

8 changes: 8 additions & 0 deletions docs/guides/mobile-plugin-ima-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ To run this plugin, install the following:
- [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk)
- [UID2 SDK for Android Reference Guide](../sdks/uid2-sdk-ref-android.md)
1. [UID2 IMA Plugin for Android v0.5.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-ima)
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)

## Installation

Expand Down Expand Up @@ -67,3 +68,10 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
<version>0.5.0</version>
</dependency>
```

## Notes for Using R8 or ProGuard

If you are using R8, the shrinking and obfuscation rules are included automatically.

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).

11 changes: 8 additions & 3 deletions docs/sdks/uid2-sdk-ref-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,14 @@ The binary is published on Sonatype:

## Minimum Requirements

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

- Android Studio version: v2023.3.1+
- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+


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:

- 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.
- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+ / API 21+ (Dev-App)

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

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

- [ Maven](#installing-with-maven)
- [Maven](#installing-with-maven)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previous typo


### Installing with Gradle

Expand Down