Table of Contents

ターゲット画像プロパティを変更する | PUT /target/<target_id>

target_id に対応するターゲット画像プロパティを変更します。パラメータは HTTP patch 形式で変更され、変更されないパラメータはそのまま保持されます。

Action

PUT /target/<target_id>

認証

必要

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" で target を有効化し、"0" で target を無効化します。デフォルトは "1" です。
name String Yes target 名。英字、英語の句読点、数字のみをサポートします。長さは最小 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 です。

リクエスト例

    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 timestamp 形式を使用し、単位はミリ秒
result.targetId ターゲット画像の一意 ID
result.trackingImage tracking image の base64 エンコード文字列
result.name target 名
result.size 認識画像の幅（単位: cm）。認識画像の高さは、アップロードした画像に基づいてシステムが自動計算します。認識画像のサイズは重ね合わせる仮想コンテンツのサイズに対応します
result.meta base64 エンコードされた追加情報。たとえば JSON 文字列を base64 エンコードして生成された文字列
result.type ImageTarget に固定
result.active "1" は有効、"0" は無効

エラーコード

ステータスコードおよびエラーコード一覧を参照してください