一度に一つのリスティングを写真、価格、住所、主要数値とともに表示するか、代理店の窓口やロビー用にタイルの壁としてまとめて表示します。
ライブカード
カテゴリ: 小売。タグ: 店舗、ロビーと受付。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
フィード:screenrig.listings/v1。
フィードドキュメントは情報源の帰属を含みます。プレーヤーがカードにフィードを提供します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "Listings" | maxLength:40 | |
agency | string | "" | maxLength:60 | フィードにない場合の代理店名。 |
currency | string | "$" | maxLength:4 | 価格の前に表示される通貨記号です。 |
units | string | "imperial" | "imperial", "metric" | インペリアル:平方フィート。メトリック:平方メートル。 |
rotateSeconds | integer | 10 | 最小値:5;最大値:60 | 各リスト(またはタイルのページ)が画面に表示される時間。 |
tiles | integer | 6 | 最小値:2;最大値:9 | グリッドレイアウトのページあたりのタイル数。 |
hideSold | boolean | false | 販売済みおよびリース済みのリストは除外してください。 | |
showAgent | boolean | true | ||
staleMinutes | integer | 720 | 最小値:1;最大値:10080 | |
hour12 | boolean | false | ||
backgroundColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。 |
textColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
listings | array | [] | minItems:0;maxItems:60 | 表示するリスト。フィード(screenrig.listings/v1)が存在する場合は優先されます。そうでなければデータストアが同じ行を提供します。 |
listings[].id | string | maxLength:40 | ||
listings[].status | string | "for-sale" | "for-sale", "for-rent", "sold", "pending", "new", "reduced", "leased" | |
listings[].price | number | 最小値:0;最大値:1000000000;必須 | ||
listings[].priceUnit | string | "" | "", "week", "month" | レンタルの場合:週または月ごとの価格。 |
listings[].address | string | minLength:1;maxLength:80;必須 | ||
listings[].locality | string | maxLength:60 | ||
listings[].type | string | maxLength:30 | 例:コンドミニアム、一戸建て、タウンハウス。 | |
listings[].beds | number | 最小値:0;最大値:20 | 0 はスタジオを示します。 | |
listings[].baths | number | 最小値:0;最大値:20 | ||
listings[].areaSqft | number | 最小値:0;最大値:200000 | ||
listings[].headline | string | maxLength:140 | ||
listings[].photo | string | maxLength:120 | メディア参照(media:<id>)。 | |
listings[].openHouse | object | additionalProperties:false | ||
listings[].openHouse.start | string | maxLength:32;必須 | ISO 8601。 | |
listings[].openHouse.end | string | maxLength:32 | ISO 8601。 | |
listings[].agent | string | maxLength:60 | ||
listings[].brokerage | string | maxLength:60 | リスト会社。存在する場合に表示されます。 | |
listings[].mls | string | maxLength:30 | ||
updated | string | "" | maxLength:32 | リスティングが取得されたとき、ISO 8601(データストアのみ;フィードはfetchedAtを含む)。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type property-listings --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "property-listings",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"listings": [],
"updated": ""
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
またはAPIを直接呼び出します。APIは同じドキュメントをdocumentフィールドにラップします。エージェントトークンはすでにプロジェクト名を含むため、プロジェクトヘッダーは送信しません。ScreenRig-Projectを送信する場合はトークンのプロジェクトと一致する必要があります。API認証は環境変数で提供してください。詳細は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":""}}'