Testing - iOS SDK (v4)

    在 Airbridge 面板进行的 SDK 测试

    您可以在 Airbridge 面板测试 Airbridge SDK 是否正常运行。请在测试前先安装 Airbridge SDK。

    After completing the Airbridge iOS SDK setup, you can test whether it works properly using real-time logs, test sites, etc. Prepare the following information before testing the iOS SDK.

    Test SDK Functionality

    Check whether the Airbridge iOS SDK is operating properly.

    Check Install event collection

    Follow the steps below to check whether the Install events are being collected by the iOS SDK.

    1. Prepare a test device where the app is not installed, or if the app is already installed, delete it before testing.

    2. Set the SDK log level to debug.

    3. Install the app on the test device. After installing the app, launch it so that the Install event is collected.

    The first Open event collected by Airbridge is recorded as an Install event. Therefore, the Open may not be recorded when the app install event is collected.

    4. Navigate to [Raw Data]>[App Real-Time Log] in the Airbridge dashboard and find the events with the test device's IDFA in the real-time logs. If the Install event can be found in the real-time log, you can confirm that the SDK is working as intended. It may take up to 10 minutes to check the Install event in the [App Real-time Log].

    5. If the Install event is not confirmed in the [App Real-time Log] even after a sufficient amount of time, check whether the Install event is in the SDK log. When the Install event is in the SDK log, delete the app from the test device and reinstall it.

    If the Install event is still not confirmed, contact your Airbridge CSM and share your SDK logs. If you don't have a designated Airbridge CSM, contact the Airbridge Help Center.

    Check attribution result

    Airbridge initiates the attribution process when a Target Event occurs. The Install event is a typical Target Event. By checking the attribution result of the Install event, you can confirm whether the process from event collection to attribution is operated successfully.

    注意

    进行测试的 App 必须提供弹出窗口,要求用户选择是否允许 ATT(App Tracking Transparency, 应用跟踪透明度)。如果无法确认用户是否允许,或者用户不允许,则无法检查 App 安装事件的归因。

    1. 1. Prepare a test device where the app is not installed, or if the app is already installed, delete it before testing. Set the Tracking Authorise Timeout (TAT) to a sufficient length.

    2. Set the SDK log level to Debug.

    3. Access the Attribution Integration Test site on your test device.

    4. Enter the App Name and IDFA, then click Submit. The App Name can be found on the [Settings]>[Tokens] page in the Airbridge dashboard.

    5. Click Test Install Attribution to move to the Apple App Store to install the app. If the Airbridge iOS SDK is not installed on the app that is available for download in the App Store, you need to install the app with the Airbridge iOS SDK through the IDE.

    6. Install the app on the test device. You must launch the app after install to collect the Install event. When the ATT prompt comes up, click Allow to allow data tracking.

    The first Open event is recorded as an Install event in Airbridge. Therefore, the Open event may not be recorded if the Install event is collected.

    7. Check the SDK logs. If the Install event is sent to the Airbridge server as intended, the addABInstallEvent to the queue log will be confirmed.

    8. Navigate to [Raw Data]>[App Real-Time Log] in the Airbridge dashboard and find the events with the test device's IDFA in the real-time logs. If the Install event can be found in the real-time log, you can confirm that the SDK is working as intended. It may take up to 10 minutes to check the Install event in the [App Real-time Log].

    9. Make sure that the information in the app install event is as shown below. If it looks like the information below, the attribution process went well.

    • Event Category: Install

    • ifa: IDFA entered in the attribution test site

    • attributionResult.channel: test_sdk

    • attributionResult.attributedTouchpointOriginURL: https://abr.ge/@sfYOUR_APP_NAME}/test_sdk?campaign=test_sdk_campaignadevice_uuid=${YOUR_IDFA}

    10. If the Install event is not confirmed in the [App Real-time Log] even after sufficient time, check whether the Install event is in the SDK log. When the Install event is in the SDK log, uninstall the application on the test device and reinstall it.

    Also, make sure you have clicked Allow in the ATT prompt. If you allowed data tracking and the Install event is still not confirmed, check whether the TAT is set to an appopriate length.

    If the Install event is still not confirmed, contact your Airbridge CSM and share your SDK logs. If you don't have a designated Airbridge CSM, contact the Airbridge Help Center.

    Test SDK Data Collection

    Check whether the event and user data are being collected as intended.

    Check event collection

    Check whether the events are being collected by the Airbridge iOD SDK as defined in your Airbridge event taxonomy by following the steps below.

    Check user data collection

    提示

    如果未在 Airbridge iOS SDK 设置用户信息收集,则无需以下检查。通过 Airbridge iOS SDK 收集用户 ID、邮箱等用户信息,有助于更丰富地使用 Airbridge,例如与第三方解决方案集成。

    Verify that user information is being collected in the iOS SDK as configured.

    You can follow the steps below to verify that the deep link feature you set up in the Airbridge iOS SDK is working properly.

    Preliminary checks

    Before testing the deep link, make sure the following items have been set up.

    #{"width":"120px"}

    #{"width":"240px"}

    Description

    #{"width":"140px"}

    Resources

    HTTP deep links (App links)

    Setup is required.

    - Dashboard Settings

    - Set up deep linking

    Scheme Deep Link

    Setup is required.

    - Dashboard Settings

    - Set up deep linking

    Deferred Deep Link

    The setup is completed automatically. No additional setup is required.

    - Set up deferred deep linking

    Custom Domain

    Setup is optional.

    - Dashboard Settings

    App Install

    - If you don't need to test the deferred deep link, install the app on your test device in advance.

    - If you need to test the deferred deep link, the app should not be installed on the test device. If the app is installed, delete the app from the test device.

    Airbridge provides a website for testing deep links. If you want to test deferred deep links, you need to uninstall the app from your test device.

    1. Visit the deep link testing site from your test device. You can access the website directly by using the QR code below.

    2. Enter the App Name you registered with Airbridge. You can find it on the [Settings]>[Tokens] page in the Airbridge dashboard.

    If you want to test the specific deeplink address, enter a scheme deeplink into the Deeplink URL field. Scheme deep links look like this: {YOUR_SCHEME}://...

    Also, If you're using a custom domain, make sure to enter your custom domain.

    3. Click one of the buttons listed below. Click the button depending on the deep link type you are testing.

    Note that you can only test deferred deep links if the app is not installed on your test device.

    #{"width":"120px"}

    Button

    #{"width":"240px"}

    Description

    #{"width":"140px"}

    Example

    Test HTTP Deeplink Type-1

    - You can test the HTTP deep link in the format of https://{your_app-name}.abr.ge.

    https://{your_app-name}.abr.ge/@{your_app-name}/test_sdk?...

    Test HTTP Deeplink Type-2

    - You can test the HTTP deep link in the format of https://abr.ge. The address format is different from Test HTTP Deeplink Type-1.

    https://abr.ge/@{your_app-name}/test_sdk?...

    Test Scheme Deeplink

    - You can test the scheme deep link.

    https://abr.ge/@{your_app-name}/test_sdk?...

    Test Deferred Deeplink

    - You can test the deferred deep link.

    https://abr.ge/@{your_app-name}/test_sdk?...

    Test Custom Domain Deeplink

    - You can test the custom domain. It is only available when a custom domain is entered.

    https://{your_custom_domain}/@{your_app-name}/test_sdk?...

    4. When the Deep Link Open event is successfully collected, you can find it on the [Raw Data]>[App Real-time Log] page in the Airbridge dashboard.

    Once you find the Deeplink Open event on the [Raw Data]>[App Real-time Log] page in the Airbridge dashboard, additional items must be confirmed. The items vary depending on the button that was clicked. If the deep link is functioning as intended, all items should be confirmed. Refer to the below information for the items that should be confirmed.

    Troubleshooting

    Refer to the information below for troubleshooting regarding deep links.

    Problem

    Solution

    You clicked a deep link, but the app was not launched. Or the SDK logs show information that is not intended as per setting.

    Check whether the deep link is set up correctly. Refer to this article for the deep linking setup.

    You clicked a deep link, and the app was launched, but you didn't land on the intended app page.

    You need to write code that redirects the user to the deep link path that is passed by the onSuccessfunction. Refer to this article for the deep linking setup.

    Was this page helpful?

    Have any questions or suggestions?