ターゲット画像プロパティの変更 | PUT /target/<target_id>
target_id に対応するターゲット画像のプロパティを変更します。Http patch 形式でパラメータを変更し、変更のないパラメータは保持されます。
Action
PUT /target/<target_id>
認証
Http ヘッダー
Content-Type=application/json
HTTP ヘッダー: Authorization (API Key Token 認証方式を使用する場合)
リクエストパラメータ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| image | String(base64) | はい | JPG および PNG 形式画像に対応する、画像コンテンツの base64 エンコード文字列。画像の最大サイズは 2MB。 |
| active | String | いいえ | ターゲットを有効化する場合は "1"、無効化する場合は "0"。デフォルトは "1"。 |
| name | String | はい | ターゲット名。英字、英数字、句読点のみ使用可能。長さは最小 1 文字、最大 64 文字。 |
| size | String（Float） | はい | 認識画像の幅（単位 cm）。認識画像の高さは、アップロードされた画像に基づきシステムが自動計算します。認識画像のサイズは仮想コンテンツのサイズに対応します。デフォルト 20。 |
| meta | String | はい | AR コンテンツ情報の保存に一般的に使用されるテキスト文字列形式。デフォルトは ""。例: 認識物体の JSON 情報、画像の base64 エンコード、またはクラウドストレージ上の大容量ファイルの URL ダウンロードアドレス。最大 2MB。 |
| type | String (Float) | はい | 文字列 "ImageTarget" に固定で設定する必要があります。大文字小文字は完全一致させること。 |
| allowSimilar | String | いいえ | 類似画像が存在する場合の強制追加許可。デフォルト 0。類似画像は認識結果に影響する可能性があるため、デフォルト設定を推奨。 |
[!注意]
- image の最大サイズは 2MB です。
- meta の最大サイズは 2MB です。
リクエスト例
PUT /target/e61db301-e80f-4025-b822-9a00eb48d8d2 HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
"active":"1",
"name":"easyar",
"size":"5",
"meta":"496fbbabc2b38ecs3460a...",
"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",
"date": "2016-06-15T09:56:30.000Z",
"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" 無効 |