GetInAppMessagesJSON-Beispiel für eine Amazon Pinpoint Pinpoint-API-Antwort

Wenn Sie den GetInAppMessagesAPI-Vorgang aufrufen, wird eine Liste von Nachrichten zurückgegeben, für die der angegebene Endpunkt berechtigt ist. Ihre App kann die Nachricht dann auf der Grundlage der Werte in der Antwort rendern.

Nachstehend finden Sie ein Beispiel eines JSON-Objekts, das zurückgegeben wird, wenn Sie die GetInAppMessages-API aufrufen:

{
  "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"
      }
    ]
  }
}

Die folgenden Abschnitte enthalten Informationen zu den Komponenten dieser Antwort und ihren Attributen.

InAppMessageCampaigns-Objekt

Das InAppMessageCampaigns-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
CampaignId	Eine Zeichenfolge, die den Namen und die eindeutige Kampagnen-ID der Amazon-Pinpoint-Kampagne enthält, von der aus die Nachricht gesendet wurde. Der Name steht vor der Kampagnen-ID. Die beiden Werte werden durch einen Bindestrich (-) getrennt.	Wird automatisch von Amazon Pinpoint erstellt, wenn Sie die Kampagne erstellen.
TreatmentId	Eine Ganzzahl, die die ID der Kampagnenbehandlung für diese Nachricht darstellt. Wenn die Kampagne nur eine Behandlung hat, ist der Wert 0.
Priority	Die Priorität der In-App-Nachricht, ausgedrückt als Ganzzahl zwischen 1 und 5, wobei 1 die höchste Priorität und 5 die niedrigste ist.	Schritt 1 des Prozesses zur Kampagnenerstellung.
InAppMessage	Ein InAppMessage-Objekt, das Informationen darüber enthält, wie die Nachricht gerendert wird.	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
Schedule	Ein Schedule-Objekt, das Informationen darüber enthält, wann die Nachricht gesendet wurde.	Schritt 4 des Prozesses zur Kampagnenerstellung (wenn die Kampagne in der Konsole erstellt wurde) oder des Schedule-Objekts (wenn die Kampagne mithilfe der API oder eines SDK erstellt wurde).
DailyCap	Die Häufigkeit, ausgedrückt als Ganzzahl, mit der eine In-App-Nachricht dem Benutzer innerhalb von 24 Stunden angezeigt werden kann.	Von Einstellungen auf Projektebene übernommen. Wenn die Kampagne Einstellungen enthält, die die Projekteinstellungen überschreiben, werden diese stattdessen verwendet.
SessionCap	Die Häufigkeit, ausgedrückt als Ganzzahl, dass dem Benutzer während einer Anwendungssitzung eine In-App-Nachricht angezeigt werden kann.
TotalCap	Die Gesamtzahl der Male, ausgedrückt als Ganzzahl, pro Kampagne eine In-App-Nachricht einem Endpunkt angezeigt werden kann.

InAppMessage-Objekt

Das InAppMessage-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
Content	Ein Array, InAppMessageContentdas ein Objekt enthält, das den Inhalt der Nachricht beschreibt.	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
Layout	Eine Zeichenfolge, die beschreibt, wie die In-App-Nachricht auf dem Gerät des Empfängers angezeigt wird. Die möglichen Werte sind: BOTTOM_BANNER – eine Nachricht, die als Banner unten auf der Seite angezeigt wird. TOP_BANNER – eine Nachricht, die als Banner oben auf der Seite angezeigt wird. OVERLAYS – eine Nachricht, die den gesamten Bildschirm abdeckt. MOBILE_FEED – eine Nachricht, die in einem Fenster vor der Seite angezeigt wird. MIDDLE_BANNER – eine Nachricht, die als Banner in der Mitte der Seite angezeigt wird. CAROUSEL – ein scrollbares Layout mit bis zu fünf eindeutigen Nachrichten.

HeaderConfig-Objekt

Das HeaderConfig-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
Alignment	Eine Zeichenfolge, die die Textausrichtung des Kopfzeilentexts angibt. Mögliche Werte sind LEFT, CENTER und RIGHT.	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
Header	Der Text der Nachrichtenkopfzeile.
TextColor	Die Farbe des Kopfzeilentexts, ausgedrückt als Hex-Farbcode (z. B. #000000 für Schwarz).

BodyConfig-Objekt

Das BodyConfig-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
Alignment	Eine Zeichenfolge, die die Textausrichtung des Nachrichtentexts angibt. Mögliche Werte sind LEFT, CENTER und RIGHT.	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
Body	Der Haupttext Text der Nachricht.
TextColor	Die Farbe des Textkörpers, ausgedrückt als eine Zeichenfolge für einen Hex-Farbcode (z. B. #000000 für Schwarz).

InAppMessageContent-Objekt

Das InAppMessageContent-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
BackgroundColor	Die Hintergrundfarbe für ein In-App-Nachrichtenbanner, ausgedrückt als Zeichenfolge mit Hex-Farbcode (z. B. #000000 für Schwarz).	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
BodyConfig	Ein BodyConfigObjekt, das Informationen enthält, die sich auf den Hauptinhalt der Nachricht beziehen.
HeaderConfig	Ein HeaderConfigObjekt, das Informationen enthält, die sich auf die Kopfzeile oder den Titel der Nachricht beziehen.
ImageUrl	Die URL des Bildes, das in der Nachricht angezeigt wird.
PrimaryBtn	Ein InAppMessageButtonObjekt, das Informationen über die Hauptschaltfläche in der Nachricht enthält.
SecondaryBtn	Ein InAppMessageButtonObjekt, das Informationen über die sekundäre Schaltfläche in der Nachricht enthält. Nicht vorhanden, wenn die In-App-Nachrichtenvorlage keine sekundäre Schaltfläche angibt.

Schedule-Objekt

Das Schedule-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
EndDate	Die geplante Zeit im ISO 8601-Format, zu der die Kampagne beendet wird.	Schritt 4 des Prozesses zur Kampagnenerstellung (wenn die Kampagne in der Konsole erstellt wurde) oder des Schedule-Objekts (wenn die Kampagne mithilfe der API oder eines SDK erstellt wurde).
EventFilter	Informationen über das Ereignis, das dazu führt, dass die In-App-Nachricht angezeigt wird. Wenn Sie ein Ereignis generieren, das mit einer Amazon-Pinpoint-In-App-Kampagne übereinstimmt, wird die Nachricht angezeigt.

InAppMessageButton-Objekt

Ein InAppMessageButton-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
DefaultConfig	Ein DefaultButtonConfigObjekt, das Informationen über die Standardeinstellungen für eine Schaltfläche in einer In-App-Nachricht enthält.	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
Android	Ein OverrideButtonConfigObjekt, das angibt, wie sich die Schaltfläche auf Android-Geräten verhält. Dies überschreibt die Standard-Schaltflächenkonfiguration, die im DefaultConfig-Objekt detailliert beschrieben ist.
IOS	Ein OverrideButtonConfigObjekt, das angibt, wie sich die Schaltfläche auf iOS-Geräten verhält. Dies überschreibt die Standard-Schaltflächenkonfiguration, die im DefaultConfig-Objekt detailliert beschrieben ist.
Web	Ein OverrideButtonConfigObjekt, das angibt, wie sich die Schaltfläche in Web-Apps verhält. Dies überschreibt die Standard-Schaltflächenkonfiguration, die im DefaultConfig-Objekt detailliert beschrieben ist.

DefaultButtonConfig-Objekt

Ein DefaultButtonConfig-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
BackgroundColor	Die Hintergrundfarbe der Schaltfläche, ausgedrückt als Zeichenfolge mit Hex-Farbcode (z. B. #000000 für Schwarz).	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
BorderRadius	Der Radius des Rahmens der Schaltfläche in Pixeln, ausgedrückt als Ganzzahl. Eine größere Zahl führt zu mehr abgerundeten Ecken.
ButtonAction	Eine Zeichenfolge, die die Aktion beschreibt, die auftritt, wenn ein Empfänger eine Schaltfläche in der In-App-Nachricht auswählt. Die möglichen Werte sind: LINK – Ein Link zu einem Webziel. DEEP_LINK – Ein Link zu einer bestimmten Seite in einer Anwendung. CLOSE – Lehnt die Nachricht ab.
Link	Die Ziel-URL für eine Schaltfläche. Nicht vorhanden für Schaltflächen, bei denen sich der ButtonAction befindetCLOSE.
Text	Der Text, der auf der Schaltfläche angezeigt wird.
TextColor	Die Farbe des Texts auf der Schaltfläche, ausgedrückt als Zeichenfolge mit Hex-Farbcode (z. B. #000000 für Schwarz).

OverrideButtonConfig-Objekt

Das OverrideButtonConfig-Objekt ist nur vorhanden, wenn die In-App-Nachrichtenvorlage Schaltflächen zum Überschreiben verwendet. Eine Override-Schaltfläche ist eine Schaltfläche, die eine spezifische Konfiguration für einen bestimmten Gerätetyp hat, z. B. ein iOS-Gerät, ein Android-Gerät oder einen Webbrowser.

Ein OverrideButtonConfig-Objekt enthält die folgenden Attribute:

Attribut	Beschreibung	Anwendungsbereiche
ButtonAction	Die Aktion, die auftritt, wenn ein Empfänger eine Schaltfläche in der In-App-Nachricht auswählt. Die möglichen Werte sind: LINK – Ein Link zu einem Webziel. DEEP_LINK – Ein Link zu einer bestimmten Seite in einer Anwendung. CLOSE – Lehnt die Nachricht ab.	Basierend auf dem Inhalt der In-App-Nachrichtenvorlage, die für die Kampagne angegeben wurde.
Link	Die Ziel-URL für eine Schaltfläche. Nicht vorhanden für Schaltflächen, bei denen die ButtonAction CLOSE lautet.
Text	Der Text, der auf der Schaltfläche angezeigt wird.
TextColor	Die Farbe des Texts auf der Schaltfläche, ausgedrückt als Zeichenfolge mit Hex-Farbcode (z. B. #000000 für Schwarz).