バージョン2.0とバージョン1.0の比較
Zoho APIはバージョン2.0への更新により、APIと関数（以前のカスタム関数）の使い方が大きく変更されました。APIの動作はほとんど同じですが、構文、出力、メソッドが異なります。
このドキュメントでは、2つのAPIの違いを踏まえながらバージョン2.0の詳細について解説します。
バージョン2.0での変更点：
- APIでサポートされるレスポンス形式と入力形式はJSONのみです。
- APIは、OAuth 2.0プロトコルを使って認証されます。
- バージョン2.0では、バージョン1.0 APIのような表示ラベルではなく、タブ、項目、関連リストのAPI名を使用します。
- API呼び出し制限は、バージョン1.0ではPSTタイムゾーンに基づいていましたが、バージョン2.0では24時間ごとに集計されます。
- 日時の値は、ISO 8601の日時の形式（2018-03-28T10:32:45+05:30）に対応しています。
- $で始まるAPI名はすべて、表示専用の属性です。
- データをGETする際、空の項目のレスポンスはJSON Nullになります。
- タブのAPI名は、"https://www.zohoapis.com/crm/v2/settings/modules"（リクエストURL）を使用して取得できます。
- 追加や更新のAPIでは、キー"trigger":["approval","workflow","blueprint"]を使用することで、すべてのデータに対するワークフロー、承認、Blueprint（ブループリント）などの自動処理を実行できます。
- GET APIでは、レスポンスにinfo JSONObjectが含まれます。例：
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}- page：データを取得する対象のページを指定してください。デフォルト値は1です。
- per_page：ページごとに取得するデータの数を指定してください。デフォルト値は200です。
- more_records：取得したデータの他にさらにデータがあるかを確認し、追加のAPI呼び出しを行うかどうかの参考にできます。
- getMyRecords（バージョン1.0 API）は、バージョン2.0 APIではsearchRecordsを使用して取得できます。
項目の属性の変更点：
| APIバージョン1.0 | APIバージョン2.0が該当する項目の属性 |
|---|---|
| {MODULE}ID（例：LEADID、CONTACTID、など） | id |
| SMOWNERID | Owner JSONObjectのid |
| {MODULE} 担当者（例：Lead Owner、Case Owner） | nameはJSONObjectのOwnerに渡されます。 |
| SMCREATORID | idはJSONObjectのCreated_Byに渡されます。 |
| Created By | nameはJSONObjectのCreated_Byに渡されます。 |
| MODIFIEDBY | idはJSONObjectのModified_Byに渡されます。 |
| Modified By | nameはJSONObjectのModified_Byに渡されます。 |
項目の形式の種類：
| 項目の種類 | バージョン1.0の形式 | バージョン2.0の形式 |
|---|---|---|
| 単一行 | <FL val="Single_Line 1"> <![CDATA[this is single line]]> </FL> | "Single_Line_1": "This is single line", |
| 複数行 | <FL val="Multi-Line 1"><![CDATA[this is multi line second line]]></FL> | "Multi_Line_1": "This is \multi line\second line", |
| メールアドレス | <FL val="Email"><![CDATA[email@zoho.com]]><FL> | "Email_1": "email1@email.com", |
| 電話番号 | <FL val="Phone 1"><![CDATA[9900000000]]></FL> | "Phone_1": "9900000000", |
| 選択リスト | <FL val="picklist1"><![CDATA[one]]></FL> | "picklist1": "one", |
| Multi-select Picklist | <FL val="Multi-Select 1"><![CDATA[Option1;Option 2]]></FL> | "Multi_Select_1": [ "Option 1", "Option 2" ] |
| 日付 | <FL val="Date 1"><![CDATA[2018-03-29]]></FL> | "Date_1": "2018-03-29", |
| 日付/時刻 | <FL val="Date/Time 1"><![CDATA[2018-04-07 10:00:00]]></FL> | "Date_Time_1": "2018-04-07T10:00:00+05:30", |
| 数値 | <FL val="Number 1"><![CDATA[50000]]></FL> | "Number_1": 50000, |
| 通貨 | <FL val="Currency 1"><![CDATA[230000500]]></FL> | "Currency_1": 230000500, |
| 小数 | <FL val="Decimal 1"><![CDATA[1234.9]]></FL> | "Decimal_1": 1234.9, |
| パーセント | <FL val="Percent 1"><![CDATA[12.3]]></FL> | "Percent_1": 12.3, |
| 長整数 | <FL val="Long Integer 1"><![CDATA[6780000000780000]]></FL> | "Long_Integer_1": "6780000000780000", |
| 真偽値 | <FL val="Checkbox 1"><![CDATA[true]]></FL> | "Checkbox_1": true, |
| URL | <FL val="URL 1"><![CDATA[https://www.zoho.com]]></FL> | "URL_1": "https://www.zoho.com", |
| ルックアップ | <FL val="Lookup 1"><![CDATA[9500495sam]]></FL> | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
| データの担当者 | <FL val="SMOWNERID">1386586000000078001</FL> <FL val="Lead Owner"<>![CDATA[BruceWills]]></FL> | "Owner": { "name": "Bruce Wills", "id": "1386586000000078001" }, |
| レイアウト | N/A | "Lookup_1": { "name": "9500495sam", "id": "1386586000001815005" } |
APIメソッド
| メソッド名 | 目的 |
|---|---|
| getRecords | APIリクエストで指定したすべてのユーザーのデータを取得するには |
| getRecordById | データのIDで個々のデータを取得するには |
| getDeletedRecordIds | ごみ箱にある削除済みのデータからIDリストを取得するには |
| insertRecords | Zoho CRMの特定のタブにデータを追加するには |
| updateRecords | Zoho CRMのデータを更新または変更するには |
| getSearchRecordsByPDC | 標準で用意されている項目に基づき値を検索するには |
| deleteRecords | 選択したデータを削除するには |
| convertLead | 見込み客を商談、取引先、連絡先に変換するには |
| getRelatedRecords | メインのタブに関連付けられているデータを取得するには |
| getFields | タブで使用できる項目の詳細を取得するには |
| updateRelatedRecords | データに関連付けられている別のデータを更新するには |
| getUsers | 組織内のユーザーの一覧を取得するには |
| uploadFile | データにファイルを添付するには |
| delink | データの関連付けを解除するには |
| downloadFile | データに添付されているファイルをダウンロードするには |
| deleteFile | データに添付されているファイルを削除するには |
| uploadPhoto | 写真を連絡先・見込み客に追加するには |
| downloadPhoto | 連絡先・見込み客の写真をダウンロードするには |
| deletePhoto | 連絡先・見込み客の写真を削除するには |
| getModules | Zoho CRMアカウントのすべてのタブを取得するには |
| searchRecords | 検索条件に一致するデータを取得するには |