■APIキー

セッションの作成メソッドでは、APIキーがリクエストヘッダに必要となります。

■セッショントークン

セッションの作成以外の全てのメソッドでは、セッショントークンがリクエストヘッダに必要となります。
一部のメソッドでは、クエリパラメータにセッショントークンを指定することもできます。

■日時系パラメータの値

フォーマットはISO 8061、UTC(協定世界時)で取り扱う。

■プレイヤー要素のロールとアセットタイプ

指定可能な組み合わせは以下の通りです。

ロール	アセットタイプ	説明
Annotation (空間タグ)	Image	画像の空間タグ。
Floorplan (図面)	Image	画像の図面。
Map (地図)	[未指定]	地図。
Scene (ポイント)	Image	画像のポイント。

■プレイヤー要素のプロパティ

指定可能なプロパティは以下の通りです。

ロール	プロパティ名	データタイプ	説明
Floorplan	description	string	図面の概要。
	order	integer	図面・地図の表示順序。
Map	description	string	地図の概要。
	latitude	number	地図の初期表示中心緯度 (DEG形式)。
	logitude	number	地図の初期表示中心経度 (DEG形式)。
	order	integer	図面・地図の表示順序。
	zoom	integer	地図の初期表示ズームレベル。0～21の間で指定。
Scene	autoPan	integer	ポイントの自動回転タイプ。以下のいずれかの値で指定。 ■0 : なし ■1 : 水平回転
	description	string	ポイントの概要。
	fov	number	ポイントの初期表示水平画角。単位は radian で指定。
	order	integer	ポイントの表示順序。
	pitch	number	ポイントの初期表示垂直方向。単位は radian で指定。ポイントのアセット(画像)の中心を0とし、上方向に+π/2、下方向に-π/2で指定。
	yaw	number	ポイントの初期表示水平方向。単位は radian で指定。ポイントのアセット(画像)の中心を0 (右回りに+2π) で指定。

■プレイヤー要素リンクのリンク元プレイヤー要素ロールとリンク先プレイヤー要素ロール

指定可能な組み合わせは以下の通りです。

リンク元	リンク先	説明
Floorplan	Scene	図面にポイントを登録する。
Map	Scene	地図にポイントを登録する。
Scene	Annotation	ポイントに空間タグを登録する。
Scene	Scene	ポイント間にウォークスルーを追加する。

■プレイヤー要素リンクのプロパティ

指定可能なプロパティは以下の通りです。

リンク元	リンク先	プロパティ名	データタイプ	説明
Floorplan	Scene	cameraOriginDirection	number	図面上でのポイントの基準方向。単位は radian で指定。図面の真上を0 (右回りに+2π) として、ポイントのアセット(画像)の中心の方向。
		fov	number	ポイントの初期表示水平画角。単位は radian で指定。
		isIconVisible	boolean	図面上のポイントのアイコン表示の有無。
		order	integer	図面内のポイントの表示順序。
		pitch	number	ポイントの初期表示垂直方向。単位は radian で指定。ポイントのアセット(画像)の中心を0とし、上方向に+π/2、下方向に-π/2で指定。
		x	number	図面上のポイントの水平位置。図面のアセット(画像)の左端を0、右端を1として指定。
		y	number	図面上のポイントの垂直位置。図面のアセット(画像)の上端を0、下端を1として指定。
		yaw	number	ポイントの初期表示水平方向。単位は radian で指定。ポイントのアセット(画像)の中心を0 (右回りに+2π) で指定。
Map	Scene	cameraOriginDirection	number	地図上でのポイントの基準方向。単位は radian で指定。地図の真北を0 (右回り2π) として、ポイントのアセット(画像)の中心の方向。
		fov	number	ポイントの初期表示水平画角。単位は radian で指定。
		isIconVisible	boolean	地図上のポイントのアイコン表示の有無。
		order	integer	地図内のポイントの表示順序。
		pitch	number	ポイントの初期表示垂直方向。単位は radian で指定。ポイントのアセット(画像)の中心を0とし、上方向に+π/2、下方向に-π/2で指定。
		latitude	number	地図上のポイントの緯度 (DEG形式)。
		longitude	number	地図上のポイントの経度 (DEG形式)。
		yaw	number	ポイントの初期表示水平方向。単位は radian で指定。ポイントのアセット(画像)の中心を0 (右回りに+2π) で指定。
Scene	Annotation	pitch	number	ポイント内での空間タグの垂直位置。単位は radian で指定。ポイントのアセット(画像)の中心を0とし、上方向に+π、下方向に-πで指定。
		rotationX	number	空間タグの垂直方向の回転角度（向き）。単位は radian で指定。推奨される初期値は-pitch、指定範囲は-pitch-π/4~-pitch+π/4。
		rotationY	number	空間タグの水平方向の回転角度（向き）。単位は radian で指定。推奨される初期値は-yaw、指定範囲は-yaw-π/4~-yaw+π/4。
		scaleX	number	空間タグの横方向の大きさを指定する倍率(スケール)。基準値は1.0。2倍の大きさで表示したい場合は2.0、0.5倍で表示したい場合は0.5。
		scaleY	number	空間タグの縦方向の大きさを指定する倍率(スケール)。基準値は1.0。2倍の大きさで表示したい場合は2.0、0.5倍で表示したい場合は0.5。
		url	string	空間タグ選択時に開く外部リンクのURL。
		xElementId	integer	空間タグ選択時に選択するプレイヤー要素(ポイント)のID。
		yaw	number	ポイント内での空間タグの水平位置。単位は radian で指定。ポイントのアセット(画像)の中心を0 (右回りに2π) で指定。

■プロパティyawとpitchの座標系

yaw：全天球画像の中心を0とし、右回りに+2π。(中心→右端＝左端→中心で一周するイメージ)
pitch：全天球画像の中心を0とし、上方向に+π/2、下方向に-π/2。

■検索クエリ

プレイヤーや画像一覧取得の検索クエリで指定可能なオプションは以下の通りです。

オプション	説明
既定の動作	検索ワードを部分一致で名前またはタグの中から検索する。
&	前後の検索ワードをAND検索する。
|	前後の検索ワードをOR検索する。
" "	この記号で括ることで検索ワードを完全一致で検索する。
*	検索ワードの前方、後方または部分一致で検索する。
( )	この記号で括ることでANDまたはORを複数組み合わせて検索する。
name:	検索対象の指定。名前の中から検索する。
tag:	検索対象の指定。タグの中から検索する。

※検索ワードは5つまで同時に指定可能です。また、英字の大小、ひらがな・カタカナは区別されません。記号は検索ワードに使用できません。

■サムネイルの大きさ

プレイヤーおよび画像のサムネイルの大きさは以下の通りです。

画像の種類	大きさ
パノラマ変換されていないもの	最大 320 x 240 px この大きさに収まるようアスペクト比は維持されます。 また、元の大きさがこれよりも小さい場合はそのままになります。
パノラマ変換されているもの	320 x 240 px