Variáveis de Conteúdo Local Conectado

A Braze faz uma solicitação GET padrão no momento do envio para o endpoint especificado na tag connected_content. Se o endpoint retornar JSON, ele será automaticamente analisado e armazenado em uma variável chamada connected. Se o endpoint retornar texto, ele será inserido diretamente na mensagem no lugar da tag connected_content.

Se você deseja salvar sua resposta em uma variável, é recomendável retornar objetos JSON. E se você quiser que a resposta do conteúdo conectado substitua a tag pelo texto, certifique-se de que a resposta não seja um JSON válido (conforme definido por [json.org][46])

Você também pode especificar :save your_variable_name após o URL para salvar os dados como outra coisa. Por exemplo, a seguinte tag connected_content armazenará a resposta em uma variável local chamada localweather (você pode salvar várias variáveis JSON connected_content):

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

Metaweather é uma API de clima gratuita que usa um “Where-on-Earth ID” para retornar o clima em uma região. Use este código apenas para fins de teste e aprendizado.

A variável armazenada só pode ser acessada dentro do campo que contém a connected_content solicitação. Por exemplo, se você quiser usar a variável localweather tanto no campo de mensagem quanto no campo de título, você deve fazer a solicitação connected_content dentro de ambos os campos. Se a solicitação for idêntica, a Braze usará os resultados em cache, em vez de fazer uma segunda solicitação ao servidor de destino. No entanto, as chamadas de Conteúdo Conectado feitas via HTTP POST não são armazenadas em cache por padrão e farão uma segunda solicitação ao servidor de destino. Se você deseja adicionar cache às chamadas POST, consulte a opção cache_max_age.

análise JSON

O conteúdo conectado interpretará quaisquer resultados formatados em JSON em uma variável local, quando você especificar :save. Por exemplo, um endpoint de conteúdo conectado relacionado ao clima retorna o seguinte objeto JSON, que você armazena em uma variável local localweather especificando :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"
  }

Você pode testar se está chovendo ou não referenciando {{localweather.consolidated_weather[0].weather_state_name}}, o que, se usado neste objeto, retornaria Clear. Se você também quiser personalizar com o nome do local resultante, {{localweather.title}} retorna New York.

A imagem a seguir ilustra o tipo de realce de sintaxe que você deve ver no dashboard se estiver configurando as coisas corretamente. Também demonstra como você pode aproveitar o exemplo de solicitação 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 %}

Se a API respondesse com {{localweather.consolidated_weather[0].weather_state_name}} retornando Rain, o usuário receberia este push.

Por padrão, o conteúdo conectado definirá um Content-Type cabeçalho em uma solicitação HTTP GET que ele faz para application/json com Accept: */*. Se precisar de outro tipo de conteúdo, especifique-o explicitamente adicionando :content_type your/content-type à tag. A Braze definirá então tanto o cabeçalho Content-Type quanto o cabeçalho Accept para o tipo que você especificar.

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

POST HTTP

Por padrão, o conteúdo conectado faz uma solicitação HTTP GET para a URL especificada. Para fazer uma solicitação POST, especifique :method post.

Você pode opcionalmente fornecer um corpo POST especificando :body seguido por uma consulta string do formato key1=value1&key2=value2&... ou uma referência aos valores capturados. O tipo de conteúdo padrão é application/x-www-form-urlencoded. Se você especificar :content_type application/json e fornecer um corpo codificado em formulário, como key1=value1&key2=value2, a Braze codificará automaticamente o corpo em JSON antes de enviar.

Tipo de conteúdo padrão

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

Tipo de Conteúdo Application/JSON

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

Fornecimento de corpo JSON

Para fornecer seu próprio corpo JSON, escreva-o em linha se não houver espaços. Se seu corpo tiver espaços, você deve usar uma instrução de atribuir ou capturar. Ou seja, qualquer um desses três é aceitável:

Em linha: espaços não permitidos

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

Corpo em uma declaração de captura: espaços permitidos

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

Corpo em uma instrução de atribuição: espaços permitidos

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

Códigos de status HTTP

Você pode utilizar o status HTTP de uma chamada de conteúdo conectado salvando-o primeiro como uma variável local e depois usando a chave __http_status_code__. Por exemplo:

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

Cache configurável

As respostas de Conteúdo Conectado podem ser armazenadas em cache em diferentes campanhas ou mensagens (dentro do mesmo espaço de trabalho) para otimizar a velocidade de envio.

O Braze não registra nem armazena permanentemente as respostas do Connected Content. Se você optar explicitamente por armazenar uma resposta de chamada do Connected Content como uma variável Liquid, o Braze armazenará essa resposta apenas na memória, ou seja, em um armazenamento temporário que será excluído após um curto período de tempo, para renderizar a variável Liquid e enviar a mensagem. Para impedir totalmente o armazenamento em cache, você pode especificar :no_cache, o que pode aumentar o tráfego de rede. Para ajudar a solucionar problemas e monitorar a integridade do sistema, o Braze também pode registrar as chamadas de Connected Content que falham (como 404s e 429s); esses registros são mantidos por até 30 dias.

Limite de tamanho do cache

O corpo da resposta do conteúdo conectado não deve exceder 1 MB, ou não será armazenado em cache.

Tempo de cache

O conteúdo conectado armazenará em cache o valor que retorna dos endpoints GET por um mínimo de 5 minutos. Se um tempo de cache não for especificado, o tempo de cache padrão é de 5 minutos.

O tempo de cache do conteúdo conectado pode ser configurado para ser mais longo com :cache_max_age, conforme mostrado no exemplo a seguir. O tempo mínimo de cache é de 5 minutos e o tempo máximo de cache é de 4 horas. Os dados de conteúdo conectado são armazenados em cache na memória usando um sistema de cache volátil, como o Memcached. Como resultado, independentemente do tempo de cache especificado, os dados do conteúdo conectado podem ser removidos do cache em memória da Braze antes do especificado. Isso significa que as durações do cache são sugestões e podem não representar realmente a duração que os dados são garantidos a serem armazenados em cache pelo Braze e você pode ver mais solicitações de Conteúdo Conectado do que pode esperar com uma determinada duração de cache.

Por padrão, o conteúdo conectado não armazena em cache as chamadas POST. Você pode alterar esse comportamento adicionando :cache_max_age à chamada POST do conteúdo conectado.

Cache por segundos especificados

Este exemplo será armazenado em cache por 900 segundos (ou 15 minutos).

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

Cache busting

Para evitar que o conteúdo conectado armazene em cache o valor que retorna de uma solicitação GET, você pode usar a configuração :no_cache. No entanto, as respostas de hosts internos à Braze ainda serão armazenadas em cache.

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

Com um POST você não precisa fazer cache bust, pois a Braze nunca armazena em cache os resultados de solicitações POST.

Daqui a [46]: http://www.json.org