コンテンツにスキップ

開発者向け機能:JSONデータレイアウト:共通

概要

APIやサーバスクリプトでレコードを操作する際に指定するJSON形式のデータレイアウトです。

JSONデータのレイアウト

No プロパティ名 項目名 データ型 備考
1 ApiVersion APIのバージョン long 省略時はApi.jsonの「ApiVersion」で指定したバージョンで動作
2 ApiKey あらかじめ作成したAPIキー string 操作するテーブル、操作する内容に応じた権限をもつユーザで作成したAPIキーを設定
4 Offset データ取得するAPIやスクリプトにおいて取得を開始するレコードの位置 long 省略時は0(1件目から取得開始)。PageSizeの値以降のレコードを取得する場合に設定します。詳細はFAQ:API で 200 レコードを超えるデータを取得したいを参照してください。
3 PageSize データ取得するAPIやスクリプトにおいて取得可能な上限値 long 省略時はApi.jsonPageSizeで指定した値。Api.jsonのPageSizeよりも大きな値を設定した場合はPageSizeの値として動作します。

対応バージョン

対応バージョン 内容
1.4.13.0 以降 PageSizeを追加

関連情報