Cartão de listagens de propriedades

Mostrar anúncios de imóveis para uma vitrine ou saguão de agência: um anúncio por vez com sua foto, preço, endereço e dados principais, ou uma parede de blocos.

Mostrar um anúncio por vez com sua foto, preço, endereço e dados principais, ou apresentar os anúncios juntos como uma parede de blocos para uma vitrine ou saguão de agência.

Cartão ao vivo

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

Categoria: Varejo. Tags: Lojas, Lobbies e recepção.

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.listings/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

NomeTipoPadrãoValores e limitesDescrição
titlestring"Listings"maxLength: 40
agencystring""maxLength: 60O nome da agência, quando o feed não traz nenhum.
currencystring"$"maxLength: 4O símbolo da moeda antes do preço.
unitsstring"imperial""imperial", "metric"imperial: sq ft. métrico: m2.
rotateSecondsinteger10mínimo: 5; máximo: 60Quanto tempo cada listagem (ou página de blocos) permanece na tela.
tilesinteger6mínimo: 2; máximo: 9Azulejos por página no layout de grade.
hideSoldbooleanfalseDeixe de fora listagens vendidas e alugadas.
showAgentbooleantrue
staleMinutesinteger720mínimo: 1; máximo: 10080
hour12booleanfalse
backgroundColorstring, nulonullpadrã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.
textColorstring, nulonullpadrã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

NomeTipoPadrãoValores e limitesDescrição
listingsarray[]minItems: 0; maxItems: 60As listagens a mostrar, em ordem. Um feed (screenrig.listings/v1) prevalece quando presente; o armazenamento de dados fornece as mesmas linhas caso contrário.
listings[].idstringmaxLength: 40
listings[].statusstring"for-sale""for-sale", "for-rent", "sold", "pending", "new", "reduced", "leased"
listings[].pricenumbermínimo: 0; máximo: 1000000000; Obrigatório
listings[].priceUnitstring"""", "week", "month"Para um aluguel: o preço por semana ou mês.
listings[].addressstringminLength: 1; maxLength: 80; Obrigatório
listings[].localitystringmaxLength: 60
listings[].typestringmaxLength: 30Por exemplo Condomínio, Casa, Sobrado.
listings[].bedsnumbermínimo: 0; máximo: 200 é um estúdio.
listings[].bathsnumbermínimo: 0; máximo: 20
listings[].areaSqftnumbermínimo: 0; máximo: 200000
listings[].headlinestringmaxLength: 140
listings[].photostringmaxLength: 120Uma referência de mídia (media:<id>).
listings[].openHouseobjectadditionalProperties: false
listings[].openHouse.startstringmaxLength: 32; ObrigatórioISO 8601.
listings[].openHouse.endstringmaxLength: 32ISO 8601.
listings[].agentstringmaxLength: 60
listings[].brokeragestringmaxLength: 60A empresa listada; exibida sempre que presente.
listings[].mlsstringmaxLength: 30
updatedstring""maxLength: 32Quando os anúncios foram buscados, ISO 8601 (apenas armazenamento de dados; um feed carrega fetchedAt).

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 property-listings --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": "property-listings",
  "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:

{
  "listings": [],
  "updated": ""
}
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":{"listings":[],"updated":""}}'