obniz Docs ドキュメント クラウド デバイス管理 CSV インポート/エクスポート

CSV インポート/エクスポート

CSVによるデバイス情報のインポート/エクスポートが可能です。

CSVエクスポート

表示されているデバイス情報の一覧をCSVファイルとしてダウンロードすることが可能です。CSVファイルの形式は、「通常のデバイス情報を掲載したもの」と「アプリのインストール情報が掲載されたもの」の２種類あります。

CSV レイアウト

「通常のデバイス情報を掲載したもの」

項目名 内容 必須
id デバイスID ✅
access_token アクセストークン
hardware ハードウェアの識別子 ✅
description デバイスの説明。metadataの中にも含まれる
metadata メタデータ
devicekey デバイスキー ✅
os インストールされているOSの識別子 ✅
osVersion インストールされているOSのバージョン ✅
region デバイスが接続されるサーバの地域 ✅
status ステータス ✅
wifi_mac_address WifiのMACアドレス
ether_mac_address イーサネットのMACアドレス
pingInterval オンライン確認間隔
createdAt デバイスの登録日 ✅

「アプリのインストール情報が掲載されたもの」

後述するCSVインポートに適したフォーマットになります。この形式でエクスポートするには、検索条件にアプリのIDを含めて検索している必要があります。これはアプリによってオプション値の指定が異なり、CSVのレイアウトを揃える必要があるためです。

項目名 内容 必須
obniz_id デバイスID ✅
app_id インストールされているアプリのID ✅
description デバイスの説明。metadataの中にも含まれる
status ステータス
pingInterval オンライン確認間隔
※ アプリインストール時に必要なオプション値

※オプション値は、アプリごとにその名前と必要な数が異なります。
以下オプション値とCSVレイアウトの例です。

通知温度(temperature_limit)と通知方法(notification_way)が必要な温度測定アプリの場合
項目名 内容 必須
obniz_id デバイスID ✅
app_id インストールされているアプリのID ✅
description デバイスの説明。metadataの中にも含まれる
status ステータス
pingInterval オンライン確認間隔
temperature_limit 通知温度(アプリインストール時に必要なオプション値)
notification_way 通知方法(アプリインストール時に必要なオプション値)
オプション値が全く必要ないサンプルアプリの場合
項目名 内容 必須
obniz_id デバイスID ✅
app_id インストールされているアプリのID ✅
status ステータス
pingInterval オンライン確認間隔
description デバイスの説明。metadataの中にも含まれる

CSVインポート

CSVファイルによって、特定アプリを複数デバイスに対して一括インストールします。インストールは、アプリが何もインストールされていないデバイスに対しては登録という形で、同アプリがすでにインストールされているデバイスに対しては更新という形で、行われます。必要なオプション値がインストールするアプリによって変わるので、アプリIDで絞り込んだデバイス情報をCSVエクスポートし、これを編集することでCSVをスムーズに作成することが可能です。

CSV レイアウト

項目名 内容 必須
obniz_id デバイスID ✅
app_id インストールするアプリID。全て同じアプリIDを指定してください。 ✅
description デバイスの説明 ✅
status ステータス
pingInterval オンライン確認間隔
※ アプリインストール時に必要なオプション値。アプリ設定画面に表示されているオプション値の順番で入力してください。オプション値が必要ないアプリでは、入力する必要がありません