このページは Cloud Translation API によって翻訳されました。

開始する

Google User Messaging Platform（UMP）SDK は、プライバシーに関するユーザー設定の管理に役立つプライバシーとメッセージのツールです。詳しくは、プライバシーとメッセージについてをご覧ください。

前提条件

Android API レベル 21 以降（Android の場合）

メッセージタイプを作成する

AdMob アカウントの [プライバシーとメッセージ] タブで、利用可能なユーザー向けメッセージの種類のいずれかを使用してユーザー向けメッセージを作成します。UMP SDK は、プロジェクトで設定された AdMob アプリケーション ID から作成されたプライバシーメッセージを表示しようとします。

詳しくは、プライバシーとメッセージについてをご覧ください。

SDK をインストールする

手順に沿って Google Mobile Ads（GMA）C++ SDK をインストールします。UMP C++ SDK は GMA C++ SDK に含まれています。
続行する前に、プロジェクトでアプリの AdMob アプリ ID を構成してください。

コードで ConsentInfo::GetInstance() を呼び出して UMP SDK を初期化します。

Android では、NDK が提供する JNIEnv と Activity を渡す必要があります。これは、GetInstance() を初めて呼び出すときにのみ行う必要があります。
または、アプリで Firebase C++ SDK をすでに使用している場合は、GetInstance() を初めて呼び出すときに firebase::App を渡すことができます。

#include "firebase/gma/ump.h"

namespace ump = ::firebase::gma::ump;

// Initialize using a firebase::App
void InitializeUserMessagingPlatform(const firebase::App& app) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance(app);
}

// Initialize without a firebase::App
#ifdef ANDROID
void InitializeUserMessagingPlatform(JNIEnv* jni_env, jobject activity) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance(jni_env, activity);
}
#else  // non-Android
void InitializeUserMessagingPlatform() {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();
}
#endif

ConsentInfo::GetInstance() の呼び出しを繰り返しても、同じインスタンスが返されます。

UMP SDK の使用が完了したら、ConsentInfo インスタンスを削除して SDK をシャットダウンできます。

void ShutdownUserMessagingPlatform() {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();
  delete consent_info;
}

`Future` を使用して非同期オペレーションをモニタリングする

firebase::Future を使用すると、非同期メソッド呼び出しの完了ステータスを特定できます。

非同期で動作するすべての UMP C++ 関数とメソッド呼び出しは Future を返します。また、最新のオペレーションから Future を取得する「前回の結果」関数も提供します。

Future から結果を取得するには、次の 2 つの方法があります。

独自のコールバック関数を渡して OnCompletion() を呼び出します。このコールバック関数は、オペレーションの完了時に呼び出されます。
Future の status() を定期的に確認します。ステータスが kFutureStatusPending から kFutureStatusCompleted に変わると、オペレーションは完了です。

非同期オペレーションが完了したら、Future の error() を確認して、オペレーションのエラーコードを取得する必要があります。エラーコードが 0（kConsentRequestSuccess または kConsentFormSuccess）の場合、オペレーションは正常に完了しています。それ以外の場合は、エラーコードと error_message() を確認して問題の原因を特定します。

完了コールバック

次の例は、OnCompletion を使用して完了コールバックを設定する方法を示しています。このコールバックは、非同期オペレーションの完了時に呼び出されます。

void MyApplicationStart() {
  // [... other app initialization code ...]

  ump::ConsentInfo *consent_info = ump::ConsentInfo::GetInstance();

  // See the section below for more information about RequestConsentInfoUpdate.
  firebase::Future<void> result = consent_info->RequestConsentInfoUpdate(...);

  result.OnCompletion([](const firebase::Future<void>& req_result) {
    if (req_result.error() == ump::kConsentRequestSuccess) {
      // Operation succeeded. You can now call LoadAndShowConsentFormIfRequired().
    } else {
      // Operation failed. Check req_result.error_message() for more information.
    }
  });
}

更新ループポーリング

この例では、アプリの起動時に非同期オペレーションが開始された後、結果はゲームの更新ループ関数（フレームごとに 1 回実行）でチェックされます。

ump::ConsentInfo *g_consent_info = nullptr;
bool g_waiting_for_request = false;

void MyApplicationStart() {
  // [... other app initialization code ...]

  g_consent_info = ump::ConsentInfo::GetInstance();
  // See the section below for more information about RequestConsentInfoUpdate.
  g_consent_info->RequestConsentInfoUpdate(...);
  g_waiting_for_request = true;
}

// Elsewhere, in the game's update loop, which runs once per frame:
void MyGameUpdateLoop() {
  // [... other game logic here ...]

  if (g_waiting_for_request) {
    // Check whether RequestConsentInfoUpdate() has finished.
    // Calling "LastResult" returns the Future for the most recent operation.
    firebase::Future<void> result =
      g_consent_info->RequestConsentInfoUpdateLastResult();

    if (result.status() == firebase::kFutureStatusComplete) {
      g_waiting_for_request = false;
      if (result.error() == ump::kConsentRequestSuccess) {
        // Operation succeeded. You can call LoadAndShowConsentFormIfRequired().
      } else {
        // Operation failed. Check result.error_message() for more information.
      }
    }
  }
}

firebase::Future の詳細については、Firebase C++ SDK のドキュメントと GMA C++ SDK のドキュメントをご覧ください。

同意を得る

同意を得るには、次の手順を行います。

最新のユーザーの同意情報をリクエストします。
必要に応じて同意フォームを読み込んで提示します。

アプリの起動ごとに RequestConsentInfoUpdate() を使用して、ユーザーの同意情報の更新をリクエストする必要があります。このリクエストは、以下を確認します。

同意が必要かどうか。たとえば、初めて同意が必要な場合や、以前の同意決定が期限切れになっている場合です。
プライバシーオプションのエントリポイントが必要かどうか。プライバシーメッセージによっては、ユーザーがプライバシーオプションをいつでも変更できるようにアプリで設定する必要があります。

必要に応じてプライバシーメッセージフォームを読み込んで表示する

最新の同意ステータスを受け取ったら、LoadAndShowConsentFormIfRequired() を呼び出して、ユーザーの同意を収集するために必要なフォームを読み込みます。読み込み後、フォームがすぐに表示されます。

次のコードは、ユーザーの最新の同意情報をリクエストする方法を示しています。必要に応じて、コードがプライバシーメッセージフォームを読み込んで表示します。

#include "firebase/gma/ump.h"

namespace ump = ::firebase::gma::ump;

void MyApplicationStart(ump::FormParent parent) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  consent_info->RequestConsentInfoUpdate(params).OnCompletion(
    [*](const Future<void>& req_result) {
      if (req_result.error() != ump::kConsentRequestSuccess) {
        // req_result.error() is a kConsentRequestError enum.
        LogMessage("Error requesting consent update: %s", req_result.error_message());
      } else {
        consent_info->LoadAndShowConsentFormIfRequired(parent).OnCompletion(
        [*](const Future<void>& form_result) {
          if (form_result.error() != ump::kConsentFormSuccess) {
            // form_result.error() is a kConsentFormError enum.
            LogMessage("Error showing privacy message form: %s", form_result.error_message());
          } else {
            // Either the form was shown and completed by the user, or consent was not required.
          }
        });
      }
    });
}

完了コールバックではなく更新ループポーリングを使用して完了を確認する例については、上記をご覧ください。

ユーザーが選択を行うかフォームを閉じた後になんらかの措置が必要な場合は、そのロジックを LoadAndShowConsentFormIfRequired() によって返された Future を処理するコードに配置します。

プライバシーオプション

一部のプライバシーメッセージフォームは、パブリッシャーがレンダリングしたプライバシーオプションのエントリポイントから表示され、ユーザーはプライバシーオプションをいつでも管理できます。プライバシーオプションのエントリポイントでユーザーに表示されるメッセージの詳細については、使用可能なユーザーメッセージの種類をご覧ください。

広告をリクエスト

アプリで広告をリクエストする前に、ConsentInfo::GetInstance()‑> CanRequestAds() を使用してユーザーの同意を得ているかどうかを確認します。同意を得る際に確認する必要がある項目は 2 つあります。

現在のセッションで同意が得られた場合。
RequestConsentInfoUpdate() を呼び出した直後。前回のセッションで同意を得ている可能性があります。レイテンシに関するベストプラクティスとして、コールバックの完了を待たずに、アプリの起動後できるだけ早く広告の読み込みを開始することをおすすめします。

同意取得プロセス中にエラーが発生した場合でも、広告をリクエストできるかどうかを確認する必要があります。UMP SDK は、前のセッションの同意ステータスを使用します。

次の完全な例では更新ループポーリングを使用していますが、OnCompletion コールバックを使用して非同期オペレーションをモニタリングすることもできます。コード構造に適した手法を使用してください。

#include "firebase/future.h"
#include "firebase/gma/gma.h"
#include "firebase/gma/ump.h"

namespace gma = ::firebase::gma;
namespace ump = ::firebase::gma::ump;
using firebase::Future;

ump::ConsentInfo* g_consent_info = nullptr;
// State variable for tracking the UMP consent flow.
enum { kStart, kRequest, kLoadAndShow, kInitGma, kFinished, kErrorState } g_state = kStart;
bool g_ads_allowed = false;

void MyApplicationStart() {
  g_consent_info = ump::ConsentInfo::GetInstance(...);

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  g_consent_info->RequestConsentInfoUpdate(params);
  // CanRequestAds() can return a cached value from a previous run immediately.
  g_ads_allowed = g_consent_info->CanRequestAds();
  g_state = kRequest;
}

// This function runs once per frame.
void MyGameUpdateLoop() {
  // [... other game logic here ...]

  if (g_state == kRequest) {
    Future<void> req_result = g_consent_info->RequestConsentInfoUpdateLastResult();

    if (req_result.status() == firebase::kFutureStatusComplete) {
      g_ads_allowed = g_consent_info->CanRequestAds();
      if (req_result.error() == ump::kConsentRequestSuccess) {
        // You must provide the FormParent (Android Activity or iOS UIViewController).
        ump::FormParent parent = GetMyFormParent();
        g_consent_info->LoadAndShowConsentFormIfRequired(parent);
        g_state = kLoadAndShow;
      } else {
        LogMessage("Error requesting consent status: %s", req_result.error_message());
        g_state = kErrorState;
      }
    }
  }
  if (g_state == kLoadAndShow) {
    Future<void> form_result = g_consent_info->LoadAndShowConsentFormIfRequiredLastResult();

    if (form_result.status() == firebase::kFutureStatusComplete) {
      g_ads_allowed = g_consent_info->CanRequestAds();
      if (form_result.error() == ump::kConsentRequestSuccess) {
        if (g_ads_allowed) {
          // Initialize GMA. This is another asynchronous operation.
          firebase::gma::Initialize();
          g_state = kInitGma;
        } else {
          g_state = kFinished;
        }
        // Optional: shut down the UMP SDK to save memory.
        delete g_consent_info;
        g_consent_info = nullptr;
      } else {
        LogMessage("Error displaying privacy message form: %s", form_result.error_message());
        g_state = kErrorState;
      }
    }
  }
  if (g_state == kInitGma && g_ads_allowed) {
    Future<gma::AdapterInitializationStatus> gma_future = gma::InitializeLastResult();

    if (gma_future.status() == firebase::kFutureStatusComplete) {
      if (gma_future.error() == gma::kAdErrorCodeNone) {
        g_state = kFinished;
        // TODO: Request an ad.
      } else {
        LogMessage("Error initializing GMA: %s", gma_future.error_message());
        g_state = kErrorState;
      }
    }
  }
}

テスト

開発中のアプリで統合をテストする場合は、次の手順に沿ってプログラムでテストデバイスを登録します。アプリをリリースする前に、テストデバイス ID を設定するコードを必ず削除してください。

RequestConsentInfoUpdate()までお電話ください。

ログ出力で次のようなメッセージを確認します。ここには、デバイス ID とテストデバイスとしてデバイスを追加する方法が示されています。

Android

Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231")
to set this as a debug device.

iOS

<UMP SDK>To enable debug mode for this device,
set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]

テストデバイスの ID をクリップボードにコピーします。

ConsentRequestParameters.debug_settings.debug_device_ids をテストデバイス ID のリストに設定するようにコードを変更します。

void MyApplicationStart() {
  ump::ConsentInfo consent_info = ump::ConsentInfo::GetInstance(...);

  ump::ConsentRequestParameters params;
  params.tag_for_under_age_of_consent = false;
  params.debug_settings.debug_device_ids = {"TEST-DEVICE-HASHED-ID"};

  consent_info->RequestConsentInfoUpdate(params);
}

地域を強制的に適用する

UMP SDK では、debug_settings.debug_geography を使用して、デバイスが EEA や英国などのさまざまな地域にあるかのようにアプリの動作をテストできます。デバッグ設定はテスト用デバイスでのみ機能します。

void MyApplicationStart() {
  ump::ConsentInfo consent_info = ump::ConsentInfo::GetInstance(...);

  ump::ConsentRequestParameters params;
  params.tag_for_under_age_of_consent = false;
  params.debug_settings.debug_device_ids = {"TEST-DEVICE-HASHED-ID"};
  // Geography appears as EEA for debug devices.
  params.debug_settings.debug_geography = ump::kConsentDebugGeographyEEA

  consent_info->RequestConsentInfoUpdate(params);
}

同意ステータスをリセットする

UMP SDK でアプリをテストする際、ユーザーの初回インストールエクスペリエンスをシミュレーションできるように、SDK の状態をリセットすると便利な場合があります。SDK には、これを行う Reset() メソッドが用意されています。

  ConsentInfo::GetInstance()->Reset();