PieceJSON Keys

目次

PieceJSON

JSON Key必須更新制約/説明
titletitleObject制約 : 30文字以内。英語の設定は必須です。
--------
説明 : Pieceのタイトル(名称)。言語毎に設定することができます。わかりやすい名称にしていただくことを推奨しています
descriptiondescriptionObject制約 : 英語の設定は必須です。
--------
説明 : Pieceの説明。言語毎に設定することができます。ユーザーがiiideaを作成する際の大きな手がかりになるのがこの説明文ですので、「どんなPieceなのか?」といった基本情報のほか、動作に必要な処理や制約事項、や特記事項等を記述しておくと親切です。
vendorIdstring×制約 : 企業アカウント登録をしたときに割り振られたVendor IDを入力(SDKを利用してPieceCoreを作成する場合のみ指定)
--------
説明 : 企業アカウントを識別するためのId。指定がない場合は"none"を指定します。
deviceIdstring×制約 : Riiiver側にデバイス登録をしたときに割り振った番号を入力(SDKを利用してPieceCoreを作成する場合のみ指定)
--------
説明 : Pieceを動作させるのに必要なデバイスのId。指定がない場合は"none"を指定します。
categoryIdsarray×制約 : カテゴリマスタIDに登録されているものから12つ選択。
--------
説明 : Pieceの属するカテゴリを識別するためのId
osTypestring×制約 : "iOS""Android""none"の中から1つ選択。
--------
説明 : Pieceの動作を保証できるスマートフォンのOSを指定します。 全てのOSに対応している場合は"none"を選択します。
versionstring制約 : 初回は"1.0.0"を指定し、バージョンアップする場合は必ずインクリメントすること。メジャーバージョンアップとマイナーバージョンアップの選択は自由。
--------
説明 : Pieceのバージョン。
sdkVersionstring制約 : 公開されているRiiiverSDKのバージョンの中から選択する。
--------
説明 : Pieceの動作が保証されているRiiiverSDKの最低バージョン。 RiiiverSDKに依存しないものであれば"1.0.0"を指定してください。
blockTypestring×制約 : "trigger""service""action"の中から1つ選択。
--------
説明 : Pieceのタイプ。このPieceT (trigger)S (service)A (action)の内のどれに属するかを指定します。
executorstring×説明 : クライアントアプリが持つ、実際にPieceを動作させるクラス(モジュール)名。
permissionListobject××説明 : Pieceの動作に必要な端末依存情報の中で、クライアントアプリのOSに対してデータアクセス許可が必要な物のパーミッションリスト。
preferencespreferenceObject×説明 : ユーザから設定してもらうPieceの設定項目。 ユーザの設定値によって処理を分けたい場合などに指定します。
inputinputObject×制約 : inputに指定できる項目は1つのみ。
--------
説明 : Pieceが入力(Pieceの出力)として受け取るデータの型、フォーマットなどを指定します。
outputoutputObject×制約 : outputに指摘できる項目は1つのみ。
--------
説明 : Pieceが出力(Pieceの入力)として受け渡すデータの型、フォーマットなどを指定します。
serviceProxyserviceProxyObject××説明 : PieceServiceProxyを利用する場合に記述する ProxyCoreの動作に必要なデータがを格納します。


titleObject

JSON Key必須更新制約/説明
enstring英語のPieceタイトル
jastring×日本語のPieceタイトル
itstring×イタリア語のPieceタイトル
frstring×フランス語のPieceタイトル
esstring×スペイン語のPieceタイトル
destring×ドイツ語のPieceタイトル
pt-PTstring×ポルトガル語のPieceタイトル
zh-Hansstring×中国語(簡体字)Pieceタイトル
zh-Hantstring×中国語(繁体字)Pieceタイトル


descriptionObject

JSON Key必須更新制約/説明
enstring英語の説明
jastring×日本語の説明
itstring×イタリア語の説明
frstring×フランス語の説明
esstring×スペイン語の説明
destring×ドイツ語の説明
pt-PTstring×ポルトガル語の説明
zh-Hansstring×中国語(簡体字)の説明
zh-Hantstring×中国語(繁体字)の説明


permissionList

JSON Key必須制約/説明
iosarray制約 : "location": 端末の位置情報にアクセスする場合に指定する。
"mediaLibrary": 端末のメディアライブラリにアクセスする場合に指定する。
--------
説明 : クライアントアプリのOSiOSの場合に必要となるパーミッションリスト。
androidarray制約 : "location": 端末の位置情報にアクセスする場合に指定する
"mediaStore": 端末のメディアストアにアクセスする場合に指定する。
--------
説明 : クライアントアプリのOSAndroidの場合に必要となるパーミッションリスト。


preferences

JSON Keyが「--」で始まるものは直前のJSON Keyの中で2階層下で使われることを表します。例えば--typeは下のような階層関係になります。

"properties": { 
   "cityName": {          // ここはユーザーが自分で定義した名前のKey 
      "type": "string",   // ここがpropertiesから見て、--typeにあたる。 
      "x-description": { 
        "en": "set the area from which to get the temperature.", 
        "ja": "気温を取得する地域を指定します。" 
      } 
   } 
},

下の表で--type"properties"の下にあります。"properties"から2個下の関係で利用することを示しています。

JSON Key必須更新制約/説明
typestring×制約 : 必ず"object"を指定する。
--------
説明 : JSONスキーマのtype
propertiesobject×制約 : 任意のPreference名をKeyとしてPreferenceデータを記述します。
-- typestring×制約 : "boolean""number""string""array"の中から1つ選択する。
--------
説明 : Preferenceに設定するデータの型。
-- maximumnumber××説明:-- x-input-type"text"または"textarea"を指定した場合、入力文字数を制限することができます。
×制約:--type"number"を指定している場合、minimummaximummultipleOf3項目すべての設定が必要です。
--------
説明:-- typenumberを設定した場合に指定する最大値です。 ただし、enumでの設定がある場合はenumの値が優先されます。
-- minimumnumber×制約:minimummaximummultipleOf3項目すべての設定が必要です。
--------
説明:-- typenumberを設定した場合に指定する最小値です。 ただし、enumでの設定がある場合はenumの値が優先されます。
-- multipleOfnumber×制約:minimummaximummultipleOf3項目すべての設定が必要です。
--------
説明:-- typenumberを設定した場合に数字の間隔を指定します。 ただし、enumでの設定がある場合はenumの値が優先されます。
-- enumarray××制約:要素の型は--typeで指定した型にする。("number""string"
--------
説明 : Preferenceに設定する値を固定の候補に制限したい場合に指定します。
-- x-enum-titlesobject×説明 : enumに指定した候補値に対し、言語毎に説明を加えたい場合に指定します。
-- x-titletitleObject説明 : Preferenceに設定する値のタイトル。
-- x-descriptiondescriptionObject説明 : Preferenceに設定する値の説明。
-- x-input-typestring○†制約 : "drumroll""calendar""slider""radio""map""text""textarea""switch""time"の中から1つ選択する。
--------
説明 : Preference設定画面での入力タイプ。
-- defaultobject××制約 : --typeで指定した型と一致する値にする。
--------
説明 : Preferenceに設定する値のデフォルト値。
-- x-hiddenboolean×制約 : true:非表示、false:表示。
--------
説明 : Preferenceの設定画面上に表示するか/表示しないかの設定。設定しない場合は、表示する。
x-field-orderarray×説明 : properties以下で定義した設定項目をUI上で表示する際の順序を指定します。

-- typeの更新はできないので、-- typeの変更を伴うx-input-typeの更新はできません。例えば、"drumroll""string"を取得するようにしていたところを"switch""boolean"を取得するというような変更はできません。


inputObject

JSON Key必須更新制約/説明
typestring×制約 : 必ず"object"を指定する。
--------
説明 : JSONスキーマのtype
propertiesobject×説明 : 任意のinput名をKeyとしてinputデータを記述します。
-- typestring×制約 : "boolean""number""string""object""array"の中から1つ選択する。
--------
説明 : inputとして受け取るデータの型。
-- x-titletitleObject×説明 : inputに設定する値のタイトル。
-- x-descriptiondescriptionObject×説明 : inputに設定する値の説明。
-- formatstring--type
string:
Other: ×
×説明 : inputとして受け取りたい値が特定のフォーマットに対応している場合は指定します。
-- x-unitstring××制約 :--type"number"を選択した場合のみ指定することができます。
--------
説明:inputとして受け取る値に単位を定義したい場合に指定します。
-- minimumnumber--type
number:
Other: ×
×制約:-- type"number"を選択した場合に必須項目となります。
--------
説明:inputとして受け取りたい数値の最小値を指定します。 必ず-1,000,000~1,000,000 の範囲内の値を指定してください。 また、必ずmaximumに指定する値より小さい値を指定してください。
-- maximumnumber--type
number:
Other: ×
×制約:-- type"number"を選択した場合に必須項目となります。
--------
説明:inputとして受け取りたい数値の最大値を指定します。 必ず -1,000,000~1,000,000 の範囲内の値を指定してください。 また、必ずminimumに指定する値より大きい値を指定してください。


outputObject

JSON Key必須更新制約/説明
typestring×制約 : 必ず"object"を指定する。
--------
説明 : JSONスキーマのtype
propertiesobject×説明 : 任意のoutput名をKeyとしてoutputデータを記述します。
-- typestring×制約 : "boolean""number""string""object""array"の中から1つ選択する。
--------
説明 : outputとして出力したいデータの型を指定する。
-- x-titletitleObject×説明 : outputに設定する値のタイトル。
-- x-descriptiondescriptionObject×説明 : outputに設定する値の説明。
-- formatstring--type
string:
Other: ×
×説明 : outputとして出力したい値が特定のフォーマットに対応している場合は指定します。
-- x-unitstring××制約 :--type"number"を選択した場合のみ指定することができます。
--------
説明 : outputとして出力する値に単位を定義したい場合に指定します。
-- minimumnumber--type
number:
Other: ×
×制約:-- type"number"を選択した場合に必須項目となります。
--------
説明:outputとして出力する数値の最小値を指定します。 必ず-1,000,000~1,000,000 の範囲内の値を指定してください。 また、必ずmaximumに指定する値より小さい値を指定してください。
-- maximumnumber--type
number:
Other: ×
×制約:-- type"number"を選択した場合に必須項目となります。
--------
説明:outputとして出力する数値の最大値を指定します。 必ず-1,000,000~1,000,000 の範囲内の値を指定してください。 また、必ずminimumに指定する値より大きい値を指定してください。


serviceProxyObject

JSON Key必須制約/説明
servicestring説明 : Lambda上で動作するスクリプトが記載されているファイル名を指定します。
parametersarray×制約 : "location_normal", "location_rough", "location_accurate"または"location"の中から選択します。 端末の位置情報を使用したい場合に指定します。
--------
説明 : ProxyCoreの動作に必要な端末依存情報を取得する場合に指定します。
authTypearray×制約 : "apiKey""oauth2""other"の中から選択します。 RiiiverSDKが認可処理をサポートしているのは"oauth2"のみです。他を選択する場合はアプリ側で独自に認可処理を実装する必要があります。
--------
説明 : ProxyCore内で外部サービスを利用し、認可処理を必要とする場合に指定します。認可処理の認証タイプを格納します。

この記事は役に立ちましたか?