ギフトカードデータを取得する

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

重要な点として、ストアには、ギフトカードを生成するために使用されるギフトカード商品と、お客様が購入に利用できる実際のギフトカードであるギフトカード自体の両方があります。[ギフトカードデータを取得] アクションは、ギフトカード自体の情報を取得します。ギフトカード商品に関する情報を取得するには、[商品データを取得] アクションまたは [商品バリエーションデータを取得] アクションを使用します。

設定

フィールド

[ギフトカードデータを取得] アクションには、クエリの作成に使用される以下のフィールドが含まれています。

クエリ文字列

過去 1 日間に更新されたギフトカードを取得するためのクエリの例は、以下のとおりです。

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

created_at 変数はギフトカードクエリで利用できるフィルターで、複数回使用したり、他の変数と組み合わせたりすることができます。scheduledAt Liquid 変数は、[スケジュールされた時間] トリガーを使用したワークフローで利用できます。date_minus Liquid タグは、日付から時間を減算できる特別な Flow タグです。

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

• 利用可能なギフトカードフィルターの一覧

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

• クエリフィールドの値は、常にドキュメント化されているとは限りません。場合によっては、API ドキュメントで値を確認できます。別の方法として、管理画面でフィルターを適用したときに、URL 内でフィールド値が見つかることがよくあります。たとえば、注文のクエリ値を確認するには、管理画面で注文管理ページにフィルターを適用してから URL を確認します。

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

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

返されるデータ

すべての Get data アクションは、0～100 件のリソースのリストを返します。ユースケースに応じて、このデータをさまざまな方法で使用することができます：

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

このアクションに続くステップで返されたデータにアクセスするには、Get gift card data という名前の変数を使用します。これはギフトカードのリストで、条件とアクションの両方で使用することができます。たとえば、次のように Send internal email アクションでギフトカードのリストを送信できます。

{% for single_gift_card in GetGiftCardData %}
* {{ single_gift_card.name }}
{% endfor %}

トリガー

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

API の詳細

• ギフトカードリソース
• ギフトカードクエリフィルター