リンク、Wi-Fi、連絡先、イベント、またはアプリストア用の鮮明なコードが明るい紙に暗いシャープなモジュールで表示され、部屋の向こう側からもきれいにスキャンできます。画面全体に表示され、中央に配置されたり、隅に収まったり、隅の一行として表示されたり、端に沿って帯状に伸びたりします。コードの内容、キャプションとその下の小さな行を設定し、インクと紙の色、モジュールとファインダーアイの形状を選択し、小または大サイズのロゴかアイコンを追加し、枠付きの行動喚起を付けます。
ライブカード
カテゴリ: メッセージ。タグ: QRコード、店舗、レストランとカフェ、ロビーと受付。
レイアウト
このコアカードはすべてのレイアウトに適合します:全画面、中央、ワイド、コーナー、チップ、ストリップ、または任意の自由な長方形。
レイアウト:フル、センター、ワイド、コーナー、チップ、ストリップ。フォーム:ランドスケープ、ポートレート、スクエア、ストリップ。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
ecc | string | "M" | "L", "M", "Q", "H" | |
ink | string | "#111111" | パターン:"^#[0-9A-Fa-f]{6}$" | モジュールの色。明るい紙の上では暗く保ってください。 |
paper | string | "#FFFFFF" | パターン:"^#[0-9A-Fa-f]{6}$" | コードの背後のカード色。 |
style | object | additionalProperties:false | モジュールとファインダーアイの形状;それぞれテーマの形状がデフォルトです。 | |
style.modules | string | "square", "rounded", "dots", "connected" | ||
style.eyes | string | "square", "rounded", "circle", "leaf" | ||
logo | null、文字列 | null | null, "activity-01", "air-vent", "airplane-01", "alert-01", "alert-02", "american-football", "analytics-up", "apple", "arrow-down-01", "arrow-down-right-01", "arrow-up-01", "arrow-up-right-01", "award-01", "baseball", "basketball-01", "battery-full", "bell-ring", "bicycle", "birthday-cake", "bitcoin", "bus-01", "calendar-03", "calendar-04", "calendar-add-01", "calendar-check", "call-02", "camera-01", "cancel-circle", "car-01", "champion", "chart-decrease", "chart-increase", "checkmark-circle-02", "clock-01", "clock-02", "cloud", "cloud-angled-rain", "cloud-angled-zap", "cloud-big-rain", "cloud-drizzle", "cloud-fog", "cloud-hailstone", "cloud-snow", "coffee-01", "coffee-02", "contact-01", "container-truck-01", "cricket-bat", "crown", "delivery-truck-01", "dices", "discord", "discount-tag-01", "dollar-02", "door-closed-locked", "door-open", "drink", "droplet", "ethereum", "euro", "exchange-01", "facebook-01", "factory", "fast-wind", "favourite", "ferry-boat", "fire", "fire-02", "first-aid-kit", "flag-01", "flag-02", "flash", "flower-01", "football", "gauge", "gift", "git-branch", "globe-02", "google", "hand-prayer", "heart", "help-circle", "home-01", "hourglass", "humidity", "ice-hockey", "information-circle", "instagram", "lamp-01", "lantern", "leaf-01", "leaf-02", "lightbulb", "link-01", "linkedin-01", "litecoin", "location-01", "location-04", "mail-01", "medal-first-place", "medical-mask", "meeting-room", "megaphone-01", "message-01", "money-exchange-02", "moon-02", "moon-cloud", "moon-star", "music-note-01", "navigation-03", "new-releases", "new-twitter", "news", "news-01", "noodles", "package-delivered", "parking-area-square", "party", "party-popper", "pause-circle", "percent-circle", "pinterest", "pizza-01", "play-circle", "play-store", "podium", "pound", "pumpkin", "qr-code", "qr-code-01", "queue-01", "quote-down", "quote-up", "ranking", "restaurant-01", "rocket-01", "rss", "running-shoes", "sale-tag-01", "security-check", "shop-sign", "shopping-bag-01", "siren", "smart-phone-01", "snapchat", "snowflake", "sparkles", "spotify", "star", "star-half", "star-off", "stop-circle", "store-01", "sun-03", "sun-cloud-02", "sunrise", "sunset", "swimming", "tag-01", "target-02", "temperature", "tennis-ball", "thermometer", "thermometer-cold", "thermometer-warm", "threads", "ticket-01", "tiktok", "time-quarter-pass", "timer-01", "tornado-02", "train-01", "tram", "trophy", "tropical-storm", "tsunami", "user-02", "user-group", "user-love-01", "vegetarian-food", "volleyball", "volume-high", "vote", "walking", "warehouse", "waves", "whatsapp", "wheat-off", "wifi-01", "wifi-full-signal", "wifi-lock", "wrench-01", "yen", "youtube" | 紙のノックアウトパッドの中央にアイコン。なしは null。ECC を Q に上げます(大きい場合は H)。 |
logoScale | string | "small" | "small", "large" | |
frame | string | "none" | "none", "card", "ticket", "badge" | 行動を促すフレーム。 |
textless | 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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
value | string | "" | maxLength:1024 | 生のペイロード。設定されている場合は action より優先されます。 |
action | object | additionalProperties:false | value が空の場合にペイロードを作成します。タイプ別のフィールド:url {url, utm};phone {number};sms {number, message};email {to, subject, body};wifi {ssid, password, security, hidden};vcard {first, last, org, title, phone, email, url, address};event {title, start, end, location, description};geo {latitude, longitude, label};whatsapp {number, message};social {network, handle};review {placeId};app {ios, android};text {text}。 | |
action.type | string | "url"、"phone"、"sms"、"email"、"wifi"、"vcard"、"event"、"geo"、"whatsapp"、"social"、"review"、"app"、"text";必須 | ||
action.url | string | maxLength:1024 | ||
action.utm | object | additionalProperties:false | ||
action.utm.source | string | maxLength:100 | ||
action.utm.medium | string | maxLength:100 | ||
action.utm.campaign | string | maxLength:100 | ||
action.utm.content | string | maxLength:100 | ||
action.utm.term | string | maxLength:100 | ||
action.number | string | maxLength:40 | ||
action.message | string | maxLength:300 | ||
action.to | string | maxLength:200 | ||
action.subject | string | maxLength:200 | ||
action.body | string | maxLength:600 | ||
action.ssid | string | maxLength:64 | ||
action.password | string | maxLength:64 | ||
action.security | string | "WPA", "WEP", "nopass" | ||
action.hidden | boolean | |||
action.first | string | maxLength:80 | ||
action.last | string | maxLength:80 | ||
action.org | string | maxLength:120 | ||
action.title | string | maxLength:120 | ||
action.phone | string | maxLength:40 | ||
action.email | string | maxLength:200 | ||
action.address | string | maxLength:300 | ||
action.start | string | maxLength:40 | ||
action.end | string | maxLength:40 | ||
action.location | string | maxLength:200 | ||
action.description | string | maxLength:600 | ||
action.latitude | number | 最小値:-90;最大値:90 | ||
action.longitude | number | 最小値:-180;最大値:180 | ||
action.label | string | maxLength:120 | ||
action.network | string | "instagram", "facebook", "x", "linkedin", "tiktok", "youtube", "threads" | ||
action.handle | string | maxLength:80 | ||
action.placeId | string | maxLength:200 | ||
action.ios | string | maxLength:1024 | ||
action.android | string | maxLength:1024 | ||
action.text | string | maxLength:1024 | ||
caption | string | "" | maxLength:80 | |
detail | string | "" | maxLength:120 | キャプションの下に小さな線。空欄の場合はURLのときに値を表示します。 |
cta | string | "" | maxLength:40 | 行動喚起;フレームがない場合は「スキャンしてください」と表示。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type qr-code --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "qr-code",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"value": "",
"action": {
"type": "url"
},
"caption": "",
"detail": "",
"cta": ""
}
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":{"value":"","action":{"type":"url"},"caption":"","detail":"","cta":""}}'