SQLAlchemy ORM を使って、Python でGMO MakeShop データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

GMO MakeShop Python Connector

GMO MakeShop データ連携用のPython Connector ライブラリ。pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにAutify をシームレスに統合。



CData Python Connector for GMO MakeShop を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でGMO MakeShop にOR マッピング可能に。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for GMO MakeShop は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで GMO MakeShop にデータ連携するPython アプリケーションを構築し、GMO MakeShop data をビジュアライズできます。 本記事では、SQLAlchemy でGMO MakeShop に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムGMO MakeShop data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。GMO MakeShop に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接GMO MakeShop 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

GMO MakeShop Data への接続

GMO MakeShop data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

GMO MakeShop に接続するには、MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId が必要です。

GMO MakeShop へのアクセスの設定

MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId を取得するには、以下の手順に従ってください。

  • GMO MakeShop には各API のAccessCode が必要です。
  • GMO MakeShop Store Manager にログインし、メニューの「ショップ作成」をクリックします。
  • 左ナビゲーションメニューの「外部システム連携」から任意の連携対象設定ををクリックします(メニューに表示されない場合は別途GMO MakeShop にご確認ください)。
  • 商品データ連携設定の場合:認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
  • 注文データ連携設定の場合:最初に「注文情報参照」と「注文情報変更」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、OrdersAccessCode を取得します。
  • 会員データ連携設定の場合:最初に「会員情報の(参照・登録・変更・削除)」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、MembersAccessCode を取得します。
  • 会員認証連携設定の場合:認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。

GMO MakeShop アカウントの認証

次の接続プロパティを設定して接続します。

  • ShopId:接続先のGMO MakeShop Store ID を設定。GMO MakeShop Store ID はログイン用の ID と同じです。
  • OrdersAccessCode:「注文データ連携設定」から取得した「認証コード」を設定。このプロパティは Orders テーブルにアクセスする場合に必要です。
  • ProductsAccessCode:「商品データ連携設定」から取得した「認証コード」を設定。このプロパティは Products テーブルにアクセスする場合に必要です。
  • MembersAccessCode:「会員データ連携設定」から取得した「認証コード」を設定。このプロパティは Members テーブルにアクセスする場合に必要です。
  • MemberAuthenticationCode:「会員認証連携設定」から取得した「認証コード」を設定。このプロパティは MemberAuthenticationConfirm を実行する場合に必要です。
  • Password:GMO MakeShop Store Manager のログインユーザーのパスワードを指定。このプロパティは ProductCategoryRegistrationOrModification,ProductMemberGroupPriceRegistrationOrModification,ProductOptionRegistrationOrModification,ProductRegistrationOrModification を実行する場合に必要です。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからGMO MakeShop に接続します。

必要なモジュールのインストールs

pip でSQLAlchemy ツールキットをインストールします:

pip install sqlalchemy

モジュールのインポートを忘れずに行います:

import sqlalchemy

Python でGMO MakeShop Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、GMO MakeShop data に連携するEngne を作成します。

engine = create_engine("gmomakeshop///?ShopId=MyShopId&ProductsAccessCode=MyProductsAccessCode&MembersAccessCode=MyMembersAccessCode&OrdersAccessCode=MyOrdersAccessCode")

GMO MakeShop Data のマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Products テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。

base = declarative_base()
class Products(base):
	__tablename__ = "Products"
	BrandCode = Column(String,primary_key=True)
	Price = Column(String)
	...

GMO MakeShop Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("gmomakeshop///?ShopId=MyShopId&ProductsAccessCode=MyProductsAccessCode&MembersAccessCode=MyMembersAccessCode&OrdersAccessCode=MyOrdersAccessCode")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Products).filter_by(BrandCode="99a87c0x3"):
	print("BrandCode: ", instance.BrandCode)
	print("Price: ", instance.Price)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Products_table = Products.metadata.tables["Products"]
for instance in session.execute(Products_table.select().where(Products_table.c.BrandCode == "99a87c0x3")):
	print("BrandCode: ", instance.BrandCode)
	print("Price: ", instance.Price)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

GMO MakeShop Data の挿入(INSERT)

GMO MakeShop data への挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、GMO MakeShop にすべての追加インスタンスを送ります。

new_rec = Products(BrandCode="placeholder", BrandCode="99a87c0x3")
session.add(new_rec)
session.commit()

GMO MakeShop Data を更新(UPDATE)

GMO MakeShop data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、GMO MakeShop にレコードを追加します。

updated_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.BrandCode = "99a87c0x3"
session.commit()

GMO MakeShop Data を削除(DELETE)

GMO MakeShop data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

製品の無償トライアル情報

GMO MakeShop Python Connector の30日の無償トライアル をぜひダウンロードして、GMO MakeShop data への接続をPython アプリやスクリプトから簡単に作成しましょう。