> ## 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.
# モバイルサービスエクステンション
> アプリにiOSおよびAndroid通知サービスエクステンションを実装します。
通知サービスエクステンションを使用すると、ユーザーに表示される前にプッシュ通知をインターセプトして変更できます。
OneSignalから送信されたプッシュ通知のデータには、[OSNotificationクラス](./osnotification-payload)を介してアクセスできます
***
## Android通知サービスエクステンション
ユーザーに表示される前に通知を処理できます。一般的なユースケースには次のものがあります:
* 通知を表示するかどうかに関わらず、バックグラウンドでデータを受信します。
* カスタムアクセントカラー、バイブレーションパターン、または利用可能なその他の`NotificationCompat`オプションなど、クライアント側アプリロジックに応じて特定の通知設定を上書きします。
詳細については、[AndroidのNotificationCompatオプションに関するドキュメント](https://developer.android.com/reference/androidx/core/app/NotificationCompat)を参照してください。
### ステップ1: サービスエクステンション用のクラスを作成する
`INotificationServiceExtension`を拡張し、`onNotificationReceived`メソッドを実装するクラスを作成します。
メソッド`onNotificationReceived`パラメータは、[INotificationReceivedEvent](https://github.com/OneSignal/OneSignal-Android-SDK/blob/25924dc3739fbe3ae64a73efc7b504449a18cdea/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/notifications/INotificationReceivedEvent.kt#L46)型の`event`です。
```Java Java theme={null}
package your.package.name
import androidx.annotation.Keep;
import com.onesignal.notifications.IActionButton;
import com.onesignal.notifications.IDisplayableMutableNotification;
import com.onesignal.notifications.INotificationReceivedEvent;
import com.onesignal.notifications.INotificationServiceExtension;
@Keep // Keep is required to prevent minification from renaming or removing your class
public class NotificationServiceExtension implements INotificationServiceExtension {
@Override
public void onNotificationReceived(INotificationReceivedEvent event) {
IDisplayableMutableNotification notification = event.getNotification();
if (notification.getActionButtons() != null) {
for (IActionButton button : notification.getActionButtons()) {
// you can modify your action buttons here
}
}
/* Add customizations here. See examples below for additional methods to modify the notification*/
}
}
```
```kotlin Kotlin theme={null}
package your.package.name
import androidx.annotation.Keep
import com.onesignal.notifications.INotificationReceivedEvent
import com.onesignal.notifications.INotificationServiceExtension
@Keep
class NotificationServiceExtension : INotificationServiceExtension {
override fun onNotificationReceived(event: INotificationReceivedEvent) {
val notification = event.notification
val context = event.context
notification.actionButtons?.forEach { button ->
// Modify action buttons here
}
}
}
```
`@Keep`アノテーションは、ProGuard/R8がミニファイ中にクラスの名前変更や削除を行わないようにするために必要です。
### ステップ2: 通知をカスタマイズする
以下は、上記のテンプレート通知サービスエクステンションクラスに実装できる一般的な例です。
`event.preventDefault()`を呼び出すと通知の自動表示を阻止し、手動で表示するかまったく表示しないかを決定できます。
```Java Java theme={null}
event.preventDefault();
//Do some async work, then decide to show or dismiss
new Thread(() -> {
try {
Thread.sleep(1000);
} catch (InterruptedException ignored) {}
//Manually show the notification
event.getNotification().display();
}).start();
```
```Kotlin Kotlin theme={null}
event.preventDefault()
//Do some async work, then decide to show or dismiss
Thread{
try {
Thread.sleep(1000)
} catch (ingored: InterruptedException) {}
//Manually show the notification
event.notification.display()
}.start()
```
`event.preventDefault()`を呼び出した後に`display()`を呼び出さない場合、通知は警告なしに静かに破棄されます。詳細については[重複通知](./duplicated-notifications#android-notification-service-extension)を参照してください。
```Java Java theme={null}
String promoCode = notification.getAdditionalData() != null
? notification.getAdditionalData().optString("promo_code", null)
: null;
if (promoCode != null) {
String updatedBody = notification.getBody() + " Use code: " + promoCode;
notification.setExtender(builder -> {
builder.setContentText(updatedBody);
});
}
```
```Kotlin Kotlin theme={null}
val promoCode = notification.additionalData?.optString("promo_code", null)
promoCode?.let {
val updatedBody = "${notification.body}\nUse code: $promoCode"
notification.setExtender { builder ->
builder.setContentText(updatedBody)
}
}
```
```Java Java theme={null}
int iconResId = R.drawable.icon_default;
String type = notitifcation.getAdditionalData() != null
? notification.getAdditionalData().optString("type", "")
: "";
switch (type) {
case "sale":
iconResId = R.drawable.icon_sale;
break;
case "reminder":
iconResId = R.drawable.icon_reminder;
break;
}
int finalIconResId = iconResId;
notification.setExtender(builder -> {
builder.setColor(0xFF0000FF).setSmallIcon(finalIconResId);
});
```
```Kotlin Kotlin theme={null}
val type = notification.additionalData?.optString("type", "") ?: ""
val iconResId = when (type) {
"sale" -> R.drawable.icon_sale
"reminder" -> R.drawable.icon_reminder
else -> R.drawable.icon_default
}
notification.setExtender { builder ->
builder.setColor(0xFF0000FF).setSmallIcon(iconResId)
}
```
ここで参照するアイコンはアプリの`res/drawable`ディレクトリに存在する必要があります。
### ステップ3: サービスエクステンションを`AndroidManifest.xml`に追加する
アプリケーションタグ内の`AndroidManifest.xml`ファイルにクラス名と値を`meta-data`として追加します。「未使用」の警告は無視してください。
```XML XML theme={null}
```
`com.onesignal.example.NotificationServiceExtension`をクラスの完全修飾名に置き換えてください。
***
## iOS通知サービスエクステンション
[UNNotificationServiceExtension](https://developer.apple.com/reference/usernotifications/unnotificationserviceextension)を使用すると、ユーザーに表示される前にプッシュ通知のコンテンツを変更でき、次のような他の重要な機能にも必要です:
* [画像とリッチメディア](./rich-media)
* [配信確認](./confirmed-delivery)
* [バッジ](./badges)
* [アクションボタン](./action-buttons)
* [Firebase Analyticsによる影響を受けた開封](./google-analytics-for-firebase)
アプリの[モバイルSDKセットアップ](./mobile-sdk-setup)の手順に従った場合は、エクステンションはすでに設定されているはずです。このセクションでは、OneSignal通知ペイロードデータにアクセスする方法と、発生している可能性のある問題をトラブルシューティングする方法について説明します。
### iOSプッシュペイロードの取得
`didReceive(_:withContentHandler:)`のオーバーライドは`OneSignalExtension.didReceiveNotificationExtensionRequest`を呼び出します。このメソッドが呼び出される前に、`bestAttemptContent`を読み取ったり変更したりできます。
この例では、次のデータを含む通知を送信します:
```json JSON theme={null}
{
"app_id": "YOUR_APP_ID",
"target_channel": "push",
"headings": {"en": "The message title"},
"contents": {"en": "The message contents"},
"data":{
"additional_data_key_1":"value_1",
"additional_data_key_2":"value_2"
},
"include_subscription_ids": ["SUBSCRIPTION_ID_1"]
}
```
`userInfo`の`custom`ディクショナリ内の`a`キーを介してOneSignalNotificationServiceExtension内でこの追加の`data`にアクセスします:
```swift Swift theme={null}
if let bestAttemptContent = bestAttemptContent {
if let customData = bestAttemptContent.userInfo["custom"] as? [String: Any],
let additionalData = customData["a"] as? [String: Any] {
if let jsonData = try? JSONSerialization.data(withJSONObject: additionalData, options: .prettyPrinted),
let jsonString = String(data: jsonData, encoding: .utf8) {
print("The additionalData dictionary in JSON format:\n\(jsonString)")
} else {
print("Failed to convert additionalData to JSON format.")
}
}
if let messageData = bestAttemptContent.userInfo["aps"] as? [String: Any],
let apsData = messageData["alert"] as? [String: Any],
let body = apsData["body"] as? String,
let title = apsData["title"] as? String {
print("The message contents is: \(body), message headings is: \(title)")
} else {
print("Unable to retrieve apsData")
}
OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest,
with: bestAttemptContent,
withContentHandler: self.contentHandler)
}
```
```objc Objective-C theme={null}
if (bestAttemptContent) {
NSDictionary *customData = bestAttemptContent.userInfo[@"custom"];
if ([customData isKindOfClass:[NSDictionary class]]) {
NSDictionary *additionalData = customData[@"a"];
if ([additionalData isKindOfClass:[NSDictionary class]]) {
NSError *error;
NSData *jsonData = [NSJSONSerialization dataWithJSONObject:additionalData options:NSJSONWritingPrettyPrinted error:&error];
if (jsonData) {
NSString *jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
NSLog(@"The additionalData dictionary in JSON format:\n%@", jsonString);
} else {
NSLog(@"Failed to convert additionalData to JSON format: %@", error.localizedDescription);
}
}
}
NSDictionary *messageData = bestAttemptContent.userInfo[@"aps"];
if ([messageData isKindOfClass:[NSDictionary class]]) {
NSDictionary *apsData = messageData[@"alert"];
if ([apsData isKindOfClass:[NSDictionary class]]) {
NSString *body = apsData[@"body"];
NSString *title = apsData[@"title"];
if ([body isKindOfClass:[NSString class]] && [title isKindOfClass:[NSString class]]) {
NSLog(@"The message content is: %@, message heading is: %@", body, title);
}
} else {
NSLog(@"Unable to retrieve apsData");
}
}
[OneSignalExtension didReceiveNotificationExtensionRequest:self.receivedRequest
withNotification:bestAttemptContent
withContentHandler:self.contentHandler];
}
```
**コンソール出力例:**
```
The additionalData dictionary in JSON format:
{
"additional_data_key_1" : "value_1",
"additional_data_key_2" : "value_2"
}
The message contents is: The message contents, message headings is: The message title
```
### iOS通知サービスエクステンションのトラブルシューティング
このガイドは、iOSモバイルアプリで画像、アクションボタン、または配信確認が表示されない問題をデバッグするためのものです。
#### Xcode設定を確認する
**General > Targets**で、**メインアプリターゲット**と**OneSignalNotificationServiceExtension**ターゲットが同じで正しいことを確認してください:
* **サポートされる送信先**
* **最小デプロイメント**（iOS 14.5以上）
Cocoapodsを使用している場合は、ビルドエラーを回避するために、これらがPodfileのメインターゲットと一致することを確認してください。
**OneSignalNotificationServiceExtension > Info**タブで続けて、`NSExtension`キーを展開します。次のことが表示されることを確認してください:
```XML XML theme={null}
NSExtensionPointIdentifier
com.apple.usernotifications.service
NSExtensionPrincipalClass
$(PRODUCT_MODULE_NAME).NotificationService
```
例:
Objective-Cを使用している場合は、`$(PRODUCT_MODULE_NAME).NotificationService`の代わりに`NotificationService`を使用してください。
#### 「インストール時のみコピー」をオフにする
**メインアプリターゲット > Build Phases > Embed App Extensions**を選択します。「インストール時のみコピー」がチェックされていないことを確認してください。チェックされている場合は、チェックを外してください:
### iOS通知サービスエクステンションのデバッグ
通知サービスエクステンションが正しくセットアップされていることを確認するには、次の手順に従ってください。
#### 1. OneSignalNotificationServiceExtensionコードを更新する
`NotificationService.m`または`NotificationService.swift`を開き、ファイルの内容全体を以下のコードに置き換えます。これにより、エクステンションが実行されていることを確認するためのログが追加されます。
`YOUR_BUNDLE_ID`を実際のBundle IDに置き換えてください。
```Swift Swift theme={null}
import UserNotifications
import OneSignalExtension
import os.log
class NotificationService: UNNotificationServiceExtension {
var contentHandler: ((UNNotificationContent) -> Void)?
var receivedRequest: UNNotificationRequest!
var bestAttemptContent: UNMutableNotificationContent?
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
self.receivedRequest = request
self.contentHandler = contentHandler
self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
let userInfo = request.content.userInfo
let custom = userInfo["custom"]
print("Running NotificationServiceExtension: userInfo = \(userInfo.description)")
print("Running NotificationServiceExtension: custom = \(custom.debugDescription)")
os_log("%{public}@", log: OSLog(subsystem: "YOUR_BUNDLE_ID", category: "OneSignalNotificationServiceExtension"), type: OSLogType.debug, userInfo.debugDescription)
if let bestAttemptContent = bestAttemptContent {
print("Running NotificationServiceExtension")
bestAttemptContent.body = "[Modified] " + bestAttemptContent.body
OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest, with: bestAttemptContent, withContentHandler: self.contentHandler)
}
}
override func serviceExtensionTimeWillExpire() {
if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent {
OneSignalExtension.serviceExtensionTimeWillExpireRequest(self.receivedRequest, with: self.bestAttemptContent)
contentHandler(bestAttemptContent)
}
}
}
```
```objc Objective-C theme={null}
#import
#import "NotificationService.h"
@interface NotificationService ()
@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;
@end
@implementation NotificationService
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
self.receivedRequest = request;
self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];
NSUserDefaults *userDefault = [[NSUserDefaults alloc] initWithSuiteName:@"group.YOUR_BUNDLE_ID.onesignal"];
NSLog(@"NSE player_id: %@", [userDefault stringForKey:@"GT_PLAYER_ID"]);
NSLog(@"NSE app_id: %@", [userDefault stringForKey:@"GT_APP_ID"]);
NSLog(@"Running NotificationServiceExtension");
self.bestAttemptContent.body = [@"[Modified] " stringByAppendingString:self.bestAttemptContent.body];
[OneSignal.Debug setLogLevel:ONE_S_LL_VERBOSE];
[OneSignalExtension didReceiveNotificationExtensionRequest:self.receivedRequest
withNotification:self.bestAttemptContent
withContentHandler:self.contentHandler];
}
- (void)serviceExtensionTimeWillExpire {
[OneSignalExtension serviceExtensionTimeWillExpireRequest:self.receivedRequest
withNotification:self.bestAttemptContent];
self.contentHandler(self.bestAttemptContent);
}
@end
```
デバッグログタイプはコンソールで **Action > Include Debug Messages** を使用して有効にする必要があります。
#### 2. アクティブスキームを変更する
アクティブスキームを`OneSignalNotificationServiceExtension`に設定します。
#### 3. プロジェクトをビルドして実行する
実際のデバイスでXcodeでプロジェクトをビルドして実行します。
#### 4. コンソールを開く
Xcodeで、**Window > Devices and Simulators**を選択します。
デバイスが接続されているのが見えるはずです。**Open Console**を選択します。
#### 5. コンソールを確認する
コンソールで:
1. **Action > Include Debug Messages** を選択します
2. CATEGORYとして`OneSignalNotificationServiceExtension`を検索します
3. **Start** を選択します
このデバイスにメッセージを含む通知を送信します（[プッシュ通知](/reference/push-notification) APIから送信する場合は`contents`プロパティを使用します）。この例では、ペイロードは次のとおりです:
```curl cURL theme={null}
curl --request POST \
--url 'https://api.onesignal.com/notifications' \
--header 'Authorization: Key YOUR_API_KEY' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"app_id": "YOUR_APP_ID",
"target_channel": "push",
"headings": {"en": "The message title"},
"contents": {"en": "The message contents"},
"data":{"additional_data_key_1":"value_1","additional_data_key_2":"value_2"},
"include_subscription_ids": [
"SUBSCRIPTION_ID_1"
]
}'
```
アプリが実行されている場合と実行されていない場合の両方で、メッセージがログに記録されているのが見えるはずです。
メッセージが表示されない場合は、アプリからOneSignalを削除し、[モバイルSDKセットアップ](./mobile-sdk-setup)を再度実行して、インテグレーションが正しいことを確認してください。
## FAQ
**iOSで通知サービスエクステンションが実行されないのはなぜですか？**
エクステンションは`mutable-content`が設定されている場合にのみ実行されます。OneSignalは添付ファイルやアクションボタンがある場合に自動的にこれを設定します。Xcode設定が[トラブルシューティングセクション](#troubleshooting-the-ios-notification-service-extension)の要件と一致していることを確認してください。
**Androidで通知の表示を防ぐことはできますか？**
はい、`event.preventDefault()`を呼び出すと通知を抑制できます。後で`event.getNotification().display()`を呼び出して表示するか、呼び出さずに静かに破棄することもできます。詳細については[重複通知](./duplicated-notifications#android-notification-service-extension)を参照してください。
**AndroidでAnnotation @Keepは必要ですか？**
はい、`@Keep`アノテーションは、ProGuard/R8がミニファイ中に`INotificationServiceExtension`を実装するクラスの名前変更や削除を行わないようにするために必要です。
## 関連ページ
iOSおよびAndroid向けにOneSignal SDKをインストールして設定します。
プッシュ通知に画像、GIF、動画を添付します。
デバイスへの通知配信確認を追跡します。
すべてのプラットフォームでの重複プッシュ通知をトラブルシューティングします。