Bắt đầu

SDK Nền tảng thông báo cho người dùng (UMP) của Google là một công cụ về quyền riêng tư và thông báo giúp bạn quản lý các lựa chọn về quyền riêng tư. Để biết thêm thông tin, hãy xem bài viết Giới thiệu về công cụ Quyền riêng tư và thông báo.

Điều kiện tiên quyết

  • API Android cấp 21 trở lên

Tạo loại thông báo

Tạo thông báo cho người dùng bằng một trong các Loại thông báo cho người dùng hiện có trong thẻ Quyền riêng tư và thông báo của tài khoản Ad Manager. UMP SDK cố gắng hiển thị một thông báo về quyền riêng tư được tạo từ Mã nhận dạng ứng dụng Ad Manager được đặt trong dự án của bạn.

Để biết thêm thông tin, hãy xem bài viết Giới thiệu về quyền riêng tư và thông báo.

Cài đặt bằng Gradle

Thêm phần phụ thuộc cho SDK Nền tảng thông báo cho người dùng của Google vào tệp Gradle ở cấp ứng dụng trong mô-đun của bạn, thường là app/build.gradle:

dependencies {
  implementation("com.google.android.ump:user-messaging-platform:3.1.0")
}

Sau khi thay đổi build.gradle của ứng dụng, hãy nhớ đồng bộ hoá dự án của bạn với các tệp Gradle.

Thêm mã ứng dụng

Bạn có thể tìm thấy mã ứng dụng trong giao diện người dùng Ad Manager. Thêm mã nhận dạng vào AndroidManifest.xml bằng đoạn mã sau:

<manifest>
  <application>
    <meta-data
        android:name="com.google.android.gms.ads.APPLICATION_ID"
        android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
  </application>
</manifest>

Để lấy thông tin về sự đồng ý của người dùng, hãy làm như sau:

Khai báo một thực thể của ConsentInformation:

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit val consentInformation: ConsentInformation

Khởi chạy phiên bản ConsentInformation:

Java

consentInformation = UserMessagingPlatform.getConsentInformation(context);

Kotlin

consentInformation = UserMessagingPlatform.getConsentInformation(context)

Bạn nên yêu cầu cập nhật thông tin về trạng thái đồng ý của người dùng mỗi lần chạy ứng dụng, bằng cách sử dụng requestConsentInfoUpdate(). Yêu cầu này kiểm tra những điều sau:

  • Có cần có sự đồng ý hay không. Ví dụ: người dùng cần đồng ý lần đầu tiên hoặc quyết định đồng ý trước đó đã hết hạn.
  • Có bắt buộc phải có điểm truy cập các lựa chọn về quyền riêng tư hay không. Một số thông báo về quyền riêng tư yêu cầu ứng dụng cho phép người dùng sửa đổi các lựa chọn về quyền riêng tư của họ bất cứ lúc nào.

Java


// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
    activity,
    params,
    () -> // Called when consent information is successfully updated.
    requestConsentError -> // Called when there's an error updating consent information.
GoogleMobileAdsConsentManager.java

Kotlin


// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
  activity,
  params,
  {
    // Called when consent information is successfully updated.
  },
  { requestConsentError ->
    // Called when there's an error updating consent information.
  },
)
GoogleMobileAdsConsentManager.kt

Tải và trình bày biểu mẫu thông báo về quyền riêng tư

Sau khi nhận được trạng thái đồng ý mới nhất, hãy gọi loadAndShowConsentFormIfRequired() để tải mọi biểu mẫu cần thiết để thu thập sự đồng ý của người dùng. Sau khi tải, các biểu mẫu sẽ xuất hiện ngay lập tức.

Java


UserMessagingPlatform.loadAndShowConsentFormIfRequired(
    activity,
    formError -> {
      // Consent gathering process is complete.
    });
GoogleMobileAdsConsentManager.java

Kotlin


UserMessagingPlatform.loadAndShowConsentFormIfRequired(activity) { formError ->
  // Consent gathering process is complete.
}
GoogleMobileAdsConsentManager.kt

Các lựa chọn về quyền riêng tư

Một số biểu mẫu thông báo về quyền riêng tư được trình bày từ điểm truy cập các lựa chọn về quyền riêng tư do nhà xuất bản hiển thị, cho phép người dùng quản lý các lựa chọn về quyền riêng tư của họ bất cứ lúc nào. Để tìm hiểu thêm về những loại thông báo mà người dùng của bạn nhìn thấy tại điểm truy cập lựa chọn về quyền riêng tư, hãy xem Các loại thông báo hiện có cho người dùng.

Kiểm tra xem bạn có cần điểm truy cập các lựa chọn về quyền riêng tư hay không

Sau khi gọi requestConsentInfoUpdate(), hãy kiểm tra getPrivacyOptionsRequirementStatus() để xác định xem ứng dụng của bạn có cần một điểm truy cập các lựa chọn về quyền riêng tư hay không. Nếu cần một điểm truy cập, hãy thêm một phần tử giao diện người dùng có thể nhìn thấy và tương tác vào ứng dụng của bạn để trình bày biểu mẫu các lựa chọn về quyền riêng tư. Nếu không bắt buộc phải có một điểm truy cập vào quyền riêng tư, hãy định cấu hình phần tử giao diện người dùng của bạn để không hiển thị và tương tác được.

Java


/** Helper variable to determine if the privacy options form is required. */
public boolean isPrivacyOptionsRequired() {
  return consentInformation.getPrivacyOptionsRequirementStatus()
      == PrivacyOptionsRequirementStatus.REQUIRED;
}

GoogleMobileAdsConsentManager.java

Kotlin


/** Helper variable to determine if the privacy options form is required. */
val isPrivacyOptionsRequired: Boolean
  get() =
    consentInformation.privacyOptionsRequirementStatus ==
      ConsentInformation.PrivacyOptionsRequirementStatus.REQUIRED

GoogleMobileAdsConsentManager.kt

Để xem danh sách đầy đủ các trạng thái yêu cầu về lựa chọn về quyền riêng tư, hãy xem ConsentInformation.PrivacyOptionsRequirementStatus.

Trình bày biểu mẫu các lựa chọn về quyền riêng tư

Khi người dùng tương tác với phần tử của bạn, hãy trình bày biểu mẫu lựa chọn về quyền riêng tư:

Java


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);
GoogleMobileAdsConsentManager.java

Kotlin


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)
GoogleMobileAdsConsentManager.kt

Yêu cầu quảng cáo có sự đồng ý của người dùng

Trước khi yêu cầu quảng cáo, hãy sử dụng canRequestAds() để kiểm tra xem bạn đã nhận được sự đồng ý của người dùng hay chưa:

Java

consentInformation.canRequestAds();

Kotlin

consentInformation.canRequestAds()

Sau đây là những nơi bạn cần kiểm tra xem bạn có thể yêu cầu quảng cáo trong khi thu thập sự đồng ý hay không:

  • Sau khi UMP SDK thu thập sự đồng ý trong phiên hiện tại.
  • Ngay sau khi bạn gọi requestConsentInfoUpdate(). UMP SDK có thể đã nhận được sự đồng ý trong phiên ứng dụng trước đó.

Nếu xảy ra lỗi trong quá trình thu thập sự đồng ý, hãy kiểm tra xem bạn có thể yêu cầu quảng cáo hay không. UMP SDK sử dụng trạng thái đồng ý từ phiên ứng dụng trước đó.

Ngăn chặn các yêu cầu quảng cáo trùng lặp

Khi bạn kiểm tra canRequestAds() sau khi thu thập sự đồng ý và sau khi gọi requestConsentInfoUpdate(), hãy đảm bảo logic của bạn ngăn chặn các yêu cầu quảng cáo dư thừa có thể dẫn đến cả hai lần kiểm tra đều trả về true. Ví dụ: với một biến boolean.

Thử nghiệm

Nếu bạn muốn kiểm thử hoạt động tích hợp trong ứng dụng khi đang phát triển, hãy làm theo các bước sau để đăng ký thiết bị thử nghiệm theo phương thức lập trình. Hãy nhớ xoá mã dùng để đặt các mã thiết bị thử nghiệm này trước khi bạn phát hành ứng dụng.

  1. Gọi cho requestConsentInfoUpdate().

  2. Kiểm tra đầu ra nhật ký để tìm thông báo tương tự như ví dụ sau. Thông báo này cho biết mã thiết bị của bạn và cách thêm thiết bị đó làm thiết bị thử nghiệm:

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

  3. Sao chép mã thiết bị thử nghiệm vào khay nhớ tạm.

  4. Sửa đổi mã của bạn để gọi ConsentDebugSettings.Builder().TestDeviceHashedIds và truyền vào danh sách mã thiết bị thử nghiệm.

    Java

    ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build();

ConsentRequestParameters params = new ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build();

consentInformation = UserMessagingPlatform.getConsentInformation(this);
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    // ...
);

    Kotlin

    val debugSettings = ConsentDebugSettings.Builder(this)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build()

val params = ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build()

consentInformation = UserMessagingPlatform.getConsentInformation(this)
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    // ...
)

Chỉ định một vị trí địa lý

UMP SDK giúp bạn thử nghiệm hành vi của ứng dụng như thể thiết bị được dùng ở nhiều khu vực, chẳng hạn như Khu vực kinh tế Châu Âu (EEA) hoặc Vương quốc Anh, bằng cách sử dụng DebugGeography. Xin lưu ý rằng chế độ cài đặt gỡ lỗi chỉ hoạt động trên thiết bị thử nghiệm.

Java

ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
    .setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build();

ConsentRequestParameters params = new ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build();

consentInformation = UserMessagingPlatform.getConsentInformation(this);
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    ...
);

Kotlin

val debugSettings = ConsentDebugSettings.Builder(this)
    .setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
    .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
    .build()

val params = ConsentRequestParameters
    .Builder()
    .setConsentDebugSettings(debugSettings)
    .build()

consentInformation = UserMessagingPlatform.getConsentInformation(this)
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
    this,
    params,
    ...
)

Khi thử nghiệm ứng dụng bằng SDK UMP, bạn nên đặt lại trạng thái của SDK để có thể mô phỏng trải nghiệm cài đặt lần đầu của người dùng. SDK cung cấp phương thức reset() để làm việc này.

Java

consentInformation.reset();

Kotlin

consentInformation.reset()

Ví dụ trên GitHub

Xem ví dụ đầy đủ về việc tích hợp UMP SDK được đề cập trong trang này trong Java BannerExample và Kotlin BannerExample.