ヘルプ
ログイン

サブスクリプション契約データを取得する

サブスクリプション契約データを使用するワークフローでは、「サブスクリプション契約データを取得する」アクションを使用してストアからサブスクリプション契約情報を取得できます。

このページの内容

設定

フィールド

「サブスクリプション契約データを取得する」アクションには、クエリの作成に使用される以下のフィールドが含まれています。

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

クエリ文字列

これは、ステータスが ACTIVE のサブスクリプション契約を取得するためのクエリの例です。

status: ACTIVE

status 変数は、サブスクリプション契約クエリで利用できるフィルターで、複数回使用できます。

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

  • 利用可能なフィルターのリスト
  • クエリは特定の構文に従う必要があります。
  • クエリフィールドの値は、必ずしもマニュアルに記載されているとは限りません。値は、API ドキュメントで確認できる場合があります。また、管理画面で絞り込みを実行した際に、URL にフィールド値が表示されることもよくあります。たとえば、注文クエリの値をいくつか見つけるには、管理画面の [注文管理] ページで絞り込みを行ってから URL を確認します。
  • Shopify GraphiQL アプリを使用すると、ストアでクエリを実行またはテストできます。
  • クエリが失敗した場合の挙動にご注意ください。APIは、結果を返さないのではなく、すべての結果を返すことがよくあります。

返されるデータ

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

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

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

{% for single_contract in GetSubscriptionContractData %}
* {{ single_contract.name }}
{% endfor %}

トリガー

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

APIリファレンス