Variables SQL du Générateur de requêtes

Découvrez comment utiliser des variables SQL dans le Générateur de requêtes afin de réutiliser vos requêtes et d’éviter de coder en dur des données dans votre code.

Pourquoi utiliser des variables SQL ?

Les avantages de l’utilisation de variables SQL incluent :

• Gagner du temps en créant une variable Campaign à sélectionner dans une liste lors de la création de votre rapport, au lieu de coller des identifiants Campaign.
• Remplacer des valeurs en ajoutant des variables qui vous permettent de réutiliser le rapport pour des cas d’utilisation légèrement différents à l’avenir (comme un événement personnalisé différent).
• Réduire les erreurs utilisateur lors de la modification de votre SQL en diminuant la quantité de modifications nécessaires pour chaque rapport. Les collègues plus à l’aise avec SQL peuvent créer des rapports que des collègues moins techniques peuvent ensuite utiliser.

Utiliser des variables

Étape 1 : Ajouter une variable

Pour ajouter une variable à votre requête, utilisez la syntaxe suivante :

1
{{variable_type.${custom_label}}}

Remplacez les éléments suivants :

Dans l’exemple suivant, le nombre total d’utilisateurs entre le premier et le dernier jour d’un mois est interrogé pour une Campaign. Chaque variable se verra attribuer une valeur à l’étape suivante.

1
2
3
4
5
SELECT COUNT(*) AS total_users
FROM USERS_CAMPAIGNS_REVENUE_SHARED
WHERE campaign_id = '{{campaign.${Campaign}}}'
  AND TIME > '{{start_date.${Month First Day}}}'
  AND TIME < '{{end_date.${Month Last Day}}}';

Étape 2 : Attribuer une valeur

Par défaut, l’onglet Variables n’est pas affiché dans le Générateur de requêtes. Il n’apparaît qu’après l’ajout de votre première variable à la requête. Vous pourrez alors lui attribuer une valeur. Les valeurs spécifiques que vous pouvez choisir dépendront du type de cette variable.

Dans l’exemple suivant, la Campaign « Summer Feature Launch » est attribuée comme valeur, ainsi que le premier et le dernier jour de juin 2025.

Types de variables généraux

Nombre

number peut être utilisé en combinaison avec d’autres variables non-chaîne. Accepte tout nombre positif ou négatif, y compris les nombres décimaux, comme 5.5.

• utilisation

1
some_number_column < {{number.${custom_label}}}

Chaîne de caractères

Pour modifier des valeurs de chaîne répétitives entre les exécutions de rapports. Utilisez cette variable pour éviter de coder en dur une valeur plusieurs fois dans votre SQL.

• utilisation

1
'{{string.${add a string here.}}}'

Liste

Pour sélectionner à partir d’une liste d’options.

• choisir une option
• choisir plusieurs options

1
{{options.${metrics} | is_radio_button: 'true' | options: '[{"label": "test", "value": "test_value"}, {"label": "test2", "value": "test_value2"}]'}}

1
{{options.${metrics} | is_multi_select: 'true' | options: '[{"label": "test", "value": "test_value"}, {"label": "test2", "value": "test_value2"}]'}}

Bouton radio

Pour afficher les options sous forme de boutons radio au lieu d’un menu déroulant dans l’onglet Variables. Cela ne peut pas être utilisé seul—il doit être utilisé en combinaison avec une liste.

• utilisation

1
is_radio_button: 'true'

Sélection multiple

Pour déterminer si le menu déroulant permet une sélection unique ou multiple. Cela ne peut pas être utilisé seul—il doit être utilisé en combinaison avec une liste.

• utilisation

1
is_multi_select: 'true'

Options

Pour fournir la liste des options sélectionnables sous la forme d’un libellé et d’une valeur. Le libellé est ce qui est affiché et la valeur est ce par quoi la variable est remplacée lorsque l’option est sélectionnée. Cela ne peut pas être utilisé seul—il doit être utilisé en combinaison avec une liste.

• utilisation

1
options: '[{"label": "test", "value": "test_value"}, {"label": "test2", "value": "test_value2"}]'

Types de variables spécifiques à Braze

Plage de dates

Pour afficher un calendrier permettant de sélectionner des dates. Remplacez start_date et end_date par un horodatage Unix en secondes pour une date spécifiée en UTC, comme 1696517353. Vous pouvez également définir uniquement une start_date ou une end_date pour n’afficher qu’une seule date dans le calendrier. Si les libellés de votre start_date et end_date ne correspondent pas, ils seront traités comme deux dates distinctes plutôt que comme une plage de dates.

• utilisation

1
time > {{start_date.${custom_label}}} AND time < {{end_date.${custom_label}}}

Vous pouvez définir la plage de dates sur l’une des options suivantes. Si start_date et end_date sont tous deux utilisés et partagent le même libellé, toutes les options seront affichées. Sinon, si un seul est utilisé, seule l’option spécifiée sera affichée.

Votre Liquid sera utilisé pour afficher un calendrier dans la plage de dates donnée :

Campaigns

• une campaign
• plusieurs campaigns
• variantes de campaign

1
campaign_id = '{{campaign.${custom_label}}}'

1
campaign_id IN ({{campaigns.${custom_label}}})

1
message_variation_api_id IN ({{campaign_variants.${custom_label}}})

Canvas

• un canvas
• plusieurs canvas
• variantes de canvas
• une étape de canvas
• plusieurs étapes de canvas

1
canvas_id = '{{canvas.${custom_label}}}'

1
canvas_id IN ({{canvases.${custom_label}}})

1
canvas_variation_api_id IN ({{canvas_variants.${custom_label}}})

1
canvas_step_api_id = '{{canvas_step.${custom_label}}}'

1
canvas_step_api_id IN ({{canvas_steps.${custom_label}}})

Produits

products est utilisé pour sélectionner un ou plusieurs produits depuis le tableau de bord de Braze.

• utilisation
• exemple

1
({{products.${custom_label}}})

1
2
3
SELECT product_name
FROM FULL_GAME_AND_DLC
WHERE product_id IN ({{products.${Games with DLC}}});

Événements personnalisés

Sélectionnez un ou plusieurs événements personnalisés ou propriétés d’événements personnalisés à partir d’une liste.

• événement
• propriétés

1
'{{custom_events.${custom_label}}}'

1
2
3
SELECT event_name
FROM CUSTOM_EVENTS_TABLE
WHERE event_name IN ({{custom_events.${Purchased Game}}});

1
name = '{{custom_event_properties.${property names)}}}'

Espace de travail

workspace est utilisé pour sélectionner un seul espace de travail depuis le tableau de bord de Braze.

• utilisation

1
workspace_id = '{{workspace.${app_group_id}}}'

Catalogues

Sélectionnez un ou plusieurs catalogues ou champs de catalogue à partir d’une liste.

• catalogues
• champs de catalogue

1
catalog_id = '{{catalogs.${catalog}}}'

1
field_name = '{{catalog_fields.${custom_label}}}'

Segments

Pour sélectionner des Segments dont le suivi analytique est activé. Défini sur l’identifiant analytique du Segment, qui correspond aux identifiants stockés dans la colonne user_segment_membership_ids dans les tables où cette colonne est disponible.

• utilisation

1
{{segments.${analytics_segments}}}

Étiquettes

Pour sélectionner des étiquettes pour les Campaigns et Canvas. Défini sur les Campaigns et Canvas avec des identifiants BSON séparés par des virgules entre guillemets simples, associés aux étiquettes sélectionnées.

• utilisation

1
{{tags.${some tags}}}

Métadonnées de variable

Les métadonnées peuvent être attachées à une variable pour modifier son comportement en les ajoutant avec un caractère pipe ( | ) après le libellé de la variable. L’ordre des métadonnées n’a pas d’importance et vous pouvez en ajouter autant que nécessaire. De plus, tous les types de métadonnées peuvent être utilisés pour n’importe quelle variable, à l’exception des métadonnées spéciales qui sont spécifiques à certaines variables (cela sera indiqué dans ces cas). L’utilisation de toutes les métadonnées est facultative et sert à modifier le comportement par défaut de la variable.

• utilisation

1
{{string.${my var}| is_required: 'false' | description: 'My optional string var'}}

Valeur booléenne

Pour savoir si la valeur d’une variable est remplie. Cela est utile pour les variables facultatives où vous souhaitez court-circuiter une condition si la valeur d’une variable n’est pas remplie. Peut être défini sur true ou false en fonction de la valeur de l’autre variable.

• utilisation

1
{{string.${type_name_has_no_value} | visible: 'false'}} or {{string.${type_name_has_value} | visible: 'false'}}

type et name font référence à la variable référencée. Par exemple, pour court-circuiter la variable facultative suivante : {{campaigns.${messaging}} :

1
{{string.${campaigns_messaging_has_no_value}  | visible: 'false'}} OR campaign_id IN ({{campaigns.${messaging} | is_required: 'false'}})

Visible

Pour déterminer si les variables sont visibles. Toutes les variables sont visibles par défaut dans l’onglet Variables, où vous pouvez saisir des valeurs.

Il existe plusieurs variables spéciales dont la valeur dépend d’une autre variable, par exemple si une autre variable a une valeur. Ces variables spéciales sont marquées comme non visibles afin qu’elles n’apparaissent pas dans l’onglet Variables.

• utilisation

1
visible: 'false'

Requis

Pour déterminer si les variables sont requises par défaut. Une valeur vide pour une variable conduit généralement à une requête incorrecte.

• utilisation

1
required: 'false'

Ordre

Pour sélectionner la position de la variable dans l’onglet Variables.

• utilisation

1
order: '1'

Inclure des guillemets

• guillemets simples
• guillemets doubles

1
include_quotes: 'true'

1
include_double_quotes: 'true'

Marque substitutive

Pour spécifier le texte de marque substitutive affiché dans le champ de saisie de la variable.

• utilisation

1
placeholder: 'enter some value'

Description

Pour spécifier le texte de description affiché sous le champ de saisie de la variable.

• utilisation

1
description: 'some description'

Valeur par défaut

Pour spécifier la valeur par défaut de la variable lorsqu’aucune valeur n’est spécifiée.

• utilisation

1
default_value: '5'

Masquer le libellé

Pour masquer le libellé de la variable.

• utilisation

1
hide_label: 'true'