カテゴリー内の他の記事

第1回 kintone コマンドラインツールを使ってみよう!

フォローする

(著者:サイボウズ 三宅 智子)

Index

はじめに

kintoneではExcel/CSVを使ってデータのインポートエクスポートをすることができますが、コマンドラインからも同様のことができます!
kintone コマンドラインツールとは、簡単にコマンドライン上からkintoneにデータのインポート・エクスポートをできるようにしたツールのことです。

「はじめようkintone コマンドラインツール」では、以下のような方向けに、基本的な操作方法や活用方法をご紹介していきます。

  • エクセルなどと連携させたいけど、プログラミング少し苦手という方
  • コマンドラインでのデータのインポートやエクスポートをしたいという初心者の方

通常のExcel/CSVのデータ入出力ではできないことも、こちらのコマンドラインツールを使えばできる!なんてこともあったりします。

初回は、まず「環境設定」と「レコードデータの取得」というテーマでお届けします。

 

環境の準備

kintoneのコマンドラインツールを利用するにあたり、まずは下準備です。OSはWindows/Linux/Mac OS Xの3種類での動作を確認しています。
本シリーズでは、Windowsの利用を想定して記事を書いています。

コマンドラインツールのダウンロードと基本的な使い方については以下でご紹介していますので、ご参照ください。

 ※コマンドラインツールは、動作を保証するものではありません。
 ※ソースコードの変更および再配布、商用利用等はライセンスに従ってご利用可能です。

それでは早速環境設定に移っていきましょう!

STEP1 ツールをダウンロードする

kintone コマンドラインツール(β)の動作OSやダウンロード用のツールについてはこちらに記載があるので、まずはそちらを確認します。

kintone コマンドラインツールはReleases kintone/cli-kintone (Github)からダウンロードできます。Windows/Linux/Mac OS Xと3種類の実行ファイルが用意されています。
ダウンロードしたZip形式のファイルを解凍して、cli-kintone.exeをCドライブ直下Program Filesなど任意のフォルダに置いてください。
※本記事では、Version 0.7.1 windows-x64.zipを使っています。

また、本記事ではShift-JIS形式のCSVを作成して取得や更新や登録処理を行っていきます。Shift-JIS形式で保存できるテキストエディタもご準備ください。

STEP2 コマンドプロンプトを立ち上げる

Windowsの場合、「キー」+「Rキー」で下の「ファイル名を指定して実行」画面を立ち上げて、名前欄に「cmd」と入力します。OKをクリックするとコマンドプロンプトが立ち上がります。
(Macの場合は、ターミナルというアプリケーションを起動します。)

STEP3 コマンドラインツールを実行する

cdコマンドで、cli-kintone.exeを置いたディレクトリに移動します。
※ディレクトリはフォルダーと同義です。以下ディレクトリと表記します。
※「cd <スペース> <exeファイルを置いたディレクトリ>」 と入力すると、指定したディレクトリに移動してくれます。Change Directoryと英語に変換するとイメージつきやすいですね!
 他にもこの先知らないコマンドが出てくるかもしれないですが、そんなときは検索して調べてみてください。

次に引数を何も指定せずに実行すると、コマンドラインツールで利用可能なオプションが表示されます。

 

オプション 説明
--export kintoneからデータをエクスポートする場合に指定します。
データは標準出力にエクスポート(コンソールに表示)されます。
--import kintoneにデータをインポートする場合に指定します。
データは標準入力からインポートされます。
-f オプションも指定されている場合、対象ファイルからデータがインポートされます。
-d ドメイン名(必須)cybozu.comは省略可能です。
FQDNを指定することで、cybozu.com 以外のドメイン(kintone.com, cybozu.cn) を利用することも出来ます。
-a アプリID(必須)
-u ログイン名(APIトークンかログイン名のいずれかが必須)
-p パスワード
-t APIトークン(APIトークンかログイン名のいずれかが必須)
-g ゲストスペース内アプリの場合、ゲストスペースのIDを指定します。
-o 出力形式。'json'もしくは'csv'が指定できます。デフォルトは'json'です。
-e エンコーディング方式。デフォルトはUTF-8です。Shift-JISでインポート・エクスポートする場合は'sjis'を指定します。
-U BASIC認証ユーザー名
-P BASIC認証パスワード
-q 条件式。条件式の書き方はこちらを参照してください。
-c エクスポートするフィールド名をカンマ区切りで指定できます。
-f データインポート時、インポートするファイル名を指定します。
-b 添付ファイルのダウンロード先、アップロード元ディレクトリを指定します。
-l データをファイルからインポートする場合に、インポート開始行を指定します。
このオプションを指定すると、データのインポートは指定した行から開始されます。
-D インポート時にこのオプションを指定すると、既存のレコードをすべて削除してからデータをインポートします。

この後、上記のオプションを利用して各種操作をしていきます。

※コマンドラインツールを利用する際は、常に最新版であることを確認してお使いください。
※セキュアアクセス環境には対応していません。

データの取得

この後のシリーズでは、データの追加/削除/更新などの処理についてもご紹介しますが、まず第1回事始めとして「データの取得」を試してみたいと思います。

その前にデータを取得するアプリをご用意ください。ここではアプリストアにある顧客リストアプリを利用します。
デモデータも数件入れておきます。後々分かりやすいようにフィールドコードも英数に修正しておきましょう。

アプリの準備ができたら、上述のオプションを利用してデータの取得を行います。パターンがいくつかあるので、順にご紹介していきます。

STEP1 ユーザー名/パスワードでkintoneのデータを表示する

ドメイン名がsample.cybozu.com、アプリIDが777、ログイン名がmynameの場合の例です。

mynameユーザーのパスワードを入力すると、以下のようにCSV形式ですべてのフィールドのデータがエクスポートされます。

※セキュリティ保護のため、パスワードを入力してもコマンドライン上には何も見えないようになっています。

※kintone.comやcybozu.cnのドメインを指定する場合は、sampleだけでなく、sample.kintone.com/sample.cybozu.cnのようにFQDNを指定するようにしてください。

1行目にはフィールド名ではなく、フィールドコードがエクスポートされます。

JSON形式で表示するには、認証オプションの後ろに続けて-o jsonを指定します。他のサービスにデータを受け渡したい時などは、JSON形式のデータを利用するケースが多いです。

※途中で処理を中断したい場合は、CTRL+Cを押してください。

STEP2 APIトークンを利用してkintoneのデータを表示する

APIトークンを利用すると、パスワードを入力しなくてもデータをインポート・エクスポートすることができます。APIトークンを使うメリットは・・・

  • ユーザー認証が必要ない
  • 限られたアプリのみ操作できる
  • 実行できる操作を制限することができる
    などが挙げられます。

APIトークンの生成方法はこちらをご参照ください。実行したい操作に合わせて、APIトークンの権限を設定していただく形になります。

※APIトークン認証を使った場合は、全てAdministratorが実行した操作として判断されます。

STEP3 Shift-JISでCSVファイルにエクスポートする

データをコマンドライン上で表示するだけでなく、次はファイルにエクスポートしてみます。諸事情(*後述)によりここではAPIトークンを利用しています。

kintoneではデフォルトでUTF-8で文字列データがエクスポートされるので、それ以外の文字コードでエクスポートしたい場合は-eオプションを利用します。
ここではsample.csvというファイルにShift-JIS形式でエクスポートします。

※エクスポート先のディレクトリを指定せずにCSVにエクスポートすると、コマンドラインツールの実行ファイルを置いたディレクトリに保存されます。
 Cドライブ直下などに実行ファイルを置いているとシステム管理権限の影響で「アクセス拒否されました」とエラーが出る可能性があります。
 その場合は、必ずエクスポート先のディレクトリのパスを指定してください。

▼実行ファイルを置いたディレクトリにそのまま保存

▼ディレクトリを指定して保存(ここではデスクトップに保存)

*ユーザー認証でデータをCSVにエクスポートしようとすると、パスワード要求がされず「あれれ?」となると思います。
 要求はされないもののコマンド上でパスワード入力すると、データとともに「Password」という文字列がCSVにエクスポートされます。
 そもそもの説明をすると、「コマンド>ファイルのパス」という書き方をファイルのリダイレクトと言うのですが、これはコマンドラインへの出力内容をファイルにエクスポートするという処理になります。
 なのでデータとともにPasswordという文字列もエクスポートされるのです。
 基本的にはファイルへのエクスポートという操作は、バッチ処理(自動実行)を想定したものなので、その場合は認証オプションの後ろに続けて-p オプションでパスワード指定してエクスポートするようにしてください。

STEP4 エクスポートするフィールドを指定する

さらに-cオプションを使うと、エクスポートするフィールドを指定することができるので、やってみます。ここでは$idと会社名と担当者名のみエクスポートします。
書き方としては、「-c "書き出したいフィールドコード"」になります。

※フィールド名ではなく、フィールドコードで指定します。ここよく間違うので注意ポイントです!

STEP5 絞り込み条件と並び順を指定する

-qオプションを使うことで、絞り込み条件と並び順を指定できます。条件式の書き方はこちらを参照してください。
ここでは、部署名が「営業部」のレコードの$idと会社名と担当者名と部署名を、レコード番号降順でエクスポートします。
クエリ指定箇所のエスケープ処理も忘れずに!

STEP6 テーブルのデータはどのような形式で表示されるのか確認する

最後にテーブル付きのレコードデータはどのように表示されるのか見てみます。慣れれば大丈夫ですが、少し見方がややこしいので要注意です。
ここでは以下の交通費申請アプリを利用しています。

3件ほどデータを登録してコマンドラインツールで表示してみます。

CSVファイルのエクスポート結果は以下になります。

CSVでどのフィールドがどこに対応しているのか見にくい場合は、Excelファイルで開いて見てください。

ここから見方の解説です。

書き出したCSVの1行目には1列目に"*"マークが出力され、その後フィールドコード名が並びます。2行目以降で"*"マークがついていない行は、テーブル内の2行目以降のデータになります。
上記のCSVデータの場合、3レコードがエクスポートされています。レコード番号1番のテーブル内に4行分、レコード番号2番のテーブル内に3行分のデータが入っているため、CSVでもそれぞれその行数分のデータがエクスポートされています。

実際に登録しているデータは以下になります。考えるときの参考にしてみてください。

また、テーブルの読み込みについてはまた後の回で詳しく解説していきます。

第1回、無事最後まで完走できましたでしょうか?今回はここら辺で!次回はデータの追加と削除をやっていきます。お楽しみに^^

2018/01/18追記:
この記事ではデータのインポート時 -f オプションのみ指定していますが、この実行方法はVersion 0.9.0(2018年1月公開)以降、推奨されません。
Version 0.9.0以降、標準入力からのインポート対応にともない、データのインポート時は、--import オプションもあわせて指定する実行方法を推奨します。
実行例: $ cli-kintone.exe --import -f importdata.csv -a 111 -d dev-demo -t xxxxx
現状は、従来の実行方法でも動作します。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

Avatar
Kenji Narizuka

コマンドラインツールを商用利用したいと考えております。

 

>商用利用等は、ライセンスに従ってご利用可能です

→上記の”ライセンスに従って”とは、具体的に何を指しますでしょうか?

 (お客様がスタンダードライセンスの契約であれば利用可能との理解で宜しいでしょうか?)

Avatar
cybozu Development team

Kenji Narizuka 様

商用利用の件は、https://cybozudev.zendesk.com/hc/ja/articles/202708214 にありますとおり、GPL v2となっております。

著作権の表示をいただくことなどを条件として、商用利用、修正、再配布可能となっております。

お客様の個々の状況の場合についてご不明な点がありましたら、外部サイトですがこちらのFAQが参考になるかと思います。

またご不明な点がありましたらご連絡ください。よろしくお願いいたします。

Avatar
Kenji Narizuka

ご回答頂きありがとうございました。

上記内容について、承知致しました。

Avatar
小山剛司

上記に

※コマンドラインツールは、動作を保証するものではありません。

と記述がありますが、お客様(商用)にて運用しておりますが

トラブルがあった場合、問合せすることは可能なのでしょうか?

 

Avatar
cybozu Development team

小山剛司さん

ご質問いただきありがとうございます。cybozu developer network運営チームです。

現在運用環境での動作保証はしておりませんが、何か不具合があった場合はご連絡ください。
対応検討をさせていただきます。
よろしくお願い致します。

ログインしてコメントを残してください。