設定 UMP SDK

Google User Messaging Platform (UMP) SDK 是一項隱私權與訊息工具,可協助您管理隱私權選項。詳情請參閱「關於隱私權與訊息」。

建立訊息類型

在 AdMob 帳戶的「隱私權與訊息」分頁,使用可用的使用者訊息類型建立使用者訊息。UMP SDK 會嘗試顯示隱私權訊息,該訊息是根據專案中設定的 AdMob 應用程式 ID 建立。

詳情請參閱「關於隱私權與訊息」一文。

每次啟動應用程式時,請使用 requestConsentInfoUpdate() 要求更新使用者同意聲明資訊。這項要求會檢查下列項目:

  • 是否需要徵求同意。例如首次要求同意,或先前的同意決策已過期。
  • 是否需要隱私權選項進入點。部分隱私權訊息會要求應用程式允許使用者隨時修改隱私權選項。
@override
void initState() {
  super.initState();

  // Create a ConsentRequestParameters object.
  final params = ConsentRequestParameters();

  // Request an update to consent information on every app launch.
  ConsentInformation.instance.requestConsentInfoUpdate(
    params,
    () async {
      // Called when consent information is successfully updated.
    },
    (FormError error) {
      // Called when there's an error updating consent information.
    },
  );
}

載入並顯示隱私權訊息表單

取得最新同意聲明狀態後,請呼叫 loadAndShowConsentFormIfRequired(),載入收集使用者同意聲明所需的表單。載入後,表單會立即顯示。

@override
void initState() {
  super.initState();

  // Create a ConsentRequestParameters object.
  final params = ConsentRequestParameters();

  // Request an update to consent information on every app launch.
  ConsentInformation.instance.requestConsentInfoUpdate(
    params,
    () async {
      ConsentForm.loadAndShowConsentFormIfRequired((loadAndShowError) {
        if (loadAndShowError != null) {
          // Consent gathering failed.
        }

        // Consent has been gathered.
      });
    },
    (FormError error) {
      // Handle the error.
    },
  );
}

隱私權選項

部分隱私權訊息表單會從發布商顯示的隱私權選項進入點顯示,讓使用者隨時管理隱私權選項。如要進一步瞭解使用者在隱私權選項進入點看到的訊息,請參閱「可用的使用者訊息類型」。

檢查是否需要隱私權選項進入點

呼叫 requestConsentInfoUpdate() 後,請檢查 getPrivacyOptionsRequirementStatus(),判斷應用程式是否需要隱私權選項進入點。如果需要,請在應用程式中加入可見且可互動的 UI 元素,用於顯示隱私權選項表單。如果不需要隱私權進入點,請將 UI 元素設為不可見且無法互動。

/// Helper variable to determine if the privacy options entry point is required.
Future<bool> isPrivacyOptionsRequired() async {
  return await ConsentInformation.instance
      .getPrivacyOptionsRequirementStatus() ==
      PrivacyOptionsRequirementStatus.required;
}

如需隱私權選項規定狀態的完整清單,請參閱 PrivacyOptionsRequirementStatus。

顯示隱私權選項表單

使用者與元素互動時,顯示隱私權選項表單:

ConsentForm.showPrivacyOptionsForm((formError) {
  if (formError != null) {
    debugPrint("${formError.errorCode}: ${formError.message}");
  }
});

在使用者同意的情況下請求廣告

請求廣告前,請先使用 canRequestAds() 確認是否已取得使用者同意:

await ConsentInformation.instance.canRequestAds()

以下列出幾個地方,可供您確認是否能在收集同意聲明時請求廣告:

  • UMP SDK 在目前工作階段收集同意聲明後。
  • 呼叫 requestConsentInfoUpdate() 後立即呼叫。UMP SDK 可能已在先前的應用程式工作階段中取得同意聲明。

如果收集同意聲明的過程發生錯誤,請檢查是否能請求廣告。UMP SDK 會使用先前應用程式工作階段的同意聲明狀態。

避免重複執行廣告請求作業

在收集同意聲明並呼叫 requestConsentInfoUpdate() 後,您會檢查 canRequestAds(),請確保邏輯能防止重複的廣告請求,以免兩次檢查都傳回 true。例如,使用布林值變數。

測試

如要在開發應用程式時測試整合,請按照下列步驟,透過程式輔助註冊測試裝置。發布應用程式前,請務必先移除用來設定測試裝置 ID 的程式碼。

  1. 歡迎致電requestConsentInfoUpdate()。
  2. 檢查記錄輸出內容,看是否有類似以下範例的訊息,指出裝置 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]
    
  3. 將測試裝置 ID 複製到剪貼簿。

  4. 修改程式碼,呼叫 ConsentDebugSettings.testIdentifiers 並傳遞測試裝置 ID 清單。

    ConsentDebugSettings debugSettings = ConsentDebugSettings(
      testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
    );
    
    ConsentRequestParameters params =
        ConsentRequestParameters(consentDebugSettings: debugSettings);
    
    ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
      // ...
    };
    

強制指定地理位置

UMP SDK 可讓您測試應用程式的行為,就像裝置位於不同區域 (例如歐洲經濟區 (EEA)、英國和瑞士),方法是使用 debugGeography。請注意,偵錯設定僅適用於測試裝置。

ConsentDebugSettings debugSettings = ConsentDebugSettings(
  debugGeography: DebugGeography.debugGeographyEea,
  testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
);

ConsentRequestParameters params =
    ConsentRequestParameters(consentDebugSettings: debugSettings);

ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
  // ...
};

使用 UMP SDK 測試應用程式時,建議您重設 SDK 狀態,模擬使用者首次安裝的體驗。SDK 提供 reset() 方法來執行這項操作。

ConsentInformation.instance.reset();

GitHub 上的範例

如要查看本頁涵蓋的 UMP SDK 整合完整範例,請參閱 Flutter 範例。