Exemplo de resposta JSON da API GetInAppMessages do Amazon Pinpoint

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 informações sobre os componentes dessa resposta e seu atributo.

Objeto InAppMessageCampaigns

O objeto InAppMessageCampaigns contém os seguintes atributos:

Atributo	Descrição	Onde é definido
CampaignId	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.
TreatmentId	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á 0.
Priority	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.
InAppMessage	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.
Schedule	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 Schedule (se a campanha foi criada usando a API ou um SDK).
DailyCap	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.
SessionCap	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.
TotalCap	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
Content	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.
Layout	Uma cadeia de caracteres que descreve como a mensagem no aplicativo será exibida no dispositivo do destinatário. Os valores possíveis são: BOTTOM_BANNER: a mensagem exibida como um banner na parte inferior da página. TOP_BANNER: a mensagem exibida como um banner na parte superior da página. OVERLAYS: a mensagem cobre toda a tela. MOBILE_FEED: a mensagem é mostrada em uma janela na frente da página. MIDDLE_BANNER: a mensagem exibida como um banner no meio da página. CAROUSEL: um layout rolável de até cinco mensagens exclusivas.

Objeto HeaderConfig

O objeto HeaderConfig contém os seguintes atributos:

Atributo	Descrição	Onde é definido
Alignment	Uma cadeia de caracteres que especifica o alinhamento do texto do cabeçalho. Os valores possíveis são LEFT, CENTER e RIGHT.	Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha.
Header	O texto do cabeçalho da mensagem.
TextColor	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
Alignment	Uma cadeia de caracteres que especifica o alinhamento do texto do corpo da mensagem. Os valores possíveis são LEFT, CENTER e RIGHT.	Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha.
Body	O corpo do texto principal da mensagem.
TextColor	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
BackgroundColor	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.
BodyConfig	Um BodyConfigobjeto que contém informações relacionadas ao conteúdo principal do corpo da mensagem.
HeaderConfig	Um HeaderConfigobjeto que contém informações relacionadas ao cabeçalho ou título da mensagem.
ImageUrl	O URL da imagem que aparece na mensagem.
PrimaryBtn	Um InAppMessageButtonobjeto que contém informações sobre o botão principal na mensagem.
SecondaryBtn	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
EndDate	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 Schedule (se a campanha foi criada usando a API ou um SDK).
EventFilter	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
DefaultConfig	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.
Android	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 DefaultConfig.
IOS	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 DefaultConfig.
Web	Um OverrideButtonConfigobjeto que especifica a forma como o botão se comporta em aplicativos web. Isso substitui a configuração de botão padrão detalhada no objeto DefaultConfig.

Objeto DefaultButtonConfig

Um objeto DefaultButtonConfig contém os seguintes atributos:

Atributo	Descrição	Onde é definido
BackgroundColor	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.
BorderRadius	O raio da borda do botão em pixels, expresso como um número inteiro. Um número maior resulta em cantos mais arredondados.
ButtonAction	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: LINK: um link para um destino na Web. DEEP_LINK: um link para uma página específica em uma aplicação. CLOSE: ignora a mensagem.
Link	O URL de destino de um botão. Não está presente nos botões onde ButtonAction estáCLOSE.
Text	O texto que aparece no botão.
TextColor	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
ButtonAction	A ação que ocorre quando um destinatário escolhe um botão em uma mensagem no aplicativo. Os valores possíveis são: LINK: um link para um destino na Web. DEEP_LINK: um link para uma página específica em uma aplicação. CLOSE: ignora a mensagem.	Com base no conteúdo do modelo de mensagem no aplicativo que foi especificado para a campanha.
Link	O URL de destino de um botão. Não está presente nos botões em que ButtonAction está CLOSE.
Text	O texto que aparece no botão.
TextColor	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).