サンプル集

利用可能なライブラリ

利用する言語によって、利用可能なライブラリが異なります。

Node.js

Node.js スクリプトで利用可能なライブラリについては、スクリプト : Node.jsスクリプトの作成をご覧ください。

ncmb ライブラリ

MobileSUITE mBaaS機能 の SDK 等を使用し、スクリプトからデータストアやファイルストアなど MobileSUITE mBaaS機能 の他の機能を使用することが可能です。

GET サンプル

以下は GET メソッドを利用して、データストアの Item クラスからデータを取得し、ランダムに選択されたレコードを返すサンプルです。

Node.js スクリプトの場合
module.exports = function(req, res) {
  var NCMB = require('ncmb');
  var ncmb = new NCMB('YOUR_APPLICATION_KEY', 'YOUR_CLIENT_KEY');

  var Item = ncmb.DataStore('Item');
  Item.fetchAll()
      .then(function(items){
        // ランダムに 1 件選択
        item = items[Math.floor(Math.random() * items.length)];
        res.status(200).json(item);
      })
      .catch(function(error){
        res.status(500).json({error: 500});
      });
}

YOUR_APPLICATION_KEY, YOUR_CLIENT_KEY にはそれぞれアプリケーションキー、クライアントキー( APIキー )の設定が必要です。
※ データストアの Item クラスからデータを取得するため、事前にデータを用意しておく必要があります。


スクリプトアップロード

GET メソッドを利用時のスクリプトアップロード方法については、スクリプト (MobilePortal) : 基本的な使い方 を参照ください。


スクリプトの実行(MobileSUITE mBaaS管理画面)

GET メソッドを利用時のスクリプト実行方法(MobileSUITE mBaaS管理画面)については、スクリプト (MobilePortal) : 基本的な使い方 を参照ください。

GET_execute


スクリプトの実行(アプリ)

GET メソッドを利用時のスクリプト実行方法(アプリ)については、スクリプト (MobilePortal) : 基本的な使い方 を参照ください。


POST サンプル

以下は POST メソッドを利用して、データストアにデータ保存するサンプルです。

Node.js スクリプトの場合
function saveData(req, res) {
  // POSTのデータを取得
  var field1 = req.body.field1;
  var field2 = req.body.field2;

  // ヘッダーのデータを取得
  var username = req.get("username");
  var password = req.get("password");

  var NCMB = require('ncmb');
  var ncmb = new NCMB('YOUR_APPLICATION_KEY', 'YOUR_CLIENT_KEY');

  if ( username != "admin" || password != "123456" ) {
    res.status(401);
    res.send("Authentication fail!");
  }

  // データを保存する
  var Item = ncmb.DataStore('Item');
  var item = new Item();
  item.set("field1", field1)
      .set("field2", field2)
      .save()
      .then(function(item){
        // 成功
        res.send("POST data successfully!");
      })
      .catch(function(err){
        // 失敗
        res.status(500).send("Error: " + err);
      });
}

module.exports = saveData;

YOUR_APPLICATION_KEY, YOUR_CLIENT_KEY にはそれぞれアプリケーションキー、クライアントキー( APIキー )の設定が必要です。


スクリプトアップロード

スクリプトファイルアップロード時のメソッド設定は POST にします。

POST_upload


スクリプトの実行(MobileSUITE mBaaS管理画面)

実行するスクリプトファイルを選択し、「詳細情報」タブから「実行」タブに切り替えます。 POST する値を Body に設定し「実行」をクリックします。

POST_execute


スクリプトの実行(アプリ)

アプリからスクリプトを呼び出す際は、次のように記述します。

// メソッドチェインでパラメータを付与し実行
ncmb.Script
      .set({"username": "admin", "password": "123456"})     // リクエストヘッダを指定
      .data({"field1": 111, "field2": 2222})           // リクエストボディを指定
      .exec("POST", "testScript_POST.js")
      .then(function(res){
        // 実行後処理
        console.log(res);
      })
      .catch(function(err){
        // エラー処理
        console.log(err);
      });

DELETE サンプル

以下は DELETE メソッドを利用して、データストアの Item クラスにあるにデータから、指定の objectId に該当するレコードを削除するサンプルです。

Node.js スクリプトの場合
function deleteData(req, res) {
    // 削除するIDを取得
    var id = req.query.id;

    var NCMB = require('ncmb');
    var ncmb = new NCMB('YOUR_APPLICATION_KEY', 'YOUR_CLIENT_KEY');

    var Item = ncmb.DataStore('Item');

    Item.equalTo("objectId", id)
        .fetchAll()
        .then(function(results) {
            var promises = [];
            for (var i = 0; i < results.length; i++) {
                var object = results[i];
                // 該当のデータを削除する
                promises.push(object.delete());
            }
            return Promise.all(promises);
        })
        .then(function(result){
            // 成功
            res.send("DELETE data successfully")
         })
         .catch(function(err){
            // 失敗
            res.status(500).send("Error: " + err);
        });
}

module.exports = deleteData;

YOUR_APPLICATION_KEY, YOUR_CLIENT_KEY にはそれぞれアプリケーションキー、クライアントキー( APIキー )の設定が必要です。
※ データストアの Item クラスからデータを削除するため、事前にデータを用意しておく必要があります。


スクリプトアップロード

スクリプトファイルアップロード時のメソッド設定は DELETE にします。

DELETE_upload


スクリプトの実行(MobileSUITE mBaaS管理画面)

実行するスクリプトファイルを選択し、「詳細情報」タブから「実行」タブに切り替えます。削除するレコードの objectId を Query に設定し「実行」をクリックします。

DELETE_execute


スクリプトの実行(アプリ)

アプリからスクリプトを呼び出す際は、次のように記述します。

// メソッドチェインでクエリストリングを付与し実行
ncmb.Script
      .query({"id": "sample_objectId"})      // クエリストリングを指定
      .exec("DELETE", "testScript_DELETE.js")
      .then(function(res){
        // 実行後処理
        console.log(res);
      })
      .catch(function(err){
        // エラー処理
        console.log(err);
      });

PUT サンプル

PUT メソッドに関しては、POST メソッドと同様に利用可能です。
POST サンプルをご参照ください。