メインコンテンツへスキップ
JSON ファイルには、documents の数、種類、名前に加えて、各 Document のページ数とページ名を指定するデータ構造が含まれます。特定ユーザー向けのシナリオでモバイルアップロードを構成するには、モバイルアップロードリンクで JSON ファイルを使用します。 md パラメータは、直接リンクをエンコードした形式と、JSON 自体をエンコードした形式の2つで JSON ファイルを受け付けます。 エンコード済みリンクを使用するには:
  1. JSON ファイルへのダイレクトアクセスリンクを生成します。
注: リンクは “http://” または “https://” で始まる必要があります。
  1. 取得したリンクを URL エンコードします。
  2. モバイルアップロードリンクの md パラメータ値として、エンコード済み URL を指定します。
エンコード済み JSON を使用するには:
  1. JSON ファイルを URL エンコードします。
  2. モバイルアップロードリンクの md パラメータ値として、エンコード済みの JSON を指定します。

​
JSON 構造

TransactionStructure は、モバイルのアップロードセッション中にユーザーが取り込むことを想定した文書セットを定義し、トランザクションでの後続処理に使用されます。すべての文書が取り込まれるまでトランザクションは開始されません。
プロパティ値説明
version2.4現在の ABBYY Vantage のバージョン。注意: 値はモバイルアップロードリンクの v パラメーターの値と一致している必要があります。
elementsElementStructure要素コレクションの構造。
ElementStructure は、トランザクションでの後続処理のためにユーザーが取り込むことを想定した、1 つまたは複数の文書セットのコレクションを定義します。
プロパティ値説明
typestandalone1 つの文書セットからなるコレクションを定義します。
typesingle_choice複数の文書セットからなるコレクションを定義します。注意: 文書セットを少なくとも 2 つ以上指定する必要があります。
nameマイクロアプリケーションの Capture Documents 画面に表示される文書セット名。注意: single_choice タイプでのみ利用可能です。
documentDocumentStructureセット内の 1 件の文書の構造。注意: standalone タイプでのみ利用可能です。
documentsDocumentStructureセット内のすべての文書の構造。注意: single_choice タイプでのみ利用可能です。
DocumentStructure は、セット内の各文書に対するプロパティのコレクションを定義します。
プロパティ値説明
typeidcardID カードの両面（表・裏）の取り込みを定義します。
typepassportパスポートの最初のページの取り込みを定義します。
typedocument任意の文書の取り込みを定義します。
nameマイクロアプリケーションの Capture Documents 画面に表示される文書名。
count1,2,3...1 回のトランザクションで取り込む必要がある文書数。既定値は「1」です。注意: すべての文書が取り込まれるまでアップロードは開始されません。
countany1 回のトランザクションで取り込む文書数。注意: 取り込まれた文書数がいくつであってもアップロードが開始されます。
galleryEnabledfalse/trueこの文書について、デバイスのギャラリーから文書ページの画像をアップロードできるかどうかを定義します。
pagesPagesStructure文書ページの構造。
PagesStructure は、ユーザーが取り込むことを想定した文書ページに関するプロパティのコレクションを定義します。
プロパティ値説明
nameFront side/Back sideID カードのページ名。
nameFirst page with photoパスポートの最初のページ名。
nameDocument page name任意の文書のページ名。
count1,2,3...文書で取り込む必要があるページ数。既定値は「1」です。文書のすべてのページが取り込まれるまでアップロードは開始されません。注意: ID カードの表面および裏面に必要な値は「1」です。
countany任意の文書で取り込むページ数。取り込まれたページ数がいくつであってもアップロードが開始されます。注意: パスポートの最初のページに必要な値は「1」です。その他のパスポートページに必要な値は「any」です。

​
JSON サンプル

あらかじめページ数を指定したパスポートドキュメントを一定数取得するための JSON 構造の例: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "パスポート",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "写真付きの最初のページ",
            "count": 1
          },
          {
            "name": "その他のページ",
            "count": "任意"
          }
        ]
      }
    }
  ]
}
複数の事前定義済みドキュメントのうち一つを取り込むための JSON 構造の例： 
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Document",
      "documents": [
        {
          "type": "idcard",
          "name": "身分証明書",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "表面",
              "count": 1
            },
            {
              "name": "裏面",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "パスポート",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "写真付きの最初のページ",
              "count": 1
            },
            {
              "name": "その他のページ",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
オプションのIDカードを含む複数の文書を取り込むためのJSON構造の例： 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "請求書",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "ページ",
            "count": "任意"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "IDカード",
        "count": "任意",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "表面",
            "count": 1
          },
          {
            "name": "裏面",
            "count": 1
          }
        ]
      }
    }
  ]
}