DataAPIを利用するには

INFO

この機能は、SheetAsset 1.5.2以上と、Movable Type 6.1以上(DataAPI v2をサポートする環境)の環境で利用できます。

表計算ファイルへのData API

次のエンドポイントでアイテムとしてアップロードしたスプレッドシートファイルにアクセスすると、JSON形式でファイルの内容を取得することができます。

http://(Movable TypeのインストールURL)/mt-data-api.cgi/sites/(ブログまたはウェブサイトID)/assets/(アイテムID)/sheetasset

パラメータ

パラメータ	説明
type	スプレッドシートのデータを行列形式(配列の配列)と、データベース・テーブル形式(ハッシュの配列)のどちらで出力するかを指定します。行列形式の場合はmatrix、データベース・テーブル形式の場合はtableを指定します。省略すると行列形式になります。
worksheet	ワークシート名を指定します。ワークシートが存在しない場合は404エラーとなります。
worksheet_index	ワークシートを順番で指定します(1から開始)。
offset	開始位置を0から始まる数値で指定します。省略すると0が適用されます。
limit	取得する行またはレコード数を指定します。省略するとすべての行またはレコードを取得します。
skip_headers	typeにtableを指定した場合にのみ使用します。列名を示す行までスキップする行数を指定します。デフォルトはスキップせず1行目を列名とみなします。
skip_rows	typeにtableを指定した場合にのみ使用します。列名を示す行から実際の行レコードまでスキップする行数を指定します。

DataAPIの使用例

パラメータを指定しない場合

各ワークシートの内容を行列形式で出力します。

http://(Movable TypeのインストールURL)/mt-data-api.cgi/sites/(ブログまたはウェブサイトID)/assets/(アイテムID)/sheetasset

レスポンス例：

{
   "worksheets": [
      {
         "index": 1,
         "name": "",
         "rows": [
            [
               "csv1",
               "csv2",
               "csv3"
            ],
            [
               "a2",
               "b2",
               "c2"
            ],
            [
               "a3",
               "b3",
               "c3"
            ],
            [
               "日本語a4",
               "日本語b4",
               "日本語c4"
            ]
         ]
      }
   ]
}

対応する表：

csv1	csv2	csv3
a2	b2	c2
a3	b3	c3
日本語a4	日本語b4	日本語c4

データベース・テーブル形式とワークシートを指定した場合

ワークシート1枚の内容をデータベーステーブル形式で出力します。

http://(Movable TypeのインストールURL)/mt-data-api.cgi/sites/(ブログまたはウェブサイトID)/assets/(アイテムID)/sheetasset?worksheet_index=1&type=table

レスポンス例：

{
   "table": [
      {
         "csv1": "a2",
         "csv2": "b2",
         "csv3": "c2"
      },
      {
         "csv1": "a3",
         "csv2": "b3",
         "csv3": "c3"
      },
      {
         "csv1": "日本語a4",
         "csv2": "日本語b4",
         "csv3": "日本語c4"
      }
   ]
}