新しい画像ターゲットの作成 | POST /targets
認識画像をアップロードし、新しい画像ターゲットを作成
Action
POST /targets
認証
Http Header
Content-Type=application/json
HTTP Header: Authorization (API Key Token認証方式の場合)
リクエストパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | 画像コンテンツのbase64エンコード文字列。JPGおよびPNG形式をサポート。画像の最大サイズは2MB。 |
| active | String | No | "1"はターゲットを有効化、"0"は無効化。デフォルトは"1"。 |
| name | String | Yes | ターゲット名。英字、英数字記号、数字のみ使用可能。長さは最小1文字、最大64文字。 |
| size | String（Float） | Yes | 認識画像の幅(cm単位)。高さはアップロード画像から自動計算。認識画像サイズは仮想コンテンツサイズに対応。デフォルト20。 |
| meta | String | Yes | ARコンテンツ情報を格納するテキスト文字列。デフォルトは""。例: 認識物のJSON情報、画像のbase64エンコード、クラウドストレージの大ファイルURL。最大2MB。 |
| type | String (Float) | Yes | 必ず文字列"ImageTarget"に固定（大文字小文字厳密一致）。 |
| allowSimilar | String | No | 類似画像存在時に強制追加を許可するか。デフォルト0。類似画像は認識精度に影響するためデフォルト推奨。 |
注記
- imageの最大サイズ: 2MB
- metaの最大サイズ: 2MB
リクエスト例
POST /targets/ HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
"image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
"active":"1",
"name":"easyar",
"size":"5",
"meta":"496fbbabc2b38ecs3460a...",
"type":"ImageTarget",
"timestamp": 1514736000000,
"appKey": "test_app_key",
"signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}
レスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"statusCode": 0,
"result": {
"target": {
"targetId":"e61db301-e80f-4025-b822-9a00eb48d8d2",
"trackingImage":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM..."，
"name": "easyar",
"size": "5",
"meta": "496fbbabc2b38ecs3460a...",
"type": "ImageTarget",
"modified":1514735000000
"active":"1"，
"trackableRate": 0,
"detectableRate": 0,
"detectableDistinctiveness"：0,
"detectableFeatureCount", 0,
"trackableDistinctiveness", 0,
"trackableFeatureCount", 0,
"trackableFeatureDistribution", 0,
"trackablePatchContrast", 0,
"trackablePatchAmbiguity", 0
}
},
"timestamp": 1514736000000
}
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| statusCode | ステータスコード。0は認証成功。詳細参照 |
| result | エラーメッセージ、またはターゲット画像情報 |
| timestamp | レスポンス返却時のサーバー時間(Unixタイムスタンプ、ミリ秒単位) |
| result.targetId | ターゲット画像の一意なID |
| result.trackingImage | トラッキング画像のbase64エンコード文字列 |
| result.name | ターゲット名 |
| result.size | 認識画像の幅(cm単位)。高さはアップロード画像から自動計算。認識画像サイズは仮想コンテンツサイズに対応 |
| result.meta | base64エンコードされた追加情報（例: JSON文字列をbase64エンコードした文字列） |
| result.type | 固定値"ImageTarget" |
| result.active | "1"有効、"0"無効 |
エラーコード
Meta 使用説明
- 動画URLの関連付け
- 各認識ターゲットに対し、metaフィールドに関連動画URLを格納可能
- アプリがターゲットを認識後、meta内のURLを使用してサーバーから動画をダウンロード/再生。例:
https://my_server/my_videos/my_video_001.mp4
- 3Dモデルの関連付け
- 各認識ターゲットに対し、関連3DモデルまたはUnityアセットバンドルをmetaフィールドに格納可能
- モデルをbase64エンコードしてmetaに保存、またはメタデータ内にモデルURLを格納
- アプリがターゲット認識後、検出されたターゲット上に3Dモデルをレンダリング