Unity SDK 설정

​

개요

​

OneSignal을 사용하여 Unity 앱용 푸시 알림 설정

​

요구사항

• Unity 2021.3 이상
• 구성된 OneSignal 앱 및 플랫폼

• Xcode 14+가 있는 macOS(설정 지침은 Xcode 16.2 사용)
• iOS 12+, iPadOS 12+ 또는 iOS 16.2+를 실행하는 Xcode 시뮬레이터가 있는 기기

• Google Play 스토어(서비스)가 설치된 Android 7.0+ 기기 또는 에뮬레이터

​

OneSignal 앱 및 플랫폼 구성

OneSignal 앱 구성을 위한 단계별 지침.

단일 OneSignal 앱에서 여러 플랫폼(iOS, Android, Huawei, Amazon, Web)을 관리할 수 있습니다.

1

앱 만들기 또는 선택

• 기존 앱에 플랫폼을 추가하려면 OneSignal 대시보드에서 설정 > 푸시 및 인앱으로 이동합니다.
• 처음부터 시작하려면 New App/Website를 클릭하고 프롬프트를 따릅니다.

새 앱 만들기를 보여주는 예제.

2

플랫폼 설정 및 활성화

• 앱 및 조직에 대해 명확하고 인식 가능한 이름을 선택합니다.
• 구성하려는 플랫폼(iOS, Android 등)을 선택합니다.
• Next: Configure Your Platform을 클릭합니다.

첫 번째 OneSignal 앱, 조직 및 채널 설정 예제.

3

플랫폼 자격 증명 구성

플랫폼에 따라 프롬프트를 따릅니다:

• Android: Firebase 자격 증명 설정
• iOS: p8 토큰(권장) 또는 p12 인증서
• Amazon: API 키 생성
• Huawei: OneSignal 권한 부여

자격 증명을 입력한 후 Save & Continue를 클릭합니다.

4

대상 SDK 선택

개발 플랫폼(예: iOS, Android, React Native, Unity)과 일치하는 SDK를 선택한 다음 Save & Continue를 클릭합니다.

문서로 이동할 사용 중인 SDK 선택.

5

SDK 설치 및 앱 ID 저장

플랫폼이 구성되면 OneSignal 앱 ID가 표시됩니다. 이 ID를 복사하고 저장하세요. SDK를 설치하고 초기화할 때 필요합니다.다른 사람과 협업하는 경우 Invite 버튼을 사용하여 개발자 또는 팀 구성원을 추가한 다음 Done을 클릭하여 설정을 완료합니다.

앱 ID를 저장하고 추가 팀 구성원을 초대합니다.

완료되면 선택한 플랫폼에 대한 SDK 설치 가이드를 따라 OneSignal 통합을 완료합니다.

​

설정

​

1. OneSignal Unity SDK 추가

• Unity Asset Store
• Unity Package Manager

1. Add to My Assets를 통해 계정에 SDK를 추가합니다.
2. Open in Unity를 클릭하여 Unity Editor 및 Package Manager를 시작합니다.
3. SDK를 다운로드하고 Import합니다.

My Assets의 OneSignal Unity SDK

4. 모든 파일을 가져오라는 프롬프트를 수락합니다.
5. Window > OneSignal SDK Setup으로 이동하여 체크리스트, 특히 Import OneSignal packages를 따릅니다.
6. 가져온 후 Unity가 레지스트리를 업데이트합니다. 설정 창에 표시된 나머지 설정 단계를 완료합니다.

OneSignal SDK 설정 창

​

2. 플랫폼 설정

​

iOS 설정

• 자동으로 서명(권장)
• 수동 프로비저닝

1. File > Build Settings > Player Settings로 이동합니다.
2. Other Settings 아래에서 Automatically Sign을 선택합니다.

Unity에서 자동 서명 활성화

​

Android 설정

1. Edit > Project Settings > Player > Android로 이동합니다.
2. Publishing Settings 아래에서 다음을 활성화합니다:

• Custom Main Gradle Template
• Custom Gradle Properties Template

3. Assets > External Dependency Manager > Android Resolver > Force Resolve를 실행합니다.

• Target API Level은 33+ 이상이어야 합니다(v5.0.6+).
• Minify가 활성화된 경우 OneSignal SDK Setup에서 Copy Android plugin to Assets를 실행하여 OneSignalConfig.androidlib를 사용합니다.
• Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res 내의 기본 아이콘을 자체 아이콘으로 교체합니다(소문자 파일 이름만, 밑줄 허용). 자세한 내용은 알림 아이콘 사용자 지정을 참조하세요.

​

Amazon 설정

 xmlns:amazon="http://schemas.amazon.com/apk/res/android"

<uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />
<permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" />

<amazon:enable-feature android:name="com.amazon.device.messaging" android:required="false"/>
<service android:name="com.onesignal.notifications.services.ADMMessageHandler" android:exported="false" />
<service android:name="com.onesignal.notifications.services.ADMMessageHandlerJob"
         android:permission="android.permission.BIND_JOB_SERVICE"
         android:exported="false" />
<receiver android:name="com.onesignal.notifications.receivers.ADMMessageReceiver"
          android:permission="com.amazon.device.messaging.permission.SEND" >
  <intent-filter>
    <action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
    <action android:name="com.amazon.device.messaging.intent.RECEIVE" />
    <category android:name="COM.YOUR.PACKAGE_NAME" />
  </intent-filter>
</receiver>

​

Huawei 설정

​

3. SDK 초기화

using OneSignalSDK;

void Start () {
  // Enable verbose logging for debugging (remove in production)
  OneSignal.Debug.LogLevel = LogLevel.Verbose;
  // Initialize with your OneSignal App ID
  OneSignal.Initialize("YOUR_APP_ID");
  // Use this method to prompt for push notifications.
  // We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
  await OneSignal.Notifications.RequestPermissionAsync(true);
}

​

Testing the OneSignal SDK integration

​

Check mobile subscriptions

1

Launch your app on a test device.

The native push permission prompt should appear automatically if you added the requestPermission method during initialization.

iOS and Android push permission prompts

2

Check your OneSignal dashboard

Before accepting the prompt, check the OneSignal dashboard:

• Go to Audience > Subscriptions.
• You should see a new entry with the status “Never Subscribed”.

Dashboard showing subscription with 'Never Subscribed' status

3

Return to the app and tap Allow on the prompt.

4

Refresh the OneSignal dashboard Subscription's page.

The subscription’s status should now show Subscribed.

Dashboard showing subscription with 'Subscribed' status

You have successfully created a mobile subscription. Mobile subscriptions are created when users first open your app on a device or if they uninstall and reinstall your app on the same device.

​

Set up test subscriptions

1

Add to Test Subscriptions.

In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.

Adding a device to Test Subscriptions

2

Name your subscription.

Name the subscription so you can easily identify your device later in the Test Subscriptions tab.

Dashboard showing the 'Name your subscription' field

3

Create a test users segment.

Go to Audience > Segments > New Segment.

4

Name the segment.

Name the segment Test Users (the name is important because it will be used later).

5

Add the Test Users filter and click Create Segment.

Creating a 'Test Users' segment with the Test Users filter

You have successfully created a segment of test users. We can now test sending messages to this individual device and groups of test users.

​

Send test push via API

1

Get your App API Key and App ID.

In your OneSignal dashboard, go to Settings > Keys & IDs.

2

Update the provided code.

Replace YOUR_APP_API_KEY and YOUR_APP_ID in the code below with your actual keys. This code uses the Test Users segment we created earlier.

Copy

Ask AI

curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'

3

Run the code.

Run the code in your terminal.

4

Check images and confirmed delivery.

If all setup steps were completed successfully, the test subscriptions should receive a notification with an image included:

Push notification with image on iOS and Android

Images will appear small in the collapsed notification view. Expand the notification to see the full image.

5

Check for confirmed delivery.

In your dashboard, go to Delivery > Sent Messages, then click the message to view stats.You should see the confirmed stat, meaning the device received the push.

Delivery stats showing confirmed delivery

If you’re on a Professional plan or higher, scroll to Audience Activity to see subscription-level confirmation:

Confirmed delivery at the device level in Audience Activity

You have successfully sent a notification via our API to a segment.

• No image received? Your Notification Service Extension might be missing.
• No confirmed delivery? Review the troubleshooting guide here.
• Having issues? Copy-paste the api request and a log from start to finish of app launch into a .txt file. Then share both with support@onesignal.com.

​

Send an in-app message

1

Close or background your app on the device.

This is because users must meet the in-app audience criteria before a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on how in-app messages are displayed.

2

Create an in-app message.

• In your OneSignal dashboard, navigate to Messages > In-App > New In-App.
• Find and select the Welcome message.
• Set your Audience as the Test Users segment we used previously.

Targeting the 'Test Users' segment with an in-app message

3

Customize the message content if desired.

Example customization of in-app Welcome message

4

Set Trigger to 'On app open'.

5

Schedule frequency.

Under Schedule > How often do you want to show this message? select Every time trigger conditions are satisfied.

In-app message scheduling options

6

Make message live.

Click Make Message Live so it is available to your Test Users each time they open the app.

7

Open the app and see the message.

After the in-app message is live, open your app. You should see it display:

Welcome in-app message shown on devices

Not seeing the message?

• Start a new session
  • You must close or background the app for at least 30 seconds before reopening. This ensures a new session is started.
  • For more, see how in-app messages are displayed.
• Still in the Test Users segment?
  • If you reinstalled or switched devices, re-add the device to Test Subscriptions and confirm it’s part of the Test Users segment.
• Having issues?
  • Follow Getting a Debug Log while reproducing the steps above. This will generate additional logging that you can share with support@onesignal.com and we will help investigate what’s going on.

​

User identification

​

Assign External ID

​

Add data tags

A user profile in OneSignal with a tag called "current_level" set to "6"

Segment editor showing a segment targeting users with a current_level value of greater than 4 and less than 10

Screenshot showing a push notification targeting the Level 5-10 segment with a personalized message

The push notification is received on an iOS and Android device with the personalized content

​

Add email and/or SMS subscriptions

• Use the addEmail method to create email subscriptions.
• Use the addSms method to create SMS subscriptions.

A user profile with push, email, and SMS subscriptions unified by External ID

​

Privacy & user consent

• setConsentRequired(true): Prevents data collection until consent is given.
• setConsentGiven(true): Enables data collection once consent is granted.

• Data collected by the SDK
• Handling personal data

​

Prompt for push permissions

​

Listen to push, user, and in-app events

​

Push notification events

• addClickListener(): Detect when a notification is tapped. Helpful for Deep Linking.
• addForegroundLifecycleListener(): Control how notifications behave in foreground.

​

User state changes

• addObserver() for user state: Detect when the External ID is set.
• addPermissionObserver(): Track the user’s specific interaction with the native push permission prompt.
• addObserver() for push subscription: Track when the push subscription status changes.

​

In-app message events

• addClickListener(): Handle in-app click actions. Ideal for deep linking or tracking events.
• addLifecycleListener(): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).

​

Advanced setup & capabilities

• 🔁 Migrating to OneSignal from another service
• 🌍 Location tracking
• 🔗 Deep Linking
• 🔌 Integrations
• 🧩 Mobile Service Extensions
• 🛎️ Action buttons
• 🌐 Multi-language messaging
• 🛡️ Identity Verification
• 📊 Custom Outcomes
• 📲 Live Activities

​

Mobile SDK setup & reference