データフィード

Documentation Index

Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt

Use this file to discover all available pages before exploring further.

• ユーザーの現在のリワードバランス
• 最新の注文ステータス
• パーソナライズされた製品の推奨

​

Data Feedsの仕組み

1. Data Feedを作成 – OneSignalがAPIに接続する方法を構成します。
2. Data Feedをメッセージテンプレートに添付します。
3. Liquid構文を使用してメッセージにレスポンスフィールドを挿入します。
4. 送信時に、OneSignalは各受信者に対してAPI呼び出しを行い、レスポンスを解析し、データをメッセージに注入します。

​

例：リワードポイントの表示

Hi {{ first_name }},

You have {{ data_feed.rewards.points }} points!
Your membership status is {{ data_feed.rewards.status_level }}.

Keep shopping to earn more points!

​

Data Feedの作成と使用

​

1. Data Feed構成の設定

• Name：フィードのリストで区別するための「Customer Rewards API」のような説明的な名前。一意の名前を推奨しますが、必須ではありません。
• Alias：Liquid構文で使用するrewardsのような短い識別子（例：{{ data_feed.rewards.points }}）。一意である必要があり、小文字の英数字のみで、スペースや特殊文字は使用できません。
• Method：OneSignalがAPIに接続するために使用するHTTPメソッド。通常はGETですが、POSTもサポートされています。
• URL：APIエンドポイント。OneSignalがユーザー固有のデータを取得できるようにLiquid構文をサポートしています。

https://acme.com/customers/user_id={{ external_id }}/rewards

• Headers：APIに必要なキーと値のペア（例：認証トークン）。Liquid構文をサポートしています。
• Body：オプションのJSONリクエストボディ。Journey Webhookと同様にLiquid構文をサポートしています。

{
	"customer_id": "{{ subscription.external_id }}"
}

​

2. Data Feedをメッセージテンプレートに添付

1. Messages > Templatesに移動します
2. Messageセクションで、Personalizationボタンを選択します

3. Data Feedsをトグルオンにして、フィードを選択します

4. テンプレートを保存します

​

3. メッセージでデータを使用

{
	"external_id": "a1-b2c3",
	"points": 193,
	"status_level": "Gold"
}

You have {{ data_feed.rewards.points }} points!
Your membership status is {{ data_feed.rewards.status_level }}.

• Data Feedを使用
• rewards Data Feedを使用
  • 復習：rewardsフィードは、受信者のexternal_idでAPIを呼び出すことを知っています
• レスポンスから、points項目の値（193）とstatus_level項目（Gold）を挿入

​

要件と制限

• ヘッダーに認証トークンを含むシングルステップ認証を受け入れる
• 迅速に応答する。 250ms未満を推奨（これは送信速度に直接影響します）
• JSONを返す。 現時点では他の形式はサポートされていません。
  • 別の形式が必要な場合は、ユースケースをお知らせください。
• 送信ボリュームを処理する。 APIのレート制限が低い場合、メッセージ配信が遅くなります。
• 妥当なサイズのペイロードを返す。 最高のパフォーマンスのために、レスポンスを50KB未満に保つことを推奨します。

• テンプレートごとに1つのData Feed。 必要なすべてのデータを1回のAPIレスポンスで取得してください。
• Data Feedごと、メッセージごとに1つのAPI呼び出し。
• Journeysのみ。 他の送信方法ではまだ利用できません。
• 連鎖呼び出しなし。 1つのData Feedからのペイロードを使用して別のData Feedを呼び出すことはできません。

​

APIの設定

​

認証

Authorization: Bearer YOUR_TOKEN

X-API-Key: YOUR_KEY

​

JSONリクエストボディ

​

JSONレスポンス

​

パーソナライゼーションパラメータ

https://api.example.com/users/{{external_id}}/data
https://api.example.com/rewards?email={{email | url_encode}}

{
	"customer_id": "{{ external_id }}",
	"email": "{{ subscription.email }}"
}

​

レート制限

​

エラーハンドリング

​

開始前のチェックリスト

• メッセージに表示したいデータは何ですか？APIから取得する項目を特定したシンプルな概要から逆算して作業すると、考えを整理するのに役立ちます。
• このデータは単一のAPIエンドポイントを介して利用可能ですか？
• APIリクエストをどのように認証しますか？
• パーソナライズされたデータを取得するために、どの識別子または他のデータ項目を使用しますか？
• その識別子はすでにOneSignalに保存されていますか？そうでない場合、どのように入力されますか？
• APIは生成するリクエストのボリュームを処理できますか？
• APIがユーザーのデータを持っていない場合はどうなりますか？

​

例と高度なユースケース

• ループによる反復：カート放棄
• カスタムイベントプロパティ
• 条件付き表示：注文ステータス
• パーソナライゼーションなしの自動化
• パーソナライズされたクーポンコード

ユーザーのカート内のアイテムの配列とカートの合計金額を返すData Feed cartがあるとします：

{
  "items": [
    {
      "name": "Blue Running Shoes",
      "price": 84.00,
      "image_url": "https://acme.com/blue-running-shoes.png"
    },
    {
      "name": "Protein Bar",
      "price": 5.99,
      "image_url": "https://acme.com/protein-bar.png"
    }
  ],
  "total": 89.99
}

カート内の各アイテムとカート合計を表示したい場合、Liquidでforループを使用できます：

<ul>
  {% for item in data_feed.cart.items %}
    <li>
      <strong>{{ item.name }}</strong><br>
      ${{ item.price }}<br>
      <img src="{{ item.image_url }}" alt="{{ item.name }}">
    </li>
  {% endfor %}
</ul>

<p>Cart total: ${{ data_feed.cart.total }}</p>

これにより次の結果が得られます：

- Blue Running Shoes
- $84.00
- <running shoes image>
- Protein Bar
- $5.99
- <protein bar image>
Cart total: $89.99

メールブロックエディターを使用している場合、特に画像やリンクを含める必要があるこの種の複雑なLiquid構文を挿入する際は、最良の結果を得るためにカスタムHTMLブロック要素を使用してください。

カスタムイベントを使用してこのカート放棄メールをトリガーする方法を確認したいですか？完全なワークフローについては、カスタムイベントプロパティタブをご覧ください。

前のカート放棄の例を続けて、最初にその特定のカートをどのように取得するかをどのように知ることができますか？1つの方法は、プロパティにcart_idを含むcart_abandoned カスタムイベントによってトリガーされるJourneyを作成することです。この例では、そのイベントがAPI経由でOneSignalに送信されています：

curl --request POST \
  --url https://api.onesignal.com/apps/{app_id}/custom_events \
  --header 'Accept: application/json' \
  --data '{
  "events": [
    {
      "name": "cart_abandoned",
      "external_id": "user_12345",
      "properties": {
        "cart_id": 98765
      }
    }
  ]
}'

ユーザーuser_12345は、このイベントが発火されたときにJourneyに入り、その後メールを送信するノードに到達します。そのメールテンプレートは、URLが次のように特定のカートの内容を取得するように設定されたcart Data Feedで設定されています：

https://acme.com/carts/{{ journey.event.cart_abandoned.data.cart_id }}

したがって、この特定のイベントが取り込まれてJourneyをトリガーすると：

1. cart_idの値98765がJourneyに保存されます
2. メールステップに到達すると、cart Data Feedはそのcart_id値を参照し、それを使用してカートAPIを呼び出します
3. 返されたJSONプロパティが解析され、前の例と同様にメールに挿入されます

注文ステータスに基づいてData Feedコンテンツを条件付きで表示する方法を確認したいですか？詳細については、条件付き表示：注文ステータスタブをご覧ください。

顧客の注文のステータスを含めたいが、注文が発送された場合にのみ追跡番号リンクを含めたいとします。ifステートメントを使用してこれを実現できます：

Your order is {{data_feed.order.status}}!

{% if data_feed.order.tracking_number != empty %}
Track it here: {{data_feed.order.tracking_url}}
{% endif %}

ここでは、tracking_numberが存在する場合にのみ追跡リンクが表示されます。

Data Feedsを使用して、受信者ごとにパーソナライズする必要なく、メッセージに最新の情報を自動的に挿入できます。例えば、メールの上部にバナー画像を挿入し、休日や他の月次イベントに合わせて毎月変更しているとします。毎月新しい画像をOneSignalにアップロードし、すべてのテンプレートを変更することを覚えておくのではなく、CMSまたは他のアセット管理場所から現在のバナー画像URLを取得するData Feedを設定することができます。次のようにURLに変数なしでエンドポイントを指すbanner Data Feedを設定します：

https://acme.com/assets/email-banner

これは現在のバナーURLを含むレスポンスを返します：

{
	"banner_url": "https://acme.com/assets/email-banner/2025july.png"
}

メールテンプレートを設定して、{{ data_feed.banner.banner_url }}を画像ソースURLとして使用し、今後このプロセスを自動化します。

この例では、各受信者に対してAPIから一意の値を取得するData Feedを使用して、メールでパーソナライズされた一回限りのクーポンコードを送信する方法について説明します。

​

目標

次のようなメールを送信します：

Hi George, Complete your booking in the next 2 hours and save 10% with your personal code: XYZ123ABC

各ユーザーは、メール送信時に外部APIコール経由でライブ生成された一意のクーポンコードを受け取ります。コードは指定された時間ウィンドウで有効であり、そのユーザーにスコープされています。

​

前提条件

• OneSignalでメールチャネルが設定済み（アプリにメール機能が有効化されている）
• ユーザー識別子（例：external_id）とキャンペーン識別子を受け取り、クーポンコード、割引、有効期限を含むJSONを返す外部API
• APIがクーポンを生成するために使用できる各ユーザーの一意の識別子（external_idなど）
• OneSignal Journeyを通じてメールを送信するために使用するセグメントまたはトリガー（例：「過去24時間以内の検索放棄」）

​

ステップ1：Data Feedを作成する

1

Data Feedsに移動

OneSignalアプリで、ナビゲーションバーからData feedsを選択し、New data feedをクリックします。

2

Data Feedを設定

次のフィールドを設定します：

• Data Feed Name: coupon_code_generator
• Alias: coupon
• Method: GET
• URL: https://api.example.com/generate-coupon?userId={{ external_id }}&campaign=AbandonedBooking10
• Headers:
  {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
  

3

APIレスポンスを参照

APIが次のようなJSONを返す場合：

{
  "code": "AB10-5F3K-HT9L",
  "discount_percent": "10%",
  "expires_in_hours": 2
}

メールテンプレートでその値を次のように参照できます：

• {{ data_feed.coupon.code }}
• {{ data_feed.coupon.discount_percent }}
• {{ data_feed.coupon.expires_in_hours }}

4

Data Feedをテストして有効化

Send Testをクリックして設定を確認し、ActivateをクリックしてData Feedをテンプレートで使用できるようにします。

​

ステップ2：メールテンプレートを作成する

1. OneSignalで、Messages → Email → New Templateに移動します
2. メッセージ本文内でData Feedのエイリアスとフィールドを使用します。例：

<h2>Hi {{ first_name }},</h2>
<p>
Complete your booking in the next {{ data_feed.coupon.expires_in_hours }} hours and save
{{ data_feed.coupon.discount_percent }} with your personal code:
<strong>{{ data_feed.coupon.code }}</strong>
</p>

<p><a href="https://example.com/checkout?coupon={{ data_feed.coupon.code }}">Use Code Now →</a></p>

• Liquid構文は{{ data_feed.<alias>.<field> }}の形式で使用します
• Data Feedがテンプレートに添付されていることを確認してください
• カスタムLiquidロジックを含むドラッグアンドドロップエディターを使用する場合は、HTMLブロックを使用してください

​

ステップ3：Data Feedを添付してメールをトリガーする

1. テンプレートコンポーザーで、Personalizationの下にあるData Feedsをトグルオンにして、フィード（coupon_code_generator）を選択します
2. これにより、OneSignalが各受信者に対して送信時にAPI呼び出しを行い、データを入力して、メールに注入します
3. メッセージを自動化するJourneyを設定します：
   • エントリ条件：「過去24時間以内の検索放棄」などのセグメント
   • Wait until：booking_completedカスタムイベントを作成します。このイベントが発火した場合にJourneyを終了するか、1時間後に続行するように待機を設定します。予約を完了した場合はメールを受け取らずに終了し、そうでない場合はクーポンを受け取るために続行します。
   • メール送信：パーソナライズされたクーポンメールテンプレートを使用します
   • Journeyがメールチャネルを使用し、受信者がメールをサブスクライブしていることを確認してください

​

ステップ4：クーポンの引き換えと追跡を管理する

バックエンドは次のことを行う必要があります：

1. userId、code、campaign、expiration_time、およびredeemedフラグとともに生成された各コードを記録します
2. チェックアウト時にコードを検証して引き換え済みとしてマークします
3. ROI分析のために引き換えデータ（ユーザー、キャンペーン、時間）を記録します

​

完全なワークフロー例

ステップ	イベント	アクション
1	ユーザーが「検索放棄」セグメントをトリガー	ユーザーがセグメント経由でJourneyに入る
2	Journeyがメール送信をトリガー	OneSignalがData Feedを添付し、ユーザーのexternal_idとキャンペーン名でAPIを呼び出す
3	APIがJSONを返す	OneSignalがData Feedクーポンフィールドを入力してメールを送信する
4	ユーザーがメールを受け取る	例：「Hi George! Save 10% with your personal code: AB10-5F3K-HT9L」
5	ユーザーがコードを引き換える	バックエンドが引き換えを検証して記録する

​

テスト

• 既知のexternal_idを持つユーザーでテストします
• APIを手動で呼び出して、正しいJSONレスポンスを確認します
• OneSignalテンプレートエディターのPreviewを使用して、Data Feedクーポンフィールドが入力されることを確認します
• レイテンシとエラーについてAPIログを確認します
• Data Feed呼び出しが失敗した場合、OneSignalはそのレシピエントへのメッセージ送信をスキップします

​

よくある質問

​

Data Feedの値がメッセージに表示されません。何を確認すべきですか？

1. Data Feedがテンプレートに添付されていること（Personalization > Data Feedsの下）。
2. Liquid構文がJSONレスポンス構造と正確に一致していること — {{ data_feed.<alias>.<field> }}。
3. APIエンドポイントが同じ識別子で手動呼び出した場合に有効なJSONを返すこと。
4. 受信者がOneSignalに必要な識別子（例：external_id）が保存されていること。

​

メッセージの送信が遅いのはなぜですか？

​

一部の受信者がメッセージを受信しないのはなぜですか？

​

テンプレートで複数のData Feedを使用できますか？

​

Data Feedsはプッシュ通知やSMSで利用できますか？

​

メッセージ送信時にAPIがダウンしている場合はどうなりますか？

​

関連ページ