Cartão de pulso de vendas para telas de sinalização digital

Cartão ao vivo

Este cartão é desenhado no seu navegador pelo mesmo código que os Players executam, com dados de exemplo.

Categoria: Operações. Tags: Números e métricas, Gráficos e medidores, Lojas.

Layouts

Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.

Layouts: cheio. Formas: paisagem, retrato.

Layouts, temas e publicação de cartões. Veja os cartões.

Dados e privacidade

Feed: screenrig.sales/v1.

Documentos do feed carregam atribuição da fonte. O Player fornece o feed para o cartão.

Mostra apenas receita, contagem de pedidos e a cidade de cada pedido; nunca nome do cliente, endereço ou detalhes de pagamento.

Propriedades

Para tema, fundo, destaque e posição, veja Propriedades comuns.

Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.

Propriedades estáticas

Nome	Tipo	Padrão	Valores e limites	Descrição
`title`	string	`"Sales pulse"`	maxLength: `40`
`currency`	string	`"USD"`	maxLength: `3`	Código ISO 4217; vence o do feed.
`rows`	integer	`5`	mínimo: `1`; máximo: `8`	Linhas em cada lista.
`staleMinutes`	integer	`15`	mínimo: `1`; máximo: `1440`	Um feed mais antigo que isso mostra há quanto tempo foi atualizado.
`backgroundColor`	string, nulo	`null`	padrão: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência.
`textColor`	string, nulo	`null`	padrão: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis.

Propriedades dinâmicas

Nome	Tipo	Padrão	Valores e limites	Descrição
`store`	string	`""`	maxLength: `60`	A loja que os números descrevem; as vitórias do feed.
`revenue`	número, nulo	`null`	mínimo: `0`; máximo: `1000000000000`	Receita até agora hoje.
`orders`	integer, null	`null`	mínimo: `0`; máximo: `100000000`	Pedidos até agora hoje.
`goal`	número, nulo	`null`	mínimo: `0`; máximo: `1000000000000`	Meta de receita para hoje; vazio indica sem meta.
`yesterdayRevenue`	número, nulo	`null`	mínimo: `0`; máximo: `1000000000000`	Receita até este horário ontem; vazio indica sem comparação.
`hourly`	array	`[]`	maxItems: `24`	Receita para cada hora de hoje na zona da tela, começando à meia-noite.
`cities`	array	`[]`	maxItems: `20`	Receita por cidade, o mesmo documento que o feed screenrig.sales/v1 `cities`.
`cities[].name`	string		minLength: `1`; maxLength: `60`; Obrigatório	Uma cidade ou região.
`cities[].revenue`	number		mínimo: `0`; máximo: `1000000000`; Obrigatório	Receita hoje da cidade.
`recent`	array	`[]`	maxItems: `20`	Os pedidos mais recentes, o mesmo documento que o feed `recent`.
`recent[].at`	string		minLength: `1`; maxLength: `40`; Obrigatório	Quando o pedido foi feito, um instante ISO 8601.
`recent[].amount`	number		mínimo: `0`; máximo: `1000000000`; Obrigatório	O total do pedido.
`recent[].city`	string	`""`	maxLength: `60`	Para onde foi enviado ou colocado; nunca um cliente.

Exemplo de tela

Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.

{
  "theme": "neomustard"
}

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

Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.

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

Escrever dados ao vivo

Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.

Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:

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

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

Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da 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":[]}}'