Variables du contenu connecté local

Cette page donne un aperçu des variables locales du contenu connecté et de la manière de les utiliser et de les stocker.

Braze effectue une demande GET standard à l’heure d’envoi au endpoint spécifié dans la balise connected_content. Si l’endpoint retourne JSON, il est automatiquement analysé et stocké dans une variable appelée connected. Si l’endpoint renvoie le texte, il sera directement inséré dans le message à la place de la balise connected_content.

Si vous souhaitez enregistrer votre réponse à une variable, il est recommandé de retourner des objets JSON. Et si vous voulez que la réponse du contenu connecté remplace l’étiquette par le texte, assurez-vous que la réponse n’est pas un JSON valide (tel que défini par [json.org][46])

Vous pouvez également spécifier :save your_variable_name après l’URL pour enregistrer les données sous un autre nom. Par exemple, les connected_content la balise enregistrera la réponse à une variable locale appelée localweather (vous pouvez enregistrer plusieurs connected_content variables JSON) :

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

Metaweather est une API météorologique gratuite qui utilise un “Where-on-Earth ID” pour renvoyer les conditions météorologiques d’une région. Utilisez ce code à des fins de test et d’apprentissage uniquement.

La variable stockée ne peut être consultée que dans le champ qui contient connected_content demande. Par exemple, si vous souhaitez utiliser localweather variable dans le champ Message et Titre, vous devez faire connected_content dans les deux champs. Si la demande est identique, Braze utilisera les résultats mis en cache plutôt que d’effectuer une seconde demande au serveur de destination. Cependant, les appels de contenu connecté effectués via HTTP POST ne sont pas mis en cache par défaut et feront une seconde demande au serveur de destination. Si vous souhaitez ajouter la mise en cache aux appels POST, reportez-vous à l’option cache_max_age.

Analyse JSON

Le contenu connecté interprète tous les résultats formatés JSON dans une variable locale, lorsque vous spécifiez :save. Par exemple, un endpoint de contenu connecté lié à la météo renvoie l’objet JSON suivant, que vous stockez dans une variable locale localweather en spécifiant :save 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"
  }

Vous pouvez tester si c’est difficile ou non en faisant référence {{localweather.consolidated_weather[0].weather_state_name}}, qui, si utilisé sur cet objet, reviendrait Clear. Si vous souhaitez également personnaliser avec le nom de l’emplacement en résultant, {{localweather.title}} retours New York.

L’image suivante illustre le type de syntaxe que vous devez voir dans le tableau de bord si vous configurez correctement les choses. Cela montre également comment vous pourriez tirer profit de l’exemple connected_content demande !

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 %}

Si l’API a répondu {{localweather.consolidated_weather[0].weather_state_name}} en renvoyant Rain, l’utilisateur recevra alors ce message.

Par défaut, le contenu connecté définit un Content-Type en-tête d’une demande GET HTTP que cela rend application/json avec Accept: */*. Si vous avez besoin d’un autre type de contenu, spécifiez-le explicitement en ajoutant :content_type your/content-type à la balise. Braze définira alors l’en-tête Type de contenu et Accepter au type que vous spécifiez.

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

POST HTTP

Par défaut, le contenu connecté fait une demande HTTP GET à l’URL spécifiée. Pour effectuer une demande POST, précisez :method post.

Vous pouvez éventuellement fournir un corps POST en spécifiant :body suivi d’une chaîne de caractères de requête du format key1=value1&key2=value2&... ou une référence à des valeurs capturées. Type de contenu par défaut application/x-www-form-urlencoded. Si vous spécifiez :content_type application/json et fournir un corps sous forme de code-urétroté, comme key1=value1&key2=value2, Braze jSON automatiquement le code de l’organisme avant d’envoyer.

Type de contenu par défaut

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

Type de contenu Application/JSON

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

Fournir le corps du JSON

Si vous souhaitez fournir votre propre corps JSON, vous pouvez l’écrire en ligne s’il n’y a pas d’espace. Si votre corps dispose d’espaces, vous devez utiliser un relevé d’affectation ou de capture. C’est-à-dire que l’un de ces trois éléments est acceptable :

Inséré : espaces non autorisés

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

Corps dans un relevé de capture : espaces autorisés

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
%}

Corps dans un état d’affectation : espaces autorisés

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

Codes de statut HTTP

Vous pouvez utiliser l’état HTTP à partir d’un appel de contenu connecté en l’enregistrant d’abord en tant que variable locale, puis en utilisant le __http_status_code__ clé. Par exemple :

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 %}

Mise en cache configurable

Les réponses au contenu connecté peuvent être mises en cache dans différentes campagnes ou messages (au sein du même espace de travail) afin d’optimiser les vitesses d’envoi.

Braze n’enregistre ni ne stocke en permanence les réponses au contenu connecté. Si vous choisissez explicitement de stocker une réponse à un appel de contenu connecté en tant que variable Liquid, Braze ne la stocke qu’en mémoire, c’est-à-dire sur un stockage temporaire qui est supprimé après un court laps de temps, pour effectuer le rendu de la variable Liquid et envoyer le message. Pour empêcher complètement la mise en cache, vous pouvez spécifier :no_cache, ce qui peut entraîner une augmentation du trafic réseau. Pour faciliter le dépannage et le contrôle de la santé du système, Braze peut également consigner les appels au contenu connecté qui échouent (tels que les 404 et les 429) ; ces journaux sont conservés pendant 30 jours maximum.

Limite de la taille du cache

Le corps de réponse du contenu connecté ne doit pas dépasser 1 Mo, ou il ne sera pas mis en cache.

Temps cache

Le contenu connecté mettra en cache la valeur qu’il renvoie à partir des critères d’évaluation GET pendant au moins 5 minutes. Si un temps de cache n’est pas spécifié, l’heure de cache par défaut est de 5 minutes.

L’heure du cache de contenu connecté peut être configurée pour être plus longue avec :cache_max_age, comme illustré dans l’exemple suivant. Le temps de cache minimum est de 5 minutes et le temps de cache maximum est de 4 heures. Les données de contenu connecté sont mises en cache en mémoire à l’aide d’un système de cache volatil, tel que Memcached. Par conséquent, indépendamment de l’heure de cache spécifiée, les données du contenu connecté peuvent être évitées depuis le cache in-memory de Braze plus tôt que spécifié. Cela signifie que les durées de cache sont des suggestions et qu’elles ne représentent pas réellement la durée pendant laquelle les données sont garanties à être mises en cache par Braze et que vous pouvez voir plus de requêtes de contenu connecté que vous ne pouvez attendre avec une durée de cache donnée.

Par défaut, le contenu connecté ne cache pas les appels POST. Vous pouvez modifier ce comportement en ajoutant :cache_max_age à l’appel POST de contenu connecté.

Cache pour les secondes spécifiées

Cet exemple se cache pendant 900 secondes (ou 15 minutes).

1
{% connected_content https://example.com/webservice.json :cache_max_age 900 %}

Mise en cache du cache

Pour empêcher le contenu connecté de mettre en cache la valeur qu’il renvoie à partir d’une demande GET, vous pouvez utiliser la configuration :no_cache. Toutefois, les réponses provenant d’hôtes internes à Braze seront toujours mises en cache.

1
{% connected_content https://example.com/webservice.json :no_cache %}

Avec un POST vous n’avez pas besoin de cache, car Braze ne cache jamais les résultats de POST demandes.

Il y a [46]: http://www.json.org