Zoho DataPrep REST API
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
The Zoho DataPrep Rest APIsworkspace は、Zoho DataPrep チームが Postman 上で公開している API コレクションです。このワークスペースは、Zoho DataPrep の API を最大限に活用したい開発者向けの包括的なハブとして機能します。
ご不明点やご要望がありましたら、support@zohodataprep.com までお問い合わせください。
メモ: REST API のサポートは、US、EU、IN、JP、AU、CA、SA の各 DC で利用できます。
Postman で API コレクションにアクセスする
すぐに使い始められるよう、サンプルのリクエストとレスポンスを含んだ Zoho DataPrep REST APIs 用 Postman コレクションを提供しています。Zoho DataPrep REST APIs コレクションには、主な API セットが含まれています。コレクションをフォークしたら、シームレスに連携できるよう OAuth の必須手順を完了してください。
Zoho DataPrep の REST API ドキュメントには DataPrep 2.0 API が含まれており、ユーザーが所属する組織、組織内のワークスペース、ワークスペース内のすべてのパイプライン、パイプラインで実行されたすべてのジョブ、および特定のジョブ ID のジョブステータスを取得できます。
メモ: POST REST API は、パイプラインが Webhook として構成されている場合にのみ動作します。
Rest API を使用してパイプラインを実行するために、Webhook 実行を設定し、DataPrep UI でインポート設定を構成するには、次の手順に従ってください。
Webhook を使用してパイプラインをトリガーする
アドバイス: 実行ボタンを使ってパイプラインを試しにドライランしてみることをおすすめします。各実行は 1 件のジョブとして保存されます。
メモ: 1 つのパイプラインで設定できる実行タイプは 1 種類のみです。
Webhook の設定
3. Schedule のドロップダウンアイコンをクリックし、Webhook オプションをクリックします。
Webhook 設定
無効な値がある場合はエクスポートを停止: このオプションを有効にすると、データに無効な値が残っている場合にエクスポートを停止します。
エクスポートの順序
このオプションは、複数のデスティネーションを構成している場合に、どの順序でデータをデスティネーションへエクスポートするかを指定します。
有効にしない場合、エクスポートはデフォルトの順序で実行されます。
有効にしない場合、エクスポートはデフォルトの順序で実行されます。
メモ: このオプションは、パイプラインに 2 つ以上のデスティネーションを追加している場合にのみ表示されます。
エクスポート先デスティネーションの順序を並べ替えるには
1) エクスポートの順序 トグルをクリックします。
2) ドラッグ＆ドロップでデスティネーションの順序を変更し、保存をクリックします。
メモ: 順序を再度並べ替えたい場合は、順序を編集 リンクをクリックします。
インポート設定
4. Webhook を構成する際は、すべてのソースに対してインポート設定を行う必要があります。インポート設定を行わないと、Webhook 設定を保存できません。
インポート設定を行うには、ここを編集 リンクをクリックします。
インポート設定は、ソースの種類ごとに異なります。各種ソースのインポート設定方法については、こちらをクリックしてご確認ください。
5. Webhook 設定が完了したら、保存をクリックします。
Webhook はどのように動作しますか？
6. DataPrep で Webhook を有効にすると、一意の URL が生成され、受信 HTTP リクエストを待ち受けます。リクエストを受信すると、その Webhook に設定された特定のパイプラインがトリガーされます。
外部サービス側で、どのイベントで Webhook をトリガーするかを設定します。
6. DataPrep で Webhook を有効にすると、一意の URL が生成され、受信 HTTP リクエストを待ち受けます。リクエストを受信すると、その Webhook に設定された特定のパイプラインがトリガーされます。
外部サービス側で、どのイベントで Webhook をトリガーするかを設定します。
例えば、レコードの新規作成、既存レコードの更新、ファイルのアップロードなどのイベントをトリガーとして設定できます。そのうえで、API リクエストを使用して Webhook 実行を設定し、特定のイベントが発生したときに Webhook URL へ HTTP リクエストを送信するようにします。
イベントが発生すると（例: 新しいファイルが追加された場合など）、外部サービスから Webhook URL に HTTP リクエストが送信されます。このリクエストを DataPrep の Webhook が受信し、関連付けられたパイプラインが実行されます。
こちらをクリックして Webhook 実行の詳細を確認してください。
REST API または Webhook 実行で処理された行数をどのように計算しますか？
Zoho DataPrep では、処理された行の合計数が、ご利用プランの「処理済み行数」としてカウントされます。Webhook 実行で処理された行数は、DataPrep のジョブ概要ページで確認できます。
ジョブ概要ページに移動するには、各パイプラインからジョブオプションを選択するか、ジョブページで対象のジョブをクリックします。
ジョブ概要では、パイプラインフロー内のジョブの詳細が、次の 3 つのタブで表示されます。概要、Stages、Outputです。
合計の処理済み行数は、概要タブで確認できます。
合計の処理済み行数は、概要タブで確認できます。
各ジョブで実行されたステージごとの行数は、次の 3 つのセクションで確認できます。インポート、Transform、エクスポートで、Stagesタブに表示されます。
Output タブでは、各出力に対してエクスポートされた行数と列数を確認できます。
Output タブでは、各出力に対してエクスポートされた行数と列数を確認できます。
データパイプラインでデータをインポートして処理するとき（ステージを追加してパイプラインを作成する場合、ステージにルールを追加する場合、またはパイプラインを実行する場合など）、そのたびに「処理済み行数」が増加します。
処理済み行数には、結合、追加、ピボット、ピボット解除などの変換を実行する際に処理される行が含まれます。また、それにより作成される中間ステージで、子ステージを作成／更新するために処理される行数も、追加で「処理済み行数」としてカウントされます。
メモ:
1. ジョブ履歴から出力データをダウンロードしても、「処理済み行数」は増加しません。
2. 「処理済み行数」は、請求サイクルの開始時（通常は毎月）にリセットされます。
関連情報