> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AlloyDB

> Sincronize eventos personalizados do Google AlloyDB para o OneSignal para acionar Jornadas automatizadas e campanhas de mensagens personalizadas com base no comportamento do usuário.

export const DATA_TYPE_0 = "colunas da tabela"

export const PLATFORM_0 = "AlloyDB"

export const COLUMN_HEADER_0 = "Coluna AlloyDB"

export const PROPERTIES_DESCRIPTION_0 = "Metadados do evento como objeto JSON"

## Visão geral

A integração OneSignal + Google AlloyDB permite a sincronização automática de eventos personalizados do seu banco de dados AlloyDB diretamente para a API de Eventos Personalizados do OneSignal. Isso permite acionar Jornadas automatizadas e campanhas de mensagens personalizadas com base no comportamento real do usuário armazenado em seu banco de dados.

Você pode sincronizar eventos como compras, visualizações de produtos, mudanças de assinatura ou quaisquer ações personalizadas do usuário para acionar automaticamente sequências de onboarding, campanhas de reengajamento, mensagens transacionais e promoções direcionadas através de notificações push, email, mensagens no aplicativo e SMS.

***

## Requisitos

* Acesso a [Event Streams](/docs/pt-BR/event-streams) para eventos de mensagem de saída (Limitações de plano e excedentes se aplicam)
* Acesso a [Custom Events](/docs/pt-BR/custom-events) para sincronização de eventos de entrada (Limitações de plano e excedentes se aplicam)
* [Plano de Conta Atualizado](https://onesignal.com/pricing) (não disponível em apps gratuitos)

### Google AlloyDB

* Conta **Google Cloud Platform** com instância AlloyDB
* **Auth Proxy** configurado conforme exigido pelo Google Cloud
* **Permissões de banco de dados** para criar usuários e conceder acesso
* **Acesso à rede** à sua instância AlloyDB

***

## Configuração

### Configurar permissões do AlloyDB

O OneSignal precisa ler dados de eventos do seu banco de dados AlloyDB. Recomendamos criar uma conta de usuário `ONESIGNAL` dedicada com acesso somente leitura às suas tabelas de eventos.

<Steps>
  <Step title="Criar usuário de banco de dados OneSignal">
    Crie uma conta de usuário dedicada com uma senha forte e única:

    ```sql theme={null}
    -- Criar o usuário OneSignal
    CREATE USER ONESIGNAL WITH PASSWORD '<senha forte e única>';
    ```
  </Step>

  <Step title="Conceder acesso ao schema">
    Conceda ao usuário OneSignal acesso para ler do seu schema de dados de eventos:

    ```sql theme={null}
    -- Permitir que o usuário OneSignal veja seu schema de eventos
    GRANT USAGE ON SCHEMA "<seu_schema_de_eventos>" TO ONESIGNAL;

    -- Permitir que o usuário OneSignal leia todas as tabelas existentes neste schema
    GRANT SELECT ON ALL TABLES IN SCHEMA "<seu_schema_de_eventos>" TO ONESIGNAL;

    -- Permitir que o usuário OneSignal leia quaisquer novas tabelas adicionadas a este schema
    ALTER DEFAULT PRIVILEGES IN SCHEMA "<seu_schema_de_eventos>" GRANT SELECT ON TABLES TO ONESIGNAL;
    ```

    <Info>
      Substitua `<seu_schema_de_eventos>` pelo schema real que contém suas tabelas de eventos.
    </Info>
  </Step>

  <Step title="Conceder permissões de função (se necessário)">
    Se você usa procedimentos armazenados ou funções para dados de eventos:

    ```sql theme={null}
    -- Permitir que o usuário OneSignal execute funções neste schema
    GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA "<seu_schema_de_eventos>" TO ONESIGNAL;

    -- Permitir que o usuário OneSignal execute quaisquer novas funções adicionadas a este schema
    ALTER DEFAULT PRIVILEGES IN SCHEMA "<seu_schema_de_eventos>" GRANT EXECUTE ON FUNCTIONS TO ONESIGNAL;
    ```
  </Step>
</Steps>

### Configurar Auth Proxy

<Steps>
  <Step title="Configurar Auth Proxy">
    AlloyDB requer um Auth Proxy para conexões de terceiros. Siga a [documentação do Auth Proxy do Google](https://cloud.google.com/alloydb/docs/auth-proxy/overview) para configurar isso.

    <Warning>
      O Auth Proxy é obrigatório - o OneSignal não pode se conectar diretamente ao AlloyDB sem ele.
    </Warning>
  </Step>

  <Step title="Anotar detalhes de conexão">
    Salve as seguintes informações de conexão:

    * **Host**: Endpoint do Auth Proxy
    * **Porta**: Porta do Auth Proxy (geralmente 5432)
    * **Banco de Dados**: Nome do seu banco de dados AlloyDB
    * **Nome de Usuário**: `ONESIGNAL` (criado acima)
    * **Senha**: A senha que você definiu
  </Step>
</Steps>

### Configurar conexão AlloyDB do OneSignal

<Steps>
  <Step title="Navegar para integrações">
    No OneSignal, vá para **Data > Integrations** e clique em **Add Integration**.
  </Step>

  <Step title="Selecionar Google AlloyDB">
    Escolha **Google AlloyDB** da lista de integrações disponíveis.
  </Step>

  <Step title="Inserir detalhes de conexão">
    Forneça as informações de conexão do AlloyDB:

    * **Host**: Seu endpoint do Auth Proxy
    * **Porta**: Porta do Auth Proxy
    * **Banco de Dados**: Nome do banco de dados AlloyDB
    * **Nome de Usuário**: `ONESIGNAL`
    * **Senha**: Senha do usuário
    * **SSL**: Habilitado (recomendado)
  </Step>

  <Step title="Testar a conexão">
    Clique em **Testar Conexão** para verificar se o OneSignal pode acessar sua instância AlloyDB.
  </Step>
</Steps>

***

## Mapeamento de Dados de Eventos

Depois de conectado, você precisará mapear as colunas da tabela AlloyDB para os campos de eventos personalizados do OneSignal:

<Steps>
  <Step title="Selecionar tabelas de eventos">
    Escolha as tabelas contendo seus dados de eventos que você deseja sincronizar com o OneSignal.
  </Step>

  <Step title="Mapear campos de eventos obrigatórios">
    Mapeie os campos obrigatórios para eventos personalizados:

    * **Nome do Evento**: Coluna contendo o tipo de evento (ex: "purchase", "signup")
    * **Identificador do Usuário**: ID de Usuário Externo, Email ou coluna de Número de Telefone
    * **Timestamp do Evento**: Quando o evento ocorreu (opcional)
  </Step>

  <Step title="Mapear dados de payload do evento">
    Mapeie colunas adicionais para propriedades de payload do evento:

    * Propriedades de eventos personalizados (product\_id, price, category, etc.)
    * Dados contextuais (source, campaign, etc.)
    * Métricas comportamentais (value, quantity, etc.)
  </Step>

  <Step title="Configurar definições de sincronização">
    Defina a frequência de processamento de eventos e preferências de entrega.
  </Step>
</Steps>

***

### Mapeamento de dados de evento

Mapeie seu {DATA_TYPE_0} {PLATFORM_0} para o formato de eventos personalizados do OneSignal:

| Campo OneSignal | {COLUMN_HEADER_0} | Descrição                  | Obrigatório |
| --------------- | ----------------- | -------------------------- | ----------- |
| `name`          | `event_name`      | Identificador de evento    | Sim         |
| `external_id`   | `user_id`         | Identificador de usuário   | Sim         |
| `timestamp`     | `event_timestamp` | Quando o evento ocorreu    | Não         |
| `properties`    | `event_data`      | {PROPERTIES_DESCRIPTION_0} | Não         |

***

## Configuração Avançada de Rede

### Listas de Permissão de Endereços IP

Se sua instância AlloyDB usa listas de permissão de IP, adicione os endereços IP do OneSignal. Você pode encontrar os intervalos de IP atuais em seu painel OneSignal em **Dados > Integrações > Acesso à Rede**.

### Tunelamento SSH

O OneSignal suporta conexão ao AlloyDB através de túneis SSH para segurança adicional:

<Steps>
  <Step title="Criar usuário SSH">
    Crie uma conta de usuário dedicada para o OneSignal em seu servidor host SSH.
  </Step>

  <Step title="Configurar túnel SSH">
    Nas configurações de conexão AlloyDB do OneSignal, habilite **Usar Túnel SSH** e forneça:

    * Host SSH
    * Porta SSH
    * Nome de Usuário SSH
  </Step>

  <Step title="Adicionar chave SSH">
    O OneSignal gerará um par de chaves SSH. Copie a chave pública para o arquivo `authorized_keys` do seu host SSH para o usuário OneSignal.
  </Step>
</Steps>

***

## Limitações

* **Desempenho**: Evite conectar a bancos de dados de produção durante picos de uso
* **Permissões**: OneSignal requer acesso somente leitura às tabelas de eventos
* **Auth Proxy**: Obrigatório para todas as conexões AlloyDB

***

## FAQ

### O que acontece se a estrutura da minha tabela de eventos mudar?

O OneSignal detectará mudanças de schema e pode exigir remapeamento de campos. Atualize seus mapeamentos de campo nas configurações de integração.

### Com que frequência o OneSignal sincroniza eventos?

O OneSignal verifica novos eventos com base na frequência de sincronização configurada, com um intervalo mínimo de 15 minutos.

***

## Precisa de ajuda?

Entre em contato com nossa equipe de suporte em `support@onesignal.com` ou use o chat no aplicativo para assistência com a configuração da sua integração AlloyDB.