プッシュ - NHN Cloud 使用ガイド

Game > Gamebase > Unreal SDK使用ガイド > プッシュ

ここでは各プラットフォームでプッシュ通知を使用するのに必要な設定方法を説明します。

Settings

AndroidやiOSでプッシュを設定する方法は、次の文書を参照してください。

Android
- Android Push Settings
- Firebase Notification Settings
iOS
- iOS Push Settings

[注意]

外部プラグインでプッシュ関連処理がある場合、Gamebaseプッシュ機能が正常に動作しない可能性があります。

Register Push

次のAPIを呼び出して、TOAST Pushに該当ユーザーを登録します。プッシュ同意(enablePush)、広告性プッシュ同意(enableAdPush)、夜間広告性プッシュ同意(enableAdNightPush)値をユーザーから受け取り、次のAPIを呼び出して登録を完了します。

[注意]

UserIDごとにプッシュ設定が異なる場合があり、プッシュトークンの有効期限切れも発生することがあるため、ログイン後は毎回registerPush APIを呼び出すことを推奨します。

API

Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS

void RegisterPush(const FGamebasePushConfiguration& Configuration, const FGamebaseErrorDelegate& Callback);
void RegisterPush(const FGamebasePushConfiguration& Configuration, const FGamebaseNotificationOptions& NotificationOptions, const FGamebaseErrorDelegate& Callback);

FGamebasePushConfiguration

Parameter	Mandatory(M) / Optional(O)	Values	Description
bPushEnabled	M	bool	プッシュ同意の有無
bAdAgreement	M	bool	広告性プッシュ同意の有無
bAdAgreementNight	M	bool	夜間広告性プッシュ同意の有無
bRequestNotificationPermission	O	bool	Android 13以上のOSでRegisterPush APIを呼び出した場合、Push権限リクエストポップアップを自動出力するかどうか default: true Androidに限る
bAlwaysAllowTokenRegistration	O	bool	ユーザーがプッシュ権限を拒否してもトークンを登録するかどうか trueに設定した場合、プッシュ権限を取得できなくてもトークンを登録します。 default: false iOSに限る

Example

void USample::RegisterPush(bool pushEnabled, bool adAgreement, bool adAgreementNight)
{
    FGamebasePushConfiguration Configuration;
    Configuration.bPushEnabled = pushEnabled;
    Configuration.bAdAgreement = adAgreement;
    Configuration.bAdAgreementNight = adAgreementNight;
    Configuration.bRequestNotificationPermission = bRequestNotificationPermission;
    Configuration.bAlwaysAllowTokenRegistration = bAlwaysAllowTokenRegistration;

    UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
    Subsystem->GetPush()->RegisterPush(Configuration, FGamebasePushConfigurationDelegate::CreateLambda([](const FGamebaseError* Error)
    {
        if (Gamebase::IsSuccess(Error))
        {
            UE_LOG(GamebaseTestResults, Display, TEXT("RegisterPush succeeded"));
        }
        else
        {
            UE_LOG(GamebaseTestResults, Display, TEXT("RegisterPush failed. (Error: %d)"), Error->Code);
        }
    }));
}

Notification Options

端末に表示する通知をどのような形式で表示するかをNotification Optionsで変更できます。
Notification Optionsは、AndroidManifest.xmlに設定したり、ランタイムにregisterPush APIを呼び出して変更できます。

Set Notification Options with RegisterPush in Runtime

RegisterPush APIを呼び出す時、FGamebaseNotificationOptionsの引数を追加して通知オプションを設定できます。 FGamebaseNotificationOptionsの作成者にGamebaseSubsystem->GetPush()->GetNotificationOptions()呼び出し結果を渡すと、現在の通知オプションで初期化されたオブジェクトが作成されるため、必要な値のみ変更できます。
設定可能な値は次のとおりです。

API	Parameter	Description
bForegroundEnabled	bool	アプリがフォアグラウンド状態の時の通知表示有無 default: false
bBadgeEnabled	bool	バッジアイコン使用有無 default: true
bSoundEnabled	bool	通知音使用有無 default: true iOS Only
Priority	int32	通知の優先順位。以下の5つの値を設定できます。 GamebaseNotificationPriority::Min : -2 GamebaseNotificationPriority::Low : -1 GamebaseNotificationPriority::Default : 0 GamebaseNotificationPriority::High : 1 GamebaseNotificationPriority::Max : 2 default: GamebaseNotificationPriority::High Android Only
SmallIconName	FString	通知用の小さなアイコンファイル名。設定しない場合、アプリアイコンが使用されます。 default: null Android Only
SoundFileName	FString	通知音ファイル名。Android 8.0未満のOSでのみ動作します。「res/raw」フォルダのmp3、wavファイル名を指定すると、通知音が変更されます。 default: null Android Only

Example

void USample::RegisterPushWithOption(bool pushEnabled, bool adAgreement, bool adAgreementNight, const FString& displayLanguage, bool foregroundEnabled, bool badgeEnabled, bool soundEnabled, int32 priority, const FString& smallIconName, const FString& soundFileName)
{
    FGamebasePushConfiguration Configuration;
    Configuration.bPushEnabled = pushEnabled;
    Configuration.bAdAgreement = adAgreement;
    Configuration.bAdAgreementNight = adAgreementNight;
    Configuration.bRequestNotificationPermission = bRequestNotificationPermission;
    Configuration.bAlwaysAllowTokenRegistration = bAlwaysAllowTokenRegistration;

    FGamebaseNotificationOptions NotificationOptions;
    NotificationOptions.bForegroundEnabled = bForegroundEnabled;
    NotificationOptions.bBadgeEnabled = bBadgeEnabled;
    NotificationOptions.bSoundEnabled = bSoundEnabled;
    NotificationOptions.Priority = Priority;
    NotificationOptions.SmallIconName = SmallIconName;
    NotificationOptions.SoundFileName = SoundFileName;

    UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
    Subsystem->GetPush()->RegisterPush(Configuration, NotificationOptions, FGamebaseErrorDelegate::CreateLambda([=](const FGamebaseError* Error)
    {
        if (Gamebase::IsSuccess(Error))
        {
            UE_LOG(GamebaseTestResults, Display, TEXT("RegisterPush succeeded"));
        }
        else
        {
            // Check the Error code and handle the Error appropriately.
            UE_LOG(GamebaseTestResults, Display, TEXT("RegisterPush failed. (Error: %d)"), Error->Code);
        }
    }));
}

Get NotificationOptions

プッシュを登録する時、既に設定している通知オプション値を取得します。

API

Supported Platforms

■ UNREAL_ANDROID ■ UNREAL_IOS

FGamebaseNotificationOptionsPtr GetNotificationOptions();

Example

void USample::GetNotificationOptions()
{
    auto NotificationOptions = UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
    Subsystem->GetPush()->GetNotificationOptions();
    if (result.IsValid())
    {
        NotificationOptions->ForegroundEnabled = true;
        NotificationOptions->SmallIconName = TEXT("notification_icon_name");

        FGamebasePushConfiguration Configuration;

        UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
        Subsystem->GetPush()->RegisterPush(Configuration, NotificationOptions, FGamebaseErrorDelegate::CreateLambda([=](const FGamebaseError* Error) { }));
    }
    else
    {
        UE_LOG(GamebaseTestResults, Display, TEXT("No GetNotificationOptions"));
    }
}

Request Push Settings

ユーザーのプッシュ設定を照会するには、次のAPIを利用します。コールバックされるPushConfiguration値でユーザー設定値を取得できます。

API

Supported Platforms ■ UNREAL_ANDROID ■ UNREAL_IOS

void QueryTokenInfo(const FGamebasePushTokenInfoDelegate& Callback);

// Legacy API
void QueryPush(const FGamebasePushConfigurationDelegate& Callback);

Example

void USample::QueryTokenInfo()
{
    UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
    Subsystem->GetPush()->QueryTokenInfo(FGamebasePushTokenInfoDelegate::CreateLambda([=](const FGamebasePushTokenInfo* TokenInfo, const FGamebaseError* Error)
    {
        if (Gamebase::IsSuccess(Error))
        {
            UE_LOG(GamebaseTestResults, Display, TEXT("QueryTokenInfo succeeded. (pushEnabled= %s, adAgreement= %s, adAgreementNight= %s, TokenInfo= %s)"),
                TokenInfo->PushEnabled ? TEXT("true") : TEXT("false"),
                TokenInfo->bAdAgreement ? TEXT("true") : TEXT("false"),
                TokenInfo->bAdAgreementNight ? TEXT("true") : TEXT("false"),
                *TokenInfo->Token);
        }
        else
        {
            UE_LOG(GamebaseTestResults, Display, TEXT("QueryTokenInfo failed. (Error: %d)"), Error->Code);
        }
    }));
}

FGamebasePushTokenInfo

Parameter	Values	Description
PushType	FString	Pushトークンタイプ
Token	FString	トークン
UserId	FString	ユーザーID
DeviceCountryCode	FString	国コード
Timezone	FString	標準時間帯
RegisteredDateTime	FString	トークンアップデート時間
LanguageCode	FString	言語設定
Agreement	FGamebasePushAgreement	受信同意有無
bSandbox	bool	sandboxかどうか(iOS Only)

FGamebasePushAgreement

Parameter	Values	Description
bPushEnabled	bool	通知表示同意有無
bAdAgreement	bool	広告性通知表示同意有無
bAdAgreementNight	bool	夜間広告性通知表示同意有無

Event Handling

プッシュメッセージが到着したときやプッシュメッセージをクリックしたときに、イベント処理を行うことができます。
イベントの登録方法はGamebaseEventHandlerガイドを参照してください。

Setting for APNS Sandbox

SandboxModeを有効にすると、APNS SandboxへPushを送信するように登録できます。
コンソールから送信する方法
- Pushメニューの対象からiOS Sandboxを選択した後、送信します。

API

Supported Platforms ■ UNREAL_IOS

void SetSandboxMode(bool isSandbox);

Example

void USample::SetSandboxMode(bool isSandbox)
{
    UGamebaseSubsystem* Subsystem = UGameInstance::GetSubsystem<UGamebaseSubsystem>(GetGameInstance());
    Subsystem->GetPush()->SetSandboxMode(isSandbox);
}

Error Handling

Error	Error Code	Description
PUSH_EXTERNAL_LIBRARY_ERROR	5101	NHN Cloud Pushライブラリエラーです。詳細エラーを確認してください。
PUSH_ALREADY_IN_PROGRESS_ERROR	5102	以前のプッシュAPIの呼び出しが完了しませんでした。以前のプッシュAPIのコールバックが実行された後に再度呼び出してください。
PUSH_UNKNOWN_ERROR	5999	定義されていないプッシュエラーです。全てのログをサポートへご送付ください。迅速に対応いたします。

エラーコードの一覧は、次の文書を参照してください。
- エラーコード

PUSH_EXTERNAL_LIBRARY_ERROR

このエラーはNHN Cloud Pushライブラリでエラーが発生した時に返されます。
NHN Cloud Pushライブラリで発生したエラー情報は詳細エラーに含まれており、詳細なエラーコードおよびメッセージは次のように確認できます。

GamebaseError* gamebaseError = Error; // GamebaseError object via callback

if (Gamebase::IsSuccess(Error))
{
    // succeeded
}
else
{
    UE_LOG(GamebaseTestResults, Display, TEXT("code: %d, message: %s"), Error->Code, *Error->Messsage);

    GamebaseInnerError* moduleError = gamebaseError.Error; // GamebaseError.Error object from external module
    if (moduleError.Code != GamebaseErrorCode::SUCCESS)
    {
        UE_LOG(GamebaseTestResults, Display, TEXT("moduleErrorCode: %d, moduleErrorMessage: %s"), moduleerror->Code, *moduleerror->Messsage);
    }
}

NHN Cloud Pushエラーコードを確認してください。
- Android
- iOS

Game > Gamebase > Unreal SDK使用ガイド > プッシュ

Settings

Register Push

FGamebasePushConfiguration

Notification Options

Set Notification Options with RegisterPush in Runtime

Get NotificationOptions

Request Push Settings

FGamebasePushTokenInfo

FGamebasePushAgreement

Event Handling

Setting for APNS Sandbox

Error Handling

目次