Unity SDK 설정

개요

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

Unity 앱에 푸시 알림을 통합하는 것은 사용자 참여 및 유지를 높이는 강력한 방법입니다. OneSignal의 Unity SDK는 iOS(APNS), Android(FCM), Amazon(ADM) 및 Huawei 기기를 지원하여 최소한의 노력으로 실시간 메시징을 가능하게 합니다. 모바일 게임이나 대화형 앱을 구축하든 이 가이드는 OneSignal을 빠르고 안정적으로 통합하는 데 도움이 됩니다.

요구사항

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

iOS 요구사항

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

Android 요구사항

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

OneSignal 앱 및 플랫폼 구성

푸시 알림에 필요한 설정 OneSignal로 푸시 알림 전송을 시작하려면 먼저 지원하는 모든 플랫폼(Apple (APNs), Google (FCM), Huawei (HMS) 및/또는 Amazon (ADM))으로 OneSignal 앱을 구성해야 합니다.

조직에 이미 OneSignal 계정이 있는 경우 관리자 역할로 초대를 요청하여 앱을 구성하세요. 그렇지 않은 경우 무료 계정에 가입하여 시작하세요.

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

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

앱 만들기 또는 선택

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

플랫폼 설정 및 활성화

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

플랫폼 자격 증명 구성

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

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

대상 SDK 선택

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

SDK 설치 및 앱 ID 저장

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

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

설정

1. OneSignal Unity SDK 추가

두 가지 설치 방법을 사용할 수 있습니다:

Unity Asset Store
Unity Package Manager

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

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

Edit > Project Settings > Package Manager로 이동합니다.

범위가 지정된 레지스트리를 추가합니다:

Name        npmjs
URL         https://registry.npmjs.org
Scope(s)    com.onesignal

Window > Package Manager를 열고 My Registries로 전환합니다.
원하는 OneSignal SDK 패키지를 설치합니다.
Window > OneSignal SDK Setup을 열고 최종 단계를 완료합니다.

2. 플랫폼 설정

앱이 지원하는 모든 플랫폼을 추가합니다.

iOS 설정

SDK가 필요한 Xcode 설정을 자동으로 구성합니다. 프로비저닝 접근 방식을 선택합니다:

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

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

Apple Developer 계정에 다음이 있는지 확인하세요:

앱 그룹: group.{your_bundle_id}.onesignal
Push Notifications 및 App Groups 활성화됨
번들 ID에 대한 프로비저닝 프로필 새로 고침됨

Android 설정

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

Custom Main Gradle Template
Custom Gradle Properties Template

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 설정

Amazon App Store를 통해 제공되는 Amazon 앱에만 필요합니다.

Amazon FireOS(ADM) 설정

Plugins/Android/AndroidManifest.xml을 편집하거나 생성합니다.
네임스페이스를 추가합니다:

 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" />

<application> 태그에 다음을 추가합니다:

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

모든 COM.YOUR.PACKAGE_NAME 인스턴스를 실제 패키지 이름으로 교체합니다.
api_key.txt를 Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/assets 아래에 배치합니다

이 파일을 만드는 데 도움이 필요하면 Amazon API 키 생성 가이드를 참조하세요.

Huawei 설정

Huawei App Gallery를 통해 제공되는 Huawei 앱에만 필요합니다.자세한 내용은 Huawei Unity SDK 설정을 참조하세요.

3. SDK 초기화

애플리케이션 수명 주기 초기에 MonoBehaviour의 Start() 메서드 내부에 이 코드를 추가합니다. OneSignal 대시보드 **설정 > 키 및 ID**에서 찾을 수 있는 OneSignal 앱 ID로 YOUR_APP_ID를 교체합니다.

OneSignal 앱에 액세스할 수 없는 경우 팀 구성원에게 초대하도록 요청하세요.

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

This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.

If you are testing with an Android emulator, it should start with a cold boot.

Go to Device Manager in Android Studio.
Select your emulator device and click Edit.
Go to Additional Settings or More.
Set the Boot option to Cold Boot.
Save changes and restart the emulator.

Check mobile subscriptions

Launch your app on a test device.

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

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

Return to the app and tap Allow on the prompt.

Refresh the OneSignal dashboard Subscription's page.

The subscription’s status should now show Subscribed.

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

Test subscriptions are helpful for testing a push notification before sending a message.

Add to Test Subscriptions.

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

Name your subscription.

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

Create a test users segment.

Go to Audience > Segments > New Segment.

Name the segment.

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

Add the Test Users filter and click Create Segment.

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

Get your App API Key and App ID.

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

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.

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"
}'

Run the code.

Run the code in your terminal.

Check images and confirmed delivery.

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

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

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.

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

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

In-app messages let you communicate with users while they are using your app.

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.

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.

Customize the message content if desired.

Set Trigger to 'On app open'.

Schedule frequency.

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

Make message live.

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

Open the app and see the message.

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

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.

You have successfully setup the OneSignal SDK and learned important concepts like:

Gathering Subscriptions, setting Test subscriptions, and creating Segments.
Sending Push with images and Confirmed Delivery using Segments and our Create message API.
Sending In-app messages.

Continue with this guide to identify users in your app and setup additional features.

User identification

Previously, we demonstrated how to create mobile Subscriptions. Now we’ll expand to identifying Users across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We’ll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.

Assign External ID

Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend’s user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for Integrations). Set the External ID with our SDK’s login method each time they are identified by your app.

OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.

Add data tags

Tags are key-value pairs of string data you can use to store user properties (like username, role, or preferences) and events (like purchase_date, game_level, or user interactions). Tags power advanced Message Personalization and Segmentation allowing for more advanced use cases. Set tags with our SDK addTag and addTags methods as events occur in your app. In this example, the user reached level 6 identifiable by the tag called current_level set to a value of 6.

We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:

Add email and/or SMS subscriptions

Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions.

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

If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates. You can view unified users via Audience > Users in the dashboard or with the View user API.

Best practices for multi-channel communication

Obtain explicit consent before adding email or SMS subscriptions.
Explain the benefits of each communication channel to users.
Provide channel preferences so users can select which channels they prefer.

To control when OneSignal collects user data, use the SDK’s consent gating methods:

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

See our Privacy & security docs for more on:

Prompt for push permissions

Instead of calling requestPermission() immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission. For best practices and implementation details, see our Prompt for push permissions guide.

Listen to push, user, and in-app events

Use SDK listeners to react to user actions and state changes. The SDK provides several event listeners for you to hook into. See our SDK reference guide for more details.

Push notification events

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

For full customization, see Mobile Service Extensions.

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

Explore more capabilities to enhance your integration:

Mobile SDK setup & reference

Make sure you’ve enabled all key features by reviewing the Mobile push setup guide. For full details on available methods and configuration options, visit the Mobile SDK reference.

Congratulations! You’ve successfully completed the Mobile SDK setup guide.

도움이 필요하신가요?지원 팀과 채팅하거나 support@onesignal.com으로 이메일을 보내주세요.다음을 포함해 주세요:

발생한 문제의 세부 정보 및 재현 단계(가능한 경우)
OneSignal 앱 ID
External ID 또는 Subscription ID(해당하는 경우)
OneSignal 대시보드에서 테스트한 메시지의 URL(해당하는 경우)
관련 로그 또는 오류 메시지

기꺼이 도와드리겠습니다!

개발자 문서

모바일 SDKs

웹 SDKs

실시간 현황

데스크탑 & 워치 설정

개요

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

요구사항

OneSignal 앱 및 플랫폼 구성

설정

1. OneSignal Unity SDK 추가

2. 플랫폼 설정

iOS 설정

Android 설정

Amazon 설정

Huawei 설정

3. SDK 초기화

Testing the OneSignal SDK integration

Check mobile subscriptions

Set up test subscriptions

Send test push via API

Send an in-app message

User identification

Assign External ID

Add data tags

Add email and/or SMS subscriptions

Prompt for push permissions

Listen to push, user, and in-app events

Push notification events

User state changes

In-app message events

Advanced setup & capabilities

Mobile SDK setup & reference

개발자 문서

모바일 SDKs

웹 SDKs

실시간 현황

데스크탑 & 워치 설정

​개요

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

​요구사항

​OneSignal 앱 및 플랫폼 구성

​설정

​1. OneSignal Unity SDK 추가

​2. 플랫폼 설정

​iOS 설정

​Android 설정

​Amazon 설정

​Huawei 설정

​3. SDK 초기화

​Testing the OneSignal SDK integration

​Check mobile subscriptions

​Set up test subscriptions

​Send test push via API

​Send an in-app message

​User identification

​Assign External ID

​Add data tags

​Add email and/or SMS subscriptions

​Privacy & user consent

​Prompt for push permissions

​Listen to push, user, and in-app events

​Push notification events

​User state changes

​In-app message events

​Advanced setup & capabilities

​Mobile SDK setup & reference

개요

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

요구사항

OneSignal 앱 및 플랫폼 구성

설정

1. OneSignal Unity SDK 추가

2. 플랫폼 설정

iOS 설정

Android 설정

Amazon 설정

Huawei 설정

3. SDK 초기화

Testing the OneSignal SDK integration

Check mobile subscriptions

Set up test subscriptions

Send test push via API

Send an in-app message

User identification

Assign External ID

Add data tags

Add email and/or SMS subscriptions

Privacy & user consent

Prompt for push permissions

Listen to push, user, and in-app events

Push notification events

User state changes

In-app message events

Advanced setup & capabilities

Mobile SDK setup & reference