ページデータを取得

ページデータを必要とするワークフローでは、ページデータを取得アクションを使用して、ストアからページ情報を取得できます。ページとは、オンラインストア上のウェブページであり、会社概要ページやお問い合わせページなど、変更されることの少ない情報が含まれています。

設定

フィールド

ページデータを取得アクションには、以下のフィールドが含まれています。

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

クエリ文字列

以下は、公開済みのページを取得するクエリの例です。

published_status:published

published_status 変数は、Pages クエリで使用できる絞り込みであり、複数回使用したり、他の変数と組み合わせたりすることができます。

データのクエリを実行する際、以下の点を知っておくと役立ちます。

  • 利用可能なページ絞り込みのリスト

  • クエリは特定の構文に従う必要があります

  • クエリのフィールド値は常にドキュメント化されているとは限りません。API ドキュメントを参照することで値を確認できる場合もあります。または、管理画面で絞り込みを実行した際、URL 内にフィールド値が見つかることもよくあります。たとえば、注文クエリの値を見つけるには、管理画面の [注文管理] ページで絞り込みを実行し、URL を確認します。

  • Shopify GraphiQL アプリを使用すると、ストアでクエリを実行またはテストできます。

  • クエリが失敗した場合の挙動に注意してください。多くの場合、API は (結果なしではなく) すべての結果を返します。

返されるデータ

すべてのデータを取得アクションは、0 から 100 件のリソースのリストを返します。ユースケースに応じて、このデータをさまざまな方法で使用できます。

  • それぞれのアイテムにタグ付けするなど、リストの各アイテムを個別に処理する必要がある場合は、For eachアクションを使用できます。
  • 返された結果の数をカウントするなど、データを集計する必要がある場合は、CountアクションまたはSumアクションを使用できます。
  • すべてのアイテムを含むメールを送信するなど、リストを出力する必要がある場合は、返されたデータを後続のアクションで直接使用できます。

このアクションに続くステップで返されたデータにアクセスするには、ページのリストであるページデータを取得という名前の変数を使用します。この変数は、条件とアクションの両方で使用できます。たとえば、次のような内部メールを送信アクションでページのリストを送信できます。

{% for single_page in getPageData %}
  * {{ single_page.title }} - {{ single_page.handle }}
{% endfor %}

トリガー

このアクションは、予定時刻トリガーを含むすべてのワークフローで使用できます。予定時刻トリガーを使用するワークフローでは、イベントの結果としてではなく、指定した時刻にワークフローが開始されます。ワークフローを開始する特定のイベントがストアやアプリ内に存在しないため、データが自動的に含まれることはありません。

API リファレンス

このアクションで使用される API の詳細については、Pages クエリを参照してください。