> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Huawei SDK 설정
> Android Studio를 위한 OneSignal Huawei SDK 설정 가이드.
## 개요
이 가이드는 Huawei AppGallery에 배포되는 Huawei 앱에 OneSignal 푸시 알림을 통합하는 방법을 설명합니다.
이 지침은 Java 또는 Kotlin으로 작성된 네이티브 앱을 위한 것입니다. 다른 지원되는 SDK는 다음을 참조하세요:
***
## 요구 사항
* [Android Studio](https://developer.android.com/studio)
* "Huawei App Gallery"가 설치된 Huawei 기기
* 구성된 OneSignal 앱 및 플랫폼
***
### OneSignal 앱 및 플랫폼 구성
지원하는 플랫폼(Apple (APNs), Google (FCM), Huawei (HMS), Amazon (ADM))으로 OneSignal 앱을 구성하세요.
조직에 이미 OneSignal 계정이 있는 경우 조직에 [초대를 요청](/docs/ko/manage-team-members)하세요. 그렇지 않은 경우 [무료 계정에 가입](https://onesignal.com)하여 시작하세요.
**New App/Website**를 클릭하여 새 앱을 만들거나 **설정 > 푸시 및 인앱**에서 기존 앱에 플랫폼을 추가합니다. 구성하려는 플랫폼을 선택하고 **Next: Configure Your Platform**을 클릭합니다.
플랫폼에 대한 자격 증명을 입력합니다:
* **Android**: [Firebase 자격 증명 설정](/docs/ko/android-firebase-credentials)
* **iOS**: [p8 토큰(권장)](/docs/ko/ios-p8-token-based-connection-to-apns) 또는 [p12 인증서](/docs/ko/ios-p12-generate-certificates)
* **Amazon**: [API 키 생성](/docs/ko/generate-an-amazon-api-key)
* **Huawei**: [OneSignal 권한 부여](/docs/ko/authorize-onesignal-to-send-huawei-push)
자격 증명을 입력한 후 **Save & Continue**를 클릭합니다.
**앱 ID**가 최종 화면에 표시됩니다. 복사하고 저장하세요 — SDK를 초기화할 때 필요합니다. SDK 플랫폼을 선택한 다음 설정 가이드를 따릅니다.
***
## 설정
### 1. OneSignal SDK 설정
OneSignal Android SDK 설정 가이드를 따라 SDK를 앱에 구현하세요.
Huawei AppGallery에 출시되는 앱 빌드에는 Firebase/Google 설정이 필요하지 않습니다.
### 2. Huawei 구성 (agconnect-services.json)
다른 Huawei 서비스를 설정하면서 Android Studio 프로젝트에 이미 Huawei `agconnect-services.json`이 있는 경우 이 단계를 건너뛸 수 있습니다.
[AppGallery Connect 프로젝트 목록](https://developer.huawei.com/consumer/en/service/josp/agc/index.html#/myProject)에서 앱을 선택합니다.
"agconnect-services.json" 버튼을 클릭하여 이 파일을 다운로드합니다.
이 파일을 Android Studio의 앱 디렉토리에 배치합니다.
### 3. 서명 인증서 지문 생성
다른 Huawei 서비스를 위해 Huawei의 대시보드에 SHA-256 인증서 지문을 이미 추가한 경우 이 단계를 건너뛸 수 있습니다.
Android Studio에서 **View > Tool Windows > Gradle**로 이동합니다.
여기서 **app > Tasks > android > signingReport**를 선택합니다.
`release` 변형에 대한 `SHA-256`을 복사합니다.
* 빠른 테스트를 위해 `debug` 변형에 대한 `SHA-256`도 권장됩니다.
* 프로젝트에 다른 사용자 지정 변형이 있는 경우 푸시 지원이 필요하면 이것들도 복사합니다.
[AppGallery Connect 프로젝트 목록](https://developer.huawei.com/consumer/en/service/josp/agc/index.html#/myProject)에서 앱을 선택합니다.
하단으로 스크롤하여 키를 입력해야 하는 "SHA-256 certificate fingerprint" 필드를 찾습니다.
### 4. Huawei gradle 플러그인 및 의존성 추가
Android Studio에서 루트 `build.gradle` (Project: )을 열고 `buildscript { repositories }` 및 `allprojects { repositories }` 아래에 ` maven {url 'https://developer.huawei.com/repo/'}`를 추가합니다.
`settings.gradle.kts` 파일을 열고 `pluginManagement { repositories }` 및 `dependencyResolutionManagement { repositories }` 아래에 `maven {url 'https://developer.huawei.com/repo/'}`를 추가합니다.
`buildscript { dependencies }` 아래에 `classpath 'com.huawei.agconnect:agcp:1.9.1.301'`을 추가합니다.
루트 `build.gradle`에 총 3개의 새 줄이 있어야 하며, 아래에 강조 표시되어 있습니다.
`app/build.gradle` 파일을 열고 `dependencies` 섹션 아래에 `implementation 'com.huawei.hms:push:6.3.0.304'`를 추가합니다.
또한 `app/build.gradle` 파일의 맨 아래에 `apply plugin: 'com.huawei.agconnect'`를 추가합니다.
`app/build.gradle`에 총 2개의 새 줄이 있어야 하며, 아래에 강조 표시되어 있습니다.
저장 후 나타나는 배너에서 "Sync Now"를 누르세요!
***
## 추가 구성 단계
### 다른 HMS 푸시 라이브러리 또는 자체 `HmsMessageService` 클래스와의 호환성
다음의 경우 필요합니다:
* OneSignal 외에 앱에 다른 HMS 푸시 SDK/라이브러리가 있는 경우
* 자체 `HmsMessageService`가 있는 경우
아직 없는 경우 `HmsMessageService`에서 확장하는 클래스를 생성하고 다음 메서드를 추가합니다.
이미 `HmsMessageService`를 확장하는 클래스가 있는 경우 다른 클래스를 생성하는 대신 두 개의 새로운 `OneSignalHmsEventBridge` 라인을 추가하세요.
```java Java theme={null}
public class YourHmsMessageService extends HmsMessageService {
public void onNewToken(String token) {
// ...
// Forward event on to OneSignal SDK
OneSignalHmsEventBridge.onNewToken(this, token);
}
@Override
public void onMessageReceived(RemoteMessage message) {
// ...
// Forward event on to OneSignal SDK
OneSignalHmsEventBridge.onMessageReceived(this, message);
}
}
```
이는 `OneSignalHmsEventBridge`를 통해 `onNewToken` 및 `onMessageReceived`를 OneSignal로 전달하기 위한 것입니다.
이전에 `HmsMessageService`를 확장하는 클래스가 없었다면 `` 태그 아래의 `AndroidManifest.xml`에 추가해야 합니다.
```xml AndroidManifest.xml theme={null}
...
...
```
### Huawei AppGallery 빌드에 대한 Google 라이브러리 생략 (선택 사항)
앱이 Huawei AppGallery에서만 사용 가능하고 OneSignal이 포함하는 Google 관련 의존성을 생략하려는 경우 `app/build.gradle`에서 `implementation`과 함께 `exclude`를 사용할 수 있습니다.
```groovy app/build.gradle theme={null}
implementation('com.onesignal:OneSignal:[5.4.0, 5.99.99]') {
exclude group: 'com.google.android.gms'
exclude group: 'com.google.firebase'
}
```
앱이 Google Play 스토어와 Huawei AppGallery 모두에 사용되고 APK를 더 작게 만들기 위해 포함할 라이브러리를 선택적으로 지정하려는 경우 buildTypes 또는 variants를 기반으로 의존성을 추가할 수 있습니다. 예시:
```groovy app/build.gradle theme={null}
android {
// ...
buildTypes {
debug {
}
release {
}
// **** Add your custom hauwei buildType here
huawei {
}
}
}
dependencies {
// \*\*\*\* Use the full OneSignal dependencies for Google Play Store builds
debugImplementation 'com.onesignal:OneSignal:[5.0.0, 5.99.99]'
releaseImplementation 'com.onesignal:OneSignal:[5.0.0, 5.99.99]'
// **** Only include hms:push for your Huawei AppGallery builds.
huaweiImplementation 'com.huawei.hms:push:6.3.0.304'
// Omit Google / Firebase libraries for Huawei builds.
huaweiImplementation('com.onesignal:OneSignal:[5.0.0, 5.99.99]') {
exclude group: 'com.google.android.gms'
exclude group: 'com.google.firebase'
}
}
```
### FCM보다 HMS 우선 사용 (선택 사항)
***위에서 Huawei AppGallery 빌드에 대해 [Google 라이브러리를 생략](./huawei-sdk-setup#omit-google-libraries-for-huawei-appgallery-builds-optional)한 경우 이 단계는 적용되지 않습니다.***
기본적으로 OneSignal은 앱에 둘 다 포함된 경우 HMS보다 FCM 사용을 선호합니다. 대신 HMS를 선호하도록 변경하려면 `AndroidManifest.xml`에 다음을 추가할 수 있습니다:
```xml xml theme={null}
...
...
```
***
## Huawei 문제 해결
테스트하는 동안 [OneSignal setLogLevel 메서드](./mobile-sdk-reference#setloglevel)를 VERBOSE로 설정해야 합니다.
로그를 확인하여 발생하는 오류와 [Huawei 일반 오류 코드](https://developer.huawei.com/consumer/en/doc/development/HMS-2-References/hmssdk_huaweipush_api_reference_errorcode)를 확인하세요.
OneSignal SDK로 Huawei `pushToken`을 등록할 때 `6003` 오류를 방지하려면 디버그 또는 릴리스 키스토어 서명을 생성해야 할 수 있습니다(올바른 앱 빌드 경로 `debug` 또는 `release` 선택). ["서명 구성" 섹션](https://developer.huawei.com/consumer/en/doc/HMS-Guides/Preparations#h2-1584707362385)을 참조하세요.
`"notification_types":-25`는 OneSignal이 푸시 토큰을 얻기 위해 Huawei의 HMS로부터 응답을 기다리다가 시간 초과되었음을 의미합니다. 이는 OneSignal 대신 다른 제3자 HMS 푸시 SDK 또는 자체 HmsMessageService가 이 이벤트를 받기 때문일 가능성이 높습니다.
이 경우 [이를 확인하고 이벤트를 전달하는 방법에 대한 단계](#compatibility-with-other-hms-push-libraries-or-your-own-hmsmessageservice-class)를 검토하세요.
이는 푸시에 필요한 클래스가 앱에서 누락되었음을 의미합니다. `build.gradle`에 `com.huawei.hms:push`만 있으면 이 특정 오류가 더 이상 발생하지 않습니다. 그러나 공격적인 Proguard 또는 R8 설정이 있는 경우 문제가 발생할 수 있습니다. 문제의 근본 원인인지 확인하기 위해 `minifyEnabled`를 일시적으로 끄는 것이 좋습니다.
또한 다른 HMS 라이브러리의 주요 릴리스 버전을 혼합해서는 안 됩니다. 4 또는 5 중 하나로 시작하세요. 3에서 5까지 혼합하지 않도록 주의하세요. 이는 다른 오류를 생성합니다.
```
E/OneSignal: HMS ApiException getting Huawei push token!
com.huawei.hms.common.ApiException: -5: Core error
```
Proguard 또는 R8 규칙이 올바르게 설정되어 있는지 확인하세요. 관련이 있는지 확인하기 위해 일시적으로 비활성화할 수 있습니다. Proguard 또는 R8을 비활성화한 후 문제가 해결되면 이 가이드를 따라 다시 활성화할 수 있습니다. ["서명 구성" 섹션](https://developer.huawei.com/consumer/en/doc/HMS-Guides/Preparations#h2-1584707362385)을 참조하세요.
## 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.
1. Go to **Device Manager** in Android Studio.
2. Select your emulator device and click **Edit**.
3. Go to **Additional Settings** or **More**.
4. Set the **Boot option** to **Cold Boot**.
5. Save changes and restart the emulator.
### Check mobile subscriptions
The native push permission prompt should appear automatically if you added the `requestPermission` method during initialization.
Before accepting the prompt, check the OneSignal dashboard:
* Go to **Audience > Subscriptions**.
* You should see a new entry with the status "Never Subscribed".
The subscription's status should now show **Subscribed**.
You have successfully created a [mobile subscription](/docs/en/subscriptions).
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 users
test users are helpful for testing a push notification before sending a message.
In the dashboard, next to the subscription, click the **Options (three dots)** button and select **Add to Test Users**.
Name the subscription so you can easily identify your device later in the **test users tab**.
Go to **Audience > Segments > New Segment**.
Name the segment `Test Users` (the name is important because it will be used later).
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
In your OneSignal dashboard, go to **Settings > [Keys & IDs](/docs/en/keys-and-ids)**.
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 theme={null}
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 in your terminal.
If all setup steps were completed successfully, the test users 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.
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.
You have successfully sent a notification via our API to a segment.
* No image received? Your [Notification Service Extension](#ios-setup) might be missing.
* No confirmed receipt? Review the troubleshooting guide [here](/docs/en/confirmed-delivery#troubleshooting-confirmed-delivery).
* 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](/docs/en/in-app-messages-setup) let you communicate with users while they are using your app.
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](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* 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.
Under **Schedule > How often do you want to show this message?** select **Every time trigger conditions are satisfied**.
Click **Make Message Live** so it is available to your Test Users each time they open the app.
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](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* Still in the `Test Users` segment?
* If you reinstalled or switched devices, re-add the device to [Test Users](#set-up-test-users) and confirm it's part of the Test Users segment.
* Having issues?
* Follow [Getting a Debug Log](/docs/en/capturing-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](/docs/en/subscriptions), setting [Test Users](/docs/en/find-set-test-subscriptions), and creating [Segments](/docs/en/segmentation).
* Sending [Push](/docs/en/push) with images and [Confirmed receipt](/docs/en/confirmed-delivery) using Segments and our [Create message](/reference/create-message) API.
* Sending [In-app messages](/docs/en/in-app-messages-setup).
Continue with this guide to identify users in your app and setup additional features.
***
## User identification
Previously, we demonstrated how to create mobile [Subscriptions](/docs/en/subscriptions). Now we'll expand to identifying [Users](/docs/en/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](/docs/en/integrations)).
Set the External ID with our SDK's [`login` method](/docs/en/mobile-sdk-reference#login-external-id) 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 Tags
[Tags](/docs/en/add-user-data-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](/docs/en/message-personalization) and [Segmentation](/docs/en/segmentation) allowing for more advanced use cases.
Set tags with our SDK [`addTag` and `addTags` methods](/docs/en/mobile-sdk-reference#data-tags) 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](/docs/en/mobile-sdk-reference#addemail-%2C-removeemail) to create email subscriptions.
* Use the [`addSms` method](/docs/en/mobile-sdk-reference#addsms-%2C-removesms) 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](/reference/view-user).
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.
***
### Privacy & user consent
To control when OneSignal collects user data, use the SDK's consent gating methods:
* [`setConsentRequired(true)`](/docs/en/mobile-sdk-reference#setconsentrequired): Prevents data collection until consent is given.
* [`setConsentGiven(true)`](/docs/en/mobile-sdk-reference#setconsentgiven): Enables data collection once consent is granted.
See our Privacy & security docs for more on:
* [Data collected by the SDK](/docs/en/data-collected-by-the-onesignal-sdk)
* [Handling personal data](/docs/en/handling-personal-data)
***
## 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](/docs/en/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](/docs/en/mobile-sdk-reference) for more details.
### Push notification events
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-push): Detect when a notification is tapped. Helpful for [Deep Linking](/docs/en/deep-linking).
* [`addForegroundLifecycleListener()`](/docs/en/mobile-sdk-reference#addforegroundlifecyclelistener-push): Control how notifications behave in foreground.
For full customization, see [Mobile Service Extensions](/docs/en/service-extensions).
### User state changes
* [`addObserver()` for user state](/docs/en/mobile-sdk-reference#addobserver-user-state): Detect when the External ID is set.
* [`addPermissionObserver()`](/docs/en/mobile-sdk-reference#addpermissionobserver-push): Track the user's specific interaction with the native push permission prompt.
* [`addObserver()` for push subscription](/docs/en/mobile-sdk-reference#addobserver-push-subscription-changes): Track when the push subscription status changes.
### In-app message events
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app): Handle in-app click actions. Ideal for deep linking or tracking events.
* [`addLifecycleListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).
***
## Advanced setup & capabilities
Explore more capabilities to enhance your integration:
* [🔁 Migrating to OneSignal from another service](/docs/en/migrating-to-onesignal)
* [🌍 Location tracking](/docs/en/mobile-sdk-reference#location)
* [🔗 Deep Linking](/docs/en/deep-linking)
* [🔌 Integrations](/docs/en/integrations)
* [🧩 Mobile Service Extensions](/docs/en/service-extensions)
* [🛎️ Action buttons](/docs/en/action-buttons)
* [🌐 Multi-language messaging](/docs/en/multi-language-messaging)
* [🛡️ Identity Verification](/docs/en/identity-verification)
* [📊 Custom Outcomes](/docs/en/custom-outcomes)
* [📲 Live Activities](/docs/en/live-activities)
### Mobile SDK setup & reference
Make sure you've enabled all key features by reviewing the [Mobile push setup](/docs/en/mobile-push-setup) guide.
For full details on available methods and configuration options, visit the [Mobile SDK reference](/docs/en/mobile-sdk-reference).
Congratulations! You've successfully completed the Mobile SDK setup guide.
***
도움이 필요하신가요?
지원 팀과 채팅하거나 `support@onesignal.com`으로 이메일을 보내주세요.
다음을 포함해 주세요:
* 발생한 문제의 세부 정보 및 재현 단계(가능한 경우)
* OneSignal 앱 ID
* External ID 또는 Subscription ID(해당하는 경우)
* OneSignal 대시보드에서 테스트한 메시지의 URL(해당하는 경우)
* 관련 [로그 또는 오류 메시지](/docs/ko/capturing-a-debug-log)
기꺼이 도와드리겠습니다!
***