API 呼び出し

接続コンテンツを使用して、ユーザー s に送信するメッセージにAPI を介して直接アクセス可能な情報を挿入します。Web サーバーから直接、またはパブリックにアクセス可能なAPI からコンテンツをプルできます。

接続内容タグ

接続内容呼び出しを送信するには、{% connected_content %} タグを使用します。このタグでは、:save を使用して変数を割り当てたり宣言したりできます。これらの変数の側面は、メッセージの後でLiquid で参照できます。

たとえば、次のメッセージ本文は、URL http://numbersapi.com/random/trivia にアクセスし、メッセージに面白いトライビアファクトを含めます。

1
2
{% connected_content http://numbersapi.com/random/trivia :save result %}
Hi there, here is fun some trivia for you!: {{result.text}}

変数の追加

また、接続コンテンツリクエストを作成するときに、URL 文字列に変数としてユーザープロファイル 属性s を含めることもできます。

たとえば、ユーザーのメールの住所とID に基づいてコンテンツを返すウェブサービスがあるとします。アットマーク(@) などの特殊文字を含む属性s を渡す場合は、URL で許可されていない文字をURL フレンドリエスケープバージョンで置き換えるために、リキッドフィルターurl_param_escape を使用するようにしてください(次のメール住所属性を参照)。

1
2
3
Hi, here are some articles that you might find interesting:

{% connected_content http://www.yourwebsite.com/articles?email={{${email_address} | url_param_escape}}&user_id={{${user_id}}} %}

接続コンテンツリクエストは、GET およびPOST リクエストのみをサポートします。

エラー処理

URL が使用できず、404 ページに達すると、Braze はその場所に空の文字列を表示します。URL がHTTP 500 または502 ページに達すると、URL は再試行ロジックで失敗します。

エンドポイントがJSON を返す場合は、connected の値がnull であるかどうかを確認して、条件付きでメッセージ を中止することで、そのことを検出できます。Braze では、ポート80 (HTTP) と443 (HTTPS) を介して通信するURL のみが許可されます。

パフォーマンス

Braze はメッセージを非常に高速で配信するため、サーバーが数千の同時接続を処理できるようにして、コンテンツをプルダウンするときにサーバーが読み込むを乗り越えないようにしてください。パブリックAPI を使用する場合は、API プロバイダーが使用するレート制限に違反しないように使用してください。Braze では、パフォーマンス上の理由からサーバーの応答時間が2 秒未満である必要があります。サーバーの応答時間が2 秒を超えると、その内容は挿入されません。

Brazeは、1受信者に複数回、同じConnected Content API呼び出しを行うことができます。これは、Braze がメッセージペイ読み込むを表示するために接続コンテンツAPI 呼び出しを行う必要がある場合があるためです。また、メッセージペイ読み込むは、検証、再試行ロジック、または他の内部のために、受信者ごとに複数回レンダリングできます。1受信者に1回以上、同じ接続内容の呼び出しを許容できる必要があります。

知っておくべきこと

• Braze はAPI コールの料金を請求せず、指定されたデータポイント割り当てにはカウントされません。
• Connected Content レスポンスには1MB の制限があります。
• 接続されたコンテンツコールは、メッセージが送信されるとh をアプリします。ただし、アプリ内メッセージs は、メッセージが表示されたときにこのコールを発信します。
• 接続されたコンテンツコールはリダイレクトに従いません。

認証タイプ

基本認証の使用

URL に基本的な認証が必要な場合、Braze はAPI 呼び出しで使用するための基本的な認証 認証情報を生成できます。既存の基本認証 認証情報s を管理し、Settings> Connected Content から新しいものを追加できます。

新しい認証情報を追加するには、認証情報を追加します。認証情報に名前を付け、ユーザーの名前とパスワードを入力します。

次に、トークンの名前を参照することで、API 呼び出しでこの基本認証 認証情報を使用できます。

1
Hi there, here is fun some trivia for you!: {% connected_content https://yourwebsite.com/random/trivia :basic_auth credential_name %}

トークン 認証の使用

Braze 接続コンテンツを使用する場合、特定のAPI では、ユーザーの名前とパスワードの代わりにトークンが必要になることがあります。次の呼び出しに含まれているのは、メッセージをリファレンスし、モデル化するためのコードな抜粋です。

1
2
3
4
5
6
7
8
9
10
11
12
{% assign campaign_name="New Year Sale" %}
{% connected_content
     https://your_API_link_here/
     :method post
     :headers {
       "X-App-Id": "YOUR-APP-ID",
       "X-App-Token": "YOUR-APP-TOKEN"
  }
     :body campaign={{campaign_name}}&customer={{${user_id}}}&channel=Braze
     :content_type application/json
     :save publication
%}

オープン認証(OAuth)の使用

一部のAPI 設定では、アクセスするAPI エンドポイントの認証に使用できるアクセストークンを取得する必要があります。

接続トークンを取得する

次の例は、アクセストークンを取得してローカル変数に保存し、後続のAPI 呼び出しの認証に使用できるようにする方法を示しています。:cache_max_ageパラメータを追加して、アクセストークンが有効な時刻を照合し、発信接続コンテンツコールの回数を減らすことができます。詳細については、[構成可能なキャッシュ]36] を参照してください。

1
2
3
4
5
6
7
8
9
10
{% connected_content
     https://your_API_access_token_endpoint_here/
     :method post
     :headers {
       "Content-Type": "YOUR-CONTENT-TYPE",
       "Authorization": "Bearer YOUR-APP-TOKEN"
  }
     :cache_max_age 900
     :save token_response
%}

取得したアクセストークンを使用してAPI を許可する

これでトークンが保存されたので、dをダイナミックな接続内容呼び出しにテンプレートして、リクエストを承認できます。

1
2
3
4
5
6
7
8
9
{% connected_content
     https://your_API_endpoint_here/
     :headers {
       "Content-Type": "YOUR-CONTENT-TYPE",
       "Authorization": "{{token_response}}"
  }
     :body key1=value1&key2=value2
     :save response
%}

接続されたコンテンツIP の許可

Brazeサーバーは、Connected Contentを使用したメッセージをBrazeから送信すると、自動的に顧客またはサードパーティのサーバーにネットワークリクエストを行い、データをプルバックします。IP allowlisting を使用すると、Connected Content リクエストが実際にBraze から送信されていることを確認し、セキュリティレイヤーを追加できます。

Braze は、次のIP 範囲から接続コンテンツリクエストを送信します。リストされている範囲は自動的に追加され、allowlisting にオプトインされているすべてのAPI キーにダイナミックな追加されます。

Braze には、すべてのサービスに使用される予約のIP があります。すべてのIP が一度に有効になるわけではありません。これは、Brazeが別のデータセンタから送信したり、保守を行ったりするために、顧客に影響を与えることなく設計されています。Brazeは、接続コンテンツリクエストを作成するときに、以下のIPの1つ、サブセット、またはすべてを使用できます。

トラブルシューティング

接続コンテンツコールのトラブルシューティングには、Webhook.site を使用します。

1. Connected Content コールのURL をサイトで生成された一意のURL に切り替えます。
2. キャンペーンまたはキャンバスステップをプレビューしてテストし、リクエストがこのWeb サイトを通過するかどうかを確認します。

このツールを使用して、リクエストヘッダーs、リクエストボディ、およびコールで送信されている他の情報に関する問題を診断できます。