カタログデータを取得
カタログデータを必要とするワークフローでは、カタログデータを取得アクションを使用して、ストアからB2Bカタログの情報を取得できます。カタログとは、特定のB2Bのお客様や会社のロケーション向けにカスタマイズされた価格が設定された商品のグループです。
このページの内容
設定
フィールド
カタログデータを取得アクションには、以下のフィールドが含まれています。
| フィールド | 説明 |
|---|---|
| データの並べ替えの基準 | 必須。検索クエリによって返されるデータを並べ替えるためのパラメーターです。 |
| 結果の最大数 | 必須。選択した検索クエリによって返される結果の最大数です。一度に最大 100 件まで返すことができます。 |
| クエリ | 必須。一般的なクエリから選択するか、高度な設定 を選択して独自のクエリを作成します。 |
クエリ文字列
これは、すべてのアクティブなカタログを取得するためのクエリの例です。
status:ACTIVEstatus 変数は、カタログクエリで利用できる絞り込みであり、複数回使用したり、他の変数と組み合わせたりできます。
データのクエリを実行する際、以下の点を知っておくと役立ちます。
クエリは特定の構文に従う必要があります
クエリフィールドの値は常にドキュメント化されているとは限りません。場合によっては、API ドキュメントを参照して値を確認できることがあります。あるいは、管理画面で絞り込みを実行した際の URL にフィールド値が含まれていることもよくあります。たとえば、注文クエリのいくつかの値を確認するには、管理画面の [注文管理] ページで絞り込みを行い、URL を確認します。
Shopify GraphiQL アプリを使用すると、ストアでクエリを実行またはテストできます。
クエリが失敗した場合にどうなるかに注意してください。多くの場合、API は (結果なしではなく) すべての結果を返します。
返されるデータ
すべての データを取得 アクションは、0 ～ 100 件のリソースのリストを返します。ユースケースに応じて、このデータをさまざまな方法で使用できます。
- リストアイテムごとにタグを追加するなど、リストの各アイテムを個別に処理する必要がある場合は、For each アクションを使用できます。
- 返された結果の数をカウントするなど、データを集計する必要がある場合は、Count または Sum アクションを使用できます。
- すべてのアイテムを含むメールを送信するなど、リストを出力する必要がある場合は、返されたデータを後続のアクションで直接使用できます。
このアクションに続くステップで返されたデータにアクセスするには、カタログのリストである Get catalog data という名前の変数を使用します。この変数は、条件とアクションの両方で使用できます。たとえば、次のように Send internal email アクションでカタログのリストを送信できます。
{% for single_catalog in getCatalogData %}
* {{ single_catalog.title }}
{% endfor %}トリガー
このアクションは、予定時刻 トリガーを含む任意のワークフローで使用できます。予定時刻 トリガーを使用するワークフローでは、イベントの結果としてではなく、指定した時刻にワークフローが開始されます。ストア内やアプリからの特定のイベントによってワークフローが開始されるわけではないため、データが自動的に含まれることはありません。
API リファレンス
このアクションで使用される API の詳細については、カタログクエリを参照してください。