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á.
Enviar e recuperar mensagens no aplicativo no Amazon Pinpoint
Você pode usar mensagens no aplicativo para enviar mensagens direcionadas aos usuários de seus aplicativos. Mensagens no aplicativo são altamente personalizáveis. Elas podem incluir botões que abrem sites ou levam os usuários a partes específicas do seu aplicativo. Você pode configurar as cores de fundo e do texto, posicionar o texto e adicionar botões e imagens à notificação. Você pode enviar uma única mensagem ou criar um carrossel que contenha até cinco mensagens exclusivas. Para uma visão geral das mensagens no aplicativo, incluindo instruções para criar modelos de mensagens no aplicativo, consulte Criação de modelos no aplicativo no Guia do usuário do Amazon Pinpoint.
Você pode usar AWS Amplify para integrar perfeitamente os recursos de mensagens no aplicativo do Amazon Pinpoint ao seu aplicativo. O Amplify pode gerenciar automaticamente os processos de busca de mensagens, renderização de mensagens e envio de dados de análise para o Amazon Pinpoint. Atualmente, essa integração é compatível com aplicativos React Native. Para obter mais informações, consulte Mensagens no aplicativo
Esta seção fornece informações sobre como solicitar mensagens no aplicativo para um endpoint em seu aplicativo e como interpretar o resultado dessa solicitação.
Recuperação de mensagens no aplicativo para um endpoint
Seus aplicativos podem chamar a GetInAppMessagesAPI para recuperar todas as mensagens no aplicativo às quais um determinado endpoint tem direito. Quando você chama a API GetInAppMessages
, fornece os seguintes parâmetros:
-
ApplicationId
: o ID exclusivo do projeto do Amazon Pinpoint ao qual a campanha de mensagem no aplicativo está associada. -
EndpointId
: o ID exclusivo do endpoint para o qual você está recuperando mensagens.
Quando você chama a API com esses valores, ela retorna uma lista de mensagens. Para obter mais informações sobre a resposta produzida por essa operação, consulte Entendimento das respostas da API GetInAppMessages
Você pode usar os AWS SDKs para chamar a GetInAppMessages
operação. Os exemplos de código a seguir incluem funções que recuperam mensagens no aplicativo.
Entendimento das respostas da API GetInAppMessages
Quando você chama a operação da GetInAppMessagesAPI, ela retorna uma lista de mensagens às quais o endpoint especificado tem direito. Seu aplicativo pode então renderizar a mensagem com base nos valores da resposta.
A lista a seguir é um exemplo do objeto JSON retornado quando você chama a API GetInAppMessages
:
{ "InAppMessagesResponse":{ "InAppMessageCampaigns":[ { "CampaignId":"inAppTestCampaign-4c545b28d21a490cb51b0b364example", "DailyCap":0, "InAppMessage":{ "Content":[ { "BackgroundColor":"#f8e71c", "BodyConfig":{ "Alignment":"CENTER", "Body":"This is a sample in-app message sent using Amazon Pinpoint.", "TextColor":"#d0021b" }, "HeaderConfig":{ "Alignment":"CENTER", "Header":"Sample In-App Message", "TextColor":"#d0021b" }, "ImageUrl":"https://example.com/images/thumbnail.png", "PrimaryBtn":{ "DefaultConfig":{ "BackgroundColor":"#d0021b", "BorderRadius":50, "ButtonAction":"CLOSE", "Text":"Dismiss", "TextColor":"#f8e71c" } } } ], "Layout":"MIDDLE_BANNER" }, "Priority":3, "Schedule":{ "EndDate":"2021-11-06T00:08:05Z", "EventFilter":{ "Dimensions":{ "Attributes":{ }, "EventType":{ "DimensionType":"INCLUSIVE", "Values":[ "_session.start" ] }, "Metrics":{ } } } }, "SessionCap":0, "TotalCap":0, "TreatmentId":"0" } ] } }
As seções a seguir fornecem mais informações sobre os componentes dessa resposta.
Objeto InAppMessageCampaigns
O objeto InAppMessageCampaigns
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
Uma cadeia de caracteres que contém o nome e o ID exclusivo da campanha do Amazon Pinpoint da qual a mensagem foi enviada. O nome precede o ID da campanha. Os dois valores são separados por um hífen (-). |
Criado automaticamente pelo Amazon Pinpoint quando você cria a campanha. |
|
Um número inteiro que representa o ID do tratamento da campanha para essa mensagem. Se a campanha tiver apenas um tratamento, o valor será |
|
|
A prioridade da mensagem no aplicativo, expressa como um número inteiro entre 1 e 5, em que 1 indica a prioridade mais alta e 5 indica a prioridade mais baixa. |
Etapa 1 do processo de criação da campanha. |
|
Um Objeto InAppMessage que contém informações sobre como a mensagem é renderizada. |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
Um objeto de programação que contém informações sobre quando a mensagem foi enviada. |
Etapa 4 do processo de criação da campanha (se a campanha foi criada no console) ou do objeto |
|
O número de vezes, mostrado como um número inteiro, em que uma mensagem no aplicativo pode ser exibida ao usuário durante um período de 24 horas. |
Herdado das configurações em nível de projeto. Se a campanha incluir configurações que substituam as configurações do projeto, as primeiras serão utilizadas. |
|
O número de vezes, expresso como um número inteiro, em que uma mensagem no aplicativo pode ser exibida ao usuário durante uma sessão do aplicativo. |
|
|
O número total de vezes, expresso como um número inteiro, em que qualquer mensagem no aplicativo pode ser exibida para um endpoint por campanha. |
Objeto InAppMessage
O objeto InAppMessage
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
Uma matriz contendo um InAppMessageContentobjeto, que descreve o conteúdo da mensagem. |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
Uma cadeia de caracteres que descreve como a mensagem no aplicativo será exibida no dispositivo do destinatário. Os valores possíveis são:
|
Objeto HeaderConfig
O objeto HeaderConfig
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
Uma cadeia de caracteres que especifica o alinhamento do texto do cabeçalho. Os valores possíveis são |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
O texto do cabeçalho da mensagem. |
|
|
A cor do texto do cabeçalho, expressa como um código de cor hexadecimal (como “#000000” para preto). |
Objeto BodyConfig
O objeto BodyConfig
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
Uma cadeia de caracteres que especifica o alinhamento do texto do corpo da mensagem. Os valores possíveis são |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
O corpo do texto principal da mensagem. |
|
|
A cor do corpo do texto, expressa como uma cadeia de caracteres que consiste em um código de cor hexadecimal (como “#000000” para preto). |
Objeto InAppMessageContent
O objeto InAppMessageContent
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
A cor de fundo da mensagem no aplicativo, expressa como uma cadeia de caracteres que contém um código de cor hexadecimal (como “#000000” para preto). |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
Um BodyConfigobjeto que contém informações relacionadas ao conteúdo principal do corpo da mensagem. |
|
|
Um HeaderConfigobjeto que contém informações relacionadas ao cabeçalho ou título da mensagem. |
|
|
O URL da imagem que aparece na mensagem. |
|
|
Um InAppMessageButtonobjeto que contém informações sobre o botão principal na mensagem. |
|
|
Um InAppMessageButtonobjeto que contém informações sobre o botão secundário na mensagem. Não está presente se o modelo de mensagem no aplicativo não especificar um botão secundário. |
Objeto Schedule
O objeto Schedule
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
O horário programado, no formato ISO 8601, quando a campanha terminou ou terminará. |
Etapa 4 do processo de criação da campanha (se a campanha foi criada no console) ou do objeto |
|
Informações sobre o evento que faz com que a mensagem no aplicativo seja exibida. Quando você gera um evento que corresponde a uma campanha no aplicativo do Amazon Pinpoint, a mensagem é exibida. |
Objeto InAppMessageButton
Um objeto InAppMessageButton
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
Um DefaultButtonConfigobjeto que contém informações sobre as configurações padrão de um botão em uma mensagem no aplicativo. |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
Um OverrideButtonConfigobjeto que especifica a forma como o botão se comporta em dispositivos Android. Isso substitui a configuração de botão padrão detalhada no objeto |
|
|
Um OverrideButtonConfigobjeto que especifica a forma como o botão se comporta em dispositivos iOS. Isso substitui a configuração de botão padrão detalhada no objeto |
|
|
Um OverrideButtonConfigobjeto que especifica a forma como o botão se comporta em aplicativos da web. Isso substitui a configuração de botão padrão detalhada no objeto |
Objeto DefaultButtonConfig
Um objeto DefaultButtonConfig
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
A cor de fundo do botão, expressa como uma cadeia de caracteres que contém o código de cor hexadecimal (como “#000000” para preto). |
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
O raio da borda do botão em pixels, expresso como um número inteiro. Um número maior resulta em cantos mais arredondados. | |
|
Uma cadeia de caracteres que descreve a ação que ocorre quando um destinatário escolhe um botão em uma mensagem no aplicativo. Os valores possíveis são:
|
|
|
O URL de destino de um botão. Não está presente nos botões onde ButtonAction está |
|
|
O texto que aparece no botão. | |
|
A cor do texto no botão, expressa como uma cadeia de caracteres que contém um código de cor hexadecimal (como “#000000” para preto). |
Objeto OverrideButtonConfig
O objeto OverrideButtonConfig
só estará presente se o modelo de mensagem no aplicativo usar botões de substituição. Um botão de substituição é um botão que tem uma configuração específica para um determinado tipo de dispositivo, como um dispositivo iOS, um dispositivo Android ou um navegador da web.
Um objeto OverrideButtonConfig
contém os seguintes atributos:
Atributo | Descrição | Onde é definido |
---|---|---|
|
A ação que ocorre quando um destinatário escolhe um botão em uma mensagem no aplicativo. Os valores possíveis são:
|
Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha. |
|
O URL de destino de um botão. Não está presente nos botões em que |
|
|
O texto que aparece no botão. | |
|
A cor do texto no botão, expressa como uma cadeia de caracteres que contém um código de cor hexadecimal (como “#000000” para preto). |