GetInAppMessages Amazon Pinpoint API 回應 JSON 範例 - Amazon Pinpoint
InAppMessageCampaigns 物件InAppMessage 物件HeaderConfig 物件BodyConfig 物件InAppMessageContent 物件Schedule 物件InAppMessageButton 物件DefaultButtonConfig 物件OverrideButtonConfig 物件

支援終止通知：2026 年 10 月 30 日， AWS 將結束對 Amazon Pinpoint 的支援。2026 年 10 月 30 日之後，您將無法再存取 Amazon Pinpoint 主控台或 Amazon Pinpoint 資源 (端點、區段、行銷活動、旅程和分析)。如需詳細資訊，請參閱 Amazon Pinpoint 終止支援。注意：與 SMS、語音、行動推播、OTP 和電話號碼驗證相關的 APIs 不受此變更影響，並受 AWS 最終使用者傳訊支援。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

GetInAppMessages Amazon Pinpoint API 回應 JSON 範例

您呼叫 GetInAppMessages API 操作時，它會傳回指定端點有權存取的訊息的清單。接著您的應用程式可以根據回應中的值轉譯訊息。

呼叫 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 物件包含以下屬性：

屬性 Description 設定是

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 物件包含以下屬性：

屬性 Description 設定是

Content

這個陣列包含 InAppMessageContent 物件，該物件說明了訊息的內容。

根據您為行銷活動指定的應用程式內訊息範本的內容。

Layout

這個字串說明應用程式內訊息顯示在收件人裝置上的外觀。可能值為：

  • BOTTOM_BANNER – 在頁面底部顯示為橫幅的訊息。

  • TOP_BANNER – 在頁面頂端顯示為橫幅的訊息。

  • OVERLAYS – 覆蓋整個畫面的訊息。

  • MOBILE_FEED – 在頁面前方視窗中顯示的訊息。

  • MIDDLE_BANNER – 在頁面中間顯示為橫幅的訊息。

  • CAROUSEL – 最多五條唯一訊息的可捲動配置。

HeaderConfig 物件

HeaderConfig 物件包含以下屬性：

屬性 Description 設定是

Alignment

指定標題文字對齊方式的字串。可能值為 LEFT、CENTER 及 RIGHT。

根據您為行銷活動指定的應用程式內訊息範本的內容。

Header

郵件標頭文字。

TextColor

標頭文字的顏色，以十六進位顏色代碼表示 (例如 #000000 代表黑色)。

BodyConfig 物件

BodyConfig 物件包含以下屬性：

屬性 Description 設定是

Alignment

指定訊息內文對齊方式的字串。可能值為 LEFT、CENTER 及 RIGHT。

根據您為行銷活動指定的應用程式內訊息範本的內容。

Body

訊息的主要本文。

TextColor

內文的顏色，以十六進位顏色代碼表示 (例如 #000000 代表黑色)。

InAppMessageContent 物件

InAppMessageContent 物件包含以下屬性：

屬性 Description 設定是

BackgroundColor

應用程式內訊息的背景顏色，以十六進位顏色代碼表示 (例如 #000000 代表黑色)。

根據您為行銷活動指定的應用程式內訊息範本的內容。

BodyConfig

BodyConfig 物件，包含訊息內文的相關資訊。

HeaderConfig

HeaderConfig 物件，包含訊息標頭或標題的相關資訊。

ImageUrl

訊息內影像的 URL。

PrimaryBtn

InAppMessageButton 物件，包含訊息內主要按鈕的相關資訊。

SecondaryBtn

InAppMessageButton 物件，包含訊息內次要按鈕的相關資訊。如果應用程式內訊息範本沒有指定次要按鈕，就不存在。

Schedule 物件

Schedule 物件包含以下屬性：

屬性 Description 設定是

EndDate

為行銷活動排定的結束時間 (依 ISO 8601 格式顯示)。

行銷活動建立程序的第 4 步 (如果行銷活動是在主控台建立) 或 Schedule 物件 (如果行銷活動是使用 API 或 SDK 建立)。

EventFilter

有關觸發應用程式內訊息的事件的相關資訊。您產生與 Amazon Pinpoint 應用程式內活動相符的事件時，將顯示該訊息。

InAppMessageButton 物件

InAppMessageButton 物件包含以下屬性：

屬性 Description 設定是

DefaultConfig

DefaultButtonConfig 物件，包含應用程式內訊息中按鈕的預設設定的相關資訊。

根據您為行銷活動指定的應用程式內訊息範本的內容。

Android

OverrideButtonConfig 物件，指定按鈕在 Android 裝置上的行為。這會覆寫 DefaultConfig 物件中詳細說明的預設按鈕組態。

IOS

OverrideButtonConfig 物件，指定按鈕在 iOS 裝置上的行為。這會覆寫 DefaultConfig 物件中詳細說明的預設按鈕組態。

Web

OverrideButtonConfig 物件，指定按鈕在 Web 應用程式上的行為。這會覆寫 DefaultConfig 物件中詳細說明的預設按鈕組態。

DefaultButtonConfig 物件

DefaultButtonConfig 物件包含以下屬性：

屬性 Description 設定是

BackgroundColor

按鈕的背景顏色，以十六進位顏色代碼表示 (例如 #000000 代表黑色)。

根據您為行銷活動指定的應用程式內訊息範本的內容。

BorderRadius

 按鈕邊框的半徑 (以像素為單位) 以整數表示。數字越大，圓角的程度越大。

ButtonAction

這個字串說明收件人選擇應用程式內訊息中的按鈕時發生的動作。可能值為：

  • LINK – Web 目的地的連結。

  • DEEP_LINK – 應用程式中特定頁面的連結。

  • CLOSE – 關閉訊息。

Link

按鈕的目的地 URL。ButtonAction 是 CLOSE 的按鈕，沒有這個項目。

Text

 按鈕上顯示的文字。

TextColor

按鈕上文字的顏色，以十六進位顏色代碼表示 (例如 #000000 代表黑色)。

OverrideButtonConfig 物件

只有應用程式內訊息範本使用覆寫按鈕時，才會出現 OverrideButtonConfig 物件。覆寫按鈕具有特定組態，適用於特定裝置類型 (例如 iOS 裝置、Android 裝置或網頁瀏覽器)。

OverrideButtonConfig 物件包含以下屬性：

屬性 Description 設定是

ButtonAction

收件人選擇應用程式內訊息中的按鈕時發生的動作。可能值為：

  • LINK – Web 目的地的連結。

  • DEEP_LINK – 應用程式中特定頁面的連結。

  • CLOSE – 關閉訊息。

根據您為行銷活動指定的應用程式內訊息範本的內容。

Link

按鈕的目的地 URL。ButtonAction 是 CLOSE 的按鈕，沒有這個項目。

Text

 按鈕上顯示的文字。

TextColor

按鈕上文字的顏色，以十六進位顏色代碼表示 (例如 #000000 代表黑色)。