Carte du pouls des ventes pour écrans d’affichage numérique

Carte en direct

Cette carte est dessinée dans votre navigateur par le même code que les lecteurs, avec des données d’exemple.

Catégorie : Opérations. Étiquettes : Nombres et métriques, Graphiques et jauges, Magasins.

Mises en page

Cette carte plein écran occupe tout l’écran en mode paysage ou portrait et n’est pas placée en coin, puce ou bande.

Mises en page : pleine. Formes : paysage, portrait.

Mises en page, thèmes et publication des cartes. Parcourir les cartes.

Données et confidentialité

Flux : screenrig.sales/v1.

Les documents du flux portent une attribution de source. Le Player fournit le flux à la carte.

Affiche uniquement les revenus, le nombre de commandes et la ville de chaque commande ; jamais un nom de client, une adresse ou un détail de paiement.

Propriétés

Pour le thème, l’arrière-plan, l’accent et la position, voir Propriétés communes.

Définissez les propriétés statiques dans les params de la carte lorsque vous la créez. Son document de données ne contient que des propriétés dynamiques. Les lignes imbriquées décrivent le contenu de leur propriété parente.

Propriétés statiques

Nom	Type	Par défaut	Valeurs et limites	Description
`title`	string	`"Sales pulse"`	maxLength : `40`
`currency`	string	`"USD"`	maxLength : `3`	Code ISO 4217 ; celui du fil prévaut.
`rows`	integer	`5`	minimum : `1` ; maximum : `8`	Lignes dans chaque liste.
`staleMinutes`	integer	`15`	minimum : `1` ; maximum : `1440`	Un flux plus ancien que cela indique depuis combien de temps il a été mis à jour.
`backgroundColor`	chaîne, nul	`null`	motif : `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Remplace le fond et la plaque de la carte par une couleur plate ordonnée en CSS. #RRGGBBAA fournit l’opacité. background none a la priorité.
`textColor`	chaîne, nul	`null`	motif : `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Remplace les couleurs du texte principal et secondaire. Les couleurs d’accentuation et de statut sémantique conservent leur rôle.

Propriétés dynamiques

Nom	Type	Par défaut	Valeurs et limites	Description
`store`	string	`""`	maxLength : `60`	Le magasin que décrivent les chiffres ; les gains du flux.
`revenue`	nombre, nul	`null`	minimum : `0` ; maximum : `1000000000000`	Revenus jusqu’à présent aujourd’hui.
`orders`	entier, nul	`null`	minimum : `0` ; maximum : `100000000`	Commandes jusqu’à aujourd’hui.
`goal`	nombre, nul	`null`	minimum : `0` ; maximum : `1000000000000`	Objectif de revenus pour aujourd’hui ; vide indique aucun objectif.
`yesterdayRevenue`	nombre, nul	`null`	minimum : `0` ; maximum : `1000000000000`	Revenus à cette heure hier ; vide indique aucune comparaison.
`hourly`	array	`[]`	maxItems : `24`	Revenus pour chaque heure d’aujourd’hui dans le fuseau de l’écran, à partir de minuit.
`cities`	array	`[]`	maxItems : `20`	Revenus par ville, le même document que le flux screenrig.sales/v1`cities`.
`cities[].name`	string		minLength : `1` ; maxLength : `60` ; Obligatoire	Une ville ou une région.
`cities[].revenue`	number		minimum : `0` ; maximum : `1000000000` ; Obligatoire	Revenus aujourd’hui provenant de la ville.
`recent`	array	`[]`	maxItems : `20`	Les dernières commandes, le même document que le flux `recent`.
`recent[].at`	string		minLength : `1` ; maxLength : `40` ; Obligatoire	Quand la commande a été passée, un instant ISO 8601.
`recent[].amount`	number		minimum : `0` ; maximum : `1000000000` ; Obligatoire	Le total de la commande.
`recent[].city`	string	`""`	maxLength : `60`	Où cela a été expédié ou placé ; jamais un client.

Exemple de canevas

Enregistrez les propriétés statiques comme params.json et créez la carte. Le résultat contient son identifiant crd_.

{
  "theme": "neomustard"
}

screenrig card create --type sales-pulse --major 1 --file params.json

Ajoutez cet élément aux primitives d’une page de liste de lecture, en remplaçant l’identifiant de l’exemple par celui de votre carte. Publiez la liste de lecture et assignez un écran.

{
  "id": "sales-pulse",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Écrire des données en direct

Écrivez le document dans la carte après l’avoir créée, puis remplacez-le pour mettre à jour l’écran sans republier. La carte vérifie chaque écriture par rapport à ses propriétés dynamiques et refuse un document qu’elle rejette. Utilisez le même projet que la liste de lecture.

Enregistrez le document sous card-data.json. La CLI lit le document lui-même, sans enveloppe :

{
  "store": "",
  "revenue": null,
  "orders": null,
  "goal": null,
  "yesterdayRevenue": null,
  "hourly": [],
  "cities": [],
  "recent": []
}

screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Ou appelez directement l’API. L’API enveloppe le même document dans un champ document. Un jeton agent nomme déjà son projet, donc aucun en-tête de projet n’est envoyé ; si vous envoyez ScreenRig-Project, il doit correspondre au projet du jeton. Fournissez votre autorisation API via l’environnement ; voir Authentification API.

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"store":"","revenue":null,"orders":null,"goal":null,"yesterdayRevenue":null,"hourly":[],"cities":[],"recent":[]}}'