現在のプランを確認
Suite、すべてのバージョン Team、Growth、Professional、EnterpriseまたはEnterprise Plus
Support Team、ProfessionalまたはEnterprise
この記事で説明する機能は、2026年5月11日から6月12日にかけて、すべてのSuiteプランおよびSupportプランを対象に順次利用可能になります。そのため、お客様のアカウントではこの機能がまだ表示されない場合があります。詳しくは、こちらの製品関連の告知をご覧ください。

REST APIは長年にわたりインテグレーションを実現するための標準として定着してきましたが、その柔軟性と効率性から、GraphQLが急速に普及しつつあります。インテグレーションビルダーの機能を活用すれば、GraphQL APIとのインテグレーションが可能です。必要なデータのみをリクエストしたり、複雑なクエリを容易に処理したりするなど、GraphQLの主要機能を活用できます。

この記事では、GraphQLスキーマの理解からクエリの作成、レスポンスの会話への組み込みまで、インテグレーションビルダーを使用してGraphQLリクエストを設定する手順を説明します。

GraphQLリクエストを設定するには

  1. 通常はAPIドキュメントに記載されているGraphQLエンドポイントURLを確認します（例：https://api.example.com/graphql、Shopifyの場合：https://{{storeName}}.myshopify.com/admin/api/2023-04/graphql.json）。
  2. そのURLをインテグレーションビルダーのインターフェイスに追加します。
    1. 「環境」に移動し、データをリクエストする場合はPOSTメソッドを選択します。
    2. URL入力欄にGraphQLエンドポイントを追加します。
  3. 認証方法を選択します（必要な場合）。
  4. 必要に応じて、ヘッダーに認証情報を追加します。たとえば、Shopifyとのインテグレーションの場合、次の画面のようになります。
  5. GraphQLスキーマを確認し、サーバーから返すデータを選択します。
  6. GraphQLサーバーからスキーマを取得します。

    スキーマには、利用可能なクエリ、ミューテーション、型が定義されています。Postman、GraphiQL、Apollo Explorerなどのツールを使用してスキーマを確認し、クエリのテストや調整を行います。

    Postmanでクエリを取得するには、「Code snippet」タブに移動し、キーが「query」のオブジェクトが含まれるデータを確認することをお勧めします。そのオブジェクトをコピーし、次のステップで使用します。
  7. 「本文」タブで、必要なデータ、または実行したいアクションを指定するGraphQLクエリを追加します。データを作成、更新、削除するミューテーションリクエストの場合もここで指定します。
    これはJSON形式で記述する必要があります。
    クエリの例：
    ```{"query":"{\n __type(name: \"Order\") {\n name,\n fields {\n name\n type {\n name\n kind\n }\n }\n }\n}","variables":{}}```
  8. 「成功」シナリオに移動し、セッションパラメータを追加します。
  9. JSONataを使用して、レスポンス内のデータにアクセスし、必要に応じて変換するためのクエリを作成します。以下の例を参考にしてください。

 

Powered by Zendesk