API コールの実行

Connected Content を使用して、ユーザに送信するメッセージに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}}

変数の追加

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

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

``` こんにちは、興味深い記事をいくつか紹介します。

{% 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 であるかどうかを確認して、条件付きでメッセージ をアボートできます。ブレーズは、ポート80 (HTTP) と443 (HTTPS) を介して通信するURL のみを許可します。

パフォーマンス

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

ブレーズ・システムは、受信者ごとに同じConnected Content APIコールを複数回呼び出すことができます。これは、Braze がメッセージペイロードをレンダリングするためにConnected Content API 呼び出しを行う必要がある場合があるためです。メッセージペイロードは、検証、再試行ロジック、またはその他の内部目的のために、受信者ごとに複数回レンダリングできます。システムは、受信者ごとに同じ接続コンテンツコールが複数回発信されることを許容できる必要があります。

知っておくべきこと

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

認証タイプ

基本認証の使用

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

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

その後、トークンを参照することで、API 呼び出しでこの基本的な認証情報を使用できます name:

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

トークン認証の使用

Braze Connected Content を使用する場合、特定の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 パラメータを追加して、アクセストークンが有効な時間を照合し、発信接続コンテンツコールの数を減らすことができます。詳細については、構成可能なキャッシュ を参照してください。

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 を許可する

トークンが保存されたので、次のConnected Content 呼び出しに動的にテンプレート化して、リクエストを承認できます。

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範囲からConnected Contentリクエストを送信します。リストされた範囲は、allowlisting 用にオプトインされたAPI キーに自動的かつ動的に追加されます。

Braze には、すべてのサービスに使用されるIP の予約セットがあります。すべてのIP が一度にアクティブになるわけではありません。これは、必要に応じて、顧客に影響を与えることなく、別のデータセンターから送信したり、メンテナンスを行うために、ブレーズ用に設計されています。ろう付けは、接続コンテンツ要求を行うときに、リストされている次のIPの1つ、サブセット、またはすべてを使用することができます。

トラブルシューティング

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

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

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