Paginate（ページ分け）

この関数カードはConnector Builderでのみ使用可能です。

ヘルパーフローを使用して、HTTP応答の複数のページをページ分けします。

Paginate関数カードを使用する際のベストプラクティスとその使用例については、以下のトピックを参照してください。

• Paginate: set a maximum page index

• Paginate: API endpoint

概要

内部のPaginate関数は「Do while」ループのように機能し、そのループで条件をチェックしてフローがループを停止する必要があるかどうかを判断します。

ループが始まると、オブジェクトが関数のobjectフィールドに渡されます。次に、ヘルパーフローがそのオブジェクト内の値を管理します。そのオブジェクト内の値が更新されると、それらの値が関数に返されます。停止条件が満たされない場合、オブジェクトは更新された値と一緒にヘルパーフローに戻されます。

入力

フィールド	定義	タイプ	必須
object	ヘルパーフローに渡されるオブジェクト。 offset、page_index、url、レコードの収集に使用されるリストオブジェクトなど、必要なだけいくつでもキーと値のペアを含むことができます。 オブジェクトは、反復を停止するタイミングを関数に指示できるように、break条件を保持するキーを含んでいる必要があります。このキーの値は、最初はFALSEに設定される必要があります。	オブジェクト	TRUE
path	このフィールドでは、関数がループを停止するタイミングを把握するために監視する必要があるオブジェクト内のキーの名前を指定します。 このキーは、通常は「break」という名前になり、オブジェクト内でFALSEに設定される必要があります。 反復を停止するには、ヘルパーフローがオブジェクトからこのpathフィールドを削除する必要があります。	テキスト	正
ヘルパーフロー	object入力に渡されるオブジェクトの処理に使用されるヘルパーフロー。	フロー	TRUE

出力

フィールド	定義	タイプ
output	新しい値を含むオブジェクト。	オブジェクト

例

Paginate関数を使用してオブジェクトを特定の回数反復処理する例については、「Paginate: set a maximum page index」を参照してください。