Configurar o SDK da plataforma de mensagens de usuários

Selecione a plataforma: Android (Beta) Novo Android iOS Unity Flutter

O SDK da plataforma de mensagens de usuários (UMP) do Google é uma ferramenta de privacidade e mensagens que ajuda você a gerenciar as opções de privacidade. Para mais informações, consulte Sobre a página "Privacidade e mensagens".

Criar um tipo de mensagem

Crie mensagens de usuário com um dos tipos de mensagem de usuário disponíveis na guia Privacidade e mensagens da sua conta do Ad Manager. O SDK da UMP tenta mostrar uma mensagem de privacidade criada com o ID do aplicativo do Ad Manager definido no seu projeto.

Para mais detalhes, consulte Sobre privacidade e mensagens.

Você precisa solicitar uma atualização das informações de consentimento do usuário a cada inicialização do app usando Update(). Essa solicitação verifica o seguinte:

  • Se o consentimento é necessário. Por exemplo, o consentimento é necessário pela primeira vez ou a decisão de consentimento anterior expirou.
  • Se um ponto de entrada de opções de privacidade é necessário. Algumas mensagens de privacidade exigem que os apps permitam que os usuários modifiquem as opções de privacidade a qualquer momento.
void Start()
{
    // Create a ConsentRequestParameters object.
    ConsentRequestParameters requestParameters = new ConsentRequestParameters();

    // Request an update of the user's consent information.
    ConsentInformation.Update(requestParameters, OnConsentInfoUpdated);
}
UMPSnippets.cs

Carregar e apresentar o formulário de mensagem de privacidade

Depois de receber o status de consentimento mais atualizado, chame LoadAndShowConsentFormIfRequired() para carregar todos os formulários necessários para coletar o consentimento do usuário. Após o carregamento, os formulários são apresentados imediatamente.

ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
{
    if (formError != null)
    {
        // Consent gathering failed.
        Debug.LogError("Error loading/showing consent form: " + formError.Message);
    }

    // ...
});
UMPSnippets.cs

Opções de privacidade

Alguns formulários de mensagem de privacidade são apresentados em um ponto de entrada de opções de privacidade renderizado pelo editor, permitindo que os usuários gerenciem as opções de privacidade a qualquer momento. Para saber mais sobre qual mensagem é mostrada aos usuários no ponto de entrada de opções de privacidade, consulte Tipos de mensagens de usuário disponíveis.

Verificar se um ponto de entrada de opções de privacidade é necessário

Depois de chamar Update(), verifique PrivacyOptionsRequirementStatus para determinar se um ponto de entrada de opções de privacidade é necessário para seu app. Se um ponto de entrada for necessário, adicione um elemento da interface visível e interativo ao app que apresente o formulário de opções de privacidade. Se um ponto de entrada de privacidade não for necessário, configure o elemento da interface para que ele não seja visível e interativo.

void UpdatePrivacyButton()
{
    if (_privacyButton != null)
    {
        // Enable the button only if a privacy options entry point is required.
        _privacyButton.interactable =
            ConsentInformation.PrivacyOptionsRequirementStatus == PrivacyOptionsRequirementStatus.Required;
    }
}
UMPSnippets.cs

Para conferir a lista completa de status de requisitos de opções de privacidade, consulte ConsentInformation.PrivacyOptionsRequirementStatus.

Apresentar o formulário de opções de privacidade

Quando o usuário interagir com o elemento, apresente o formulário de opções de privacidade:

public void ShowPrivacyOptionsForm()
{
    ConsentForm.ShowPrivacyOptionsForm((FormError showError) =>
    {
        if (showError != null)
        {
            Debug.LogError("Error showing privacy options form: " + showError.Message);
        }
    });
}
UMPSnippets.cs

Solicitar anúncios com o consentimento do usuário

Antes de solicitar anúncios, use CanRequestAds() para verificar se você recebeu o consentimento do usuário:

ConsentInformation.CanRequestAds()

Confira a seguir os locais em que você pode verificar se é possível solicitar anúncios ao coletar o consentimento:

  • Depois que o SDK da UMP coletar o consentimento na sessão atual.
  • Imediatamente depois de chamar Update(). O SDK da UMP pode ter recebido o consentimento na sessão anterior do app.

Se ocorrer um erro durante o processo de coleta de consentimento, verifique se é possível solicitar anúncios. O SDK da UMP usa o status de consentimento da sessão anterior do app.

Evitar trabalho repetitivo na solicitação de anúncio

Ao verificar CanRequestAds() depois de coletar o consentimento e depois de chamar Update(), verifique se a lógica impede solicitações de anúncios redundantes que podem resultar em true nas duas verificações. Por exemplo, com uma variável booleana.

Teste

Se você quiser testar a integração no app durante o desenvolvimento, siga estas etapas para registrar seu dispositivo de teste de maneira programática. Remova o código que define esses IDs de dispositivo de teste antes de lançar o app.

  1. Ligue para a Update().

  2. Procure uma mensagem semelhante ao exemplo a seguir na saída do registro. Ela mostra o ID do dispositivo e como adicioná-lo como um dispositivo de teste:

    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. Copie o ID do dispositivo de teste para a área de transferência.

  4. Modifique o código para chamar DebugGeography.TestDeviceHashedIds e transmita uma lista dos IDs dos dispositivos de teste.

    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);
}

Forçar uma região geográfica

O SDK da UMP oferece uma maneira de testar o comportamento do app como se o dispositivo estivesse localizado em várias regiões, como o Espaço Econômico Europeu (EEE), o Reino Unido (RU) e a Suíça, usando DebugGeography. As configurações de depuração só funcionam em dispositivos de teste.

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);
}

Ao testar o app com o SDK da UMP, pode ser útil redefinir o estado do SDK para simular a experiência de primeira instalação de um usuário. O SDK oferece o método Reset() para fazer isso.

ConsentInformation.Reset();

Exemplos no GitHub

Confira um exemplo completo da integração do SDK da UMP abordada nesta página em HelloWorld.