Google Mobile Ads Unity Plugin の更新 Vol.2 (2023年11月版)後編

こんにちは。ちでソフトです。
本記事では、Google Mobile Ads Unity プラグイン の更新作業について紹介しています。
こちらは後編になります。

スクリプトの編集

リワード広告

このクラスには、4つのメソッドが存在します。それぞれの役割をおおざっぱに説明しますと、

・・・となっていまして、コードを記述する際は数字の順に各メソッドが行われるようにします。
なお後述しますが、処理の順序はスマホ実機と開発環境（Unityエディタ）とでは一部が異なるので注意が必要です。

まず考慮するべき事は、スマホ実機においては、広告を読み込む処理に時間がかかるという点です。
（Unityエディタ上ではテスト広告がすぐに表示されるため、初学者は見落としやすいかもです）
通信環境にもよりますが、最低でも数秒はかかると見込んでおいたほうがいいでしょう。

よって、LoadAdメソッドが終了しないうちにShowAdメソッドが実行された場合に、プレイする側からしたら不自然な挙動にならないような工夫が必要になります。
たとえば、リワード報酬をもらうボタンがゲームシーン上にはじめから表示されていると、「アレ押しても何ももらえないじゃん？」という期間がわずかながらも発生します。
Updateメソッドを活用してローディングメッセージを表示させたり、LaodAdメソッドが終了するまではShowAdメソッドを行うボタンは表示させない、みたいな処理を追加したほうがよいでしょうか？

また、通信環境は常に安定しているとは限りません。
ユーザーが電車に乗ってプレイしている最中に通信が遮断された間は、リワード報酬はもらえないようにするべきなのか？またその旨や原因を通知する仕組みも必要なのかどうかも判断が必要になるでしょう（ここは記述やルールが甘すぎると、抜け道を見つけたとばかりにわざとスマホ本体の通信機能を常時オフにしてプレイするユーザーも出現するかもしれませんね）。

そもそもリワード広告を、ゲームにおけるどの位置に配置するべきか？またどういう報酬をどのように与えるのか？という課題もありますが、公式による定義を熟読することもおすすめします。

...
using GoogleMobileAds.Api;
using UnityEngine.SceneManagement;
...

public class Rewarded : MonoBehaviour
{
    // These ad units are configured to always serve test ads.
    #if UNITY_ANDROID
        private const string _adUnitId = "ca-app-pub-3940256099942544/5224354917";//テスト用のユニットID
    #elif UNITY_IPHONE
        private const string _adUnitId = "ca-app-pub-3940256099942544/1712485313";//テスト用のユニットID
    #else
        private const string _adUnitId = "unused";
    #endif

    private RewardedAd _rewardedAd;
    private bool IsEarnReward;

    // Start is called before the first frame update
    void Start()
    {

    }

    // Update is called once per frame
    void Update()
    {

    }

    /// <summary>
    /// Loads the ad.
    /// </summary>
    public void LoadAd()
    {
        // Clean up the old ad before loading a new one.
        if (_rewardedAd != null)
        {
            DestroyAd();
        }

        Debug.Log("Loading rewarded ad.");

        // Create our request used to load the ad.
        var adRequest = new AdRequest();

        // Send the request to load the ad.
        RewardedAd.Load(_adUnitId, adRequest, (RewardedAd ad, LoadAdError error) =>
        {
            // If the operation failed with a reason.
            // 何らかの理由で操作が失敗した場合。通信エラーなど。---------------※①
            if (error != null)
            {
                Debug.LogError("Rewarded ad failed to load an ad with error : " + error);
                return;
            }
            // If the operation failed for unknown reasons.
            // 不明な理由で操作が失敗した場合。
            // This is an unexpected error, please report this bug if it happens.
            // これは予期しないエラーです。発生した場合はこのバグを報告してください。----------※②
            if (ad == null)
            {
                Debug.LogError("Unexpected error: Rewarded load event fired with null ad and null error.");
                return;
            }

            // The operation completed successfully.
            // 操作は正常に完了しました。
            Debug.Log("Rewarded ad loaded with response : " + ad.GetResponseInfo());
            _rewardedAd = ad;

            // Register to ad events to extend functionality.
            // 機能を拡張するには広告イベントに登録します。
            RegisterEventHandlers(ad);//---------------※③
        });
    }

    /// <summary>
    /// Shows the ad.
    /// </summary>
    public void ShowAd()
    {
        if (_rewardedAd != null && _rewardedAd.CanShowAd())
        {
            Debug.Log("Showing rewarded ad.");//---------------※④
            _rewardedAd.Show((Reward reward) =>
            {
                Debug.Log(String.Format("Rewarded ad granted a reward: {0} {1}",
                                        reward.Amount,
                                        reward.Type));
                this.IsEarnReward = true;//---------------※⑤
            });
        }
        else
        {
            Debug.LogError("Rewarded ad is not ready yet.");
        }
    }

    /// <summary>
    /// Destroys the ad.
    /// </summary>
    public void DestroyAd()
    {
        if (_rewardedAd != null)
        {
            Debug.Log("Destroying rewarded ad.");
            _rewardedAd.Destroy();
            _rewardedAd = null;
        }
    }

    private void RegisterEventHandlers(RewardedAd ad)
    {
        // Raised when the ad is estimated to have earned money.
        // 広告が収益を上げたと推定される場合に発生します。
        ad.OnAdPaid += (AdValue adValue) =>
        {
            Debug.Log(String.Format("Rewarded ad paid {0} {1}.",
                adValue.Value,
                adValue.CurrencyCode));
        };
        // Raised when an impression is recorded for an ad.
        // 広告のインプレッションが記録されるときに発生します。
        ad.OnAdImpressionRecorded += () =>
        {
            Debug.Log("Rewarded ad recorded an impression.");
        };
        // Raised when a click is recorded for an ad.
        // 広告のクリックが記録されたときに発生します。
        ad.OnAdClicked += () =>
        {
            Debug.Log("Rewarded ad was clicked.");
        };
        // Raised when the ad opened full screen content.
        // 広告が全画面コンテンツを開いたときに発生します。
        ad.OnAdFullScreenContentOpened += () =>
        {
            Debug.Log("Rewarded ad full screen content opened.");
        };
        // Raised when the ad closed full screen content.
        // 広告が全画面コンテンツを閉じたときに発生します。
        // Unityエディター上では、_rewardedAd.Showよりも先に行われるので注意
        //---------------※⑥
        ad.OnAdFullScreenContentClosed += () =>
        {
            Debug.Log("Rewarded ad full screen content closed.");
            ChkEarnReward();
        };
        // Raised when the ad failed to open full screen content.
        // 広告が全画面コンテンツを開けなかった場合に発生します。
        ad.OnAdFullScreenContentFailed += (AdError error) =>
        {
            Debug.LogError("Rewarded ad failed to open full screen content with error : "
                + error);
        };
    }
    
    /// <summary>
    /// 説明用のメソッドです
    /// </summary>
    public void ChkEarnReward()
    {
        DestroyAd();//この実行もお忘れなく
        Debug.Log($"IsEarnReward:{this.IsEarnReward}");
        
        if (this.IsEarnReward)
        {
            SceneManager.LoadScene("OK");
        }
        else
        {
            SceneManager.LoadScene("NG");
        }
    }
}

例えば、ユーザーがリワード広告を閉じた直後に、ShowAdメソッドに指定した、※⑤の報酬を受け取ったかどうか（広告を最後まで視聴したかどうか）を確認したいとします。
IsEarnReward変数がtrueになったかどうかをチェックして、内容に応じてシーンの遷移先を分岐するChkEarnRewardメソッドを用意してみました（リワード広告の本来の性質や実装ルールをここでは考えずに、あくまでも説明のためのコードとします）。

このChkEarnRewardメソッドは、OnAdFullScreenContentClosedに追加しています。つまり広告が閉じられたら実行されるわけですね。

そして、Unityエディタおよびスマホ実機（ビルド済み）にて、それぞれ挙動を確認してみたところ・・・。

検証してみたところ、スマホ実機では広告を最後まで視聴した時点でShowAdメソッド内の報酬をもらえる処理（※⑤におけるIsEarnReward変数がtrueになる処理）が実施されるのですが、Unityエディタでは、テスト広告上の【Close Ad】ボタンを押せる段階になった後、押した際にOnAdFullScreenContentClosedが実施され、その直後に報酬をもらえる処理が動く仕様になっていました。

よって、今回の例でいえばUnityエディタ上ではChkEarnRewardメソッドによるチェックが行われる際にはIsEarnReward変数がfalseのままになっているため、結果としてこのような違いが生じてしまうのでした（以前のAdsでは見られなかった現象のはずですが・・・）。

実際にコードを記述される際は留意しておいていただければと存じます。

ビルドの注意点

Android

手順

Unityエディターの上部メニューより【Edit】→【Project Settings】→【Player】→【Publishing Settings】→「Minify」より以下を選択します。

・「Use R8」
・「Release」

以上

手順

1)【Edit】→【Project Settings】→【Player】→【Publishing Settings】→「Build」より以下を選択します。

・Custom Proguard File

2) 以下のテキストファイルを編集します。

Assets\Plugins\Android\proguard-user.txt

-keep class com.google.unity.** {
   *;
}

-keep public class com.google.android.gms.ads.** {
    public *;
}

-keep public class com.google.ads.** {
    public *;
}

以上

▼Logcatで取得したスマホ実機のキャプチャーです。これ、こういう時便利ですよね。

iOS

まとめにかえて

個人的なお話ですが、この記事を公開した背景としまして、前回の記事が思っていた以上にアクセス数があり、しかも内容に心残りがあったため、再びプラグインの導入に挑むことにいたしました。

その途上におきまして、とても驚くような出来事が起こりました。新しいバージョンが出ていた、というのもありますが・・・。深い悲しみに包まれ作業に力が入らなくなったものですが、今一度自分に何ができるのかを問い、あきらめることなく記事の完成に取り組んでみました。ITスクールの恩師からいただいた『一番大切なことは完成させること』という言葉も思い出しながら。

前編・後編併せまして、ようやく最低限必要な情報をお伝えするという使命は果たせたのではと思います。不十分と思われる方がいらっしゃるかもしれませんが、ご容赦くださいね。

皆さまの導入作業も無事に成功できますように！！
最後まで読んでいただきまして、どうもありがとうございました。