getMyRecordsメソッド
目次
- 目的
- リクエストURL
- リクエストパラメーター
- エラーコード
- 例
- Zoho CRMから見込み客データを取得する
- 200件を超えるデータを取得する
- 「Company」名の昇順で見込み客を取得する
- 「Company」名の降順で見込み客を取得する
- newFormatパラメーターを指定せずに見込み客を取得する
- 「newFormat=2」を使用して見込み客を取得する
- Zoho CRMから最初の25件の見込み客を取得する
- 「lastModifiedTime」パラメーターを使用して見込み客を取得する
- newFormat=1パラメーターを使用して見込み客の全項目を選択する
- newFormat=2を使用して見込み客の全項目を選択する
- lastModifiedTime、fromIndex、toIndexパラメーターを使用して見込み客を取得する
- テストプログラム
目的
getMyRecordsメソッドを使用すると、APIリクエストで指定した認証トークンの所有者のデータを取得できます。
リクエストURL
XML形式：
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi
JSON形式：
https://crm.zoho.com/crm/private/json/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi
リクエストパラメーター
| パラメーター | データ型 | 説明 |
| authtoken* | 文字列 | Zoho認証情報の認証に使用する、暗号化された英数字文字列。 |
| scope* | 文字列 | 値をcrmapiと指定してください。 |
| selectColumns | 文字列 | CRMタブの必須項目を選択してください。 形式：タブ(項目のオプション) 例：leads(Last Name,Website,Email)またはAll |
| fromIndex | 整数 | デフォルト値 - 1 |
| toIndex | 整数 | デフォルト値 - 20 最大範囲値 - 200 （最大範囲値 = toIndex - fromIndex） |
| sortColumnString | 文字列 | CRMの項目を1つ選択して、データを並べ替えます。 例：sortColumnString=Company この例では、データはCompany項目に基づいて並べ替えられます。 |
| sortOrderString | 文字列 | ソート順：ascまたはdesc sortColumnStringパラメーターを使用する場合、デフォルトではデータが昇順で並べ替えられます。 |
| lastModifiedTime | yyyy-MM-dd HH:mm:ss | デフォルト値：null 時間を指定すると、指定した時間以降に作成/変更されたデータが取得されます。 |
| newFormat | 整数（1または2） | newFormat=1：値が「null」の項目を除外して、CRMアカウントのデータを取得します。 newFormat=2：値が「null」の項目を含めて、CRMアカウントのデータを取得します。 |
| version | 整数 | version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。 現在のバージョンは4です。 |
* - 必須パラメーター
注：
- API実装で行われた強化の詳細については、リリースノートページを参照してください。
エラーコード
エラーコードを参照してください。
その他の注意事項
- Zoho CRMアカウントからデータを取得する際、役職に応じたセキュリティ（役職、権限、項目単位のセキュリティとデータ共有ルール）が適用されます。役職に応じたセキュリティ設定については、セキュリティ管理を参照してください。
- fromIndexとtoIndexは、オプションのパラメーターです。デフォルトでは、fromlndexは1、toIndexは20に設定されます。
- sortColumnStringとsortOrderStringもオプションのパラメーターです。
- lastModifiedTimeパラメーターの値は、yyyy-MM-dd HH:mm:ss形式にする必要があります。
例
Zoho CRMから見込み客データを取得する
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?newFormat=1&authtoken=Auth Token&scope=crmapi
他のタブからデータを取得するには、LeadsをAccounts、Contacts、Potentialsなどに置き換えます。
200件を超えるデータを取得する
デフォルトでは、バッチごとに20件のデータを取得できます。ただし、toIndexパラメーターを使用すると、バッチごとに最大200件のデータを取得できます。200件を超えるデータを取得する場合は、次の手順に従います。
イテレーション1：fromIndex=1&toIndex=200
イテレーション2：fromIndex=201&toIndex=400
「Company」名の昇順で見込み客を取得する
sortColumnString=Company&sortOrderString=asc
「Company」名の降順で見込み客を取得する
sortColumnString=Company&sortOrderString=desc
newFormatパラメーターを指定せずに見込み客を取得する
注：
- レスポンス形式に関する指定がない場合は、デフォルト値「1」がnewFormatパラメーターに割り当てられます。つまり、newFormat = 1となります。
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)
以下のようなレスポンスが返されます。
<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="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Leads>
「newFormat=2」を使用して見込み客を取得する
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)
以下のようなレスポンスが返されます。
<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>
</row>
</Leads>
Zoho CRMから最初の25件の見込み客を取得する
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&fromIndex=1&toIndex=25
「lastModifiedTime」パラメーターを使用して見込み客を取得する
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&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/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All
注：
- 値を持つすべての項目が返されます。
newFormat=2を使用して見込み客の全項目を選択する
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All
注：
- 値がnullの項目を含め、すべての項目が返されます。
lastModifiedTime、fromIndex、toIndexパラメーターを使用して見込み客を取得する
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23 &fromIndex=1&toIndex=25
テストプログラム
添付のプログラムを使用すると、Java環境でgetMyRecordsメソッドの動作を実行、テストできます。
このJavaプログラムには、以下が含まれています。
- 認証トークン作成形式
- パラメーターとその値
- メソッドの実際の使用