Excel / Google Spreadsheet連携

/v1/sheet/* は、セル関数から直接呼び出すことを想定した 単一の値だけを text/plain で返す APIです。金融機関名から金融機関コードを引く、支店名から支店コードを引くといった変換を、表計算ソフト上で完結させられます。

このAPIは正式に提供している機能です。レスポンス形式（text/plain の単一値）や認証方式（?token= クエリパラメータ）に破壊的変更を加える場合は、リリースノートで事前に告知します。詳細な仕様は公開API仕様を参照してください。

認証

リクエストURLに token パラメータを付けてAPIキーを渡します。このAPIはヘッダー認証を使えません（セル関数からヘッダーを設定できないため）。

https://api.ginconnect.jp/v1/sheet/bank?token=<<your_api_key>>

注意: ?token= 形式はURLにAPIキーが含まれるため、アクセスログや共有したシートからキーが漏れる恐れがあります。シートを第三者と共有する場合は、キーを別セルに置いて数式から参照する・共有範囲を絞る等の対策をしてください。キーの取り扱いはAPIキーについてを参照。

金融機関情報を取得する

GET https://api.ginconnect.jp/v1/sheet/bank

パラメーター

名前型デフォルト必須説明
tokenstring—✔発行したAPIキー
codestring—※検索したい金融機関コード（完全一致）。code と name のどちらかが必須。両方指定した場合は code が優先される
namestring—※検索したい金融機関名（部分一致）
fieldstringcode取得したいフィールド。code / name / katakana / hiragana / halfKatakana が指定可能

使用例

Google Spreadsheet — セル A2 の金融機関名から金融機関コードを取得する

=IMPORTDATA("https://api.ginconnect.jp/v1/sheet/bank?token=<<your_api_key>>&name="&ENCODEURL(A2))

Excel — 同じ処理を WEBSERVICE 関数で行う

=WEBSERVICE("https://api.ginconnect.jp/v1/sheet/bank?token=<<your_api_key>>&name="&ENCODEURL(A2))

金融機関コードからカタカナ表記を取得する（field を指定）

=IMPORTDATA("https://api.ginconnect.jp/v1/sheet/bank?token=<<your_api_key>>&code=0001&field=katakana")

支店情報を取得する

支店を引くにはURLのパスに 金融機関コード を含めます。

GET https://api.ginconnect.jp/v1/sheet/banks/{金融機関コード}/branch

パラメーター

名前型デフォルト必須説明
tokenstring—✔発行したAPIキー
codestring—※検索したい支店コード（完全一致）。code と name のどちらかが必須
namestring—※検索したい支店名（部分一致）
fieldstringcode取得したいフィールド。code / name / katakana / hiragana / halfKatakana が指定可能

使用例

Google Spreadsheet — みずほ銀行（0001）の中からセル A2 の支店名で支店コードを引く

=IMPORTDATA("https://api.ginconnect.jp/v1/sheet/banks/0001/branch?token=<<your_api_key>>&name="&ENCODEURL(A2))

Excel — 同じ処理を WEBSERVICE 関数で行う

=WEBSERVICE("https://api.ginconnect.jp/v1/sheet/banks/0001/branch?token=<<your_api_key>>&name="&ENCODEURL(A2))

実践例: 名称の一覧からコード表を作る

金融機関名と支店名が並んだシートから、それぞれのコードを自動で埋める例です。B列で取得した金融機関コードを、D列の支店コード取得にそのまま使い回します。

A（金融機関名）B（金融機関コード）C（支店名）D（支店コード）
1金融機関名コード支店名支店コード
2みずほ銀行0001東京営業部001

B2 — 金融機関コード（4桁にゼロ埋め）

=TEXT(IMPORTDATA("https://api.ginconnect.jp/v1/sheet/bank?token=<<your_api_key>>&name="&ENCODEURL(A2)), "0000")

D2 — 支店コード（B2 の金融機関コードを参照し、3桁にゼロ埋め）

=TEXT(IMPORTDATA("https://api.ginconnect.jp/v1/sheet/banks/"&B2&"/branch?token=<<your_api_key>>&name="&ENCODEURL(C2)), "000")

ゼロ埋めが必要な理由: APIは 0001 のような先頭ゼロ付きの文字列を返しますが、表計算ソフトが数値として解釈すると先頭のゼロが失われて 1 になります。TEXT 関数で金融機関コードは "0000"、支店コードは "000" の書式を指定してください。

エラーになったとき

このAPIは失敗時に本文として #N/A を返します。セルに #N/A が表示される場合は、次を確認してください。

原因確認すること
APIキーが無効・期限切れ（401）ダッシュボードでキーの状態と有効期限を確認する
サブスクリプションが有効でない（402）契約状態が active または trialing か確認する
許可オリジンの制限に引っかかっている（403）セル関数からの呼び出しでは Origin ヘッダーが付かないため通常は発生しない。ブラウザ拡張等を経由していないか確認する
該当する金融機関・支店が無い（404）name は部分一致。表記ゆれ（「銀行」の有無、全角/半角）を確認する
指定した field が存在しないcode / name / katakana / hiragana / halfKatakana のいずれかを指定する

レートリミット: IPごとに15分あたり100リクエストです。超過した場合のみ #N/A ではなくJSONのエラーが返るため、セルにJSONの文字列がそのまま表示されます。多数のセルに数式を貼る場合は、一度に展開する行数を抑えてください。

利用上の注意

  • 関数の対応状況: WEBSERVICE / ENCODEURL はExcel for Windows（デスクトップ版）向けの関数です。Excel for Mac や Excel for the web では利用できないため、Google Spreadsheetの IMPORTDATA を使ってください
  • 再計算のタイミング: IMPORTDATA の結果はGoogle Spreadsheet側でキャッシュされます。最新の値に更新したい場合はシートを開き直すか、数式を再入力してください
  • 大量取得には向かない: 1リクエストにつき1つの値しか返りません。一覧をまとめて取得する場合は公開API仕様の /v1/banks を使ってください

関連ドキュメント