Google I/O 2022 で発表された Firebase の最新情報をご覧ください。詳細

チュートリアル: AdMob 広告の表示頻度を最適化する

ステップ 3: アプリのコードで Remote Config のパラメータ値を処理する

概要: Firebase を使用して AdMob 広告の表示頻度を最適化する

ステップ 1: AdMob を使用して、テスト用の新しい広告ユニットバリアントを作成する

ステップ 2: Firebase コンソールで A/B テストを設定する

ステップ 3: アプリのコードで Remote Config のパラメータ値を処理する

ステップ 4: A/B テストを開始し、テスト結果を Firebase コンソールで確認する

ステップ 5: 新しい広告フォーマットを展開するかどうかを決める

前のステップの最後に、Remote Config パラメータ（INTERSTITIAL_AD_KEY）を作成しました。このステップでは、パラメータの値に基づいてアプリが表示する内容を決めるロジックをアプリのコードに追加します。

必要な SDK を追加する

アプリケーションコードで Remote Config を使用する前に、プロジェクトのビルドファイルに Remote Config SDK と Google アナリティクス用の Firebase SDK の両方を追加します。

Swift

Podfile に次の Pod を追加してインストールします。

pod 'Google-Mobile-Ads-SDK'
pod 'Firebase/Analytics'
pod 'Firebase/RemoteConfig'

Objective-C

Podfile に次の Pod を追加してインストールします。

pod 'Google-Mobile-Ads-SDK'
pod 'Firebase/Analytics'
pod 'Firebase/RemoteConfig'

Java

build.gradle ファイルに次のライブラリ依存関係を追加します。

implementation 'com.google.android.gms:play-services-ads:20.6.0'
implementation 'com.google.firebase:firebase-analytics:21.0.0'
implementation 'com.google.firebase:firebase-config:21.1.0'

Kotlin+KTX

build.gradle ファイルに次のライブラリ依存関係を追加します。

implementation 'com.google.android.gms:play-services-ads:20.6.0'
implementation 'com.google.firebase:firebase-analytics-ktx:21.0.0'
implementation 'com.google.firebase:firebase-config-ktx:21.1.0'

Unity

Firebase Unity SDK をダウンロードしてインストールしてから、プロジェクトに次の Unity パッケージを追加します。

FirebaseAnalytics.unitypackage
FirebaseRemoteConfig.unitypackage

Remote Config インスタンスを構成する

Remote Config のパラメータ値を使用するには、クライアントアプリインスタンスの新しい値を取得するように Remote Config インスタンスを構成します。

この例では、Remote Config が新しいパラメータ値を 1 時間ごとにチェックするように構成されています。

Swift

remoteConfig = RemoteConfig.remoteConfig()
let settings = RemoteConfigSettings()
settings.minimumFetchInterval = 3600
remoteConfig.configSettings = settings

Objective-C

self.remoteConfig = [FIRRemoteConfig remoteConfig];
FIRRemoteConfigSettings *remoteConfigSettings = [[FIRRemoteConfigSettings alloc] init];
remoteConfigSettings.minimumFetchInterval = 3600;
self.remoteConfig.configSettings = remoteConfigSettings;

Java

mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);

Kotlin+KTX

remoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

Unity

var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
var configSettings = new ConfigSettings {
  MinimumFetchInternalInMilliseconds =
        (ulong)(new TimeSpan(1, 0, 0).TotalMilliseconds)
};
remoteConfig.SetConfigSettingsAsync(configSettings)
        .ContinueWithOnMainThread(task => {
          Debug.Log("Config settings confirmed");
}

Remote Config を取得して有効にする

Remote Config のパラメータを取得して有効にし、新しいパラメータ値の使用を開始します。

この呼び出しは非同期で、Remote Config の値をプリフェッチしてアプリが表示する広告を認識する必要があるため、アプリの読み込みフェーズのできるだけ早い段階で、この呼び出しを行う必要があります。

Swift

remoteConfig.fetch() { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    self.remoteConfig.activate() { (changed, error) in
      // ...
    }
  } else {
    print("Config not fetched")
    print("Error: \(error?.localizedDescription ?? "No error available.")")
  }
  self.loadAdUnit()
}

Objective-C

[self.remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
    if (status == FIRRemoteConfigFetchStatusSuccess) {
        NSLog(@"Config fetched!");
      [self.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
        // ...
      }];
    } else {
        NSLog(@"Config not fetched");
        NSLog(@"Error %@", error.localizedDescription);
    }
    [self loadAdUnit];
}];

Java

mFirebaseRemoteConfig.fetchAndActivate()
        .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
            @Override
            public void onComplete(@NonNull Task<Boolean> task) {
                if (task.isSuccessful()) {
                    boolean updated = task.getResult();
                    Log.d(TAG, "Config params updated: " + updated);
                } else {
                    Log.d(TAG, "Config params failed to update");
                }
                loadAdUnit();
            }
        });

Kotlin+KTX

remoteConfig.fetchAndActivate()
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                val updated = task.result
                Log.d(TAG, "Config params updated: $updated")
            } else {
                Log.d(TAG, "Config params failed to update")
            }
            loadAdUnit()
        }

Unity

remoteConfig.FetchAndActivateAsync().ContinueWithOnMainThread(task => {
  if (task.IsFaulted) {
    Debug.LogWarning("Config params failed to update");
  } else {
    Debug.Log("Config params updated: " + task.Result);
  }
  LoadAdUnit();
});

これで、このチュートリアルの前半で設定した A/B テストで作成した Remote Config パラメータをアプリで処理できるようになりました。

Remote Config のパラメータ値を使用する

プリフェッチされた Remote Config 値を loadAdUnit() 関数で使用して、このアプリインスタンスに表示する広告頻度のバリアントを決定します。

Swift

private func loadAdUnit() {
  let adUnitId = remoteConfig["INTERSTITIAL_AD_KEY"].stringValue;
  let request = GADRequest()
  GADInterstitialAd.load(withAdUnitID: adUnitId,
                               request: request,
                     completionHandler: { [self] ad, error in
                       if let error = error {
                         print("Failed to load: \(error.localizedDescription)")
                         return
                       }
                       interstitial = ad
                       // Register for callbacks.
                     }
  )
}

// Register for callbacks.

Objective-C

- (void)loadAdUnit {
    NSString *adUnitId =
      self.remoteConfig[@"INTERSTITIAL_AD_KEY"].stringValue;

  GADRequest *request = [GADRequest request];
  [GADInterstitialAd loadAdWithAdUnitId:adUnitId
                         request:request
                         completionHandler:^(GADInterstitialAd *ad,
                             NSError *error) {
    if (error) {
      NSLog(@"Failed to load interstitial ad with error: %@",
        [error localizedDescription]);
      return;
    }

    self.interstitial = ad;
  }];
}

Java

private void loadAdUnit() {
    String adUnitId =
      mFirebaseRemoteConfig.getString("INTERSTITIAL_AD_KEY");

    // Load Interstitial Ad (assume adUnitId not null)
    AdRequest adRequest = new AdRequest.Builder().build();

    InterstitialAd.load(this, adUnitId, adRequest, new
        InterstitialAdLoadCallback() {
          @Override
          public void onAdLoaded(@NonNull InterstitialAd intertitialAd) {
            mInterstitialAd = interstitialAd;
          }

          @Override
          public void onAdFailedToLoad(@NonNull LoadAdError loadAdError) {
            mInterstitialAd = null;
          }
    });
}

Kotlin+KTX

private fun loadAdUnit() {
  String adUnitId = remoteConfig.getString("INTERSTITIAL_AD_KEY")
  var adRequest = AdRequestBuilder.Builder().build()

  AdRequestBuilder.load(this, adUnitId, adRequest, object :
    InterstitialAdLoadCallback() {
      override fun onAdFailedToLoad(adError: LoadAdError) {
        mInterstitialAd = null
      }

      override fun onAdLoaded(interstitialAd: InterstitialAd) {
        mInterstitialAd = interstitialAd
      }
    })
}

Unity

void LoadAdUnit() {

  // Note that you may want to encode and parse two sets of ad unit IDs for
  // Android / iOS in the Unity implementation.
  String adUnitId = remoteConfig.GetValue("INTERSTITIAL_AD_KEY").StringValue;
  this.interstitial = new InterstitialAd(adUnitId);
}

パラメータ値にその他のチェックを追加する

アプリケーションコードには、どの広告を読み込むのかを指示するために、Remote Config パラメータ値のチェックが必要になる箇所がほかにもあります。たとえば、ユーザーが現在の広告の表示を終了した後に、同じ広告を再度読み込むかどうかを決定できます。

パラメータ値の変更を取得するには、まず、取得と有効化の呼び出しを行う必要があります。たとえば、テストを終了するか、新しいテストを作成するかを決める場合です。

パラメータの値は、次の呼び出しを使用していつでも確認できます。

Swift

remoteConfig["INTERSTITIAL_AD_KEY"].stringValue

Objective-C

self.remoteConfig[@"INTERSTITIAL_AD_KEY"].stringValue;

Java

mFirebaseRemoteConfig.getString(INTERSTITIAL_AD_KEY)

Kotlin+KTX

remoteConfig.getString(INTERSTITIAL_AD_KEY)

Unity

remoteConfig.GetValue("INTERSTITIAL_AD_KEY").StringValue

これらの呼び出しは、アプリインスタンスがコントロールグループに配置されているか、新しい広告バリアントグループの一つに配置されているかに応じて、常に同じ値を返します。ただし、前の呼び出しで取得して有効にした変更が Firebase コンソールで行われている場合は除きます。

ステップ 2: Firebase コンソールで A/B テストを設定する ステップ 4: A/B テストを開始してテスト結果を確認する