Skip to content

ローカルコネクテッドコンテンツ変数

このページでは、ローカルコネクテッドコンテンツ変数の概要と、その使用方法および保存方法について説明します。

Brazeは送信時にconnected_contentタグ内で指定されたエンドポイントに対して標準的なGETリクエストを行います。エンドポイントがJSONを返す場合、自動的に解析され、connectedという変数に格納されます。エンドポイントがテキストを返す場合、connected_contentタグの代わりにメッセージに直接挿入されます。

応答を変数に保存したい場合は、JSONオブジェクトを返すことをお勧めします。コネクテッドコンテンツの応答でタグをテキストに置き換えたい場合は、応答が有効なJSON（json.org で定義されているもの）でないことを確認してください。

URLの後に:save your_variable_nameを指定して、データを別の名前で保存することもできます。たとえば、次のconnected_contentタグは応答をlocalweatherというローカル変数に保存します（複数のconnected_content JSON変数を保存できます）。

1

{% connected_content https://www.metaweather.com/api/location/2459115/ :save localweather %}

Metaweatherは「Where-on-Earth ID」を使用してエリアの天気を返す無料の天気APIです。このコードはテストと学習目的でのみ使用してください。

保存された変数は、connected_contentリクエストを含むフィールド内でのみアクセスできます。たとえば、メッセージフィールドとタイトルフィールドの両方でlocalweather変数を使用したい場合は、両方のフィールド内でconnected_contentリクエストを行う必要があります。

GETリクエストは通常デフォルトでキャッシュされますが、いくつかの例外があります（高カーディナリティのユーザー属性を含むURL、:no_cache、または1 MBを超えるレスポンスボディなど）。同一のGETリクエストが複数のフィールドに存在する場合、Brazeはエンドポイントを再度呼び出す代わりにキャッシュされた応答を再利用します。キャッシュの動作の詳細については、応答のキャッシュを参照してください。

HTTP POST経由で行われたコネクテッドコンテンツの呼び出しはデフォルトではキャッシュされません。POST応答をキャッシュするには、タグに:cache_max_ageを追加します。デフォルトのキャッシュ設定を参照してください。

JSONの解析

コネクテッドコンテンツは、:saveを指定すると、JSON形式の結果をローカル変数として解釈します。たとえば、天気関連のコネクテッドコンテンツエンドポイントが次のJSONオブジェクトを返し、:save localweatherを指定してローカル変数localweatherに格納します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "consolidated_weather": [
    {
      "id": 5.8143475362693e+15,
      "weather_state_name": "Clear",
      "weather_state_abbr": "c",
      "wind_direction_compass": "WSW",
      "created": "2017-06-12T14:14:46.268110Z",
      "applicable_date": "2017-06-12",
      "min_temp": 22.511666666667,
      "max_temp": 31.963333333333,
      "the_temp": 27.803333333333,
      "wind_speed": 6.8884690250312,
      "wind_direction": 251.62921994166,
      "air_pressure": 1021.335,
      "humidity": 50,
      "visibility": 14.945530601288,
      "predictability": 68
    },
    .
    .
    .
    "title": "New York",
    "location_type": "City",
    "woeid": 2459115,
    "latt_long": "40.71455,-74.007118",
    "timezone": "US\/Eastern"
  }

{{localweather.consolidated_weather[0].weather_state_name}}を参照することで、雨が降っているかどうかをテストできます。このオブジェクトで使用した場合、Clearが返されます。結果のロケーション名でもパーソナライズしたい場合は、{{localweather.title}}でNew Yorkが返されます。

次の画像は、正しく設定されている場合にダッシュボードで表示されるシンタックスハイライトの種類を示しています。また、connected_contentリクエストの例をどのように活用できるかも示しています。

1
2
3
4
5
6
7
8
9
10

{% connected_content https://www.metaweather.com/api/location/search/?query={{custom_attribute.${customCity}}} :save locationjson %}
{% connected_content https://www.metaweather.com/api/location/{{locationjson[0].woeid}}/ :save localweather %}

{% if {{localweather.consolidated_weather[0].weather_state_name}} == 'Rain' %}
It's raining! Grab an umbrella!
{% elsif {{localweather.consolidated_weather[0].weather_state_name}} == 'Clouds' %}
No sunscreen needed :)
{% else %}
Enjoy the weather!
{% endif %}

APIが{{localweather.consolidated_weather[0].weather_state_name}}でRainを返した場合、ユーザーは次のプッシュ通知を受け取ります。

「It's raining! Grab an umbrella!」というメッセージのプッシュ通知

コネクテッドコンテンツはデフォルトで、作成する GET HTTP リクエストの Content-Type ヘッダーを、Accept: */* を持つ application/json に設定します。別のコンテンツタイプが必要な場合は、タグに:content_type your/content-typeを追加して明示的に指定してください。Brazeは、指定したタイプにContent-TypeおよびAcceptヘッダーの両方を設定します。

1

{% connected_content http://numbersapi.com/random/trivia :content_type application/json %}

HTTP POST

デフォルトでは、コネクテッドコンテンツは指定されたURLにHTTP GETリクエストを送信します。代わりにPOSTリクエストを行うには、:method postを指定します。

指定された:bodyの後にkey1=value1&key2=value2&...形式のクエリ文字列またはキャプチャされた値への参照を指定することで、オプションでPOSTボディを提供できます。Content-Typeのデフォルトはapplication/x-www-form-urlencodedです。:content_type application/jsonを指定し、key1=value1&key2=value2のようなフォームURLエンコードされた本文を提供すると、Brazeは送信前に自動的に本文をJSONエンコードします。

また、接続されたコンテンツは、デフォルトではPOST 呼び出しをキャッシュしません。:cache_max_age をコネクテッドコンテンツの POST 呼び出しに追加することで、この動作を更新できます。

{% connected_content https://example.com/api/endpoint :method post :body key1=value1&key2=value2 %}

{% connected_content https://example.com/api/endpoint :method post :body key1=value1&key2=value2 :content_type application/json %}

JSONボディの提供

独自のJSONボディを提供したい場合、スペースがなければインラインで記述できます。ボディにスペースがある場合は、assignまたはcaptureステートメントを使用する必要があります。つまり、以下の3つのいずれも使用できます。

インライン：スペースは使用不可
1

{% connected_content https://example.com/api/endpoint :method post :body {"foo":"bar","baz":"{{1|plus:1}}"} :content_type application/json %}
captureステートメント内のボディ：スペース使用可
1
2
3
4

{% capture postbody %}
{"foo": "bar", "baz": "{{ 1 | plus: 1 }}"}
{% endcapture %}
{% connected_content https://example.com/api/endpoint :method post :body {{postbody}} :content_type application/json %}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{% capture postbody %}
{
"ids":[ca_57832,ca_75869],"include":{"attributes":{"withKey":["daily_deals"]}}
}
{% endcapture %}

{% connected_content
    https://example.com/api/endpoint
    :method post
    :headers {
      "Content-Type": "application/json"
  }
  :body {{postbody}}
  :save result
%}
assignステートメント内のボディ：スペース使用可
1
2

{% assign postbody = '{"foo":"bar", "baz": "2"}' %}
{% connected_content https://example.com/api/endpoint :method post :body {{postbody}} :content_type application/json %}

HTTPステータスコード

コネクテッドコンテンツの呼び出しからHTTPステータスを利用するには、まずローカル変数として保存し、次に__http_status_code__キーを使用します。例：

1
2
3
4

{% connected_content https://example.com/api/endpoint :save result %}
{% if result.__http_status_code__ != 200 %}
  {% abort_message('Connected Content returned a non-200 status code') %}
{% endif %}
New Stuff!