![CRM/SFA#[br]使い方診断](/sites/zweb/images/jp/crm/jpc-prdh-banner-2-usage-diagnosis.png)
![15日間の#[br]やることリスト](/sites/zweb/images/jp/crm/jpc-prdh-banner-3-15day-todo-list.png)
getCVRecordsメソッド
目次
目的
getCVRecordsメソッドを使用すると、Zoho CRMのカスタムビューに関するデータを取得できます。
重要：Zoho CRMプランに関係なく、1日に送信できるAPIリクエストは250件までです。リクエストごとに、最大200件のデータを取得できます。
リクエストURL
XML形式：
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Name of Custom View
JSON形式：
https://crm.zoho.com/crm/private/json/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Name of Custom View
リクエストパラメーター
| パラメーター | データ型 | 説明 |
| authtoken* | 文字列 | Zoho認証情報の認証に使用する、暗号化された英数字文字列。 |
| scope* | 文字列 | 値をcrmapiと指定してください。 |
| fromIndex | 整数 | デフォルト値 - 1 |
| toIndex | 整数 | デフォルト値 - 20 最大値 - 200 |
| cvName* | 文字列 | 指定したカスタムビューのデータを取得してください。 例：cvName=All Open Leads |
| lastModifiedTime | 日時 | デフォルト値：null 時間を指定すると、指定した時間以降に作成/変更されたデータが取得されます。 |
| newFormat | 整数 | newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。 newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。 |
| version | 整数 | version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。 現在のバージョンは4です。 |
* - 必須パラメーター
エラーコード
エラーコードを参照してください。
例
［見込み客］タブから未対応の見込み客をすべて取得する
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&cvName=All Open Leads
newFormatパラメーターを指定せずに見込み客を取得する
注：
- レスポンス形式に関する指定がない場合、デフォルト値「1」がnewFormatパラメーターに割り当てられます。つまり、newFormat = 1となります。
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=All Open Leads&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
以下のようなレスポンスが返されます。
<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
</row>
<row no="2">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
</row>
</Leads>
メールは値がnullであるため、レスポンスには示されません。
newFormat=2を使用して取得する
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&newFormat=2
&cvName=All Open Leads
&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue,Campaign Source)
以下のようなレスポンスが返されます。
<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
<FL val="CAMPAIGNID">null</FL>
<FL val="Campaign Source">null</FL>
</row>
<row no="2">
<FL val="LEADID">200000002222</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
...............
...............
</row>
<row no="3">
<FL val="LEADID">2000000024444</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
...............
...............
</row>
</Leads>
fromIndex=1、toIndex=25を使用して呼び出す
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&cvName=All Open Leads
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&fromIndex=1
&toIndex=25
注：
- 最初の25件のデータが返されます。
lastModifiedTimeを使用して呼び出す
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&cvName=All Open Leads
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&lastModifiedTime=2010-04-21 11:09:23
注：
- 時間を指定すると、指定した時間以降に作成/変更されたデータが取得されます。
newFormat=1を使用して見込み客の全項目を選択する
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All&cvName=All Open Leads
注：
- 値を持つすべての項目が返されます。
newFormat=2を使用して見込み客の全項目を選択する
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All&cvName=All Open Leads
注：
- 値がnullの項目を含め、すべての項目が返されます。
lastModifiedTime、fromIndex、toIndexを使用して呼び出す
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&cvName=All Open Leads
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&lastModifiedTime=2010-04-21 11:09:23
&fromIndex=1
&toIndex=25
テストプログラム
添付のプログラムを使用すると、Java環境でgetCVRecordsメソッドの動作を実行、テストできます。このJavaプログラムには、以下が含まれています。
- トークン作成形式
- パラメーターとその値
- メソッドの実際の使用
プログラムをダウンロードするには、こちらをクリックしてください。