製品をチェック

Smaregi Driver の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

Smaregi アイコン Smaregi JDBC Driver 相談したい

商品、在庫、発送状況などのスマレジアカウントデータを組み込んだ強力なJava アプリケーションを迅速に作成して配布できます。

DbVisualizer でスマレジ のデータに連携しクエリを作成

DbVisualizer のビジュアルデータ分析ツールやデータ接続ウィザードにスマレジ のデータを連携する方法を紹介します。

加藤龍彦
デジタルマーケティング

最終更新日:2024-03-08
smaregi ロゴ

CData

jdbc ロゴ画像
DbVisualizer ロゴ

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for Smaregi は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでスマレジ のデータへの接続を提供します。この記事では、DbVisualizer からスマレジ のデータに接続する方法、およびtable エディタを使ってスマレジ を編集、および保存する方法を説明します。

CData JDBC ドライバとは?

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

  1. スマレジ をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
  2. DBeaver を含む多様なアプリケーション、ツールにスマレジ のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてスマレジ の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

スマレジ のデータの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからスマレジ のデータに接続します。

  1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
  2. 」ボタンをクリックして新しくドライバーを作成します。
  3. テンプレートは「Custom」を選択します。
  4. Driver Settings タブで:
    • Name をわかりやすい名前に設定します(例:CData スマレジ Driver)。
    • URL Formatjdbc:smaregi: に設定します。 ドライバー設定(Salesforce の場合)
    • Driver artifacts and jar files (jars are loaded in order from top) セクションで:
      1. 」ボタンをクリックして、「Add Files」に進みます。
      2. インストールディレクトリ(C:\Program Files\CData\CData JDBC Driver for スマレジ XXXX\)の「lib」フォルダに移動します。
      3. JAR ファイル(cdata.jdbc.Smaregi.jar)を選択して「Open」をクリックします。
      ドライバーのJAR ファイルをロード。
  5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス(cdata.jdbc.smaregi.SmaregiDriver)を選択してください。
設定されたJDBCドライバー(Salesforce の場合)

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

  1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。
  2. 「Connection」セクションで以下のオプションを設定します。

    • Database Type:ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
    • Driver Type:先ほど作成したドライバーを選択します。
    • Database URL:完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:smaregi: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

      スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。

      • スマレジにログイン後、「設定」->「システム連携」->「スマレジAPI 設定」に移動します。
      • 「API受信設定」セクションにある「受信機能を利用する」を「利用する」に変更し、「アクセストークンの生成」をクリックし、AccessToken を取得します。
      • 次に必要なAPI アクセスを有効にするため、「機能設定」セクションで必要な機能を「利用する」に変更します。

      ContractId: アカウントの契約ID。これは受信設定セクションでも確認できます。
      AccessToken: 受信設定セクションのアクセストークン。

      組み込みの接続文字列デザイナー

      JDBC URL の作成の補助として、スマレジ JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

      java -jar cdata.jdbc.smaregi.jar

      接続プロパティを入力し、接続文字列をクリップボードにコピーします。

      組み込みの接続文字列デザイナーを使ってJDBC URL を生成(Salesforce の場合)

      JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

      一般的な接続文字列は次のとおりです。

      jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;
    • NOTE:スマレジ は認証にUser やPassword を必要としないため、Database UseridDatabase Password には任意の値を使用できます。
  3. 「Connection」タブで「Connect」をクリックします。 新しく設定されたデータベース接続(Salesforce の場合)。

スマレジ JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

DBVisualizer でクエリを実行した結果(Salesforce の場合)。

おわりに

CData JDBC Driver for Smaregi の 30日間無償トライアル をダウンロードして、DbVisualizer でリアルタイムスマレジ のデータの操作をはじめましょう!ご不明な点があれば、サポートチームにお問い合わせください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。