ヘルプ
ログイン

コレクションのデータを取得する

コレクションデータが必要なワークフローでは、「コレクションのデータを取得する」アクションを使用して、ストアからコレクション情報を取得できます。

このページの内容

設定

フィールド

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

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

クエリ文字列

以下は、過去 1 日間に更新されたコレクションを取得するためのクエリの例です。

updated_at:<='{{ scheduledAt }}' AND updated_at:>'{{ scheduledAt | date_minus: "1 day" }}'

updated_at 変数は コレクションクエリ で利用できるフィルターで、複数回使用したり、他の変数と組み合わせたりできます。scheduledAt Liquid 変数は、「時間指定」トリガーを使用したワークフローで利用できます。date_minus Liquid タグは、日付から時間を減算できる特別な Flow タグです。

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

  • 利用可能なコレクションフィルターのリスト
  • クエリフィールドの値が、常にマニュアルに記載されているとは限りません。値は API ドキュメントで確認できる場合があります。あるいは、管理画面でフィルターを適用した際に、URL 内でフィールド値が見つかることがよくあります。たとえば、注文クエリの値をいくつか見つけるには、管理画面で注文管理ページにフィルターを適用し、URL を確認します。
  • Shopify GraphiQL アプリを使用すると、ストアでクエリを実行またはテストできます。
  • クエリが失敗した場合に何が起こるかに注意してください。多くの場合、API は (結果なしではなく) すべての結果を返します。

返されるデータ

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

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

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

{% for single_collection in GetCollectionData %}
* {{ single_collection.title }}
{% endfor %}

トリガー

このアクションは、「時間指定」トリガーなどのあらゆるワークフローで使用できます。「時間指定」トリガーを使用するワークフローでは、ワークフローはイベントの結果としてではなく、指定した時間に開始されます。ストアやアプリからの特定のイベントによってワークフローが開始されるわけではないため、データは自動的には含まれません。

APIリファレンス