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 オブジェクトには、次の属性が含まれます。

属性 説明 設定場所は

CampaignId

メッセージの送信元である Amazon Pinpoint キャンペーンの名前と一意のキャンペーン ID を格納する文字列です。キャンペーン ID の前に名前が付加されます。2 つの値はハイフン (-) で区切られます。

キャンペーンの作成時に Amazon Pinpoint によって自動的に作成されます。

TreatmentId

このメッセージのキャンペーン処理の ID を表す整数値です。キャンペーンに 1 つの処理しかない場合、値は 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 — 最大 5 つの一意のメッセージをスクロールできるレイアウト。

HeaderConfig オブジェクト

HeaderConfig オブジェクトには、次の属性が含まれます。

属性 説明 設定場所は

Alignment

ヘッダーのテキストのアライメントを指定する文字列です。指定できる値は LEFT、CENTER、および RIGHT です。

キャンペーンに指定されたアプリケーション内メッセージテンプレートの内容に基づきます。

Header

メッセージのヘッダーのテキスト。

TextColor

ヘッダーのテキストの色。16 進数のカラーコードを格納する文字列で表示されます (例: 黒の場合は「#000000」)。

BodyConfig オブジェクト

BodyConfig オブジェクトには、次の属性が含まれます。

属性 説明 設定場所は

Alignment

メッセージの本文のアライメントを指定する文字列です。指定できる値は LEFT、CENTER、および RIGHT です。

キャンペーンに指定されたアプリケーション内メッセージテンプレートの内容に基づきます。

Body

メッセージの本文

TextColor

本文のテキストの色。16 進数のカラーコードを格納する文字列で表示されます (例: 黒の場合は「#000000」)。

InAppMessageContent オブジェクト

InAppMessageContent オブジェクトには、次の属性が含まれます。

属性 説明 設定場所は

BackgroundColor

アプリケーション内のメッセージの背景色。16 進数のカラーコードを格納する文字列で表されます (例: 黒の場合は「#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

Android 端末でのボタンの動作を指定する OverrideButtonConfig オブジェクトです。これは、DefaultConfig オブジェクトで詳述されているデフォルトのボタン設定を上書きします。

IOS

iOS 端末でのボタンの動作を指定する OverrideButtonConfig オブジェクトです。これは、DefaultConfig オブジェクトで詳述されているデフォルトのボタン設定を上書きします。

Web

ウェブアプリケーションでのボタンの動作を指定する OverrideButtonConfig オブジェクトです。これは、DefaultConfig オブジェクトで詳述されているデフォルトのボタン設定を上書きします。

DefaultButtonConfig オブジェクト

DefaultButtonConfig オブジェクトには、次の属性が含まれます。

属性 説明 設定場所は

BackgroundColor

ボタンの背景色。16 進数のカラーコードを格納する文字列で表されます (例: 黒の場合は「#000000」)。

キャンペーンに指定されたアプリケーション内メッセージテンプレートの内容に基づきます。

BorderRadius

 ボタンの境界線の半径をピクセル単位で整数値で指定します。数値が大きいほど、角が丸くなります。

ButtonAction

受信者がアプリケーション内のメッセージに配置されたボタンを選択したときに発生するアクションを説明する文字列です。可能な値は以下のとおりです。

  • LINK — ウェブ上の移動先へのリンク。

  • DEEP_LINK — アプリケーション内の特定のページへのリンク。

  • CLOSE – メッセージを閉じます。

Link

ボタンの移動先の URL。ButtonAction が CLOSE であるボタンには存在しません。

Text

 ボタンに表示されるテキスト。

TextColor

ボタンテキストの色。16 進数のカラーコードを含む文字列で表示されます (例: 黒の場合は「#000000」)。

OverrideButtonConfig オブジェクト

OverrideButtonConfig オブジェクトは、アプリケーション内のメッセージテンプレートがオーバーライドボタンを使用している場合にのみ存在します。オーバーライドボタンとは、iOS デバイス、Android デバイス、ウェブブラウザなど、特定のデバイスの種類に応じた設定を持つボタンのことです。

OverrideButtonConfig オブジェクトには、次の属性が含まれます。

属性 説明 設定場所は

ButtonAction

アプリケーション内のメッセージで受信者がボタンを選択した際に発生するアクションです。可能な値は以下のとおりです。

  • LINK — ウェブ上の移動先へのリンク。

  • DEEP_LINK — アプリケーション内の特定のページへのリンク。

  • CLOSE – メッセージを閉じます。

キャンペーンに指定されたアプリケーション内メッセージテンプレートの内容に基づきます。

Link

ボタンの移動先の URL。ButtonAction が CLOSE であるボタンには存在しません。

Text

 ボタンに表示されるテキスト。

TextColor

ボタンテキストの色。16 進数のカラーコードを含む文字列で表示されます (例: 黒の場合は「#000000」)。