カーソル

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

この関数カードは、ポーリング監視イベントフロー内でのみ機能します。

カーソルカードが実行されると、フローのメタデータに値が保存され、ポーリング監視のスケジュールされた実行のAPIクエリをフィルタリングするために使用できます。

この値は、デプロイされたポーリング監視を使用してユーザーが作成する各フローに固有です。

通常、カーソルはAPIクエリフィルターとして使用するためのタイムスタンプ値を保存します。また、以前に記録された識別子のリストなど、ポーリング要求の状態値を保存することもできます。

ポーリング モニター イベントでカーソルを実装する最も簡単な方法は、タイムスタンプを使用して API をクエリすることです。このメソッドは新しいレコードまたは更新されたレコードを返します。ポーリング間で他のメタデータを保持するために複雑なカーソル オブジェクトは必要ありません。

カーソルカードを追加する

コネクタービルダーでポーリング監視イベントを作成すると、イベントカードにはCursor（カーソル）という名前の出力が含まれます。ポーリング監視イベントを作成すると、［Properties（プロパティー）］という名前の単一の入力が含まれ、出力がないカーソル関数カードも追加されます。

ポーリング監視が実行されるたびに、［Properties（プロパティー）］フィールドに渡される値は、ポーリング監視イベントカードの［Cursor（カーソル）］フィールドの新しい値になります。

カーソルカードは次の型をサポートします：Date & Time、Number、Text、Object。API呼び出しのフィルターを構築するために必要な任意の形式を使用できます。ポーリング監視カードの［Cursor（カーソル）］フィールドとカーソル関数カードの［Properties（プロパティー）］入力フィールドで指定された型は一致している必要があります。

ポーリング監視カードを更新する

ポーリング監視が初めて実行されるときは、ポーリング監視イベントカードの［Cursor（カーソル）］フィールドは空なので、フローでその最初の実行を処理する必要があります。［Cursor（カーソル）］フィールドが空の場合は、レコードを取得するためにAPIを呼び出すカードをスキップします。たとえば、カーソルにタイムスタンプを使用している場合は、Now関数カードを使用してカーソルを初期化します。ポーリング監視の後続の実行すべてには、フローによってカーソルカードが毎回呼び出されるため、値を持つ［Cursor（カーソル）］フィールドが含まれます。

クエリフィルタリングにカーソルを使用する

今後の実行では、ポーリング監視カードの［Cursor（カーソル）］フィールドに、前回の実行で割り当てられた値が含まれます。フローは、この値をAPIクエリのフィルターの開始点として、たとえばstartDateというパラメーターとして取得します。

APIクエリの終了点として別のデータポイントを作成します。たとえば、Now関数カードを呼び出すと、新しいendDateパラメーターが提供されます。次に、startDateパラメーターとendDateパラメーターをAPIクエリに指定します。パラメーター名は、APIサービスで指定されたフィルター名によって異なります。時間枠は、ポーリング監視が最後に実行されたときからポーリング監視の現在の実行までの期間です。

APIリクエストのフィルターとしてstartDateパラメーターとendDateパラメーターを使用します。レコードを取得した後、フローはカーソルカードの［Properties（プロパティー）］フィールドを更新し、スケジュールされた次回の実行で使用できるようにします。

カーソルカードを使用したポーリング監視イベントフローの例については、「ポーリング監視 イベントフローを構築する」を参照してください。

入力

フィールド	定義	タイプ	必須
プロパティ	ポーリング監視イベントクエリで使用する保存された値。 フィールドは次のいずれかの型になります。 日時 数値 テキスト オブジェクト 選択した型は、ポーリング監視イベントカードの［Cursor（カーソル）］出力フィールドと一致する必要があります。 このフィールドのサイズ制限は10 KBです。「コネクタービルダー機能制限」の「カーソルカード」を参照してください。	各種	TRUE

出力

このアクションカードには出力フィールドがありません。

関連項目

関数

ポーリング監視イベントフローを構築する

コネクタービルダー機能制限