リワード広告を設定する

リワード広告では、動画広告、体験プレイ広告、アンケートを操作したユーザーに報酬としてアプリ内アイテムを進呈できます。詳しくは、リワード広告ユニットの概要をご覧ください。

Google Mobile Ads SDK for React Native では、表示の遅延をなくし、ユーザーが報酬を獲得したときに広告を表示できるように、広告のプリロードを使用して、バックグラウンドでの読み込み、キャッシュ、バッファの補充を管理しています。

このガイドでは、React Native アプリにリワード広告を組み込む方法について説明します。

前提条件

先に進む前に、次のことを実施してください。

Android

ca-app-pub-3940256099942544/5224354917

iOS

ca-app-pub-3940256099942544/1712485313

広告のプリロードについて

Google Mobile Ads SDK for React Native の広告のプリロード機能により、広告の読み込みとキャッシュが自動化されます。

広告のプリロードには、次のようなメリットがあります。

  • 参照管理: 広告が表示されるまで参照を維持します。
  • 自動再読み込み: キャッシュから広告が取得されると、新しい広告が読み込まれます。
  • マネージド再試行: 広告の読み込みに失敗した場合に、新しい広告を読み込みます。
  • 有効期限の処理: 有効期限が切れる前に広告を更新します。
  • キャッシュの最適化: キャッシュの順序を最適化して、優先度の最も高い広告を配信します。

広告を手動で読み込むには、単一のリワード広告を読み込むをご覧ください。

プリロードを開始する

広告のプリロードを開始するには、RewardedAdPreloader.start メソッドを呼び出し、preloadId 値、構成設定、イベント コールバックを渡して、バッファ状態の変化をモニタリングします。

export function startRewardedAdPreloader(
  adUnitId: string,
  preloadId: string,
  customPreloadCallback?: PreloadCallback,
): boolean {
  const started = RewardedAdPreloader.start(
    preloadId,
    {
      request: {adUnitId},
      bufferSize: 2,
    },
    {
      // Called when an ad is preloaded into the buffer.
      onAdPreloaded: (event) => {
        console.log(`Rewarded ad preloaded for ${event.preloadId}`);
        customPreloadCallback?.onAdPreloaded?.(event);
      },
      // Called when an ad fails to preload.
      onAdFailedToPreload: (error: LoadAdError) => {
        console.error('Failed to preload rewarded ad:', error.message);
        customPreloadCallback?.onAdFailedToPreload?.(error);
      },
      // Called when all preloaded ads in the buffer have been shown.
      onAdsExhausted: () => {
        console.log('Rewarded ad buffer exhausted.');
        customPreloadCallback?.onAdsExhausted?.();
      },
    },
  );
  return started;
}

プリロード ID は、広告のプリロード構成を一意に識別する文字列です。アプリで単一のプリロード構成に広告ユニット ID を使用する場合は、その広告ユニット ID をプリロード ID として使用できます。アプリで同じ広告ユニット ID に複数のプリローダーが必要な場合は、プリロード ID ごとに異なる文字列を渡します。

アプリがバッファからプリロードされた広告をポーリングすると、Google Mobile Ads SDK for React Native はバックグラウンドで代替広告をリクエストしてバッファを補充します。バッファにプリロードされた広告が残っていない場合、Google Mobile Ads SDK for React Native は onAdsExhausted を呼び出します。

プリロード キャッシュの上限

Google Mobile Ads SDK for React Native は、すべての広告ユニットとプリロード ID にわたるプリロード広告の合計数に、アプリ全体の上限を適用します。

  • デフォルトの上限: Google は、最大 6 つのプリロードされた広告をメモリに保持します。この上限は、すべてのフォーマットとプリロード ID で共有されます。
  • 推奨されるバッファサイズ: プリロード ID ごとに 2 つ。

アプリがアプリ全体の上限に達すると、既存の広告がキャッシュからポーリングされるか破棄されるまで、プリロードされた広告のバックグラウンド リクエストが一時停止します。また、フルスクリーン広告が画面に表示されている間も、プリロードは一時的に停止します。

ポーリングして広告を表示する

広告を表示する前に、RewardedAdPreloader.isAdAvailable メソッドを呼び出して広告が利用可能であることを確認します。広告を取得するには、RewardedAdPreloader.pollAd メソッドを呼び出します。

広告の非表示や表示エラーなどの表示イベントをリッスンするには、show メソッドを呼び出す前に、広告インスタンスに adEventCallback プロパティを設定します。

次の例では、広告の可用性を確認し、広告を表示する前に表示イベントをリッスンしています。

export function showPreloadedRewardedAd(
  preloadId: string,
  onRewardEarned: (reward: Reward) => void,
  customAdEventCallback?: FullScreenAdEventCallback,
) {
  if (!RewardedAdPreloader.isAdAvailable(preloadId)) {
    console.log('No preloaded rewarded ad available right now.');
    return;
  }

  const ad = RewardedAdPreloader.pollAd(preloadId);
  if (!ad) {
    return;
  }

  ad.adEventCallback = {
    // Called when the ad is presented on screen.
    onAdShowedFullScreenContent: () => {
      console.log('Preloaded rewarded ad showed full screen content.');
      customAdEventCallback?.onAdShowedFullScreenContent?.();
    },
    // Called when the ad is closed by the user.
    onAdDismissedFullScreenContent: () => {
      console.log('Preloaded rewarded ad dismissed full screen content.');
      customAdEventCallback?.onAdDismissedFullScreenContent?.();
      ad.destroy();
    },
    // Called when presentation fails.
    onAdFailedToShowFullScreenContent: (error) => {
      console.error('Failed to show preloaded rewarded ad:', error);
      customAdEventCallback?.onAdFailedToShowFullScreenContent?.(error);
      ad.destroy();
    },
    // Called when an impression is recorded.
    onAdImpression: () => {
      console.log('Preloaded rewarded ad recorded an impression.');
      customAdEventCallback?.onAdImpression?.();
    },
    // Called when the user taps the ad.
    onAdClicked: () => {
      console.log('Preloaded rewarded ad was clicked.');
      customAdEventCallback?.onAdClicked?.();
    },
    // Called when the ad is estimated to have earned money.
    onAdPaid: (adValue) => {
      console.log(
        `Preloaded rewarded ad paid: ${adValue.amountMicros}` +
          ` ${adValue.currencyCode}`,
      );
      customAdEventCallback?.onAdPaid?.(adValue);
    },
  };

  ad.show(onRewardEarned);
}

メモリとリソースを解放するには、onAdDismissedFullScreenContent コールバックと onAdFailedToShowFullScreenContent コールバックで ad.destroy メソッドを呼び出します。

レスポンス情報を読み取る

キャッシュから広告を削除せずに、次にプリロードされる広告のレスポンス情報を検査するには、RewardedAdPreloader.peekAdResponseInfo メソッドを呼び出します。

export function peekRewardedAdResponseInfo(
  preloadId: string,
): ResponseInfo | null {
  const responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId);
  if (responseInfo) {
    console.log('Next preloaded rewarded ad response info:', responseInfo);
  }
  return responseInfo;
}

広告が利用可能な場合、peekAdResponseInfo メソッドは、読み込まれた広告ソースとネットワーク アダプターに関する情報を含む ResponseInfo オブジェクトを返します。

任意: サーバーサイド認証コールバックを検証する

サーバーサイド認証(SSV)コールバックで、ユーザー ID やカスタム リワード メタデータなどのカスタム認証パラメータがアプリで必要な場合は、show を呼び出す前に、ポーリングされた広告インスタンスに serverSideVerificationOptions プロパティを設定します。

設定した値は、SSV コールバックのクエリ パラメータに渡されます。

  • userId: user_id クエリ パラメータに渡され、ユーザーを識別します。
  • customData: カスタム メタデータを転送するために custom_data クエリ パラメータに渡します。

次の例では、広告を表示する前に、リワード広告オブジェクトに ServerSideVerificationOptions(customData と userId)を設定しています。

export function setServerSideVerificationRewarded(ad: RewardedAd) {
  ad.serverSideVerificationOptions = {
    userId: 'user_123',
    customData: 'sample_custom_data',
  };
}

リソースのクリーンアップ

セッションの残りの部分で特定のプリロード ID の広告を表示する必要がなくなった場合は、RewardedAdPreloader.destroy メソッドを呼び出します。このプロセスにより、そのプリロード ID のプリロードが停止し、未使用のプリロードされた広告がメモリから解放されます。

次の例では、プリロードを停止しています。

export function destroyRewardedAdPreloader(preloadId: string) {
  RewardedAdPreloader.destroy(preloadId);
}

ユーザーが広告を閉じた後、または広告の表示に失敗した後は、ポーリングされた個々の広告インスタンスを破棄します。詳しくは、広告をポーリングして表示するをご覧ください。

サンプル全体を表示する

次のコンポーネントの例では、マウント時にプリロードを開始し、利用可能な広告数を追跡して、プリロードされたリワード広告を表示するコントロールを提供します。

export function RewardedScreen() {
  const [numAdsAvailable, setNumAdsAvailable] = useState<number>(0);
  const [status, setStatus] = useState<string>('Preloader idle.');
  const [reward, setReward] = useState<string | null>(null);

  const refreshAdCount = () => {
    const count = RewardedAdPreloader.getNumAdsAvailable(PRELOAD_ID);
    setNumAdsAvailable(count);
  };

  useEffect(() => {
    // Start preloading ads on component mount
    const started = startRewardedAdPreloader(REWARDED_AD_UNIT_ID, PRELOAD_ID, {
      onAdPreloaded: () => {
        refreshAdCount();
        setStatus('Rewarded ad preloaded into buffer.');
      },
      onAdFailedToPreload: (error) => {
        setStatus(`Failed to preload rewarded ad: ${error.message}`);
      },
      onAdsExhausted: () => {
        refreshAdCount();
        setStatus('Preload buffer exhausted for rewarded ads.');
      },
    });
    if (started) {
      setStatus('Preloader started.');
    }

    // Clean up preloader resources on component unmount
    return () => {
      destroyRewardedAdPreloader(PRELOAD_ID);
    };
  }, []);

  const handleShowAd = () => {
    setReward(null);
    setStatus('Showing preloaded ad...');
    showPreloadedRewardedAd(
      PRELOAD_ID,
      (userReward) => {
        setReward(`${userReward.amount} ${userReward.type}`);
      },
      {
        onAdDismissedFullScreenContent: () => {
          setStatus('Ad dismissed.');
        },
        onAdFailedToShowFullScreenContent: (error) => {
          setStatus(`Failed to show preloaded ad: ${error.message}`);
        },
      },
    );
    refreshAdCount();
  };

  return (
    <View style={styles.container}>
      <Text style={styles.title}>Preload Rewarded Ads</Text>
      <Text style={styles.status}>Status: {status}</Text>
      <Text style={styles.status}>Ads Available: {numAdsAvailable}</Text>
      {reward && <Text style={styles.rewardText}>Earned: {reward}</Text>}
      <View style={styles.buttonGroup}>
        <Button
          title="Show Preloaded Ad"
          onPress={handleShowAd}
          disabled={numAdsAvailable === 0}
        />
      </View>
    </View>
  );
}

次のように置き換えます。

  • REWARDED_AD_UNIT_ID を実際の広告ユニット ID に置換。
  • PRELOAD_ID を実際のプリローダー ID に置換。

次のステップ

リワード広告を統合したら、次のトピックをご覧ください。