JayDeBeApi を使って Python からShopify のデータにアクセス
Python と Java がインストールされている環境であれば、Python スクリプトと標準 SQL を使ってShopify のデータにアクセスできます。CData JDBC Driver for Shopify と JayDeBeApi モジュールを組み合わせることで、Python からリモートのShopify のデータを操作できます。CData ドライバーを使用することで、業界標準に準拠した実績のあるドライバーを Python という人気の高い言語で活用できます。この記事では、ドライバーを使って Shopify に SQL クエリを実行し、標準的な Python でShopify のデータを可視化する方法を説明します。
JayDeBeApi モジュールを使用
JayDeBeApi は、JDBC(Java Database Connectivity)のブリッジとして機能する Python ライブラリで、Python プログラムから CData JDBC ドライバーを含む Java データベースとやり取りできるようになります。pip install コマンドでモジュールをインストールします。
pip install JayDeBeApi
JDBC URL を作成
JayDeBeApi をインストールしたら、SQL を使って Python からShopify のデータを操作する準備が整います。
それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。
アクセストークンによる接続
アクセストークン経由の接続には、以下の2つのステップが必要です。
- Shopify の管理画面でアクセストークンを作成
- アクセストークンを使用して認証
アクセストークンの作成
まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。
- 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
- Develop apps をクリックしてCreate an app を選択します
- Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
- Save をクリックします
- Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです:
- unauthenticated_read_content
- Save をクリックします
- API Credentials を選択します
- "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
- Admin API Access token のアクセストークンをコピーします。注意:トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください
アクセストークンによる認証
続いて、アクセストークンで認証するには、以下のプロパティを設定してください。
- AuthScheme:AccessToken に設定
- AccessToken:カスタムアプリからコピーしたアクセストークンの値に設定
OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。
ビルトイン接続文字列デザイナー
JDBC URL の作成には、Shopify JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから実行します。
java -jar cdata.jdbc.shopify.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
以下は、一般的な JDBC 接続文字列を含む変数の例です。
jdbc_url = "jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;"
Python からShopify のデータにアクセス
JDBC URL を設定したら、あとは JDBC ドライバーの JAR ファイルへの絶対パスだけが必要です。これはインストールディレクトリの "lib" フォルダにあります(Windows では "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.shopify.jar")。
注意: まだ設定していない場合は、JAVA_HOME 環境変数を Java のインストールディレクトリに設定してください。
以下のようなコードで Shopify からデータを読み取り、表示できます。
import jaydebeapi
#The JDBC connection string
jdbc_url = "jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;"
username = "****"
password = "****"
#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.shopify.jar"
conn = jaydebeapi.connect(
"cdata.jdbc.shopify.ShopifyDriver",
jdbc_url,
[username, password],
jdbc_driver_jar,
)
cursor = conn.cursor()
cursor.execute("SELECT * FROM Customers;")
results = cursor.fetchall()
for row in results:
print(row)
cursor.close()
conn.close()
無料トライアルと詳細情報
CData JDBC Driver for Shopify の 30 日間無料トライアルをダウンロードして、Python でリアルタイムのShopify のデータを操作してみてください。ご不明な点がございましたら、サポートチームまでお問い合わせください。