レスポンスと例外 - Python SDK

APIResponse、BulkAPIResponse、FileAPIResponseは、Zoho CRM APIのレスポンスのラッパーオブジェクトです。すべてのAPI呼び出しメソッドは、これら3つのオブジェクトのいずれかを返します。

  • メソッド検索エンティティーはAPIResponseオブジェクトを返し、メソッド検索エンティティーのリストはBulkAPIResponseオブジェクトを返します。
  • インスタンス変数dataを使用して、エンティティーデータのみをレスポンスラッパーオブジェクトから取得します。APIResponse.dataは、単一のZoho CRMエンティティーオブジェクトを返し、BulkAPIResponse.dataは、Zoho CRMエンティティーオブジェクトのリストを返します。
  • ファイルダウンロードAPIではFileAPIResponseが返されて、データまたはメモからrecord.download_photo()、record.download_attachment(attachment_id)などの写真または添付ファイルがダウンロードされます。

これらのレスポンスラッパーオブジェクトには、データ以外に次のプロパティーがあります。

  1. response_headers - 現在の日付/ウィンドウの残りのAPIカウントと、現在のウィンドウがリセットされてから経過した時間。
  2. info - 実際のデータに加えて、APIによって提供される場合は、その他の情報。
  3. bulk_entity_response（EntityResponseインスタンスのリスト） - 一括APIの個々のエンティティーのステータス。たとえば、データの挿入では、いくつかのデータのためにAPIが部分的に失敗することがあります。このディクショナリーは、個々のデータの作成ステータスを示します。

アプリの起動

SDKでは、アプリを起動するたびに、次のコード行を呼び出す必要があります。

ZCRMRestClient.initialize()

このメソッドは、アプリケーションを起動するためにPythonアプリケーションのメインクラスから呼び出す必要があります。例外なく呼び出す必要があります。

例外の確認

問題のあるAPIレスポンス、SDKの異常などの予期しない動作はすべてSDKによって処理され、単一の例外であるZCRMExceptionとしてのみスローされます。したがって、この例外を検出するには、クライアントアプリコードだけで十分です。