Syw UID2-3502 fix android doco #581

sunnywu · 2024-05-24T05:50:48Z

add more info (R8/Proguard warning) from android sdk repo readme into IMA/GMA plugin guide,
change minimum requirements for different uses of SDK and make it clearer to app publishers

… and change minimum requirements for different uses of SDK and make it clearer to app publishers

…roid-doco

sunnywu · 2024-05-24T05:52:09Z

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

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

-  [ Maven](#installing-with-maven)
+-  [Maven](#installing-with-maven)


previous typo

… and change minimum requirements for different uses of SDK and make it clearer to app publishers

IanDBird

Looks great, thanks!

IanDBird · 2024-05-24T09:20:56Z

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

+- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+
+
+
+To run the development app as mentioned in the [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or build binary from source code, minimum requirements are as follows:


Good clarification, thanks!

genwhittTTD

Few copy mods. Your call. LMK if any questions.

genwhittTTD · 2024-05-24T14:51:05Z

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


 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 section](../sdks/uid2-sdk-ref-android.md#minimum-requirements) in UID2 SDK for Android Reference Guide, open the directory that you checked out.


In Android Studio (check the version required in the Minimum Requirements section in the UID2 SDK for Android Reference Guide), open the directory that you checked out.

(close parens missing + "section" isn't part of the link and can go outside link text + added "the")

genwhittTTD · 2024-05-24T14:52:10Z

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

   - [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 necessary file mentioned in [here](#notes-for-using-r8-or-proguard)


If you are using R8 or Proguard, add the applicable file specified in Notes for Using R8 or ProGuard

genwhittTTD · 2024-05-24T14:52:27Z

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

 </dependency>
 ```
+
+## Notes for using R8 or ProGuard


Notes for Using R8 or ProGuard

(capitalization)

genwhittTTD · 2024-05-24T14:53:00Z

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

+
+## Notes for using R8 or ProGuard
+
+If you are using R8 the shrinking and obfuscation rules are included automatically.


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

genwhittTTD · 2024-05-24T14:58:22Z

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

+
+If you are using R8 the shrinking and obfuscation rules are included automatically.
+
+ProGuard users must manually add the options from


If you are using ProGuard, you must manually add the option specified in the following file:
uid2-gma.pro.

genwhittTTD · 2024-05-24T14:59:20Z

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

   - [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 necessary file mentioned in [here](#notes-for-using-r8-or-proguard)


If you are using R8 or Proguard, add the applicable file specified in Notes for Using R8 or ProGuard

genwhittTTD · 2024-05-24T15:00:17Z

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

+
+## Notes for using R8 or ProGuard
+
+If you are using R8 the shrinking and obfuscation rules are included automatically.


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

genwhittTTD · 2024-05-24T15:01:08Z

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

+If you are using R8 the shrinking and obfuscation rules are included automatically.
+
+ProGuard users must manually add the options from
+[uid2-ima.pro](https://github.com/IABTechLab/uid2-android-sdk/blob/main/securesignals-ima/uid2-ima.pro).


If you are using ProGuard, you must manually add the option specified in the following file: uid2-ima.pro.

genwhittTTD · 2024-05-24T15:02:33Z

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

+- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+
+
+
+To run the development app as mentioned in the [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or build binary from source code, minimum requirements are as follows:


To run the development app (see Client-Side Integration Guide for Mobile), or to build the binary from source code, the minimum requirements are as follows:

genwhittTTD · 2024-05-24T15:04:29Z

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

+
+To run the development app as mentioned in the [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or build binary from source code, 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), and check [here](https://developer.android.com/build/releases/gradle-plugin) for the corresponding Android Studio version required


Android Studio version: Check the Android Gradle Plugin (AGP) version required by the UID2 SDK specified in the code repository, and check the Android Gradle release notes for the corresponding Android Studio version required.

dcaunt and others added 3 commits May 22, 2024 08:14

Add CocoaPods instructions

81577a1

add more info from android sdk repo readme into IMA/GMA plugin guide,…

e6befe8

… and change minimum requirements for different uses of SDK and make it clearer to app publishers

Merge remote-tracking branch 'origin/main' into syw-UID2-3502-fix-and…

fc64ba5

…roid-doco

sunnywu mentioned this pull request May 24, 2024

Syw UID2-3502 fix android doco IABTechLab/uid2-android-sdk#84

Merged

sunnywu requested review from IanDBird and genwhittTTD May 24, 2024 05:51

sunnywu commented May 24, 2024

View reviewed changes

sunnywu added 2 commits May 24, 2024 17:52

add more info from android sdk repo readme into IMA/GMA plugin guide,…

c445b06

… and change minimum requirements for different uses of SDK and make it clearer to app publishers

add more info from android sdk repo readme into IMA/GMA plugin guide,…

5bc8c62

… and change minimum requirements for different uses of SDK and make it clearer to app publishers

IanDBird approved these changes May 24, 2024

View reviewed changes

genwhittTTD approved these changes May 24, 2024

View reviewed changes

sunnywu added 2 commits May 27, 2024 11:45

review feedback

3129cfc

review feedback

5718242

sunnywu merged commit 118b8aa into main May 27, 2024

		- Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+


		To run the development app as mentioned in the [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or build binary from source code, minimum requirements are as follows:


		## Notes for using R8 or ProGuard

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


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

		ProGuard users must manually add the options from


		To run the development app as mentioned in the [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or build binary from source code, 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), and check [here](https://developer.android.com/build/releases/gradle-plugin) for the corresponding Android Studio version required

Syw UID2-3502 fix android doco #581

Syw UID2-3502 fix android doco #581

Uh oh!

Conversation

sunnywu commented May 24, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IanDBird left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

genwhittTTD left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants