メインコンテンツへスキップ

1. Connected Contentの仕組み

Notiflyはメッセージの生成時に外部APIのデータを使います。GETリクエストではキャッシュされたレスポンスを再利用する場合があります。POSTリクエストでは毎回APIを呼び出します。

メッセージに差し込めるデータの例

  1. 商品レコメンドでは、ユーザーの過去の行動に基づいて商品を提案します。
  2. アカウント情報の通知では、メッセージに必要な項目だけを取得します。
  3. 口座や市況の情報では、ポイント残高、口座残高、株価などをメッセージに含めます。
  4. 外部システムとの連携では、メッセージ生成時に、外部サービスから必要な情報を取得します。

対応チャネル

  • アプリプッシュ、アプリ内ポップアップ、Webポップアップで使用できます。ポップアップでは、新しいポップアップエディターで作成したテンプレートと、対応するSDKバージョンが必要です。

使用できる項目

  • アプリプッシュでは、キャンペーン作成画面の メッセージとアクション にある次の項目で使用できます。
    • メッセージのタイトル
    • メッセージの本文
    • アクションのURL。URL(ディープリンク)に移動 を選び、URLまたはディープリンクを入力します。
  • ポップアップのテンプレート編集画面では、Textの内容、Buttonのラベルとリンク、HTMLブロックで使用できます。HTMLとLiquidを一緒に記述するには、HTMLブロックを使います。入力箇所は、アプリ内ポップアップテンプレートの作成とWebポップアップテンプレートの作成をご覧ください。

2. Connected Contentを設定する

必要な項目

  1. {% connected_content %} タグで、メッセージ内に外部APIの呼び出しを記述します。
  2. 呼び出す外部APIのエンドポイントをURLで指定します。
  3. 別の変数名でレスポンスを参照するには、:save で名前を指定します。省略すると connected で参照できます。

API呼び出しの例

このタグは https://api.example.com/data にリクエストを送り、レスポンスを response 変数に保存します。

レスポンスのデータをメッセージで使う

取得したデータは、Liquidで加工したり、メッセージに表示したりできます。

3. 構文とオプション

基本構文

主なオプション

  1. :save
    • APIのレスポンスを指定した変数名で保存します。標準の変数名は connected です。
    • 構文::save variable_name
    • 例:{% connected_content https://api.example.com/profile :save user_profile %}
  2. :method
    • HTTPメソッドを指定します。デフォルトはGETです。
    • GETとPOSTに対応しています。
    • 例:{% connected_content https://api.example.com/products/search :method post :body category=books %}
  3. :headers
    • リクエストに含めるHTTPヘッダーを指定します。
    • 構文::headers { "Header-Name": "Header-Value", ... }
    • 例:{% connected_content https://api.example.com/data :headers { "Authorization": "Bearer token" } %}
  4. :body
    • POSTリクエストのボディを指定します。key=value の形式で項目を書き、複数ある場合は & でつなぎます。JSONで送るには :content_type application/json を追加します。各値はJSON文字列として送信されます。
    • 構文::body key=value&other=value
    • 例:{% connected_content https://api.example.com/products/search :method post :content_type application/json :body user_id={{user["$user_id"]}}&category=books %}
  5. :content_type
    • リクエストのContent-Typeを指定します。
    • 構文::content_type application/json
    • 例:{% connected_content https://api.example.com/data :content_type application/json %}

エラーとタイムアウト

  • 外部APIの4xx、5xxレスポンスやネットワークエラーでデータを取得できない場合も、メッセージの送信は自動で停止しません。条件式で必要な値があるかを確認し、値がなければ {% abort_message() %} を実行します。ポップアップでこのタグを実行すると、ポップアップ全体が表示されません。
  • Connected ContentのHTTPリクエストは15秒でタイムアウトします。

APIのレスポンスから一覧を表示する

Liquidの条件式やループを使って、APIから取得したデータを加工できます。
この例では、商品一覧を取得し、商品名と価格をメッセージに表示します。