Adicionar conteúdo personalizado a modelos de mensagem - Amazon Pinpoint

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Adicionar conteúdo personalizado a modelos de mensagem

Para fornecer conteúdo dinâmico e personalizado em mensagens que usam um modelo, adicione variáveis de mensagem ao modelo de mensagem. Uma variável de mensagem é um espaço reservado que faz menção a um atributo específico que você ou o Amazon Pinpoint criou para armazenar informações sobre seus usuários. Normalmente, cada atributo corresponde a uma característica de um usuário, como o nome do usuário ou a cidade onde ele mora. Ao adicionar variáveis de mensagem a modelos, esses atributos podem ser usados para entregar conteúdo personalizado a cada destinatário de uma mensagem que usa um modelo.

Se um modelo contiver variáveis de mensagem, o Amazon Pinpoint substituirá cada variável pelo valor atual e correspondente do atributo para cada destinatário. Isto é feito cada vez que ele envia uma mensagem que usa o modelo. Isto significa que você pode enviar conteúdo personalizado para cada destinatário sem criar várias versões personalizadas de uma mensagem ou modelo de mensagem. Também pode ter certeza de que a mensagem contém as informações mais recentes que você tem para um destinatário.

Por exemplo, se o seu projeto for um aplicativo de fitness para corredores e incluir atributos para o primeiro nome, a atividade preferencial e o registro pessoal de cada usuário, você poderá usar as seguintes variáveis de texto e mensagem em um modelo:

Hi {{User.UserAttributes.FirstName}}, congratulations on your new {{User.UserAttributes.Activity}} record of {{User.UserAttributes.PersonalRecord}}!

Quando você envia uma mensagem que usa o modelo, o Amazon Pinpoint substitui as variáveis pelo valor atual de cada atributo para cada destinatário. Isso é mostrado nos exemplos a seguir:

Exemplo 1

Hi Sofia, congratulations on your new half marathon record of 1:42:17!

Exemplo 2

Hi Alejandro, congratulations on your new 5K record of 20:52!

Se um valor de atributo não existir para um destinatário, o Amazon Pinpoint pode substituir uma variável por um valor padrão especificado para a variável. Por exemplo, se um usuário de seu aplicativo de fitness não tiver escolhido a atividade preferida dele, você poderá usar running como o valor padrão para a variável {{User.UserAttributes.Activity}}. Nesse caso, o Amazon Pinpoint substitui a variável conforme mostrado nos exemplos a seguir:

Exemplo 1

Hi Jane, congratulations on your new running record of 1:42:17!

Exemplo 2

Hi John, congratulations on your new running record of 20:52!

Se você não especificar um valor padrão e se não existir um valor para o destinatário, o Amazon Pinpoint omitirá os textos da variável ao enviar uma mensagem para esse destinatário. Por exemplo: .

Hi Mary, congratulations on your new record of 20:52!

Como uma melhor prática, recomendamos que você especifique um valor padrão para cada variável incluída em um modelo.

Adicionar variáveis de mensagem

Você pode adicionar atributos de mensagem a um novo modelo ou a um modelo existente. Se você adicionar variáveis a um modelo existente, o Amazon Pinpoint não aplicará necessariamente as alterações a todas as mensagens existentes que usam o modelo e ainda não foram enviadas, como mensagens de campanha programadas para serem enviadas posteriormente. Isso depende da versão do modelo à qual você adiciona variáveis e de como você configurou as mensagens que usam o modelo. Para ter mais informações, consulte Gerenciar versões de modelos de mensagem.

nota

Os modelos de mensagens no aplicativo não oferecem suporte ao uso de variáveis de mensagem.

Para adicionar uma variável de mensagem a um modelo de mensagem
  1. Faça login no console do Amazon Pinpoint em https://console.aws.amazon.com/pinpoint/.

  2. No painel de navegação, escolha Modelos de mensagem.

  3. Na página Modelos de mensagem, execute uma das seguinte ações:

    • Para criar um modelo e adicionar uma variável de mensagem a ele, escolha Criar modelo. Em seguida, na página de modelo, insira um nome para o modelo e, opcionalmente, uma descrição do modelo.

    • Para adicionar uma variável de mensagem a um modelo existente, escolha o modelo ao qual deseja adicionar uma variável. Em seguida, na página de modelo, escolha Editar. Em Detalhes do modelo, use o seletor de versão para escolher a versão do modelo que você deseja usar como ponto de partida. Se você escolher a versão mais recente, poderá salvar as alterações diretamente nessa versão do modelo. Caso contrário, você poderá salvar essas alterações como uma nova versão do modelo.

  4. Na seção de detalhes da mensagem, determine onde você deseja adicionar uma variável de mensagem. É possível adicionar uma variável ao corpo de qualquer tipo de modelo. Para modelos de notificação por e-mail e push, também é possível adicionar uma variável ao assunto ou título da mensagem.

  5. No Localizador de atributos, expanda a seção do tipo de atributo ao qual você deseja adicionar uma variável de mensagem. Você pode escolher entre os seguintes tipos de atributos:

    Atributos padrão

    Estes são atributos que o Amazon Pinpoint cria automaticamente para qualquer projeto. Isso significa que você pode usá-los em mensagens enviadas para qualquer projeto. Para obter informações detalhadas sobre cada um desses atributos, consulte Atributos compatíveis.

    Para adicionar uma variável a um atributo padrão, escolha o atributo na lista.

    Atributos personalizados

    Estes são atributos que você cria opcionalmente para projetos individuais. Como esses atributos podem não estar disponíveis para alguns de seus projetos, o Amazon Pinpoint talvez não possa substituir a variável por um valor para cada destinatário de uma mensagem que usa o modelo. Para evitar esse problema, o Amazon Pinpoint fornece opções para ajudá-lo a escolher um atributo existente para projetos específicos ou para todos os seus projetos.

    Para adicionar um atributo personalizado:

    1. Escolha Atributos personalizados e, em seguida, Carregar atributos personalizados. Na janela exibida, o Amazon Pinpoint listará todos os projetos que você criou. Conforme você escolhe cada projeto, os atributos comuns aos projetos selecionados serão exibidos no painel de navegação à direita. Se nenhum atributo for exibido, não haverá atributos comuns entre esses projetos.

    2. Execute um destes procedimentos:

      • Para usar todos os atributos comuns aos projetos selecionados, escolha Carregar atributos personalizados.

      • Se você quiser usar um atributo específico da lista, insira qualquer parte do nome do atributo no campo de pesquisa. Os atributos que correspondem ao texto inserido são exibidos. Escolha Carregar atributos personalizados quando o atributo que você deseja usar for exibido. O Localizador de atributos exibe os atributos personalizados recém-adicionados.

        nota

        Você não pode adicionar atributos comuns de diferentes conjuntos de projetos, nem modificar a seção Atributos personalizados do Localizador de atributos. Se você precisar fazer alterações nos atributos personalizados, escolha X para limpar o Localizador de atributos e comece novamente.

    3. No Localizador de atributos, escolha o atributo para o qual deseja adicionar uma variável.

    Atributos recomendados

    Esses são atributos que você cria opcionalmente para sua conta ao configurar o Amazon Pinpoint para recuperar recomendações personalizadas de um modelo de recomendação. Para obter informações sobre como usar modelos de recomendação, consulte Modelos de machine learning. Você pode adicionar variáveis para esse tipo de atributo a modelos de e-mail, modelos de notificação por push e modelos de SMS. Não é possível adicioná-los a modelos de voz.

    Para adicionar uma variável a um atributo recomendado, escolha o atributo na lista. Se o Localizador de atributos não listar nenhum atributo recomendado, primeiro conecte o modelo a um modelo de recomendação.

    Para adicionar um atributo recomendado:

    1. Escolha Conectar modelo.

    2. Selecione o modelo do qual você deseja recuperar recomendações ao enviar mensagens que usam o modelo.

    3. Escolha Conectar modelo.

  6. Quando você escolhe um atributo no Localizador de atributos, o Amazon Pinpoint cria uma variável de mensagem para o atributo e copia-a para a área de transferência. Cole a variável no local desejado. Se você tiver uma lista longa de atributos, insira o texto de pesquisa para restringir a lista. Escolha X para limpar o campo de pesquisa.

    Depois de colar a variável, o Amazon Pinpoint a exibe como o nome do atributo associado, inserido entre chaves, por exemplo, {{User.UserAttributes.FirstName}}.

  7. Repita as etapas 4 a 6 para cada variável de mensagem que você deseja adicionar.

  8. Para especificar um valor padrão para uma variável de mensagem, expanda a seção Valores de atributo padrão . Em seguida, na lista de variáveis, insira o valor padrão que deseja usar para a variável.

    nota

    Recomendamos que você faça isso para cada variável no modelo. Caso contrário, o Amazon Pinpoint talvez não possa enviar uma mensagem que usa o modelo, ou a mensagem pode ser exibida de maneiras inesperadas ou indesejadas.

  9. Ao concluir, siga um destes procedimentos:

    • Se você adicionou variáveis de mensagem a um novo modelo, escolha Criar.

    • Se você adicionou variáveis de mensagem a um modelo existente e quiser salvar as alterações como uma nova versão do modelo, escolha Salvar como nova versão.

    • Se você adicionou variáveis de mensagem a um modelo existente e quiser salvar as alterações como uma atualização da versão mais recente do modelo, escolha Atualizar versão. Essa opção só estará disponível se você tiver aberto a versão mais recente do modelo na etapa 3.

Atributos compatíveis

Cada projeto pode ter atributos padrão e atributos personalizados. Os atributos padrão são atributos que o Amazon Pinpoint cria automaticamente para qualquer projeto. Os atributos personalizados são atributos que você cria opcionalmente para um projeto. Existem três tipos de atributos personalizados:

  • Atributos de usuário: esses atributos descrevem um usuário, por exemplo, o nome, o sobrenome e a data de nascimento de um usuário. Um usuário é uma pessoa que tem um ID de usuário exclusivo para um projeto.

  • Atributos de endpoint: esses atributos descrevem um endpoint específico para um usuário. Um endpoint é um destino para o qual é possível enviar mensagens, como um endereço de e-mail, número de telefone ou dispositivo móvel. Cada usuário pode ser associado a um ou mais endpoints. Por exemplo, se você se comunicar com um usuário por e-mail, SMS e telefone, o usuário poderá ser associado a três endpoints: um para o endereço de e-mail do usuário, outro para o número de celular do usuário e outro para o número de telefone residencial (fixo) do usuário.

  • Atributos de métrica: esses atributos são métricas numéricas que seu aplicativo relata ao Amazon Pinpoint em relação a endpoints individuais, como, por exemplo, o número de sessões de um aplicativo móvel ou o número de itens deixados em um carrinho.

  • Pinpoint atributos — Esses atributos são identificadores exclusivos para seu aplicativo, campanha ou jornada.

Além dos atributos personalizados e padrão que você ou o Amazon Pinpoint cria para os projetos, o Amazon Pinpoint oferece suporte a atributos recomendados. Um atributo recomendado é um atributo que armazena temporariamente recomendações personalizadas para seus usuários ou endpoints. O Amazon Pinpoint recupera essas recomendações de um modelo de recomendação configurado por você. Os atributos recomendados não estão associados a projetos específicos. Em vez disso, eles estão associados à sua conta do Amazon Pinpoint. Para obter informações sobre como usar modelos de recomendação, consulte Modelos de machine learning.

Você pode usar qualquer atributo padrão, personalizado ou recomendado em uma variável de mensagem. A tabela a seguir indica o texto que aparece na variável de mensagem para cada atributo compatível e descreve cada atributo. Na tabela, custom_attribute indica o texto que aparece em uma variável para um atributo personalizado. Nesses casos, substitua custom_attribute pelo nome do atributo personalizado. Por exemplo, se o projeto armazena os nomes dos usuários em um atributo de usuário personalizado chamado FirstName e você adicionar uma variável a esse atributo, o texto da variável é {{User.UserAttributes.FirstName}}.

Atributo Descrição
Address O endereço de destino para mensagens ou notificações por push enviadas para o endpoint, por exemplo, um endereço de e-mail, número de telefone ou token de dispositivo.
Pinpoint.ApplicationId O identificador exclusivo do aplicativo.
Attributes.custom_attribute Um atributo de endpoint personalizado que descreve o endpoint.
Pinpoint.CampaignId O identificador exclusivo da campanha.
ChannelType O canal a ser usado ao enviar mensagens ou notificações por push para o endpoint. Por exemplo: .
  • APNS: para um endpoint que pode receber notificações por push enviadas através do canal Apple Push Notification service (APNs) para aplicativos em execução em dispositivos iOS.

  • EMAIL: para um endpoint que possa receber mensagens de e-mail.

  • GCM: para um endpoint que possa receber notificações por push enviadas através do canal Firebase Cloud Messaging (FCM) para aplicativos em execução em dispositivos Android.

  • SMS: para um endpoint que possa receber mensagens de texto SMS.

  • VOICE: para um endpoint que possa receber mensagens de voz.

CreationDate A data e a hora em que o endpoint foi adicionado ao projeto, no formato ISO 8601. Por exemplo, 2019-06-30T11:45:25.220Z para 11:45 UTC 30 de junho de 2019.
Demographic.AppVersion O número da versão do aplicativo que está associado ao endpoint.
Demographic.Locale A região do endpoint, no seguinte formato: o código ISO 639-1 alfa-2 seguido por um sublinhado (_), seguido por um valor ISO 3166-1 alfa-2 . Por exemplo, en_US é a região do idioma Inglês para os Estados Unidos.
Demographic.Make O fabricante do dispositivo de endpoint, como apple ou samsung.
Demographic.Model O nome do modelo ou número do dispositivo do endpoint, como iPhone ou SM-G900F.
Demographic.ModelVersion A versão do modelo do dispositivo de endpoint.
Demographic.Platform O sistema operacional do dispositivo do endpoint, como ios ou android.
Demographic.PlatformVersion A versão do sistema operacional do dispositivo do endpoint.
Demographic.Timezone O fuso horário do endpoint, como um valor de banco de dados tz. Por exemplo, America/Los_Angeles para o horário do Pacífico (América do Norte).
EffectiveDate A data e a hora em que o endpoint foi atualizado pela última vez, no formato ISO 8601. Por exemplo, 2019-08-23T10:54:35.220Z para 10:54 UTC 23 de agosto de 2019.
EndpointId O identificador exclusivo do endpoint.
EndpointStatus Se desejar enviar mensagens ou notificações push para o endpoint: ACTIVE, enviar mensagens para o endpoint; ou INACTIVE, não enviar mensagens para o endpoint.
Id O identificador exclusivo do endpoint.
Pinpoint.JourneyId O identificador exclusivo da viagem.
Location.City A cidade onde o endpoint está localizado.
Location.Country O código de três letras no formato ISO 3166-1 alpha-2 do país ou região onde o endpoint está localizado. Por exemplo, US para os Estados Unidos.
Location.Latitude A coordenada de latitude da localização do endpoint, arredondada para uma casa decimal.
Location.Longitude A coordenada de longitude da localização do endpoint, arredondada para uma casa decimal.
Location.PostalCode O código postal ou CEP para a área onde o endpoint está localizado.
Location.Region O nome da região, como o estado ou a província onde o endpoint está localizado.
Metrics.custom_attribute Uma métrica numérica personalizada que o aplicativo informa ao Amazon Pinpoint para o endpoint.
OptOut Se o usuário tiver optado por não receber mensagens e notificações por push de você: ALL, o usuário optou por não receber mensagens ou notificações por push; ou NONE, o usuário não optou por não receber e deseja receber todas as mensagens e notificações por push.
RecommendationItems Um atributo padrão recomendado que armazena uma recomendação para o endpoint ou usuário. Esse atributo contém texto fornecido diretamente por um modelo de recomendação.
RecommendationItems.[#]

Um atributo padrão recomendado que armazena uma lista ordenada de duas a cinco recomendações para o endpoint ou usuário. Esse atributo contém texto fornecido diretamente por um modelo de recomendação.

O espaço reservado numérico (.[#]) indica que o atributo contém vários valores. Uma variável de mensagem para esse atributo pode se referir a um valor específico na lista.

Recommendations.custom_attribute Um atributo recomendado personalizado que armazena uma recomendação para o endpoint ou o usuário. Esse atributo contém conteúdo fornecido por um modelo de recomendação e aprimorado por uma AWS Lambda função.
Recommendations.custom_attribute.[#]

Um atributo recomendado personalizado que armazena várias recomendações para o endpoint ou o usuário. Esse atributo contém conteúdo fornecido por um modelo de recomendação e aprimorado por uma função do AWS Lambda .

O espaço reservado numérico (.[#]) indica que o atributo contém vários valores. Uma variável de mensagem para esse atributo pode se referir a um desses valores especificamente.

RequestId O identificador exclusivo da solicitação mais recente de atualização do endpoint.
User.UserAttributes.custom_attribute Um atributo de usuário personalizado que descreve o usuário.
User.UserId Um identificador exclusivo para o usuário.