ホーム/ガイド/開発者向け
開発者向け

リアルタイムの自転車空き状況:アプリでの表示方法は?

ROOTE APIを使い、自転車の空き状況を鮮度やタイムスタンプ、不明値、更新、期限切れデータとともにアプリに表示する方法をご紹介します。

By ROOTE·7分読み
リアルタイムの自転車空き状況:アプリでの表示方法は?
観測された空き状況とそのコンテキスト。

要点を数秒でまとめて

利用可能台数を鮮度、タイムスタンプ、貸出可能条件情報とともに示します。不明値は不明のままであり、古い観測値はアプリが受信しただけでリアルタイムとはなりません。

アプリでリアルタイムの自転車空き情報を表示するには、返された台数を鮮度と車両の貸出可能状況に紐づけます。観測値はある時点で情報元が知っていた内容を表し、到着時に自転車がまだ存在することは保証しません。

ROOTEモビリティ契約では、ステーション、個別の車両、その状態を区別します。インターフェースは、不明値、空のステーション、一時的に利用不可の情報源を混同しないよう訳し分ける必要があります。

ステーションと個別車両を区別する

ステーションは自転車と返却スペースのカウンターを公開できます。個別車両は空き状態やその他の情報を持ちます。ステーションを自転車としてカウントしたり、同じ在庫を表すカウンターを合算することは避けてください。

ROOTEモビリティDTOでは、availability.bikesやavailability.docksは不明となる可能性があります。駆動方式やバッテリーに関するフィールドは存在し処理可能である場合のみ表示すべきです。

ROOTE OpenAPI契約

鮮度とタイムスタンプの読み方

フィールド解釈
freshness.state表示状態:fresh(新鮮)、stale(古い)、unknown(不明)、static(固定)
freshness.source_updated_at情報元の更新日時(分かる場合)
freshness.received_at契約で示された受信日時
freshness.expires_at有効期限(分かる場合)
availability.bikes既知の数量または不明値
pickup.enabled と pickup.stateステーションでの自転車貸出情報

呼び出し時刻は必ずしも観測時刻と一致しません。例えば10時に受信した結果は9時45分に更新された情報を含むことがあります。受信時間だけで「今更新」と表示しないでください。

異なる表示状態を用意する

受信データ表示例
既知の数量かつ新鮮なデータ観測された数量と時間表示
数量がゼロの場合自転車がゼロで、その時間的文脈の表示
数量がnullの場合空き状況不明
stale状態または有効期限切れ古いデータ;更新を促す表示
pickup.enabled=false貸出不可。カウンターが正でも貸出不可とする
検索エラー一時的に空き不明、0として扱わない

unknownやstatic状態はfreshとして扱わないでください。ステーション情報は安定でもカウンターは急変する可能性があります。応答に必要な警告や属性は保持してください。

レンダリング前の正規化例

以下の関数はROOTEスキーマで検証済みステーションから表示状態を生成します。完全な応答検証器ではなく、表示用ラベルはインターフェースの翻訳キーから取得すべきです。

function availabilityView(station, now = Date.now()) {
  const freshness = station.freshness;
  const expiresAt = freshness.expires_at
    ? Date.parse(freshness.expires_at) : null;
  const expired = expiresAt !== null &&
    Number.isFinite(expiresAt) && expiresAt <= now;
  if (station.pickup.enabled === false ||
      station.pickup.state === 'unavailable_now') {
    return { state: 'pickup_unavailable', count: null };
  }
  if (expired || freshness.state === 'stale') {
    return { state: 'stale', count: null };
  }
  const count = station.availability.bikes;
  if (freshness.state !== 'fresh' || count === null ||
      !Number.isFinite(count) || count < 0) {
    return { state: 'unknown', count: null };
  }
  return {
    state: count === 0 ? 'empty' : 'observed', count,
    sourceUpdatedAt: freshness.source_updated_at,
    receivedAt: freshness.received_at,
    pickupState: station.pickup.state
  };
}

observed状態であってもpickupState=unknownを貸出確定に変換しないでください。カウンターは観測値のままです。ユーザーがステーション選択を助ける場合は貸出状況の文脈を表示してください。

無駄な呼び出し増加なく更新する

公開された有効期限、サービス状況、ユーザー行動に合わせて更新を調整します。同一要求はまとめ、非アクティブページでの裏バックグラウンド呼び出しを避け、置き換えられた検索呼び出しはキャンセルしてください。

ローカルキャッシュ時間は情報元の鮮度を保証しません。エラー後は最後の観測情報を古いと明示して表示できます。情報元がstaleのままなら最初の成功時でもこの区別を消さないでください。

GBFSとの関係を理解する

GBFSは共有モビリティサービスとその状態を記述します。統合時はファイル、バージョン、フィードのタイムスタンプを解釈します。標準APIではAPI契約を使い、不明なGBFSフィールドを追加しないでください。

GTFS、GTFS Realtime、GBFSの選択

読者が誤解する状況をテストする

実際にゼロ、未知値、有効期限切れ、貸出無効、エラー後の正常結果のテスト。表示タイムゾーンも検証してください。正のカウンターは「予約済み」とせず、空き不明は「ゼロ」にしないでください。

空応答とエラーの処理

AIアシスタントでの規則適用

自転車検索ユーザーガイド

開発者向けROOTE Mobility API

拠点周辺のモビリティ。
あなたのアプリに直接。

  • 検索
    位置周辺で
  • モビリティ
    データへアクセス
  • アプリに
    統合する

地図からデータへ。ROOTE APIで近隣のモビリティとサービスを検索。

よくある質問

正の数量は到着時の自転車保証か?

いいえ。観測値であり、検索と到着間に変化する可能性があります。

nullをゼロに置き換えられるか?

いいえ。nullは不明値を示し、ゼロは既知の数量で異なる意味があります。

数秒ごとに更新すべきか?

有効期限やサービス制限、インターフェース要件に従ってください。任意の頻度は情報元の新鮮さを保証しません。

周辺を見てみませんか?

ROOTEで街を探索し、移動のための情報を集めましょう。

ROOTEマップを探索 ↗