getSearchRecordsメソッド

目次

目的

このメソッドを使用すると、特定の列の式でデータを検索できます。

リクエストURL

XML形式：
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

JSON形式：
https://crm.zoho.com/crm/private/json/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

注：

  • Zoho CRMプランに関係なく、1日に送信できるAPIリクエストは250件までです。呼び出しごとに、最大200件のデータを取得できます。

リクエストパラメーター

パラメーターデータ型説明
authtoken*文字列Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*文字列範囲としてcrmapiを指定してください。
selectColumns*文字列タブ(項目のオプション)形式（Leads(Last Name,Website,Email)など）またはAllと指定してください。
searchCondition*文字列(Created By|=|username)
newFormat整数newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。
newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。
fromIndex整数デフォルト値 - 1
toIndex整数デフォルト値 - 20
最大値 - 200
version整数version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。
version = 2：最新のAPI実装に基づいてレスポンスを取得します。

* - 必須パラメーター

注：

正規表現

このメソッドを使用する際は、selectColumnsパラメーターとsearchConditionパラメーターが必須に設定されていることを確認してください。APIリクエストでは、以下の式を指定できます。

  • isまたは=
  • isn'tまたは<>
  • contains(*srcString*)
  • starts with(srcString*)
  • ends with(*srcString)
  • doesn't contain
  • <またはis before
  • >またはis after
  • <=
  • =>

例

例1

メールアドレスに「@sample.com」が含まれる見込み客の名前、組織、メールアドレス、携帯電話番号、Webサイトを検索する場合、検索APIリクエストは以下のようになります。

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Company,Email,Mobile,Website)&searchCondition=(Email|contains|*@sample.com*)

例2

従業員数が100名を超える見込み客の組織、メールアドレス、Webサイトを検索する場合、検索APIリクエストは以下のようになります。

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Company,Email,Website)&searchCondition=(No of Employees|>|100)

例3

組織名が「Zoho」で始まる見込み客の名前、メールアドレスを検索する場合、検索APIリクエストは以下のようになります。

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Email)&searchCondition=(Company|starts with|Zoho*)

等号（=）の使用例

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)&searchCondition=(Email|=|test@test.com)

大なり記号（>）の使用例

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Annual Revenue|>|1000)

小なり記号（<）の使用例

注：

  • null値の整数項目は「0」に置き換えてください。値のない整数項目は検索されません。

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(customfield1|<|1000)

containsの使用例

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|contains|*oho*)

starts withの使用例

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|starts with|zoho*)

ends withの使用例

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|ends with|*zoho)

等号（=）とselectColumns=Allの使用例

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=All
&searchCondition=(Email|=|test@test.com)

テストプログラム

添付のプログラムを使用すると、Java環境でgetSearchRecordsメソッドの動作を実行、テストできます。

このJavaプログラムには、以下が含まれています。

  • 認証トークン作成形式
  • パラメーターとその値
  • メソッドの実際の使用

プログラムをダウンロードするには、こちらをクリックしてください。