準備 - KiiLib-TypeScript(JavaScript) ドキュメント

本ライブラリはTypeScriptで記述されており、プラットフォームに応じたビルドを提供しています。

jQuery

通信部分をjQueryのajax()を用いたビルドです。Webアプリケーションで本ライブラリを使用する時には本ビルドを使います。

手順

  1. リポジトリのbin/KiiLib-jquery.jsをコピーします。
  2. 次のタグをHTMLに追加します。KiiLib-jquery.jsのパスは適宜変更してください。 
    
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script type="text/javascript" src="javascripts/KiiLib-jquery.js"></script>

Google Apps Script

Google Apps Script用のビルドです。Googleスプレッドシートなどで本ライブラリの機能を使用することができます。

手順(Google スプレッドシートの例)

  1. Google スプレッドシートで、[ツール] -> [スクリプトエディタ]を選び、スクリプトエディタを開きます
  2. スクリプトエディタで、[ファイル] -> [新規作成] -> [スクリプト ファイル]を選び、空のスクリプトファイルを追加します。
  3. リポジトリのbin/KiiLib-gas.jsをテキストエディタなどで開き、内容をコピーします。(GitHubのファイルブラウザでコピーするのが楽でしょう)
  4. 追加したスクリプトファイルに、先ほどコピーした内容を張り付けます。

AppAPIオブジェクトの作成

本ライブラリでは、Kii Cloudとの通信はすべてAppAPIオブジェクトと、AppAPIオブジェクトから提供される各APIオブジェクト経由で行います。

AppAPIオブジェクトを作成するには、アプリ情報などを保持しているContextオブジェクトを作成した後、AppAPIオブジェクトを作成します。 


var context = new Kii.KiiContext(APP_ID, APP_KEY, BASE_URL);
var api = new Kii.KiiAppAPI(context);
KiiContextのコンストラクタには次の値を指定します。
APP_ID
Kii Cloudで作成したアプリのApp ID
APP_KEY
Kii Cloudで作成したアプリのApp Key
BASE_URL
サーバーのURL。
  • 日本サーバー：'https://api-jp.kii.com/api'を指定
  • アメリカサーバー：'https://api.kii.com/api'を指定