Shopify
Shopify コネクタを使用すると、Shopify で挿入、削除、更新、読み取りのオペレーションを実行できます。
サポート対象のバージョン
このコネクタは、Shopify Admin API をリレーショナル データベースとしてモデル化します。
準備
Shopify コネクタを使用する前に、次の作業を行います。
- Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。
- 次のサービスを有効にします。
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。
コネクタを構成する
コネクタを構成するには、データソース(バックエンド システム)への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続の作成] ページを開きます。
- [ロケーション] セクションで、接続のロケーションを選択します。
- リージョン: プルダウン リストからロケーションを選択します
サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
- [NEXT] をクリックします。
- リージョン: プルダウン リストからロケーションを選択します
- [接続の詳細] セクションで、次の操作を行います。
- コネクタ: 使用可能なコネクタのプルダウン リストから [Shopify] を選択します。
- コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。
接続名は次の条件を満たす必要があります。
- 接続名には英字、数字、ハイフンを使用できます。
- 文字は小文字のみを使用できます。
- 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
- 接続名は 49 文字以内で指定してください。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは
Error
に設定されています。 - サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- 必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。
- App Id: 管理 API の AppId。
- 呼び出しあたりの最大ポイント数: 呼び出しごとにかかるポイントの数を指定します。
- スキーマ: 接続する Shopify サーバーのバージョンを指定します。
- Use proxy: このチェックボックスを選択して、接続用のプロキシ サーバーを構成し、次の値を構成します。
-
Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
- 基本: 基本的な HTTP 認証。
- ダイジェスト: ダイジェスト HTTP 認証。
- Proxy User: プロキシ サーバーでの認証に使用されるユーザー名。
- プロキシ パスワード: ユーザーのパスワードの Secret Manager シークレット。
-
Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次の認証タイプがサポートされています。
- 自動: デフォルトの設定。URL が HTTPS URL の場合は、[トンネル] オプションが使用されます。URL が HTTP URL の場合、[なし] オプションが使用されます。
- 常に: 接続は常に SSL 対応です。
- なし: 接続は SSL に対応していません。
- トンネル: 接続はトンネリング プロキシ経由で行われます。プロキシ サーバーがリモートホストへの接続を開き、トラフィックはプロキシを経由するようになります。
- [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
- [+ 宛先を追加] をクリックします。
- [宛先の種類] を選択します。
- Host address: 宛先のホスト名または IP アドレスを指定します。
バックエンドへのプライベート接続を確立する場合は、次のようにします。
- PSC サービス アタッチメントを作成します。
- エンドポイント アタッチメントを作成し、続いて [Host address] フィールドにあるエンドポイント アタッチメントの詳細を入力します。
- Host address: 宛先のホスト名または IP アドレスを指定します。
- 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
- [NEXT] をクリックします。
- [宛先] セクションに、接続するリモートホスト(バックエンド システム)の詳細を入力します。
- 宛先の種類: 宛先の種類を選択します。
- リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
- バックエンド システムへのプライベート接続を確立する場合は、リストからエンドポイント アタッチメントを選択し、次にエンドポイント アタッチメントリストから必要なエンドポイント アタッチメントを選択します。
セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォール ルールを構成します。
他の宛先を入力するには、[+ 宛先を追加] をクリックします。
- [NEXT] をクリックします。
- 宛先の種類: 宛先の種類を選択します。
-
[認証] セクションで、認証の詳細を入力します。
- Shopify 接続に認証は必要ありません。
- [NEXT] をクリックします。
- Review: 接続と認証の詳細を確認します。
- [作成] をクリックします。
エンティティ、オペレーション、アクション
すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。
- エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、
Entities
リストは空になります。 - オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは
Operations
リストに含まれません。 - アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、
Actions
リストが空になります。
エンティティ オペレーションの例
例 - すべてのプロダクトを一覧表示する
この例では、Products
エンティティ内のすべてのレコードを一覧表示します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からProducts
を選択します。- [
List
] オペレーションを選択してから、[完了] をクリックします。
例 - 購入者の詳細を取得する
この例では、指定した購入者の詳細を Customers
エンティティから取得します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からCustomers
を選択します。- [
Get
] オペレーションを選択し、[完了] をクリックします。 - 詳細を取得する購入者のエンティティ ID を入力します。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに
365009521884E12
を入力します。
例 - 注文レコードを削除する
この例では、指定した注文を Order
エンティティから削除します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からOrder
を選択します。- [
Delete
] オペレーションを選択し、[完了] をクリックします。 - 削除する注文のエンティティ ID を入力します。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに
475009571483E15
を入力します。
例 - 購入者を追加する
この例では、指定した購入者を Customer
エンティティに追加します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からCustomer
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "FirstName": "Test", "LastName": "Customer5" }
この例を実行すると、コネクタタスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 6448083206296 }
例 - DiscountCode にレコードを作成する
この例では、DiscountCode
エンティティに新しいレコードを作成します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDiscountCode
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "PriceRuleId": 1.394097291568E12, "Code": "FREESHIP2025798" }
この例を実行すると、コネクタタスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 1.97836790828E13, "PriceRuleId": null }
例 - Pricerule にレコードを作成する
この例では、Pricerule
エンティティに新しいレコードを作成します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPricerule
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Id": 7.13459564696E11, "AllocationMethod": "each", "CustomerSelection": "all", "TargetType": "line_item", "UsageLimit": 100.0, "Title": "DP_PriceRule" }
この例を実行すると、コネクタタスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 197836790834, "PriceRuleId": null }
例 - ProductVariant にレコードを作成する
この例では、ProductVariant
エンティティに新しいレコードを作成します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からProductVariant
を選択します。- [
Create
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Id": 1070325065, "ProductId": 7652181016728, "ImageId": null, "Price": 1, "CompareAtPrice": null, "Title": "Yellow", "Barcode": null, "FulfillmentService": "manual", "InventoryManagement": "shopify", "InventoryPolicy": "deny", "InventoryQuantity": 1070325069, "Option1": "Yellow", "Option2": null, "Option3": null, "Position": 5, "Sku": "", "Taxable": true }
この例を実行すると、コネクタタスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 42711984373912 }
例 - 購入者の詳細を更新する
この例では、Customer
エンティティで指定された購入者の詳細を更新します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からCustomer
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "FirstName": "Test", "LastName": "Customer2" }
- 削除する購入者のエンティティ ID を入力します。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに
648400653532
を入力します。[entityId] を指定する代わりに、[filterClause] を
648400653532
に設定することもできます。この例を実行すると、コネクタタスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 648400653532 }
例 - ProductVariant にレコードを更新する
この例では、ProductVariant
エンティティに レコードを作成します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からProductVariant
を選択します。- [
Update
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProductId": 7.652181016728E12, "ImageId": null, "Price": 200.0, "CompareAtPrice": null, "Title": "Yellow Updated", "Barcode": null, "FulfillmentService": "manual", "InventoryManagement": "shopify", "InventoryQuantity": 1.070325069E9, "Option1": "Yellow new", "Option2": null, "Option3": null, "Position": 5.0, "Sku": "", "Taxable": true }
- 更新するレコードのエンティティ ID を指定します。
エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「
34601602744472
」と入力します。この例を実行すると、コネクタタスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 2484258073471 }
Terraform を使用して接続を作成する
Terraform リソースを使用して、新しい接続を作成できます。Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。
接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。
Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
max_points_per_call | STRING | False | 通話ごとにかかるポイントの数を指定します。 |
schema_v23 | ENUM | False | 接続する Shopify サーバーのバージョンを指定します。サポートされている値は、REST-2023-04、REST-2023-07、GRAPHQL-2023-04、GRAPHQL-2023-07 です。 |
proxy_enabled | BOOLEAN | False | 接続用のプロキシ サーバーを構成するには、このチェックボックスをオンにします。 |
proxy_auth_scheme | ENUM | False | ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。 |
proxy_user | STRING | False | ProxyServer プロキシへの認証に使用されるユーザー名です。 |
proxy_password | SECRET | False | ProxyServer プロキシの認証に使用されるパスワード。 |
proxy_ssltype | ENUM | False | ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。 |
統合で Shopify 接続を使用する
接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。
- Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
- Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。