ウィジェット用JS API

ウィジェット用JS API

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

1. ウィジェット内のJS APIの利用

Zoho CreatorはJS API タスクを提供しており、これを利用してアプリケーションのウィジェット内からCRUD操作を実行することが可能です。これらのタスクは同一Creatorアカウント内の他のアプリケーションでデータを追加および操作するのを容易にします。基本的に、これらのタスクはCreatorのREST APIのラッパーとして機能します。API呼び出しがアプリケーション内のタスクを実行するための完了は、ターゲットアプリケーション内のウィジェットにアクセスしているユーザーに付与された権限によります。
2つの利用可能なJS APIバージョンは以下の通りです:
V1 - REST API V2に基づいています
V2 - REST API V2。1に基づいています(推奨)

- フィードバックマトリックスのユニークなカスタムフォームを作成することを目指しているとします。これはウィジェットとして構築し、ページに埋め込むことで達成できます。このフォームはウィジェット内に位置しているため、アプリケーションデータを操作する場合はJS API タスクを実行する必要があります。

2. 使用ケース

同一アプリケーション内でのデータ追加と更新 - プロジェクト管理アプリケーションにタイマーウィジェットを埋め込んだとします。従業員がプロジェクトを開始すると、ウィジェット内の開始するボタンをクリックします。この操作はプロジェクトタイムラインフォームにデータを追加します。従業員がプロジェクトを完了し、プロジェクト完了ボタンをクリックすると、同じデータが終了タイムラインで更新されます。データを追加するデータを更新するJS APIタスクをそれぞれ使用してこれを達成します。

3. JS APIの設定

ウィジェット内でJS APIタスクをスクリプトするためには、以下の設定を実行する必要があります。
手順 1 : ウィジェット郵便番号のHTMLファイルで実行する
下記のCDN URLをウィジェットのHTMLファイルのスクリプトタグにリンクすることで含めてください。このHTMLファイルは、ウィジェット郵便番号を作成する際に自動的に作成されます。
Notes
メモ :
  1. ウィジェット内で実行できるタスクは、特定のバージョンに関連するものに制限されています。例えば、ウィジェット内でJS API V2データ取得タスクを実行したいとしましょう。”差出人”でこのタスクを実行すれば、データはV2用のCDN URLをウィジェットのHTMLファイルにリンクしている場合にのみ取得されます。

手順 2 : ウィジェット郵便番号のJSファイルで実行する
自分のウィジェット郵便番号内にJSファイルを作成し、インタラクティブ要素を組み込んでいるはずです。同じファイル内でJS APIタスクのロジックをスクリプト化するためのブロックを使用してください。
Notes
JS API V1の要件:
V1では、JS APIタスクのロジックをスクリプト化する前に、CDN URLに存在するSDKを初期化する必要があります。ウィジェット郵便番号のJSファイルで以下の方法を使用してください:
  1. Zoho。CREATOR。init()
  2. .then(function(data) {
  3. //ここにコードを書く
  4. });

4. JS APIタスク

ウィジェット内で実行できるJS API V2タスクは以下のとおりです:
1. データAPIs
  1. IDによるデータ取得
  2. データ取得
  3. データの件数取得
  4. IDによるデータ更新
  5. データ更新
  6. IDによるデータ削除
  7. データ削除
 2. 公開APIs
  1. データ追加
  2. IDによるデータ取得
  3. データ取得 
 3. ファイルAPIs
  1. ファイルをアップロードする
  2. ファイルを読む
4. メタAPI
  1. フィールドを取得する
  2. フォームを取得する
  3. レポートを取得する
  4. ページを取得する
  5. セクションを取得する
  6. アプリケーションを取得する
  7. ワークスペースによるアプリケーションを取得する
5. ユーティリティAPI
  1. 画像データを設定する
  2. 親URLに移動する
  3. 初期化パラメーターを取得する
  4. クエリパラメーターを取得する
  5. ウィジェットパラメーターを取得する
Info
これらのタスクのいくつかはV1でのみサポートされています。JS API V1概要をご覧いただき、V1で実行可能なタスクについて詳細を確認してください。

5. メモを取得する点

バージョンごとの制限
  1. ウィジェット内で実行可能なタスクはバージョンに関連するものに限られます。例えば、ウィジェット内でJS API v2 データ取得タスクを実行したいとします。データは、ウィジェットのHTMLファイルにv2に関連するCDN URLをリンクしている場合にのみ取得されます。
  2. 現在のJS APIバージョンを切り替える必要がある場合、次の変更が必要です:
    1. ウィジェットのZIPファイルのHTMLファイルにあるCDN URLを必要なバージョンに変更します。
    2. SDKの初期化はJS API v1のみが必要です。ウィジェットのZIPファイルのJSファイル内で、必要なバージョンに基づいて初期化メソッドを追加または削除します。
    3. ウィジェットのZIPファイルのJSファイル内で、JS APIタスクの構文と設定パラメータを必要なバージョンに合わせて修正します。
ウィジェットファイルを変更した後、再アップロードが必要です。CDN URLが更新されると、前のバージョンのタスクは機能しなくなることに注意してください。
一般事項
  1. ウィジェットのファイル内のJSスクリプトを修正すると、ウィジェットが意図した通りに動作するためには変更されたファイルを再アップロードする必要があります。
  2. 設定内のタスクで必要な基本的なパラメーターを含めることを確認し、成功するように実行します。
  3. 公開APIタスクは、Creatorアカウントを持たない個人でもアクセスできる公開済みのページで動作します。

    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

                                • 「APIアクセス制御」

                                  お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho Creatorの REST API は、Zoho Creatorアプリケーションとインターフェイスするためにデータを取得、追加、更新、削除することを可能にします。APIアクセス制御ページでは、これらのAPIを使用してアクセスできるアプリケーションを制限することができます。 ...
                                • カスタムAPIの理解

                                  お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 このヘルプページは、Creator 6のユーザーを対象としています。あなたの Creator バージョンを特定してください。 1. このページの目的は何ですか? ...
                                • カスタムAPIステータスコード

                                  お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 カスタムAPIのリクエストが成功(完了)したか失敗したかは、そのレスポンス内のコードとメッセージで伝えられます。以下の表は、Zoho CreatorのカスタムAPIに関連するすべてのコードを一覧にしたものです。 HTTPステータスコード HTTPステータス コード メッセージ 説明 ...
                                • カスタムAPIの作成と管理

                                  お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 このヘルプページは、Creator 6のユーザーを対象としています。あなたのCreator バージョンを確認します。 1. このページで何がカバーされていますか? Zoho Creatorとの統合のためにカスタムAPIを作成し、それを認証する方法を探ります。 ...
                                • サードパーティAPIを使用してバーコードを生成する

                                  お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 要件 指定されたIMEI(海外モバイルEquipment Identity)番号を使用し、サードパーティAPIでバーコードを生成します。 ユースケース モバイルストアが順番管理アプリケーションを利用して注文を管理しています。このアプリケーションには ...

                                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.