OSS に保存された画像内の QR コードおよびバーコードを検出します。応答には、各コードのデコードされたテキストと、画像内でのバウンディングボックス座標が返されます。
この機能は Intelligent Media Management (IMM) によって提供され、同期処理のみをサポートします。
ユースケース
支払いフロー:支払いスクリーンショットや領収書に埋め込まれた QR コードをデコードします。
マーケティングおよび広告:スキャンしたポスターやパッケージング画像上の QR コードから URL や商品情報を抽出します。
コンテンツモデレーション:ユーザーがアップロードした画像内の QR コードまたはバーコードの位置を特定し、後続のマスキングやぼかし処理を適用します。
制限事項
同期処理(
x-oss-process)のみをサポートします。1 枚の画像につき最大 5 個のコードを検出します。
匿名アクセスは拒否されます。
バウンディングボックスは矩形表現(Left、Top、Width、Height)を使用します。
前提条件
開始する前に、以下の準備が完了していることを確認してください。
OSS コンソールまたは IMM AttachOSSBucket API を介して、IMM プロジェクトをバケットに紐付けます
QR コードおよびバーコードの検出
OSS に保存された画像オブジェクト内のすべての QR コードおよびバーコードを検出するには、image/codes 操作を使用します。
Python
OSS SDK for Python 2.18.4 以降が必要です。
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 環境変数 OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET からアクセス認証情報を読み込みます。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# バケットが配置されているリージョンのエンドポイントを指定します。
endpoint = 'https://oss-cn-hangzhou.aliyuncs.com'
# バケットが配置されているリージョンを指定します。
region = 'cn-hangzhou'
bucket = oss2.Bucket(auth, endpoint, 'examplebucket', region=region)
# オブジェクトのフルパスを指定します。例:exampledir/example.jpg
key = 'example.jpg'
try:
# QR コード検出リクエストを送信します。
result = bucket.get_object(key, process='image/codes')
print(result.read().decode('utf-8'))
except oss2.exceptions.OssError as e:
print("Error:", e)Java
OSS SDK for Java 3.17.4 以降が必要です。
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.OSSObject;
import com.aliyun.oss.model.GetObjectRequest;
import com.aliyuncs.exceptions.ClientException;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
public class Demo {
public static void main(String[] args) throws ClientException {
// バケットが配置されているリージョンのエンドポイントを指定します。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// バケットが配置されているリージョンを指定します。例:cn-hangzhou
String region = "cn-hangzhou";
// 環境変数 OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET からアクセス認証情報を読み込みます。
EnvironmentVariableCredentialsProvider credentialsProvider =
CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// バケット名を指定します。
String bucketName = "examplebucket";
// オブジェクトのフルパスを指定します。例:exampledir/example.jpg
String key = "example.jpg";
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
// QR コード検出リクエストを送信します。
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
getObjectRequest.setProcess("image/codes");
OSSObject ossObject = ossClient.getObject(getObjectRequest);
// JSON 応答を読み取ります。
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buffer = new byte[1024];
int bytesRead;
while ((bytesRead = ossObject.getObjectContent().read(buffer)) != -1) {
baos.write(buffer, 0, bytesRead);
}
System.out.println(baos.toString("UTF-8"));
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
} finally {
ossClient.shutdown();
}
}
}Go
OSS SDK for Go 3.0.2 以降が必要です。
package main
import (
"fmt"
"io"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 環境変数 OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET からアクセス認証情報を読み込みます。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// OSS クライアントを作成します。バケットが配置されているエンドポイントとリージョンを指定します。
client, err := oss.New(
"https://oss-cn-hangzhou.aliyuncs.com", "", "",
oss.SetCredentialsProvider(&provider),
oss.AuthVersion(oss.AuthV4),
oss.Region("cn-hangzhou"),
)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
bucket, err := client.Bucket("examplebucket")
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// QR コード検出リクエストを送信します。
body, err := bucket.GetObject("example.jpg", oss.Process("image/codes"))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
defer body.Close()
data, err := io.ReadAll(body)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
fmt.Println(string(data))
}PHP
OSS SDK for PHP 2.7.0 以降が必要です。
<?php
if (is_file(__DIR__ . '/../autoload.php')) {
require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
require_once __DIR__ . '/../vendor/autoload.php';
}
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
try {
// 環境変数 OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET からアクセス認証情報を読み込みます。
$provider = new EnvironmentVariableCredentialsProvider();
// バケットが配置されているリージョンのエンドポイントを指定します。
$endpoint = 'https://oss-cn-hangzhou.aliyuncs.com';
// バケット名を指定します。
$bucket = 'examplebucket';
// オブジェクトのフルパスを指定します。例:exampledir/example.jpg
$key = 'example.jpg';
$config = array(
"provider" => $provider,
"endpoint" => $endpoint,
"signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
"region" => "cn-hangzhou"
);
$ossClient = new OssClient($config);
// QR コード検出リクエストを送信します。
$options[$ossClient::OSS_PROCESS] = "image/codes";
$result = $ossClient->getObject($bucket, $key, $options);
var_dump($result);
} catch (OssException $e) {
printf($e->getMessage() . "\n");
}API リファレンス
直接 API にアクセスする場合は、GetObject リクエストに x-oss-process=image/codes パラメーターを含めてください。Authorization ヘッダーは署名バージョン 4を使用して計算します。GetObject の完全な仕様については、「GetObject」をご参照ください。
リクエスト例
GET /example.jpg?x-oss-process=image/codes HTTP/1.1
Host: image-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 21 Jul 2023 08:56:50 GMT
Authorization: SignatureValue応答例
HTTP/1.1 200 OK
Server: AliyunOSS
Date: Fri, 21 Jul 2023 08:56:52 GMT
Content-Type: application/json;charset=utf-8
Content-Length: 64
Connection: keep-alive
x-oss-request-id: 64BA48531253C5383707D5B3
ETag: "2CE2EA370531B7CC1D23BE6015CF5DA5"
Last-Modified: Mon, 10 Jul 2023 13:07:30 GMT
x-oss-object-type: Normal
x-oss-hash-crc64ecma: 13420962247653419692
x-oss-storage-class: Standard
x-oss-ec: 0048-00000104
Content-Disposition: attachment
x-oss-force-download: true
x-oss-server-time: 453
{
"RequestId": "3B7BD09F-18D8-56F0-90B7-889FBD9FFF70",
"Codes": [
{
"Content": "https://www.aliyun.com/product/imm",
"Boundary": {
"Width": 741,
"Height": 706,
"Left": 460,
"Top": 295
}
}
]
}応答フィールド
Codes 配列には、検出されたコードごとに 1 つのエントリが含まれます。
| フィールド | タイプ | 説明 |
|---|---|---|
Content | String | QR コードまたはバーコードからデコードされたテキストまたは URL |
Boundary.Left | Integer | 左上隅の X 座標(ピクセル単位) |
Boundary.Top | Integer | 左上隅の Y 座標(ピクセル単位) |
Boundary.Width | Integer | バウンディングボックスの幅(ピクセル単位) |
Boundary.Height | Integer | バウンディングボックスの高さ(ピクセル単位) |
完全な応答スキーマについては、「DetectImageCodes」をご参照ください。
権限
同期型 QR コード認識(x-oss-process=image/codes)では、以下の権限を付与する必要があります。
呼び出し元(RAM ユーザーまたは RAM ロール)の権限
呼び出し元に権限を付与するには、RAM ポリシーまたはバケットポリシーを使用します。
| API | アクション | 説明 |
|---|---|---|
| GetObject | oss:GetObject | OSS からソース画像を読み取ります |
| — | kms:Decrypt | オブジェクトが KMS で暗号化されている場合(X-Oss-Server-Side-Encryption: KMS)にのみ必要です |
| — | oss:ProcessImm | OSS から IMM データ処理を呼び出します |
| PostProcessTask | oss:PostProcessTask | 非同期処理(x-oss-async-process)の場合にのみ必要です |
IMM サービスロールの権限
IMM は、デフォルトのサービスロール AliyunIMMDefaultRole(ARN:acs:ram:*:<account-id>:role/aliyunimmdefaultrole)を使用して、お客様に代わって OSS を呼び出します。このロールに以下の権限を付与してください。
| API | アクション | 説明 |
|---|---|---|
| GetObject | oss:GetObject | ソース画像を読み取ります |
| — | kms:Decrypt | オブジェクトが KMS で暗号化されている場合にのみ必要です |
IMM の権限
| API | アクション | 説明 |
|---|---|---|
| DetectImageCodes | imm:DetectImageCodes | IMM で QR コード認識を実行します |
課金
QR コード認識は、OSS および IMM の両方で課金が発生します。単価はリージョンによって異なります。
OSS の課金項目 — 最新の料金については、「OSS 料金」をご参照ください。
| 課金項目 | 基盤 |
|---|---|
| GET リクエスト | 成功したリクエストごと |
| アウトバウンドトラフィック | パブリックエンドポイント(例:oss-cn-hangzhou.aliyuncs.com)またはアクセラレーションエンドポイント経由でアクセスされたデータサイズ |
| IA データ取得 | 取得された IA オブジェクトのサイズ |
| アーカイブデータ取得 | バケットでリアルタイムアクセスが有効になっている場合の、取得されたアーカイブオブジェクトのサイズ |
| 転送アクセラレーション | 転送アクセラレーションが有効になっている場合のデータサイズ |
IMM の課金項目 — 最新の料金については、「IMM 課金」をご参照ください。
| 課金項目 | 基盤 |
|---|---|
| ImageQRCodes | 成功した DetectImageCodes リクエストごと |