ターゲット画像の削除

EasyAR は不要になったターゲット画像を処理するために、永久削除と一時無効化の2つの方法を提供します。本番環境の安定性を確保するために、以下の操作手順をよくお読みください。

EasyAR web 管理センターでの操作

操作手順: EasyAR 開発センターにログイン -> クラウド認識管理 -> 対象の画像ライブラリを選択 -> 管理をクリックしてライブラリ管理画面に入る。
削除方法:
- 一括削除: リストで対象の画像をチェックし、削除をクリックして確認する。
- 個別削除: 対象画像の詳細ページに入り、ページ内の削除ボタンをクリックする。

削除操作ガイド

警告

削除操作は取り消せません。一度削除を確認すると、その画像の全ての特徴データと関連情報が永久に失われます。テストライブラリでプロセスを検証してから行い、本番環境での破壊的テストは厳禁です。

Best practices: ターゲット画像の無効化

多くの業務シナリオでは、将来的に画像を使用するかどうか不確かな場合、削除ではなく無効化を使用することを推奨します。

機能特徴: 無効化されたターゲット画像はデータベースリストに残りますが、クラウド認識検索プロセスには参加されません。ただし認識クォータを消費します。
無効化方法: 管理画面で画像をチェックし、無効化をクリックする。

無効化操作ガイド

APIによる無効化: ターゲット更新 API を呼び出し、active 属性を 0 に設定する。

APIを使用したターゲット画像の削除

REST API を通じて画像の自動クリーンアップが可能です。

準備作業

開始前にターゲット削除 API ドキュメントを読み、以下のリソースを準備してください:

CRS AppId
API Key / Secret または Token
サーバーエンド URL (ポート443)
TargetId: 削除対象画像の一意のID。TargetId が存在しない場合、API は statusCode: 404 (Target not found) を返します。

プレースホルダーを実際のパラメータに置き換え、curlスクリプトを実行してください

Your-Server-side-URL → 実際のAPIホスト
Your-Token → 実際のAPIキー認証トークン
Your-CRS-AppId → あなたのappId
Your-todo-TargetId → 削除対象のtargetId

curl -X DELETE "https://<Your Server-side-URL>/target/<Your-todo-TargetId>?appId=<Your-CRS-AppId>" \
  -H "Content-Type: application/json" \
  -H "Authorization: <Your-Token>"

Javaサンプルコードのダウンロード

Java Samples Download

Maven経由でのプロジェクトインポート

Step 1. 関連コードファイル RemoveTarget.java を開く

Step 2. グローバル変数を変更し、準備リストの認証パラメータを置き換える

CRS AppId
API Key / API Secret
TARGET_MGMT_URL → サーバー側URL
TARGET_ID → 削除対象ターゲット targetId

public class RemoveTarget {

    private static final String TARGET_MGMT_URL = "https://cn1.crs.easyar.com";
    private static final String CRS_APPID       = "--here is your CRS AppId--";
    private static final String API_KEY         = "--here is your API Key--";
    private static final String API_SECRET      = "--here is your API Secret--";
    private static final String TARGET_ID       = "my_targetid";
    /* TO_DEL_IDs lists all the targetIds to be removed
     * must be separated by ","
     */
    private static final String TO_DEL_IDs = "targetId1,targetId2,targetId3";

    public String remove(Auth auth, String targetId) throws IOException {
        okhttp3.Request request = new okhttp3.Request.Builder()
                .url(auth.getCloudURL()+"/target/"+targetId+"?"+ Common.toParam(
                        Auth.signParam(new JSONObject(), auth.getAppId(), auth.getApiKey(), auth.getApiSecret())
                ))
                .delete()
                .build();
        return new OkHttpClient.Builder().build().newCall(request).execute().body().string();
    }

    public String removeMultiTargets(Auth auth, String targetIds) throws IOException {
        JSONObject params = new JSONObject().put("targetId", targetIds);
        Auth.signParam(params, auth.getAppId(), auth.getApiKey(), auth.getApiSecret());
        RequestBody requestBody = FormBody.create(MediaType.parse("application/json; charset=utf-8")
                , params.toString());
        okhttp3.Request request = new okhttp3.Request.Builder()
                .url(auth.getCloudURL() + "/targets")
                .delete(requestBody)
                .build();
        return new OkHttpClient.Builder().build().newCall(request).execute().body().string();
    }
    public static void main(String[] args) throws IOException{
        Auth accessInfo  =  new Auth(CRS_APPID, API_KEY, API_SECRET, TARGET_MGMT_URL);
        System.out.println(new RemoveTarget().remove(accessInfo, TARGET_ID));
        System.out.println(new RemoveTarget().removeMultiTargets(accessInfo, TO_DEL_IDs));
    }
}

Step 3. Mainを実行

NodeJS サンプルコードのダウンロード

NodeJS Samples Download

ステップ 1. キーファイル keys.json の設定

CRS AppId
API Key / API Secret
to-delete-targetId

{
  "appId": "--here is your appId for CRS App Instance for SDK 4--",
  "apiKey": "--here is your api key which is create from website and which has crs permission--",
  "apiSecret": "--here is your api secret which is create from website--"
}

ステップ 2. 実行、キーファイルとサーバーエンド URL の指定

node bin/deleteTarget <to-delete-targetId> -t <Server-end-URL> -c keys.json

var argv = require('yargs')
    .usage('Usage: $0 [targetId] -t [host] -c [keys]')
    .demand(1)
    .default('t', 'http://localhost:8888').alias('t', 'host')
    .default('c', 'keys.json').alias('c', 'keys')
    .help('h').alias('h', 'help')
    .epilog('copyright 2015, sightp.com')
    .argv;

var fs = require('fs');

var targetId = argv._[0];
var host = argv.host;
var keys = JSON.parse(fs.readFileSync(argv.keys));

var farmer = require('../farmer')(host, keys.appKey, keys.appSecret);

farmer.deleteTarget(targetId)
.then(function(resp) {
    console.log(resp.result.targetId);
})
.fail(function(err) {
    console.log(err);
});

deleteTarget はクラウドサービスインターフェースを呼び出し、サンプルコードは farmer.js にあります

function deleteTarget(targetId) {
    return Q.promise(function(resolve, reject) {
        request.del(host + '/target/' + targetId)
        .query(signParams())
        .end(done(resolve, reject));
    });
}

Php サンプルコードのダウンロード

PHP Samples Download

ステップ1. エントリーコードdemo.phpを開く

ステップ2. グローバル変数を修正し、準備リストの認証パラメータを置換

CRS AppId
API Key / API Secret
サーバー側URL
toDeleteTargetId

<?php
include 'EasyARClientSdkCRS.php';
$apiKey = 'API Key';
$apiSecret = 'API Secret';
$crsAppId = 'CRS AppId'
$crsCloudUrl = 'https://cn1-crs.easyar.com';
$toDeleteTargetId = 'to-delete-targetId';

$sdk = new EasyARClientSdkCRS($apiKey, $apiSecret, $crsAppId, $crsCloudUrl);

$rs = $sdk->delete($toDeleteTargetId);
if ($rs->statusCode == 0) {
  print_r($rs->result);
} else {
  print_r($rs);
}

ステップ3. php demo.phpを実行する

新しい関連コードファイル delete_target.py を作成し、グローバル変数を変更してから実行します

pip install requests
python delete_target.py

import time
import hashlib
import requests

# --- 全局变量配置 ---
API_KEY = "YOUR_API_KEY"
API_SECRET = "YOUR_API_SECRET"
APP_ID = "YOUR_APP_ID"
HOST = "https://crs-cn1.easyar.com" 
TARGET_ID = "TARGET_ID"

def main():
    timestamp = str(int(time.time() * 1000))
    
    params = {
        'apiKey': API_KEY,
        'appId': APP_ID,
        'timestamp': timestamp
    }

    sorted_keys = sorted(params.keys())
    sign_str = "".join([f"{k}{params[k]}" for k in sorted_keys]) + API_SECRET
    signature = hashlib.sha256(sign_str.encode('utf-8')).hexdigest()

    url = f"{HOST}/target/{TARGET_ID}"
    final_params = {**params, 'signature': signature}

    print(f"Requesting DELETE {url}...")
    response = requests.delete(url, params=final_params)
    print(f"Response: {response.text}")

if __name__ == "__main__":
    main()

新規関連コードファイル main.go を作成し、グローバル変数を変更してから実行します

go run main.go

main.go:

package main

import (
  "crypto/sha256"
  "fmt"
  "io"
  "net/http"
  "sort"
  "strconv"
  "time"
)

var (
  ApiKey    = "YOUR_API_KEY"
  ApiSecret = "YOUR_API_SECRET"
  AppId     = "YOUR_APP_ID"
  Host      = "https://crs-cn1.easyar.com"
  TargetId  = "TARGET_ID"
)

func main() {
  ts := strconv.FormatInt(time.Now().UnixNano()/1e6, 10)
  params := map[string]string{
    "apiKey":    ApiKey,
    "appId":     AppId,
    "timestamp": ts,
  }

  keys := make([]string, 0, len(params))
  for k := range params { keys = append(keys, k) }
  sort.Strings(keys)

  builder := ""
  for _, k := range keys { builder += k + params[k] }
  builder += ApiSecret
  signature := fmt.Sprintf("%x", sha256.Sum256([]byte(builder)))

  url := fmt.Sprintf("%s/target/%s?apiKey=%s&appId=%s&timestamp=%s&signature=%s", 
    Host, TargetId, ApiKey, AppId, ts, signature)
  
  req, _ := http.NewRequest("DELETE", url, nil)
  resp, _ := http.DefaultClient.Do(req)
  defer resp.Body.Close()
  body, _ := io.ReadAll(resp.Body)
  fmt.Printf("Response: %s\n", string(body))
}

Cargo.toml に reqwest, tokio, sha2, hex の依存関係を追加。

cargo run を実行。

use sha2::{Sha256, Digest};
use std::collections::BTreeMap;
use std::time::{SystemTime, UNIX_EPOCH};

const API_KEY: &str = "YOUR_API_KEY";
const API_SECRET: &str = "YOUR_API_SECRET";
const APP_ID: &str = "YOUR_APP_ID";
const HOST: &str = "https://crs-cn1.easyar.com";
const TARGET_ID: &str = "YOUR_TARGET_ID";

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let ts = SystemTime::now().duration_since(UNIX_EPOCH)?.as_millis().to_string();

    let mut params = BTreeMap::new();
    params.insert("apiKey", API_KEY);
    params.insert("appId", APP_ID);
    params.insert("timestamp", &ts);

    let mut sign_str = String::new();
    for (k, v) in &params {
        sign_str.push_str(k);
        sign_str.push_str(v);
    }
    sign_str.push_str(API_SECRET);
    
    let mut hasher = Sha256::new();
    hasher.update(sign_str.as_bytes());
    let signature = hex::encode(hasher.finalize());

    let url = format!("{}/target/{}?apiKey={}&appId={}&timestamp={}&signature={}", 
                      HOST, TARGET_ID, API_KEY, APP_ID, ts, signature);
    
    let res = reqwest::Client::new().delete(url).send().await?;
    println!("Response: {}", res.text().await?);
    Ok(())
}

.NET コンソールプロジェクトを作成します。

dotnet new console
dotnet run

using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using System.Net.Http;

class Program {
    static string API_KEY = "API_KEY";
    static string API_SECRET = "API_SECRET";
    static string APP_ID = "APP_ID";
    static string HOST = "https://crs-cn1.easyar.com";
    static string TARGET_ID = "TARGET_ID";

    static async System.Threading.Tasks.Task Main() {
        string timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds().ToString();

        var dict = new SortedDictionary<string, string> {
            { "apiKey", API_KEY },
            { "appId", APP_ID },
            { "timestamp", timestamp }
        };

        StringBuilder sb = new StringBuilder();
        foreach (var kv in dict) sb.Append(kv.Key).Append(kv.Value);
        sb.Append(API_SECRET);
        
        string signature = Sha256(sb.ToString());

        using var client = new HttpClient();
        string query = string.Join("&", dict.Select(x => $"{x.Key}={x.Value}")) + $"&signature={signature}";
        string url = $"{HOST}/target/{TARGET_ID}?{query}";
        
        var response = await client.DeleteAsync(url);
        Console.WriteLine($"Result: {await response.Content.ReadAsStringAsync()}");
    }

    static string Sha256(string str) {
        byte[] bytes = SHA256.HashData(Encoding.UTF8.GetBytes(str));
        return BitConverter.ToString(bytes).Replace("-", "").ToLower();
    }
}

実行環境
- Unity 2020 LTS 以降
- Scripting Backend：Mono または IL2CPP のいずれでも可
- API Compatibility Level：.NET Standard 2.1（推奨）

Step 1：画像ファイルの準備

Unityプロジェクト内にディレクトリを作成：

Assets/
└── Scripts/
     └── DeleteImageTarget.cs

Assetsディレクトリ名に従い
- 以下のサンプルコード DeleteImageTarget.cs をコピー

using System.Collections;
using UnityEngine;
using UnityEngine.Networking;

public class DeleteImageTarget : MonoBehaviour
{
    [Header("Config")]
    public string targetId = "Your targetId";
    public string apiBaseUrl = "https://Your-Server-end-URL";
    public string authorizationToken = "YOUR API KEY AUTH TOKEN"; 
    public string crsAppId = "CRS-AppId"; 

    private void Start()
    {
        StartCoroutine(DeleteTarget());
    }

    private IEnumerator DeleteTarget()
    {
     
        string url =
            $"{apiBaseUrl}/target/{targetId}?appId={crsAppId}";

        UnityWebRequest request = UnityWebRequest.Delete(url);
        request.downloadHandler = new DownloadHandlerBuffer();

        request.SetRequestHeader("Content-Type", "application/json");
        request.SetRequestHeader("Authorization", authorizationToken);

        yield return request.SendWebRequest();

        if (request.result == UnityWebRequest.Result.Success)
        {
            Debug.Log("Delete target success:");
            Debug.Log(request.downloadHandler.text);
        }
        else
        {
            Debug.LogError("Delete target failed:");
            Debug.LogError(request.error);
            Debug.LogError(request.downloadHandler.text);
        }
    }
}

Unity Editor内で：
- 空のGameObjectを作成
- DeleteTargetと命名
- DeleteImageTargetスクリプトをこのオブジェクトにドラッグ

Step 3：パラメータ設定（Inspector）

Inspectorパネルで以下を修正：
- Api Url
- Authorization Token
- Crs App Id
- Target Id : 削除対象のターゲット画像のtargetId
これらの項目のみを修正して実行可能。準備済みのパラメータを入力

Step 4：実行

Playをクリック
Consoleで結果を確認：
- 成功：JSON（targetIdを含む）が返却
- 失敗：HTTP/エラーメッセージが表示

関連トピック:

Table of Contents

ターゲット画像の削除

EasyAR web 管理センターでの操作

警告

Best practices: ターゲット画像の無効化

APIを使用したターゲット画像の削除

準備作業