ページ分け（Paginate）
この関数カードはWorkflowsコネクタービルダーでのみ使用可能です。
ヘルパーフローを使用して、HTTP応答の複数のページをページ分けします。
Paginate関数カードを使用する際のベストプラクティスとその使用例については、以下のトピックを参照してください。
概要
内部のPaginate関数は「Do while」ループのように機能し、そのループで条件をチェックしてフローがループを停止する必要があるかどうかを判断します。
ループが始まると、オブジェクトが関数のobjectフィールドに渡されます。次に、ヘルパーフローがそのオブジェクト内の値を管理します。そのオブジェクト内の値が更新されると、それらの値が関数に返されます。停止条件が満たされない場合、オブジェクトは更新された値と一緒にヘルパーフローに戻されます。
ページネーション関数では、pathフィールドを適切に使用することが重要です。適切に管理されない場合、フローは最大反復回数5,000に達するまで実行される可能性があります。
反復を停止するには、フローがオブジェクトからpathフィールドを削除する必要があります。
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
object |
ヘルパーフローに渡されるオブジェクト。
オブジェクトは、反復を停止するタイミングを関数に指示できるように、break条件を保持するキーを含んでいる必要があります。このキーの値は、最初は |
オブジェクト | 正 |
|
パス（path） |
このフィールドでは、関数がループを停止するタイミングを把握するために監視する必要があるオブジェクト（object）内のキーの名前を指定します。 このキーは、通常は 反復を停止するには、ヘルパーフローがオブジェクト（path）からこのpath（object）フィールドを削除する必要があります。 |
テキスト | 正 |
|
ヘルパーフロー（Helper Flow） |
object入力に渡されるオブジェクトの処理に使用されるヘルパーフロー。 |
フロー |
正 |
出力
| フィールド | 定義 | タイプ |
|---|---|---|
|
出力（output） |
新しい値を含むオブジェクト。 |
オブジェクト |
例
Paginate関数を使用してオブジェクトを特定の回数反復処理する例については、Paginate: set a maximum page indexを参照してください。