Google コードスキャナ(Android のみ)

Google Code Scanner API は、アプリがカメラ権限をリクエストしなくても、ユーザーのプライバシーを保護しながら、コードをスキャンするための完全なソリューションを提供します。これを行うには、コードをスキャンするタスクを Google Play 開発者サービスに委任し、スキャン結果のみをアプリ(動画 1)に返します。画像処理はすべてデバイス上で行われ、Google が結果や画像データを保存することはありません。この API は ML Kit Barcode Scanning API と同じコード形式をサポートしており、同じ Barcode オブジェクトを返します。

この API は、カスタム UI やカメラ エクスペリエンスを必要としないシームレスなコードスキャンを必要とするアプリに最適です。実装はすべて Google Play 開発者サービス内に行われるため、アプリのサイズへの影響は最小限に抑えられます。

バージョン 16.1.0 以降では、自動ズームを有効にして、カメラから遠くにあるバーコードを Google コードスキャナが自動的にスキャンできます。ユーザーがデバイスをバーコードに向けると、スキャナがバーコードをインテリジェントに検出して拡大します。これにより、ズームを手動で調整する必要がなくなり、バーコード スキャンの速度、精度、使いやすさが向上します(動画 2 を参照)。

動画 1. Google コードスキャナの統合 動画 2. 自動ズーム効果

カスタム UI を必要とする複雑なユースケースでは、ML Kit Barcode Scanning API を直接使用することをおすすめします。

質問がある場合、バグを報告したい場合、またはサポートが必要な場合は、ML Kit コミュニティ ページをご覧ください。

始める前に

アプリを準備するには、以下のセクションに示す手順を完了します。

アプリを設定する

  1. 最上位の settings.gradle ファイルで、dependencyResolutionManagement ブロック以下に Google の Maven リポジトリMaven セントラル リポジトリを含めます。

    dependencyResolutionManagement {
      repositories {
        google()
        mavenCentral()
      }
    }
    
  2. play-services-code-scanner SDK 用の Google Play 開発者サービスの依存関係をモジュールの Gradle ビルドファイル(通常は app/build.gradle)に追加します。

    dependencies {
      implementation 'com.google.android.gms:play-services-code-scanner:16.1.0'
    }
    
  3. アプリが Google Play ストアからインストールされるときに、スキャナ モジュールが Google Play 開発者サービスによって自動的にデバイスにダウンロードされるようにアプリを構成できます。

    <application ...>
      ...
      <meta-data
          android:name="com.google.mlkit.vision.DEPENDENCIES"
          android:value="barcode_ui"/>
      ...
    </application>
    

    また、スキャナ モジュールの可用性を明示的に確認し、Google Play 開発者サービスの ModuleInstallClient API を使用してダウンロードをリクエストすることもできます。

    インストール時のモジュール ダウンロードを有効にせず、明示的なダウンロードをリクエストせず、スキャナ モジュールが別のユースケース用にまだインストールされていない場合、Google Play 開発者サービスは、スキャナ モジュールが初めて使用されたときにそのスキャナ モジュールをダウンロードします。

コードをスキャンする

バーコードをスキャンするには、次の手順を実装します。

  1. 省略可: コードスキャナを構成します。

    読み取るバーコード形式がわかっている場合は、その形式のみを検出するように構成することで、バーコード検出機能の速度を向上させることができます。たとえば、Aztec コードと QR コードのみを検出するには、次の例のように GmsBarcodeScannerOptions オブジェクトをビルドします。

    Kotlin

    val options = GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(
           Barcode.FORMAT_QR_CODE,
           Barcode.FORMAT_AZTEC)
       .build()
    

    Java

    GmsBarcodeScannerOptions options = new GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(
           Barcode.FORMAT_QR_CODE,
           Barcode.FORMAT_AZTEC)
       .build();
    

    デフォルトでは、自動ズームはオフになっています。バージョン 16.1.0 以降で自動ズーム機能を有効にするには、次のコード例に示すように enableAutoZoom() を呼び出します。

    Kotlin

    val options = GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(...)
       .enableAutoZoom() // available on 16.1.0 and higher
       .build()
    

    Java

    GmsBarcodeScannerOptions options = new GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(...)
       .enableAutoZoom() // available on 16.1.0 and higher
       .build();
    
  2. コードサンプルに示すように、GmsBarcodeScanner のインスタンスを取得します。

    Kotlin

    val scanner = GmsBarcodeScanning.getClient(this)
    // Or with a configured options
    // val scanner = GmsBarcodeScanning.getClient(this, options)
    

    Java

    GmsBarcodeScanner scanner = GmsBarcodeScanning.getClient(this);
    // Or with a configured options
    // GmsBarcodeScanner scanner = GmsBarcodeScanning.getClient(context, options);
    
  3. startScan() を呼び出して、コードのスキャンをリクエストします。

    Kotlin

    scanner.startScan()
       .addOnSuccessListener { barcode ->
           // Task completed successfully
       }
       .addOnCanceledListener {
           // Task canceled
       }
       .addOnFailureListener { e ->
           // Task failed with an exception
       }
    

    Java

    scanner
       .startScan()
       .addOnSuccessListener(
           barcode -> {
             // Task completed successfully
           })
       .addOnCanceledListener(
           () -> {
             // Task canceled
           })
       .addOnFailureListener(
           e -> {
             // Task failed with an exception
           });
    
  4. 結果の Barcode を処理します。

    Kotlin

    val rawValue: String? = barcode.rawValue
    

    Java

    String rawValue = barcode.getRawValue();