サブスクリプション契約のデータを取得する

このページはApr 27, 2024に印刷されています。最新のバージョンについては、https://help.shopify.com/ja/manual/shopify-flow/reference/actions/get-subscription-contract-dataをご覧ください。

サブスクリプション契約のデータを使用するワークフローでは、[サブスクリプション契約のデータを取得] アクションを実行して、サブスクリプション契約の情報をストアから取得できます。

目次

設定

フィールド

[サブスクリプション契約データを取得] アクションには、以下のフィールドが用意されており、これらのフィールドはクエリの作成に使用されます。

[データを取得] アクションで使用されるフィールド。
フィールド 説明
データの並べ替え方法 必須です。検索クエリから返されたデータを並べ替える際の基準になるパラメーターです。
結果の最大数 必須。選択した検索クエリが返すことのできる結果の最大数です。一度に最大100件返すことができます。
クエリ 必須。一般的なクエリから選択するか、[高度] を選択して自分でクエリを作成します。

クエリ文字列

これは、ステータスがACTIVEであるサブスクリプション契約データを取得するためのクエリの例です。

status: ACTIVE

変数statusは、サブスクリプション契約クエリで利用可能な絞り込みであり、複数回使用することができます。

以下の情報は、データのクエリ時に役立ちます。

  • 利用可能な絞り込みのリスト- クエリは特定の構文に従う必要があります。
  • 全クエリのクエリフィールド名は、QueryRootオブジェクトの開発者向けドキュメントで確認できます。
  • クエリフィールドの値が必ずしも文書化されているわけではありません。場合によっては、APIドキュメントを見ることで値を確認できます。あるいは、管理画面で絞り込みをするときに、URLからフィールドの値を確認できる場合がしばしばあります。たとえば、注文クエリの値を見つけるには、管理画面の注文ページを絞り込み、URLを確認します。
  • Shopify GraphiQLアプリを使用して、ショップでクエリを実行またはテストできます。
  • クエリが失敗した際に何が起きるかに注意します。多くの場合、APIはすべての結果を返します (何も返さないことはありません)。

返されたデータ

すべての [データを取得] アクションは、実行すると0〜100の任意のリソースを含むリストを返します。使用例に応じて、さまざまな方法でこのデータを使用することができます。

  • それぞれにタグを追加するなど、リストの各項目を個別に処理する必要がある場合は、[For each] アクションを実行します。
  • 返された結果の数をカウントするなど、データを集計する必要がある場合は、[カウント] アクションまたは [合計] アクションを実行します。
  • すべてのアイテムを記載したメールを送信するなど、リストを出力する必要がある場合は、返されたデータを後続のアクションで直接使用します。

このアクションに続く手順で、返されたデータにアクセスするには、サブスクリプション契約のリストである [サブスクリプション契約データを取得] という名前の変数を使用します。この変数は、条件とアクションの両方で使用できます。たとえば、以下のような [内部メールを送信する] アクションを実行して、注文のリストを送信することができます。

{% for single_contract in GetSubscriptionContractData %}
- {{ single_contract.name }}
{% endfor %}

トリガー

このアクションは、[予定時刻] トリガーが設定されたワークフローなど、どのワークフローでも実行できます。[予定時刻] トリガーが設定されたワークフローは、イベント発生時ではなく指定された時刻に起動します。ストア内やワークフローを起動するアプリ内で特定のイベントが発生しないため、データが自動的に取り込まれることはありません。

APIリファレンス

Shopifyで販売を開始する準備はできていますか?

無料体験を試す