Ejemplo de JSON de respuesta de la API GetInAppMessages de Amazon Pinpoint

Cuando llamas a la operación de la GetInAppMessagesAPI, devuelve una lista de mensajes a los que tiene derecho el punto final especificado. Después, la aplicación puede procesar el mensaje en función de los valores de la respuesta.

A continuación, se ofrece un ejemplo del objeto JSON que se devuelve cuando llame a la API de 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"
      }
    ]
  }
}

En las siguientes secciones se proporciona más información sobre los componentes de esta respuesta y sus atributos.

Objeto InAppMessageCampaigns

El objeto InAppMessageCampaigns contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
CampaignId	Una cadena que contiene el nombre y el ID de campaña exclusivo de la campaña de Amazon Pinpoint desde la que se envió el mensaje. El nombre precede al ID de la campaña. Los dos valores se separan con un guion (-).	Amazon Pinpoint la crea automáticamente al crear la campaña.
TreatmentId	Un número entero que representa el ID del tratamiento de campaña de este mensaje. Si la campaña solo tiene un tratamiento, el valor es 0.
Priority	La prioridad del mensaje en la aplicación, expresada como un número entero entre 1 y 5, ambos inclusive, donde 1 indica la prioridad más alta y 5 indica la más baja.	Paso 1 del proceso de creación de la campaña.
InAppMessage	Y Objeto InAppMessage que contiene información sobre cómo se representa el mensaje.	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
Schedule	Un objeto de programación que contiene información sobre cuándo se envió el mensaje.	El paso 4 del proceso de creación de la campaña (si la campaña se creó en la consola) o el objeto de Schedule (si la campaña se creó mediante la API o un SDK).
DailyCap	El número de veces, que se muestra como un número entero, que se puede mostrar al usuario un mensaje integrado en la aplicación durante un periodo de 24 horas.	Se hereda de la configuración a nivel de proyecto. Si la campaña incluye ajustes que invalidan los ajustes del proyecto, se utilizan en su lugar.
SessionCap	El número de veces, expresado como un entero, que se puede mostrar al usuario un mensaje integrado en la aplicación durante una sesión de la aplicación.
TotalCap	El número total de veces, expresado como un entero, que se puede mostrar un mensaje integrado en la aplicación a un punto de conexión por campaña.

Objeto InAppMessage

El objeto InAppMessage contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
Content	Matriz que contiene un InAppMessageContentobjeto que describe el contenido del mensaje.	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
Layout	Una cadena que describe cómo aparecerá el mensaje integrado en la aplicación en el dispositivo del destinatario. Los valores posibles son los siguientes: BOTTOM_BANNER: un mensaje que aparece como un banner en la parte inferior de la página. TOP_BANNER: un mensaje que aparece como un banner en la parte superior de la página. OVERLAYS: un mensaje que abarca toda la pantalla. MOBILE_FEED: un mensaje que aparece en una ventana delante de la página. MIDDLE_BANNER: un mensaje que aparece como un banner en el centro de la página. CAROUSEL: un formato desplazable de hasta cinco mensajes únicos.

Objeto HeaderConfig

El objeto HeaderConfig contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
Alignment	Una cadena que especifica la alineación del texto del encabezado. Los posibles valores son LEFT, CENTER y RIGHT.	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
Header	El texto del encabezado del mensaje.
TextColor	El color del texto del encabezado, expresado como una cadena que describe el código de color hexadecimal (por ejemplo, “#000000” para el negro).

Objeto BodyConfig

El objeto BodyConfig contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
Alignment	Una cadena que especifica la alineación del texto del cuerpo del mensaje. Los posibles valores son LEFT, CENTER y RIGHT.	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
Body	El texto principal del cuerpo del mensaje.
TextColor	El color del texto del cuerpo, expresado como una cadena que contiene un código de color hexadecimal (por ejemplo, “#000000” para el color negro).

Objeto InAppMessageContent

El objeto InAppMessageContent contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
BackgroundColor	El color de fondo del mensaje integrado en la aplicación, expresado como una cadena que contiene un código de color hexadecimal (por ejemplo, “#000000” para el negro).	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
BodyConfig	BodyConfigObjeto que contiene información relacionada con el contenido del cuerpo principal del mensaje.
HeaderConfig	Un HeaderConfigobjeto que contiene información relacionada con el encabezado o el título del mensaje.
ImageUrl	La URL de la imagen que aparece en el mensaje.
PrimaryBtn	InAppMessageButtonObjeto que contiene información sobre el botón principal del mensaje.
SecondaryBtn	InAppMessageButtonObjeto que contiene información sobre el botón secundario del mensaje. No está presente si la plantilla de mensaje integrada en la aplicación no especifica un botón secundario.

Objeto Schedule

El objeto Schedule contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
EndDate	La hora programada, en formato ISO 8601, cuando la campaña terminará.	El paso 4 del proceso de creación de la campaña (si la campaña se creó en la consola) o el objeto de Schedule (si la campaña se creó mediante la API o un SDK).
EventFilter	Información sobre el evento que provoca que se muestre el mensaje integrado en la aplicación. Cuando genera un evento que coincide con una campaña integrada en la aplicación de Amazon Pinpoint, se muestra el mensaje.

Objeto InAppMessageButton

Un objeto InAppMessageButton contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
DefaultConfig	DefaultButtonConfigObjeto que contiene información sobre la configuración predeterminada de un botón en un mensaje integrado en la aplicación.	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
Android	OverrideButtonConfigObjeto que especifica el comportamiento del botón en los dispositivos Android. Esto invalida la configuración de botones predeterminada detallada en el objeto de DefaultConfig.
IOS	OverrideButtonConfigObjeto que especifica el comportamiento del botón en los dispositivos iOS. Esto invalida la configuración de botones predeterminada detallada en el objeto de DefaultConfig.
Web	OverrideButtonConfigObjeto que especifica el comportamiento del botón en las aplicaciones web. Esto invalida la configuración de botones predeterminada detallada en el objeto de DefaultConfig.

Objeto DefaultButtonConfig

Un objeto DefaultButtonConfig contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
BackgroundColor	El color de fondo del botón, expresado como una cadena que contiene un código de color hexadecimal (por ejemplo, “#000000” para el negro).	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
BorderRadius	El radio del borde del botón en píxeles, expresado como un número entero. Un número mayor da como resultado esquinas más redondeadas.
ButtonAction	Una cadena que describe la acción que se produce cuando un destinatario elige un botón en el mensaje integrado en la aplicación. Los valores posibles son los siguientes: LINK: un enlace a un destino web. DEEP_LINK: un enlace a una página específica de una aplicación. CLOSE: omite el mensaje.
Link	La URL de destino de un botón. No está presente en los botones donde ButtonAction estáCLOSE.
Text	El texto que aparece en el botón.
TextColor	El color del texto en el botón, expresado como una cadena que contiene un código de color hexadecimal (por ejemplo, “#000000” para el negro).

Objeto OverrideButtonConfig

El objeto OverrideButtonConfig solo está presente si la plantilla de mensajes integrada en la aplicación utiliza botones de invalidación. Un botón de invalidación es un botón que tiene una configuración específica para un tipo de dispositivo concreto, como un dispositivo iOS, un dispositivo Android o un navegador web.

Un objeto OverrideButtonConfig contiene los siguientes atributos:

Atributo	Descripción	Dónde tiene lugar
ButtonAction	La acción que se produce cuando un destinatario elige un botón en el mensaje en la aplicación. Los valores posibles son los siguientes: LINK: un enlace a un destino web. DEEP_LINK: un enlace a una página específica de una aplicación. CLOSE: omite el mensaje.	En función del contenido de la plantilla de mensajes integrada en la aplicación que se especificó para la campaña.
Link	La URL de destino de un botón. No está presente para los botones en los que ButtonAction es CLOSE.
Text	El texto que aparece en el botón.
TextColor	El color del texto en el botón, expresado como una cadena que contiene un código de color hexadecimal (por ejemplo, “#000000” para el negro).