GetInAppMessagesExemple JSON de réponse à l'API Amazon Pinpoint

Lorsque vous appelez l'opération GetInAppMessagesAPI, elle renvoie une liste de messages auxquels le point de terminaison spécifié a droit. Votre application peut ensuite afficher le message en fonction des valeurs de la réponse.

Voici un exemple d'objet JSON renvoyé lorsque vous appelez l'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"
      }
    ]
  }
}

Les sections suivantes fournissent des informations sur les composants de cette réponse et leurs attributs.

Objet InAppMessageCampaigns

L'objet InAppMessageCampaigns contient les attributs suivants :

Attribut	Description	Emplacement d'installation
CampaignId	Chaîne contenant le nom et l'ID de campagne unique de la campagne Amazon Pinpoint à partir de laquelle le message a été envoyé. Nom précède l'ID de campagne. Les deux valeurs sont séparées par un tiret (-).	Créé automatiquement par Amazon Pinpoint lorsque vous créez la campagne.
TreatmentId	Nombre entier qui représente l'ID du traitement de campagne pour ce message. Si la campagne ne comporte qu'un seul traitement, la valeur est 0.
Priority	La priorité du message intégré, exprimée sous la forme d'un nombre entier compris entre 1 et 5, inclus, où 1 indique la priorité la plus élevée et 5 la priorité la plus faible.	Étape 1 du processus de création de campagne.
InAppMessage	Un Objet InAppMessage qui contient des informations sur la façon dont le message est rendu.	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
Schedule	Un objet Schedule qui contient des informations sur la date d'envoi du message.	Étape 4 du processus de création de campagne (si la campagne a été créée dans la console) ou de l'objet Schedule (si la campagne a été créée à l'aide de l'API ou d'un kit SDK).
DailyCap	Le nombre de fois, sous forme de nombre entier, qu'un message dans l'application peut être affiché à l'utilisateur sur une période de 24 heures.	Hérité des paramètres au niveau du projet. Si la campagne inclut des paramètres qui remplacent ceux du projet, ceux-ci sont utilisés à la place.
SessionCap	Le nombre de fois, exprimé sous forme de nombre entier, qu'un message intégré à l'application peut être affiché à l'utilisateur au cours d'une session d'application.
TotalCap	Le nombre total de fois, exprimé sous forme de nombre entier, qu'un message intégré à l'application peut être affiché à un point de terminaison par campagne.

Objet InAppMessage

L'objet InAppMessage contient les attributs suivants :

Attribut	Description	Emplacement d'installation
Content	Tableau contenant un InAppMessageContentobjet qui décrit le contenu du message.	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
Layout	Une chaîne qui décrit la façon dont le message intégré à l'application s'affichera sur l'appareil du destinataire. Les valeurs possibles sont : BOTTOM_BANNER : un message qui s'affiche sous la forme d'une bannière en bas de la page. TOP_BANNER : un message qui s'affiche sous la forme d'une bannière en haut de la page. OVERLAYS : un message qui couvre la totalité de l'écran. MOBILE_FEED : un message qui s'affiche dans une fenêtre en face de la page. MIDDLE_BANNER : un message qui s'affiche sous forme de bannière au milieu de la page. CAROUSEL : une mise en page déroulante contenant jusqu'à cinq messages uniques.

Objet HeaderConfig

L'objet HeaderConfig contient les attributs suivants :

Attribut	Description	Emplacement d'installation
Alignment	Chaîne qui indique l'alignement du texte de l'en-tête. Les valeurs possibles sont LEFT, CENTER et RIGHT.	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
Header	Texte de l'en-tête du message.
TextColor	La couleur du texte de l'en-tête, exprimée sous la forme d'une chaîne décrivant le code couleur hexadécimal (tel que « #000000 » pour le noir).

Objet BodyConfig

L'objet BodyConfig contient les attributs suivants :

Attribut	Description	Emplacement d'installation
Alignment	Chaîne qui spécifie l'alignement du texte du corps du message. Les valeurs possibles sont LEFT, CENTER et RIGHT.	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
Body	Le corps du texte principal du message.
TextColor	La couleur du corps du texte, exprimée sous la forme d'une chaîne composée d'un code couleur hexadécimal (par exemple : « #000000 » pour le noir).

Objet InAppMessageContent

L'objet InAppMessageContent contient les attributs suivants :

Attribut	Description	Emplacement d'installation
BackgroundColor	La couleur d'arrière-plan du message dans l'application, exprimée sous la forme d'une chaîne contenant un code de couleur hexadécimal (tel que « #000000 » pour le noir).	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
BodyConfig	BodyConfigObjet contenant des informations relatives au contenu principal du message.
HeaderConfig	HeaderConfigObjet contenant des informations relatives à l'en-tête ou au titre du message.
ImageUrl	L'URL de l'image qui apparaît dans le message.
PrimaryBtn	InAppMessageButtonObjet contenant des informations sur le bouton principal du message.
SecondaryBtn	InAppMessageButtonObjet contenant des informations sur le bouton secondaire du message. Absent si le modèle de message intégré à l'application ne spécifie pas de bouton secondaire.

Objet Schedule

L'objet Schedule contient les attributs suivants :

Attribut	Description	Emplacement d'installation
EndDate	Heure planifiée, au format ISO 8601, à laquelle la campagne se terminera.	Étape 4 du processus de création de campagne (si la campagne a été créée dans la console) ou de l'objet Schedule (si la campagne a été créée à l'aide de l'API ou d'un kit SDK).
EventFilter	Informations sur l'événement à l'origine de l'affichage du message dans l'application. Lorsque vous générez un événement correspondant à une campagne intégrée à l'application Amazon Pinpoint, le message s'affiche.

Objet InAppMessageButton

Un objet InAppMessageButton contient les attributs suivants :

Attribut	Description	Emplacement d'installation
DefaultConfig	DefaultButtonConfigObjet contenant des informations sur les paramètres par défaut d'un bouton dans un message intégré à l'application.	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
Android	OverrideButtonConfigObjet qui indique le comportement du bouton sur les appareils Android. Cette option remplace la configuration par défaut des boutons décrite dans l'objet DefaultConfig.
IOS	OverrideButtonConfigObjet qui indique le comportement du bouton sur les appareils iOS. Cette option remplace la configuration par défaut des boutons décrite dans l'objet DefaultConfig.
Web	OverrideButtonConfigObjet qui indique le comportement du bouton dans les applications Web. Cette option remplace la configuration par défaut des boutons décrite dans l'objet DefaultConfig.

Objet DefaultButtonConfig

Un objet DefaultButtonConfig contient les attributs suivants :

Attribut	Description	Emplacement d'installation
BackgroundColor	La couleur d'arrière-plan d'un bouton, exprimée sous la forme d'une chaîne contenant un code couleur hexadécimal (par exemple : « #000000 » pour le noir).	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
BorderRadius	Rayon de la bordure du bouton en pixels, exprimé sous forme de nombre entier. Plus le nombre est élevé, plus les coins sont arrondis.
ButtonAction	Chaîne décrivant l'action qui se produit lorsque le destinataire choisit un bouton dans le message intégré à l'application. Les valeurs possibles sont : LINK : un lien vers une destination web. DEEP_LINK : un lien vers une page spécifique d'une application. CLOSE : ignore le message.
Link	L'URL de destination d'un bouton. Non présent pour les boutons où se ButtonAction trouve leCLOSE.
Text	Le texte qui apparaît sur le bouton.
TextColor	La couleur du texte du bouton, exprimée sous la forme d'une chaîne contenant un code couleur hexadécimal (par exemple : « #000000 » pour le noir).

Objet OverrideButtonConfig

L'objet OverrideButtonConfig n'est présent que si le modèle de message intégré à l'application utilise des boutons de remplacement. Un bouton de remplacement est un bouton dont la configuration est spécifique pour un type d'appareil particulier, tel qu'un appareil iOS, un appareil Android ou un navigateur Web.

Un objet OverrideButtonConfig contient les attributs suivants :

Attribut	Description	Emplacement d'installation
ButtonAction	L'action qui se produit lorsqu'un destinataire choisit un bouton dans le message intégré à l'application. Les valeurs possibles sont : LINK : un lien vers une destination web. DEEP_LINK : un lien vers une page spécifique d'une application. CLOSE : ignore le message.	Sur la base du contenu du modèle de message dans l'application spécifié pour la campagne.
Link	L'URL de destination d'un bouton. Non présent pour les boutons dont la valeur ButtonAction est CLOSE.
Text	Le texte qui apparaît sur le bouton.
TextColor	La couleur du texte du bouton, exprimée sous la forme d'une chaîne contenant un code couleur hexadécimal (par exemple : « #000000 » pour le noir).