ディスカウントデータを取得する

ディスカウントデータを必要とするワークフローでは、[ディスカウントデータを取得] アクションを使用して、ストアからディスカウント情報を取得できます。

設定

フィールド

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

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

クエリ文字列

これは、コードを使用した有効なディスカウントを取得するためのクエリの例です。

method:code AND status:active

method変数とstatus変数は、ディスカウントのノードクエリで利用可能な絞り込みであり、複数回使用することや、他の変数と組み合わせることができます。

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

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

返されたデータ

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

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

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

{% for discount_item in getDiscountData %}
{% if discount_item.discount.__typename == "DiscountAutomaticApp" %}
- {{discount_item.discount.DiscountAutomaticApp.title}}
{% endif %}
{% endfor %}

トリガー

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

週に1回繰り返される、コードを使用した有効なディスカウントをチェックし、メールレポートを送信するワークフローの例。

このワークフローの例では、毎週月曜日の午前9時にワークフローが実行されるようにスケジュールが設定されています。[ディスカウントデータを取得] アクションは、コードを使用する有効なディスカウントのデータを収集するために使用されます。このアクションでは、ディスカウントの数がカウントされます。1つ以上のディスカウントが返された場合、詳細がメールで送信されます。

APIリファレンス

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

無料体験を試す