GetInAppMessages Amazon Pinpoint API 响应 JSON 示例

当您调用 GetInAppMessagesAPI 操作时，它会返回指定端点有权接收的消息列表。然后，您的应用程序可以根据响应中的值呈现消息。

以下是您在调用 GetInAppMessages API 时返回的 JSON 对象的示例：

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

以下几节提供了有关此响应的组成部分及其属性的信息。

InAppMessageCampaigns 对象

InAppMessageCampaigns 对象包含以下属性：

属性	描述	在哪里设置
CampaignId	一个字符串，其中包含发送消息的 Amazon Pinpoint 活动的名称和唯一活动 ID。该名称位于活动 ID 之前。这两个值用连字符 (-) 分隔。	由 Amazon Pinpoint 在您创建活动时自动创建。
TreatmentId	一个整数，表示此消息的活动处理的 ID。如果活动只有一种处理，则值为 0。
Priority	应用程序内消息的优先级，表示为 1 到 5 之间的整数，其中 1 为最高优先级，5 为最低优先级。	创建活动过程的第 1 步。
InAppMessage	一个 InAppMessage 对象，其中包含有关如何呈现消息的信息。	基于为活动指定的应用程序内消息模板中的内容。
Schedule	Schedule 对象，其中包含关于消息发送时间的信息。	创建活动过程的第 4 步（如果活动是在控制台创建的），或者是 Schedule 对象（如果活动是使用 API 或 SDK 创建的）。
DailyCap	在 24 小时内可以向用户显示一条应用程序内消息的次数，以整数表示。	继承自项目级设置。如果活动包含覆盖项目设置的设置，则会改用这些设置。
SessionCap	应用程序会话期间可以向用户显示一条应用程序内消息的次数，以整数表示。
TotalCap	每个活动可以向端点显示任何应用程序内消息的总次数，以整数表示。

InAppMessage 对象

InAppMessage 对象包含以下属性：

属性	描述	在哪里设置
Content	一个包含InAppMessageContent对象的数组，该对象描述了消息的内容。	基于为活动指定的应用程序内消息模板中的内容。
Layout	描述应用程序内消息在收件人设备上的显示方式的字符串。可能的值有： BOTTOM_BANNER – 显示为页面底部横幅的消息。 TOP_BANNER – 显示为页面顶部横幅的消息。 OVERLAYS – 覆盖整个屏幕的消息。 MOBILE_FEED – 在页面置顶窗口中显示的消息。 MIDDLE_BANNER – 显示为页面中间横幅的消息。 CAROUSEL – 最多包含五条唯一消息的可滚动布局。

HeaderConfig 对象

HeaderConfig 对象包含以下属性：

属性	描述	在哪里设置
Alignment	一个字符串，指定标题文本的文本对齐方式。可能的值为 LEFT、CENTER 和 RIGHT。	基于为活动指定的应用程序内消息模板中的内容。
Header	消息标题文本。
TextColor	标题文本的颜色，以十六进制颜色代码（例如，#000000 代表黑色）表示。

BodyConfig 对象

BodyConfig 对象包含以下属性：

属性	描述	在哪里设置
Alignment	一个字符串，指定消息正文的文本对齐方式。可能的值为 LEFT、CENTER 和 RIGHT。	基于为活动指定的应用程序内消息模板中的内容。
Body	消息的主体文本。
TextColor	正文的颜色，以由十六进制颜色代码（例如，#000000 代表黑色）组成的字符串表示。

InAppMessageContent 对象

InAppMessageContent 对象包含以下属性：

属性	描述	在哪里设置
BackgroundColor	应用程序内消息的背景色，以十六进制颜色代码（例如，#000000 代表黑色）表示。	基于为活动指定的应用程序内消息模板中的内容。
BodyConfig	一个BodyConfig对象，它包含与消息正文内容相关的信息。
HeaderConfig	一个HeaderConfig对象，其中包含与消息标题或标题相关的信息。
ImageUrl	消息中显示的图像的 URL。
PrimaryBtn	一个InAppMessageButton对象，其中包含有关消息中主按钮的信息。
SecondaryBtn	一个InAppMessageButton对象，其中包含有关消息中辅助按钮的信息。如果应用程序内消息模板未指定辅助按钮，则不显示。

Schedule 对象

Schedule 对象包含以下属性：

属性	描述	在哪里设置
EndDate	将结束活动的计划时间，采用 ISO 8601 格式。	创建活动过程的第 4 步（如果活动是在控制台创建的），或者是 Schedule 对象（如果活动是使用 API 或 SDK 创建的）。
EventFilter	有关导致显示应用程序内消息的事件的信息。当您生成与 Amazon Pinpoint 应用程序内活动匹配的事件时，系统会显示该消息。

InAppMessageButton 对象

InAppMessageButton 对象包含以下属性：

属性	描述	在哪里设置
DefaultConfig	一个DefaultButtonConfig对象，其中包含有关应用程序内消息中按钮的默认设置的信息。	基于为活动指定的应用程序内消息模板中的内容。
Android	一个OverrideButtonConfig对象，用于指定按钮在 Android 设备上的行为方式。这将覆盖 DefaultConfig 对象中详细介绍的默认按钮配置。
IOS	一个OverrideButtonConfig对象，用于指定按钮在 iOS 设备上的行为方式。这将覆盖 DefaultConfig 对象中详细介绍的默认按钮配置。
Web	一个OverrideButtonConfig对象，用于指定按钮在 Web 应用程序中的行为方式。这将覆盖 DefaultConfig 对象中详细介绍的默认按钮配置。

DefaultButtonConfig 对象

DefaultButtonConfig 对象包含以下属性：

属性	描述	在哪里设置
BackgroundColor	按钮的背景色，以十六进制颜色代码（例如，#000000 代表黑色）表示。	基于为活动指定的应用程序内消息模板中的内容。
BorderRadius	按钮边框的半径（以像素为单位），以整数表示。数字越大，圆角越大。
ButtonAction	一个字符串，描述当收件人在应用程序内消息中选择按钮时发生的操作。可能的值有： LINK – 指向 Web 目标的链接。 DEEP_LINK – 指向应用程序中特定页面的链接。 CLOSE – 关闭消息。
Link	按钮的目标 URL。不适用于原来的 ButtonAction 按钮CLOSE。
Text	按钮上显示的文本。
TextColor	按钮上文本的颜色，以十六进制颜色代码（例如，#000000 代表黑色）表示。

OverrideButtonConfig 对象

仅当应用程序内消息模板使用覆盖按钮时，OverrideButtonConfig 对象才会出现。覆盖按钮是针对特定设备类型（例如 iOS 设备、Android 设备或 Web 浏览器）具有特定配置的按钮。

OverrideButtonConfig 对象包含以下属性：

属性	描述	在哪里设置
ButtonAction	当收件人在应用程序内消息中选择按钮时发生的操作。可能的值有： LINK – 指向 Web 目标的链接。 DEEP_LINK – 指向应用程序中特定页面的链接。 CLOSE – 关闭消息。	基于为活动指定的应用程序内消息模板中的内容。
Link	按钮的目标 URL。对于 ButtonAction 为 CLOSE 的按钮不存在。
Text	按钮上显示的文本。
TextColor	按钮上文本的颜色，以十六进制颜色代码（例如，#000000 代表黑色）表示。