Zoho DataPrep REST API

Zoho DataPrep REST API

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

The Zoho DataPrep Rest APIsworkspace は、Zoho DataPrep チームが Postman 上で公開しているコレクションです。このワークスペースは、Zoho DataPrep の API を最大限に活用したい開発者向けの包括的なハブとして機能します。

Zoho DataPrep REST APIs コレクションには、複数の API が含まれています。コレクションをフォークしたら、シームレスに連携できるよう、OAuth の必須手順を完了してください。

ご不明点やご要望がありましたら、support@zohodataprep.com までお問い合わせください。

Notes
メモ: REST API のサポートは US、EU、IN、JP、AU、CA、SA の各 DC で利用できます。

API コレクション

Zoho DataPrep の REST API ドキュメントには DataPrep 2.0 API が含まれており、ユーザーが所属する組織、その組織内のワークスペース、ワークスペース内のすべてのパイプライン、パイプラインで実行されたすべてのジョブ、および特定のジョブ ID のジョブステータスを取得できます。

前提条件

1. すべての API リクエストは HTTPS 経由で送信する必要があります。HTTP(暗号化なし)での通信は失敗します。
2. 以下から Api_base_url を選択し、API リクエスト URI で同じ値を使用してください。

US 用 Api_base_url = www.zohoapis.com/dataprep/v1

AU 用 Api_base_url = www.zohoapis.com.au/dataprep/v1

IN 用 Api_base_url = www.zohoapis.in/dataprep/v1

JP 用 Api_base_url = www.zohoapis.jp/dataprep/v1

CA 用 Api_base_url = www.zohoapis.ca/dataprep/v1

EU 用 Api_base_url = www.zohoapis.eu/dataprep/v1

SA 用 Api_base_url = www.zohoapis.sa/dataprep/v1


3. ユーザーは Zoho DataPrep の有効なアカウントを保有している必要があります。アカウントをお持ちでない場合は、Zoho DataPrep にユーザー登録するしてください。

クリック hereto 詳細はこちら about authentication and API コレクション hosted in Postman.

4. REST API は、パイプラインが Webhook として設定されている場合にのみ動作します。

以下の手順に従って Webhook 実行を設定し、DataPrep UI でインポート設定を行って、REST API を使用してパイプラインを実行します。

 Webhook を使用してパイプラインをトリガーする方法 

1. パイプラインを作成し、各ステージで必要な変換を適用し、データを1 つ以上のデスティネーションにエクスポートします。

2. パイプライン全体の作成が完了したら、
 
Idea
アドバイス: 実行ボタンを使用してパイプラインを試しに実行(ドライラン)してみることをおすすめします。各実行はジョブとして保存されます。

パイプライン実行が行われると、データソースから取得されたデータに対して、各ステージで適用した一連の変換が実行され、その後データがデスティネーションにエクスポートされます。この一連の処理はジョブ履歴に記録されます。まず手動実行が問題なく動作することを確認し、下書きオプションを選択してパイプラインを「準備完了」に設定します。その後、Webhook を設定してパイプラインをトリガーできます。 
 
Notesメモ: 1 つのパイプラインで同時に設定できる実行タイプは 1 種類のみです。


 
Webhook 設定

3. Scheduleドロップダウンアイコンをクリックし、Webhookオプションをクリックします。


Webhook 設定 

無効な値がある場合にエクスポートを停止: このオプションを有効にすると、データに無効な値が残っている場合にエクスポートを停止します。

エクスポート順序

このオプションは、複数のデスティネーションを設定している場合に、どの順序でデータを各デスティネーションへエクスポートするかを指定します。

有効にしない場合、エクスポートはデフォルトの順序で実行されます。
Notes
メモ: このオプションは、パイプラインに 2 つ以上のデスティネーションを追加している場合にのみ表示されます。


エクスポート先の順序を並べ替えるには

1) エクスポート順序トグルをクリックします。
2) ドラッグ&ドロップでデスティネーションの順序を変更し、保存をクリックします。

 
Notesメモ: 順序を再度並べ替えたい場合は、順序を編集リンクをクリックします。

インポート設定

4. Webhook を設定する際は、すべてのソースに対してインポート設定を必ず行う必要があります。インポート設定を行わないと、Webhook 設定を保存できません。
 


インポート設定を行うには、ここを編集リンクをクリックします。
 
インポート設定はソースごとに異なります。各種ソースに対してインポート設定を行う方法の詳細は、こちらをクリックしてご確認ください。
 
5. Webhook 設定が完了したら、保存をクリックします。

 Webhook はどのように動作しますか? 

6. DataPrep で Webhook を有効にすると、一意の URL が生成され、受信 HTTP リクエストを待ち受けます。リクエストを受信すると、その Webhook に設定された特定のパイプラインがトリガーされます。

外部サービス側で、どのイベントで Webhook をトリガーするかを設定します。

例えば、イベントとしては、新しいデータの作成、既存データの更新、ファイルのアップロードなどが挙げられます。そのうえで、API リクエストを使用して、特定のイベントが発生したときに Webhook URL に HTTP リクエストを送信する Webhook 実行を設定します。

Notes
メモ: この Webhook ベースのパイプライン実行は、1 時間に最大 4 回までしか実行できません。API のその他の利用方法については、REST API ドキュメントを参照してください。
イベントが発生すると(例: 新しいファイルが追加された場合)、外部サービスから Webhook URL に HTTP リクエストが送信されます。このリクエストは DataPrep の Webhook で受信され、その後、関連付けられたパイプラインが実行されます。

こちらをクリックして、Webhook 実行の詳細を確認してください。

REST API または Webhook 実行でトリガーされた実行の処理済み行数を計算する方法

Zoho DataPrep では、処理された行の合計数が、ご利用中のプランの「処理済み行数」としてカウントされます。Webhook 実行で処理された行数は、DataPrep のジョブ概要ページで確認できます。

ジョブ概要ページに移動するには、各パイプラインからジョブオプションを選択するか、ジョブページから対象のジョブをクリックします。



ジョブ概要では、パイプラインフロー内のジョブの詳細が、次の 3 つのタブで表示されます:概要ステージ出力です。
概要タブでは、処理された行の合計数を確認できます。

 

各ジョブで実行されたステージごとの行数は、インポート」「変換」「エクスポート」の 3 つのセクションに分けて、ステージタブで確認できます。



出力タブでは、各出力ごとにエクスポートされた行数と列数を確認できます。




データパイプラインでデータをインポートして処理するとき(ステージを追加してパイプラインを作成する場合、ステージにルールを追加する場合、またはパイプラインを実行する場合など)、そのたびに「処理済み行数」が増加します。

「処理済み行数」には、結合、追加、ピボット、ピボット解除などの変換を実行する際に処理される行が含まれます。また、それにより作成される中間ステージについても、子ステージを作成・更新するために処理された行数が、追加で「処理済み行数」としてカウントされます。

メモ:
1. ジョブ履歴から出力データをダウンロードしても、「処理済み行数」は増加しません
2. 「処理済み行数」は、請求サイクルの開始時(通常は毎月)にリセットされます。


関連情報

    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts









                                  • Related Articles

                                  • Zoho DataPrep MCPサーバー

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 概要 MCP とは? Model Context Protocol (MCP) は、アプリケーションが大規模言語モデル(LLM)とやり取りするための標準化された方法を定めるオープンなプロトコルです。MCP を使用すると、AI ...
                                  • Zoho DataPrep ユーザーガイド概要

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho ...
                                  • DataPrep 2.0の新機能とは?

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 DataPrep 2。+10、-10のリリースを発表できることを大変嬉しく思います。新規バージョンでは、エンドツーエンドのパイプラインを簡単に作成でき、データ品質の管理やデータ移動のコントロールも自在です。DataPrep ...
                                  • ジョブサマリーAPIレスポンス | Zoho DataPrep

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho DataPrepのJob 概要 APIは、パイプライン実行のステータス、タスク単位の監査、データセット、データソース、詳細エクスポートなど、パイプライン実行に関する包括的な概要を提供します。 ...
                                  • Freshdeskコネクタ for Zoho DataPrep [BETA]

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho ...

                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.