Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add signature testing steps for each platform #1092

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
4 changes: 3 additions & 1 deletion src/content/docs/sdk/android/v5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,9 @@ The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.

## 6. Set up SDK Signature {#set-up-sdk-signature}

SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Signature protection is inactive by default. To enable it, you need to:
SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Follow [the testing guide](/en/sdk/android/integrations/signature-library#test-your-app) to ensure your integration works.

Signature protection is inactive by default. To enable it, you need to:

1. [Enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).
2. [Provide your app's SHA-1 fingerprints](https://help.adjust.com/en/article/sdk-signature#manage-your-certificate-fingerprints) prior to testing.
Expand Down
15 changes: 12 additions & 3 deletions src/content/docs/sdk/cordova/v5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,16 @@ The Adjust SDK automatically links the frameworks listed below on iOS devices.
| `StoreKit.framework` | Enables access to the SKAdNetwork framework | Required to allow the Adjust SDK to handle communication with SKAdNetwork on devices running iOS 14 or later |
| `AppTrackingTransparency.framework` | Required to allow the Adjust SDK to wrap user tracking consent dialog and access consent responses on devices running iOS 14 or later | Don't add this framework if your app targets the "Kids" category |

## 4. Initialize the Adjust SDK {#initialize-the-adjust-sdk}
## 4. Set up SDK Signature {#set-up-sdk-signature}

SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Follow the testing guide for [iOS](/en/sdk/ios/integrations/signature-library#test-your-app) and [Android](/en/sdk/android/integrations/signature-library#test-your-app) to ensure your integration works.

Signature protection is inactive by default. To enable it, you need to:

1. [Enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).
2. [Provide your app's SHA-1 fingerprints](https://help.adjust.com/en/article/sdk-signature#manage-your-certificate-fingerprints) prior to testing.

## 5. Initialize the Adjust SDK {#initialize-the-adjust-sdk}

<Callout type="important">

Expand All @@ -123,13 +132,13 @@ var adjustConfig = new AdjustConfig(
Adjust.initSdk(adjustConfig);
```

## 5. Build your app {#build-your-app}
## 6. Build your app {#build-your-app}

Well done! You should now be able to build and run your Cordova app. Enable logging to check for any issues. Check your logs to see the `Install tracked` message.

You are ready to start attributing your users with the Adjust SDK.

## 6. Test your integration {#test-your-integration}
## 7. Test your integration {#test-your-integration}

The Adjust SDK provides tools for testing and troubleshooting issues with your integration. To test your setup:

Expand Down
15 changes: 12 additions & 3 deletions src/content/docs/sdk/flutter/v5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,16 @@ The Adjust SDK is able to get extra information when you include certain iOS fra
| `StoreKit.framework` | Enables access to the SKAdNetwork framework | Required to allow the Adjust SDK to handle communication with SKAdNetwork on devices running iOS 14 or later |
| `AppTrackingTransparency.framework` | Required to allow the Adjust SDK to wrap user ATT consent dialog and access consent responses on devices running iOS 14 or later | Don't add this framework if your app targets the "Kids" category |

## 4. Initialize the Adjust SDK {#initialize-the-adjust-sdk}
## 4. Set up SDK Signature {#set-up-sdk-signature}

SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Follow the testing guide for [iOS](/en/sdk/ios/integrations/signature-library#test-your-app) and [Android](/en/sdk/android/integrations/signature-library#test-your-app) to ensure your integration works.

Signature protection is inactive by default. To enable it, you need to:

1. [Enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).
2. [Provide your app's SHA-1 fingerprints](https://help.adjust.com/en/article/sdk-signature#manage-your-certificate-fingerprints) prior to testing.

## 5. Initialize the Adjust SDK {#initialize-the-adjust-sdk}

Make sure you initialize the Adjust SDK as soon as possible in your Flutter app. To do this, initialize your config object with your app token and the environment you want to run your application in.

Expand All @@ -142,13 +151,13 @@ AdjustConfig config = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandb
Adjust.initSdk(config);
```

## 5. Build your app {#build-your-app}
## 6. Build your app {#build-your-app}

Well done! You should now be able to build and run your Flutter app. Enable logging to check for any issues. Check your logs to see the `Install tracked` message.

You are ready to start attributing your users with the Adjust SDK.

## 6. Test your integration {#test-your-integration}
## 7. Test your integration {#test-your-integration}

The Adjust SDK provides tools for testing and troubleshooting issues with your integration. To test your setup:

Expand Down
12 changes: 7 additions & 5 deletions src/content/docs/sdk/ios/v5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ The Adjust SDK depends on frameworks to access certain device information. To en

## 4. Set up SDK signature {#set-up-sdk-signature}

SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Signature protection is inactive by default. To enable it, you need to [enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).
SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Follow [the testing guide](/en/sdk/ios/integrations/signature-library#test-your-app) to ensure your integration works.

Signature protection is inactive by default. To enable it, you need to [enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).

## 5. (Optional) set up the Adjust Web Bridge {#set-up-web-bridge}

Expand Down Expand Up @@ -171,7 +173,7 @@ Adjust.initSdk(adjustConfig);
</Tab>
</Tabs>

## 5. Initialize the Adjust SDK {#initialize-the-adjust-sdk}
## 6. Initialize the Adjust SDK {#initialize-the-adjust-sdk}

To initialize the Adjust SDK, you need to create a config object. This object contains configuration options that control how the Adjust SDK behaves. Pass the following arguments for a minimal setup:

Expand Down Expand Up @@ -321,17 +323,17 @@ func willResignActive(with conversation: MSConversation) {
</Tab>
</Tabs>

## 6. Configure the Adjust SDK {#configure-the-adjust-sdk}
## 7. Configure the Adjust SDK {#configure-the-adjust-sdk}

Once you've added your config object and initialization logic, you can configure the Adjust SDK to record information about different parts of your app. Check out the [configuration reference](/en/sdk/ios/configuration) and [feature guides](/en/sdk/ios/features) to set up exactly what you want to record.

## 7. Test the Adjust SDK {#test-the-adjust-sdk}
## 8. Test the Adjust SDK {#test-the-adjust-sdk}

Now that you've configured the Adjust SDK to record information about your app, it's time to test it. Adjust offers a [testing console](https://help.adjust.com/en/article/testing-console) and a [Device API](https://help.adjust.com/en/article/device-api) to help you test your app.

Follow the [testing guide](https://help.adjust.com/en/article/test-the-adjust-sdk) to make sure Adjust receives the expected values back from your app.

## 8. Build your app for production {#build-your-app-for-production}
## 9. Build your app for production {#build-your-app-for-production}

Once you've finished your testing, you can build your app for production. To do this, you need to update your config object.

Expand Down
14 changes: 9 additions & 5 deletions src/content/docs/sdk/react-native/v5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ You can also add optional permissions that allow you to access additional inform
```xml
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

```

</CodeBlock>
Expand Down Expand Up @@ -152,12 +151,8 @@ Although install referrer isn't required, it's highly recommended to improve att

#### Google Play Referrer API {#google-play-referrer-api}

<MinorVersion added="v4.12.0">

To support the [Google Play Referrer API](https://developer.android.com/google/play/installreferrer):

</MinorVersion>

1. Add the following line in the **dependencies block** of your top-level `build.gradle` file:

<CodeBlock title="build.gradle">
Expand Down Expand Up @@ -206,6 +201,15 @@ The Adjust SDK is able to get extra information when you include certain iOS fra
| **StoreKit.framework** | This framework is needed to access the SKAdNetwork framework and for the Adjust SDK to andle communication with it automatically in iOS 14 or later. | |
| **AppTrackingTransparency.framework** | This framework is needed in iOS 14 and later for the SDK to be able to wrap he user ATT consent dialog and access the user’s consent response. | If your app is targeting the "Kids" category, you shouldn't implement this framework. |

## 6. Set up SDK Signature {#set-up-sdk-signature}

SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Follow the testing guide for [iOS](/en/sdk/ios/integrations/signature-library#test-your-app) and [Android](/en/sdk/android/integrations/signature-library#test-your-app) to ensure your integration works.

Signature protection is inactive by default. To enable it, you need to:

1. [Enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).
2. [Provide your app's SHA-1 fingerprints](https://help.adjust.com/en/article/sdk-signature#manage-your-certificate-fingerprints) prior to testing.

## 7. Test your integration {#test-your-integration}

The Adjust SDK provides tools for testing and troubleshooting issues with your integration. To test your setup:
Expand Down
13 changes: 11 additions & 2 deletions src/content/docs/sdk/unity/v5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,16 @@ The Adjust SDK supports the [Meta Install Referrer](https://developers.facebook.
Adjust.InitSdk(config);
```

## 5. Build your app {#build-your-app}
## 5. Set up SDK Signature {#set-up-sdk-signature}

SDK v5 includes the [SDK signature library](https://help.adjust.com/en/article/sdk-signature). Follow the testing guide for [iOS](/en/sdk/ios/integrations/signature-library#test-your-app) and [Android](/en/sdk/android/integrations/signature-library#test-your-app) to ensure your integration works.

Signature protection is inactive by default. To enable it, you need to:

1. [Enforce signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation).
2. [Provide your app's SHA-1 fingerprints](https://help.adjust.com/en/article/sdk-signature#manage-your-certificate-fingerprints) prior to testing.

## 6. Build your app {#build-your-app}

To complete the app build process, the Adjust Unity package performs custom post-build actions to ensure the Adjust SDK works in your app. This process is performed by the `OnPostprocessBuild` method in `AdjustEditor.cs`.

Expand Down Expand Up @@ -252,7 +261,7 @@ To enable deep linking, add the following information:

The output of the process is shown in the Unity IDE console window.

## 6. Test your integration {#test-your-integration}
## 7. Test your integration {#test-your-integration}

<Callout type="tip">

Expand Down
Loading