GetInAppMessagesEsempio JSON di risposta dell'API Amazon Pinpoint

Quando si chiama l'operazione GetInAppMessagesAPI, viene restituito un elenco di messaggi a cui l'endpoint specificato ha diritto. L'app può quindi eseguire il rendering del messaggio in base ai valori della risposta.

Di seguito è riportato un esempio dell'oggetto JSON restituito quando si esegue una chiamata all'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"
      }
    ]
  }
}

Le seguenti sezioni forniscono informazioni sui componenti di questa risposta e sui relativi attributi.

Oggetto InAppMessageCampaigns

L'oggetto InAppMessageCampaigns contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
CampaignId	Stringa contenente il nome e l'ID univoco della campagna Amazon Pinpoint da cui è stato inviato il messaggio. Il nome precede l'ID della campagna. I due valori sono separati da un trattino (-).	Creato automaticamente da Amazon Pinpoint al momento della creazione della campagna.
TreatmentId	Numero intero che rappresenta l'ID del trattamento della campagna per questo messaggio. Se la campagna ha un solo trattamento, il valore è 0.
Priority	La priorità del messaggio in-app, espressa come numero intero compreso tra 1 e 5, incluso, dove 1 indica la priorità più alta e 5 indica la priorità più bassa.	Passaggio 1 del processo di creazione della campagna.
InAppMessage	Oggetto InAppMessage contenente informazioni su come viene visualizzato il messaggio.	In base al contenuto del modello di messaggio in-app specificato per la campagna.
Schedule	Oggetto Schedule contenente informazioni su quando il messaggio è stato inviato.	Passaggio 4 del processo di creazione della campagna (se la campagna è stata creata nella console) o dell'oggetto Schedule (se la campagna è stata creata utilizzando l'API o un SDK).
DailyCap	Numero di volte, espresso come numero intero, in cui un messaggio in-app può essere mostrato all'utente nell'arco di 24 ore.	Ereditato dalle impostazioni a livello di progetto. Se la campagna include impostazioni che sovrascrivono le impostazioni del progetto, vengono utilizzate le impostazioni della campagna.
SessionCap	Numero di volte, espresso come numero intero, in cui un messaggio in-app può essere mostrato all'utente durante una sessione dell'applicazione.
TotalCap	Numero totale di volte, espresso come numero intero, in cui un messaggio in-app può essere mostrato a un endpoint per campagna.

Oggetto InAppMessage

L'oggetto InAppMessage contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
Content	Un array contenente un InAppMessageContentoggetto, che descrive il contenuto del messaggio.	In base al contenuto del modello di messaggio in-app specificato per la campagna.
Layout	Stringa che descrive come verrà visualizzato il messaggio in-app sul dispositivo del destinatario. I valori possibili sono: BOTTOM_BANNER: un messaggio visualizzato come banner nella parte inferiore della pagina. TOP_BANNER: un messaggio visualizzato come banner nella parte superiore della pagina. OVERLAYS: un messaggio che copre l'intero schermo. MOBILE_FEED: un messaggio visualizzato in una finestra davanti alla pagina. MIDDLE_BANNER: un messaggio visualizzato come banner nella parte centrale della pagina. CAROUSEL: un layout scorrevole contenente fino a cinque messaggi univoci.

Oggetto HeaderConfig

L'oggetto HeaderConfig contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
Alignment	Stringa che specifica l'allineamento del testo dell'intestazione. I valori possibili sono LEFT, CENTER e RIGHT.	In base al contenuto del modello di messaggio in-app specificato per la campagna.
Header	Testo dell'intestazione del messaggio.
TextColor	Colore del testo dell'intestazione, espresso come codice colore esadecimale (come "#000000" per il nero).

Oggetto BodyConfig

L'oggetto BodyConfig contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
Alignment	Stringa che specifica l'allineamento del corpo del messaggio. I valori possibili sono LEFT, CENTER e RIGHT.	In base al contenuto del modello di messaggio in-app specificato per la campagna.
Body	Il corpo del testo principale del messaggio.
TextColor	Colore del corpo del testo, espresso sotto forma di stringa contenente un codice colore esadecimale (come "#000000" per il nero).

Oggetto InAppMessageContent

L'oggetto InAppMessageContent contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
BackgroundColor	Colore di sfondo del messaggio in-app, espresso come stringa contenente un codice colore esadecimale (ad esempio "#000000" per il nero).	In base al contenuto del modello di messaggio in-app specificato per la campagna.
BodyConfig	Un BodyConfigoggetto, che contiene informazioni relative al contenuto principale del messaggio.
HeaderConfig	Un HeaderConfigoggetto che contiene informazioni relative all'intestazione o al titolo del messaggio.
ImageUrl	URL dell'immagine visualizzata nel messaggio.
PrimaryBtn	Un InAppMessageButtonoggetto che contiene informazioni sul pulsante principale del messaggio.
SecondaryBtn	Un InAppMessageButtonoggetto che contiene informazioni sul pulsante secondario del messaggio. Non presente se il modello di messaggio in-app non specifica un pulsante secondario.

Oggetto Schedule

L'oggetto Schedule contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
EndDate	Ora pianificata, in formato ISO 8601, per il termine della campagna.	Passaggio 4 del processo di creazione della campagna (se la campagna è stata creata nella console) o dell'oggetto Schedule (se la campagna è stata creata utilizzando l'API o un SDK).
EventFilter	Informazioni sull'evento che causa la visualizzazione del messaggio in-app. Quando generi un evento che corrisponde a una campagna in-app Amazon Pinpoint, viene visualizzato il messaggio.

Oggetto InAppMessageButton

Un oggetto InAppMessageButton contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
DefaultConfig	Un DefaultButtonConfigoggetto che contiene informazioni sulle impostazioni predefinite per un pulsante in un messaggio in-app.	In base al contenuto del modello di messaggio in-app specificato per la campagna.
Android	Un OverrideButtonConfigoggetto che specifica il comportamento del pulsante sui dispositivi Android. Ciò sovrascrive la configurazione predefinita dei pulsanti specificata nell'oggetto DefaultConfig.
IOS	Un OverrideButtonConfigoggetto che specifica il comportamento del pulsante sui dispositivi iOS. Ciò sovrascrive la configurazione predefinita dei pulsanti specificata nell'oggetto DefaultConfig.
Web	Un OverrideButtonConfigoggetto che specifica il comportamento del pulsante nelle app Web. Ciò sovrascrive la configurazione predefinita dei pulsanti specificata nell'oggetto DefaultConfig.

Oggetto DefaultButtonConfig

Un oggetto DefaultButtonConfig contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
BackgroundColor	Colore di sfondo del pulsante, espresso come stringa contenente un codice colore esadecimale (ad esempio "#000000" per il nero).	In base al contenuto del modello di messaggio in-app specificato per la campagna.
BorderRadius	Raggio del bordo del pulsante in pixel, espresso come numero intero. Un numero più alto genera angoli più arrotondati.
ButtonAction	Stringa che descrive l'azione che si verifica quando un destinatario sceglie un pulsante in un messaggio in-app. I valori possibili sono: LINK: un collegamento a una destinazione Web. DEEP_LINK: un collegamento a una pagina specifica di un'applicazione. CLOSE: elimina il messaggio.
Link	URL di destinazione di un pulsante. Non presente per i pulsanti in cui è presente. ButtonAction CLOSE
Text	Il testo visualizzato sul pulsante.
TextColor	Colore del testo del pulsante, espresso come stringa contenente un codice colore esadecimale (ad esempio "#000000" per il nero).

Oggetto OverrideButtonConfig

L'oggetto OverrideButtonConfig è presente solo se il modello di messaggio in-app utilizza pulsanti di override. Un pulsante di override è un pulsante con una configurazione specifica per un particolare tipo di dispositivo, ad esempio un dispositivo iOS, un dispositivo Android o un browser Web.

Un oggetto OverrideButtonConfig contiene gli attributi seguenti:

Attributo	Descrizione	Dove viene impostato
ButtonAction	Azione che si verifica quando un destinatario sceglie un pulsante in un messaggio in-app. I valori possibili sono: LINK: un collegamento a una destinazione Web. DEEP_LINK: un collegamento a una pagina specifica di un'applicazione. CLOSE: elimina il messaggio.	In base al contenuto del modello di messaggio in-app specificato per la campagna.
Link	URL di destinazione di un pulsante. Non presente per i pulsanti in cui l'attributo ButtonAction è impostato su CLOSE.
Text	Il testo visualizzato sul pulsante.
TextColor	Colore del testo del pulsante, espresso come stringa contenente un codice colore esadecimale (ad esempio "#000000" per il nero).