Cartão de visitantes ao vivo 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, Escritórios e locais de trabalho, 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.visitors/v1.

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

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	`"Live visitors"`	maxLength: `40`
`rows`	integer	`5`	mínimo: `1`; máximo: `8`	Linhas em cada lista.
`staleMinutes`	integer	`10`	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
`site`	string	`""`	maxLength: `60`	O site ou app que os números descrevem; as vitórias do feed.
`active`	integer, null	`null`	mínimo: `0`; máximo: `100000000`	Visitantes online agora. Vazio recai para o total maior das listas.
`series`	array	`[]`	maxItems: `60`	Visitantes online a cada minuto, do mais antigo ao mais recente; os últimos 30 são exibidos.
`record`	integer, null	`null`	mínimo: `0`; máximo: `100000000`	A melhor contagem anterior; uma contagem acima dela é um recorde. O `record` de vitórias do feed quando presente.
`updatedAt`	string	`""`	maxLength: `40`	Quando os números mudaram pela última vez (ISO 8601); ancoragem do momento da atualização quando o feed não tem fetchedAt.
`pages`	array	`[]`	maxItems: `20`	Principais páginas, o mesmo documento do feed screenrig.visitors/v1 `pages`. O feed prevalece quando presente.
`pages[].path`	string	`""`	maxLength: `80`	O caminho da página (/pricing).
`pages[].title`	string	`""`	maxLength: `80`	Mostrado em vez do caminho quando presente.
`pages[].visitors`	integer		mínimo: `0`; máximo: `10000000`; Obrigatório	Visitantes na página agora.
`sources`	array	`[]`	maxItems: `20`	Principais fontes, o mesmo documento do `sources` do feed.
`sources[].name`	string		minLength: `1`; maxLength: `80`; Obrigatório	De onde vieram os visitantes (Google, Direto, Newsletter).
`sources[].visitors`	integer		mínimo: `0`; máximo: `10000000`; Obrigatório	Visitantes desta fonte agora.

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 live-visitors --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": "live-visitors",
  "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:

{
  "site": "",
  "active": null,
  "series": [],
  "record": null,
  "updatedAt": "",
  "pages": [],
  "sources": []
}

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":{"site":"","active":null,"series":[],"record":null,"updatedAt":"","pages":[],"sources":[]}}'