Google User Messaging Platform (UMP) SDK adalah alat privasi dan pesan untuk membantu Anda mengelola pilihan privasi. Untuk mengetahui informasi selengkapnya, lihat Tentang Privasi &pesan.
Buat jenis pesan
Buat pesan pengguna dengan salah satu Jenis pesan pengguna yang tersedia pada tab Privasi &pesan di akun Ad Manager Anda. UMP SDK mencoba menampilkan pesan privasi yang dibuat dari ID Aplikasi Ad Manager yang ditetapkan dalam project Anda.
Untuk mengetahui detail selengkapnya, lihat Tentang privasi dan pesan.
Kumpulkan izin
Untuk mengumpulkan izin, selesaikan langkah-langkah berikut:
- Meminta informasi izin pengguna terbaru.
- Memuat dan menampilkan formulir izin, jika diperlukan.
Permintaan informasi izin
Anda harus meminta pembaruan informasi izin pengguna setiap kali aplikasi diluncurkan, menggunakan Update()
. Permintaan ini memeriksa
hal berikut:
- Apakah izin diperlukan atau tidak. Misalnya, izin diperlukan untuk pertama kalinya, atau keputusan izin sebelumnya sudah tidak berlaku.
- Apakah titik entri opsi privasi diperlukan atau tidak. Beberapa pesan privasi mengharuskan aplikasi mengizinkan pengguna untuk mengubah opsi privasi kapan saja.
Memuat dan menampilkan formulir pesan privasi jika diperlukan
Setelah Anda menerima status izin terbaru, panggil LoadAndShowConsentFormIfRequired()
untuk memuat formulir apa pun yang diperlukan untuk mengumpulkan izin pengguna. Setelah dimuat, formulir akan langsung ditampilkan.
Kode berikut menunjukkan cara meminta informasi izin terbaru pengguna. Jika diperlukan, kode akan dimuat dan menampilkan formulir pesan privasi:
void Start()
{
// Create a ConsentRequestParameters object.
ConsentRequestParameters request = new ConsentRequestParameters();
// Check the current consent information status.
ConsentInformation.Update(request, OnConsentInfoUpdated);
}
void OnConsentInfoUpdated(FormError consentError)
{
if (consentError != null)
{
// Handle the error.
UnityEngine.Debug.LogError(consentError);
return;
}
// If the error is null, the consent information state was updated.
// You are now ready to check if a form is available.
ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
{
if (formError != null)
{
// Consent gathering failed.
UnityEngine.Debug.LogError(consentError);
return;
}
// Consent has been gathered.
});
}
Opsi privasi
Beberapa formulir pesan privasi ditampilkan dari titik entri opsi privasi yang dirender penayang, sehingga pengguna dapat mengelola opsi privasi mereka kapan saja. Untuk mempelajari lebih lanjut pesan yang dilihat pengguna di titik entri opsi privasi, lihat Jenis pesan pengguna yang tersedia.
Untuk menerapkan titik entri opsi privasi, selesaikan langkah-langkah berikut:
- Setelah Anda memanggil
Update()
, periksaPrivacyOptionsRequirementStatus
untuk menentukan apakah titik entri opsi privasi diperlukan atau tidak. - Jika diperlukan, tambahkan elemen UI yang terlihat dan dapat berinteraksi ke aplikasi Anda untuk berfungsi sebagai titik entri opsi privasi. Jika titik entri privasi tidak diperlukan, konfigurasikan elemen UI Anda agar tidak terlihat dan tidak dapat berinteraksi.
- Tampilkan formulir opsi privasi menggunakan
ShowPrivacyOptionsForm()
.
Contoh kode berikut menunjukkan langkah-langkah ini:
[SerializeField, Tooltip("Button to show the privacy options form.")]
private Button _privacyButton;
private void Start()
{
// Enable the privacy settings button.
if (_privacyButton != null)
{
_privacyButton.onClick.AddListener(UpdatePrivacyButton);
// Disable the privacy settings button by default.
_privacyButton.interactable = false;
}
}
/// <summary>
/// Shows the privacy options form to the user.
/// </summary>
public void ShowPrivacyOptionsForm()
{
Debug.Log("Showing privacy options form.");
ConsentForm.ShowPrivacyOptionsForm((FormError showError) =>
{
if (showError != null)
{
Debug.LogError("Error showing privacy options form with error: " + showError.Message);
}
// Enable the privacy settings button.
if (_privacyButton != null)
{
_privacyButton.interactable =
ConsentInformation.PrivacyOptionsRequirementStatus ==
PrivacyOptionsRequirementStatus.Required;
}
});
}
Permintaan iklan
Sebelum meminta iklan di aplikasi, periksa apakah Anda telah memperoleh izin dari pengguna menggunakan
CanRequestAds()
. Ada dua tempat untuk memeriksa saat mengumpulkan izin:
- Setelah izin dikumpulkan dalam sesi saat ini.
- Segera setelah Anda memanggil
Update()
. Izin mungkin telah diperoleh dalam sesi sebelumnya. Sebagai praktik terbaik latensi, sebaiknya jangan menunggu callback selesai sehingga Anda dapat mulai memuat iklan sesegera mungkin setelah aplikasi diluncurkan.
Jika terjadi error selama proses pengumpulan izin, Anda tetap harus memeriksa apakah Anda dapat meminta iklan. UMP SDK menggunakan status izin dari sesi sebelumnya.
void Start()
{
// Create a ConsentRequestParameters object.
ConsentRequestParameters request = new ConsentRequestParameters();
// Check the current consent information status.
ConsentInformation.Update(request, OnConsentInfoUpdated);
}
void OnConsentInfoUpdated(FormError consentError)
{
if (consentError != null)
{
// Handle the error.
UnityEngine.Debug.LogError(consentError);
return;
}
// If the error is null, the consent information state was updated.
// You are now ready to check if a form is available.
ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
{
if (formError != null)
{
// Consent gathering failed.
UnityEngine.Debug.LogError(consentError);
return;
}
// Consent has been gathered.
if (ConsentInformation.CanRequestAds())
{
MobileAds.Initialize((InitializationStatus initstatus) =>
{
// TODO: Request an ad.
});
}
});
}
Pengujian
Jika Anda ingin menguji integrasi di aplikasi saat sedang mengembangkan, ikuti langkah-langkah berikut untuk mendaftarkan perangkat pengujian secara terprogram. Pastikan untuk menghapus kode yang menetapkan ID perangkat pengujian ini sebelum merilis aplikasi.
- Hubungi
Update()
. Periksa output log untuk menemukan pesan yang mirip dengan contoh berikut, yang menampilkan ID perangkat Anda dan cara menambahkannya sebagai perangkat pengujian:
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]
Salin ID perangkat pengujian Anda ke papan klip.
Ubah kode Anda untuk memanggil
DebugGeography.TestDeviceHashedIds
dan meneruskan daftar ID perangkat pengujian Anda.void Start() { var debugSettings = new ConsentDebugSettings { TestDeviceHashedIds = new List<string> { "TEST-DEVICE-HASHED-ID" } }; // Create a ConsentRequestParameters object. ConsentRequestParameters request = new ConsentRequestParameters { ConsentDebugSettings = debugSettings, }; // Check the current consent information status. ConsentInformation.Update(request, OnConsentInfoUpdated); }
Paksa geografi
UMP SDK menyediakan cara untuk menguji perilaku aplikasi Anda seolah-olah perangkat
berada di berbagai wilayah, seperti EEA atau Inggris Raya, menggunakan
DebugGeography
. Perhatikan bahwa setelan debug hanya berfungsi di perangkat pengujian.
void Start()
{
var debugSettings = new ConsentDebugSettings
{
// Geography appears as in EEA for debug devices.
DebugGeography = DebugGeography.EEA,
TestDeviceHashedIds = new List<string>
{
"TEST-DEVICE-HASHED-ID"
}
};
// Create a ConsentRequestParameters object.
ConsentRequestParameters request = new ConsentRequestParameters
{
ConsentDebugSettings = debugSettings,
};
// Check the current consent information status.
ConsentInformation.Update(request, OnConsentInfoUpdated);
}
Mereset status izin
Saat menguji aplikasi dengan UMP SDK, sebaiknya reset
status SDK agar Anda dapat menyimulasikan pengalaman penginstalan pertama pengguna.
SDK menyediakan metode Reset()
untuk melakukannya.
ConsentInformation.Reset();
Contoh di GitHub
Lihat contoh lengkap integrasi UMP SDK yang dibahas di halaman ini di HelloWorld.