Zoho DataPrep REST API
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
Zoho DataPrep Rest APIsワークスペースは、Zoho DataPrep チームがキュレーションしたコレクションを Postman 上にホストしています。本ワークスペースは、Zoho DataPrep の API を最大限に活用したい開発者向けの総合的なハブです。
Zoho DataPrep REST APIs コレクションには、複数の API が含まれています。コレクションをフォークした後は、シームレスな連携のために OAuth の必須ステップを完了してください。
ご質問やご提案がございましたら、サポート@zohodataprep.comまでお問い合わせください。
メモ: REST APIs サポートは US、EU、IN、JP、AU、CA、SA の各 DC で利用可能です。
API コレクション
Zoho DataPrep の REST API ドキュメントには、DataPrep の 2。+10、-10 の API が含まれています。ユーザーはこれらを利用して所属する組織、組織内のワークスペース、ワークスペース内のすべてのパイプライン、パイプラインで実行されたすべてのジョブ、および特定のジョブ ID のジョブステータスを取得できます。
前提条件
1. すべての API リクエストは HTTPS 経由で行う必要があります。プレーンな HTTP での通信は失敗します。
2. 以下から Api_base_url を選択し、API リクエスト URI で使用してください。
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. API を利用するには、有効な Zoho DataPrep アカウントが必要です。未取得の場合は、ユーザー登録を行ってください。
こちらをクリックして、認証や Postman でホストされている API コレクションの詳細をご覧ください。
4. REST APIs はパイプラインが Webhook として設定されている場合のみ動作します。
以下の手順に従い、Webhook 実行の設定および DataPrep UI での設定インポートを行い、Rest API でパイプラインを実行してください。
Webhookを使用してパイプラインをトリガーする方法
アドバイス: パイプラインのテスト実行を「実行」ボタンでお試しください。各実行はジョブとして保存されます。
メモ: パイプラインには一度に1種類の実行タイプのみ設定できます。
Webhookの設定
3. Schedule ドロップダウンアイコンをクリックし、Webhook オプションをクリックします。
Webhook 設定
データに無効な値がある場合、エクスポートするを停止する: これを有効にすると、データに無効な値が残っている場合、エクスポートが停止されます。
順番エクスポート
このオプションは、複数の送信先を設定した場合に、データをどの順番で送信先へエクスポートするかを決定します。
有効にしない場合は、エクスポートは初期設定の順番で実行されます。
有効にしない場合は、エクスポートは初期設定の順番で実行されます。
メモ: このオプションは、パイプラインに2つ以上の送信先を追加している場合のみ表示されます。
エクスポート先の順番を並べ替える方法
1) 順番エクスポート トグルをクリックします。
2) ドラッグ＆ドロップで送信先の順番を変更し、保存 をクリックします。
メモ: 順番を再度並べ替える場合は、編集 順番 リンクをクリックしてください。
インポートする configuration
4. Webhookの設定時に、インポートする configurationはすべてのデータ元に対して必ず設定する必要があります。インポートする configurationを設定しないと、Webhookの設定を保存できません。
「編集はこちら」リンクをクリックし、インポートする configurationを設定してください。
インポートする configurationはデータ元によって異なります。こちらをクリックすると、各種データ元におけるインポートする設定方法の詳細をご覧いただけます。
5. Webhookの設定が完了したら、「保存」をクリックしてください。
Webhookはどのように機能しますか？
6. WebhookをDataPrepで有効にすると、固有のURLが生成され、HTTPリクエストの受信を待機します。リクエストが受信されると、このWebhookは指定されたパイプラインを実行するように設定されます。
外部サービスで、Webhookをトリガーするイベントを設定してください。
6. WebhookをDataPrepで有効にすると、固有のURLが生成され、HTTPリクエストの受信を待機します。リクエストが受信されると、このWebhookは指定されたパイプラインを実行するように設定されます。
外部サービスで、Webhookをトリガーするイベントを設定してください。
例として、新規データの作成、既存データの変更、ファイルのアップロードなどのイベントが挙げられます。その後、APIリクエストを利用し、特定のイベントが発生した場合にWebhook URLへHTTPリクエストを送信するWebhook実行を設定します。
メモ: このWebhookベースのパイプライン実行は、1時間に4回のみ実行できます。APIのさらに詳しい内容については、REST APIドキュメントをご参照ください。
イベントが発生すると（例：新規ファイルが追加された場合）、外部サービスがWebhook URLにHTTPリクエストを送信します。このリクエストはDataPrepのWebhookで受信され、その後、関連付けられたパイプラインが実行されます。
こちらをクリックするとWebhook実行の詳細をご覧いただけます。
Rest APIまたはWebhook実行による処理済み行数の計算方法
Zoho DataPrepでは、処理済みの行の合計数がご利用プランの「処理済み行数」としてカウントされます。Webhook実行で処理された行数は、DataPrepのジョブ概要ページで確認できます。
ジョブ概要ページに移動するには、各パイプラインからジョブオプションを選択するか、ジョブページからジョブをクリックしてください。
Job 概要は、ジョブの詳細をパイプラインフロー内で、3つの異なるタブ（概要、Stages、Output）で表示します。
概要タブでは、処理済みの合計行数が表示されます。
概要タブでは、処理済みの合計行数が表示されます。
各ジョブのステージごとの行数は、3つのセクション（インポートする、Transform、エクスポートする）でStagesタブに表示されます。
Outputタブでは、各出力ごとにエクスポート済みの行数と列数が表示されます。
Outputタブでは、各出力ごとにエクスポート済みの行数と列数が表示されます。
データがインポートされてデータパイプラインで処理済みになると、パイプラインの作成時にステージを追加した場合や、ステージ内でルールを追加した場合、またはパイプラインを実行した場合に「rows 処理済み」件数が増加します。
処理済みとなる行には、参加する・Append・Pivot・Unpivotの各変換で処理される行が含まれ、「rows 処理済み」としてカウントされます。また、それにより作成される中間ステージでも、子ステージの作成や更新のために処理される行数も「rows 処理済み」に追加してカウントされます。
メモ:
1. job履歴から出力データをダウンロードしても、「rows 処理済み」件数は増加しません。
2. 「rows 処理済み」件数は請求間隔の開始時、毎月リセットされます。
関連情報
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho Campaigns Resources
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
Zoho DataPrep - ユーザーガイドの概要
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho ...Freshdeskコネクタ for Zoho DataPrep [BETA]
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho DataPrep を利用すると、Freshdesk からサポートチケットデータをインポートしてデータ準備を行うことができます。また、Freshdesk からのヘルプデスクデータのインポートを定期的にスケジュールすることも可能です。このコネクターにより、ETL ...Zoho DataPrep用Dataikuコネクタ
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho ...Odooコネクタ for Zoho DataPrep [BETA]
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho DataPrep は、ERP プラットフォームである Odoo ...Zoho DataPrep用Salesforceコネクタ
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho ...