Configuração do Unity SDK

​

Visão geral

​

Configurando notificações push para seu app Unity usando OneSignal

​

Requisitos

• Unity 2022.3 ou mais recente
• App e plataforma OneSignal configurados

• macOS com Xcode 14+ (instruções de configuração usam Xcode 16.2)
• Dispositivo com iOS 12+, iPadOS 12+, ou simulador Xcode rodando iOS 16.2+

• Dispositivo ou emulador Android 7.0+ com Google Play Store (Services) instalado

​

Configure seu app e plataforma OneSignal

Instruções de configuração passo a passo

1

Crie ou selecione seu app

Crie um novo app clicando em New App/Website, ou adicione uma plataforma a um app existente em Settings > Push & In-App. Selecione a(s) plataforma(s) que você quer configurar e clique em Next: Configure Your Platform.

2

Configure credenciais da plataforma

Insira as credenciais para sua plataforma:

• Android: Configure Credenciais Firebase
• iOS: Token p8 (Recomendado) ou Certificado p12
• Amazon: Gere API Key
• Huawei: Autorize OneSignal

Clique em Save & Continue após inserir suas credenciais.

3

Salve seu App ID e instale o SDK

Seu App ID é exibido na tela final. Copie e salve-o — você precisa dele ao inicializar o SDK. Selecione sua plataforma de SDK e siga o guia de configuração.

​

Configuração

​

1. Adicionar o OneSignal Unity SDK

• Unity Asset Store
• Unity Package Manager

1. Adicione o SDK à sua conta via Add to My Assets.
2. Clique em Open in Unity para abrir o Unity Editor e Package Manager.
3. Baixe e Importe o SDK.

4. Aceite o prompt para importar todos os arquivos.
5. Vá para Window > OneSignal SDK Setup e siga a checklist, especialmente Import OneSignal packages.
6. Após importar, Unity atualizará o registro. Complete os passos de configuração restantes mostrados na janela de setup.

1. Navegue para Edit > Project Settings > Package Manager.

2. Adicione um scoped registry:

Name        npmjs
URL         https://registry.npmjs.org
Scope(s)    com.onesignal

3. Abra Window > Package Manager e mude para My Registries.
4. Instale os pacotes OneSignal SDK desejados.
5. Abra Window > OneSignal SDK Setup e complete os passos finais.

​

2. Configuração de plataforma

​

Configuração iOS

• Automatically Sign (Recomendado)
• Provisionamento Manual

1. Vá para File > Build Settings > Player Settings.
2. Em Other Settings, marque Automatically Sign.

Certifique-se de que sua conta Apple Developer tem:

• Um App Group: group.{your_bundle_id}.onesignal
• Push Notifications e App Groups habilitados
• Perfis de provisionamento atualizados para seu bundle ID

​

Configuração Android

1. Vá para Edit > Project Settings > Player > Android.
2. Em Publishing Settings, habilite:

• Custom Main Gradle Template
• Custom Gradle Properties Template

3. Execute Assets > External Dependency Manager > Android Resolver > Force Resolve.

• Target API Level deve ser 33+ (v5.0.6+).
• Se Minify estiver habilitado, execute Copy Android plugin to Assets de OneSignal SDK Setup para usar OneSignalConfig.androidlib.
• Substitua os ícones padrão dentro de Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res pelos seus próprios (apenas nomes de arquivo em minúsculas, sublinhados permitidos). Veja Ícones de notificação para mais.

​

Configuração Amazon

 xmlns:amazon="http://schemas.amazon.com/apk/res/android"

<uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />
<permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" />

<amazon:enable-feature android:name="com.amazon.device.messaging" android:required="false"/>
<service android:name="com.onesignal.notifications.services.ADMMessageHandler" android:exported="false" />
<service android:name="com.onesignal.notifications.services.ADMMessageHandlerJob"
         android:permission="android.permission.BIND_JOB_SERVICE"
         android:exported="false" />
<receiver android:name="com.onesignal.notifications.receivers.ADMMessageReceiver"
          android:permission="com.amazon.device.messaging.permission.SEND" >
  <intent-filter>
    <action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
    <action android:name="com.amazon.device.messaging.intent.RECEIVE" />
    <category android:name="COM.YOUR.PACKAGE_NAME" />
  </intent-filter>
</receiver>

​

Configuração Huawei

​

Opcional: Desabilitar o módulo de localização

• Alternância do Editor (interativa): No Unity Editor, vá para Project Settings > OneSignal e habilite Disable Location Module. A configuração é salva em ProjectSettings/OneSignalSettings.json.
• Variável de ambiente (CLI/CI): Exporte ONESIGNAL_DISABLE_LOCATION=true (ou 1) no shell antes de iniciar o Unity. A variável de ambiente tem precedência sobre a alternância do Editor.

{
    "disableLocation": true
}

ONESIGNAL_DISABLE_LOCATION=true /path/to/Unity \
  -batchmode -quit -projectPath . -buildTarget Android

env:
  ONESIGNAL_DISABLE_LOCATION: true

​

Aplicar a alteração após as dependências nativas serem armazenadas em cache

• Exclua Assets/OneSignal/Editor/OneSignalAndroidDependencies.xml e Assets/OneSignal/Editor/OneSignaliOSDependencies.xml, depois reabra o projeto para que o Unity os regenere a partir de ProjectSettings/OneSignalSettings.json.
• Execute Assets > External Dependency Manager > Android Resolver > Force Resolve para que Assets/Plugins/Android/mainTemplate.gradle receba os pacotes sem localização.
• Reexporte o projeto Xcode do iOS e execute pod install, se necessário.
• Remova Build/ e outras saídas geradas antes de recompilar.

​

3. Inicializar o SDK

using OneSignalSDK;

void Start () {
  // Enable verbose logging for debugging (remove in production)
  OneSignal.Debug.LogLevel = LogLevel.Verbose;
  // Initialize with your OneSignal App ID
  OneSignal.Initialize("YOUR_APP_ID");
  // Use this method to prompt for push notifications.
  // We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
  await OneSignal.Notifications.RequestPermissionAsync(true);
}

​

Testando a integração do OneSignal SDK

​

Verifique inscrições mobile

1

Inicie seu app em um dispositivo de teste.

O prompt de permissão push nativo deve aparecer automaticamente se você adicionou o método requestPermission durante a inicialização.

2

Verifique seu dashboard OneSignal

Antes de aceitar o prompt, verifique o dashboard OneSignal:

• Vá para Audience > Subscriptions.
• Você deve ver uma nova entrada com o status “Never Subscribed”.

3

Retorne ao app e toque em Allow no prompt.

4

Atualize a página de Subscription do dashboard OneSignal.

O status da inscrição deve agora mostrar Subscribed.

Você criou com sucesso uma inscrição mobile. Inscrições mobile são criadas quando usuários abrem seu app pela primeira vez em um dispositivo ou se eles desinstalam e reinstalam seu app no mesmo dispositivo.

​

Configure inscrições de teste

1

Adicione a Test Users.

No dashboard, próximo à inscrição, clique no botão Options (três pontos) e selecione Add to Test Users.

2

Nomeie sua inscrição.

Nomeie a inscrição para que você possa identificar facilmente seu dispositivo depois na aba Test Users.

3

Crie um segmento de usuários de teste.

Vá para Audience > Segments > New Segment.

4

Nomeie o segmento.

Nomeie o segmento Test Users (o nome é importante porque será usado depois).

5

Adicione o filtro Test Users e clique em Create Segment.

Você criou com sucesso um segmento de usuários de teste. Agora podemos testar enviar mensagens para este dispositivo individual e grupos de usuários de teste.

​

Envie push de teste via API

1

Obtenha seu App API Key e App ID.

No seu dashboard OneSignal, vá para Settings > Keys & IDs.

2

Atualize o código fornecido.

Substitua YOUR_APP_API_KEY e YOUR_APP_ID no código abaixo com suas chaves reais. Este código usa o segmento Test Users que criamos anteriormente.

curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'

3

Execute o código.

Execute o código no seu terminal.

4

Verifique imagens e entrega confirmada.

Se todos os passos de configuração foram completados com sucesso, as inscrições de teste devem receber uma notificação com uma imagem incluída:

Imagens aparecerão pequenas na visualização de notificação recolhida. Expanda a notificação para ver a imagem completa.

5

Verifique por entrega confirmada.

No seu dashboard, vá para Delivery > Sent Messages, depois clique na mensagem para ver as estatísticas.Você deve ver a estatística confirmed, significando que o dispositivo recebeu o push.

Você enviou com sucesso uma notificação via nossa API para um segmento.

• Não recebeu imagem? Sua Notification Service Extension pode estar faltando.
• Sem entrega confirmada? Revise o guia de solução de problemas aqui.
• Tendo problemas? Copie e cole a requisição da api e um log do início ao fim do lançamento do app em um arquivo .txt. Depois compartilhe ambos com support@onesignal.com.

​

Envie uma mensagem in-app

1

Feche ou coloque em background seu app no dispositivo.

Isso é porque usuários devem atender aos critérios de público in-app antes que uma nova sessão inicie. No OneSignal, uma nova sessão inicia quando o usuário abre seu app depois de ter estado em background ou fechado por pelo menos 30 segundos. Para mais detalhes, veja nosso guia sobre como mensagens in-app são exibidas.

2

Crie uma mensagem in-app.

• No seu dashboard OneSignal, navegue para Messages > In-App > New In-App.
• Encontre e selecione a mensagem Welcome.
• Defina seu Público como o segmento Test Users que usamos anteriormente.

3

Personalize o conteúdo da mensagem se desejar.

4

Defina Trigger como 'On app open'.

5

Agende frequência.

Em Schedule > How often do you want to show this message? selecione Every time trigger conditions are satisfied.

6

Torne a mensagem ativa.

Clique em Make Message Live para que fique disponível para seus Test Users cada vez que eles abrem o app.

7

Abra o app e veja a mensagem.

Depois que a mensagem in-app estiver ativa, abra seu app. Você deve vê-la exibida:

Não está vendo a mensagem?

• Inicie uma nova sessão
  • Você deve fechar ou colocar em background o app por pelo menos 30 segundos antes de reabrir. Isso garante que uma nova sessão seja iniciada.
  • Para mais, veja como mensagens in-app são exibidas.
• Ainda no segmento Test Users?
  • Se você reinstalou ou trocou de dispositivo, adicione novamente o dispositivo a Test Users e confirme que ele faz parte do segmento Test Users.
• Tendo problemas?
  • Siga Obtendo um Debug Log enquanto reproduz os passos acima. Isso gerará logging adicional que você pode compartilhar com support@onesignal.com e nós ajudaremos a investigar o que está acontecendo.

​

Identificação de usuário

​

Atribua External ID

​

Adicione Tags

​

Adicione inscrições de email e/ou SMS

• Use o método addEmail para criar inscrições de email.
• Use o método addSms para criar inscrições de SMS.

​

Privacidade e consentimento do usuário

• setConsentRequired(true): Previne coleta de dados até que consentimento seja dado.
• setConsentGiven(true): Habilita coleta de dados uma vez que consentimento é concedido.

• Dados coletados pelo SDK
• Tratamento de dados pessoais

​

Solicite permissões push

​

Escute eventos de push, usuário e in-app

​

Eventos de notificação push

• addClickListener(): Detecte quando uma notificação é tocada. Útil para Deep Linking.
• addForegroundLifecycleListener(): Controle como notificações se comportam em foreground.

​

Mudanças de estado do usuário

• addObserver() para estado do usuário: Detecte quando o External ID é definido.
• addPermissionObserver(): Rastreie a interação específica do usuário com o prompt de permissão push nativo.
• addObserver() para inscrição push: Rastreie quando o status de inscrição push muda.

​

Eventos de mensagem in-app

• addClickListener(): Lide com ações de clique in-app. Ideal para deep linking ou rastreamento de eventos.
• addLifecycleListener(): Rastreie o ciclo de vida completo de mensagens in-app (exibida, clicada, descartada, etc.).

​

Configuração avançada e capacidades

• 🔁 Migrando para OneSignal de outro serviço
• 🌍 Rastreamento de localização
• 🔗 Deep Linking
• 🔌 Integrações
• 🧩 Mobile Service Extensions
• 🛎️ Botões de ação
• 🌐 Mensagens multilíngues
• 🛡️ Verificação de Identidade
• 📊 Custom Outcomes
• 📲 Live Activities

​

Configuração e referência do Mobile SDK